Welcome to GetEmotion!

GetEmotion is an Android mobile application used as a Haptic Touch Data Collector tool as part of the methodologies of the thesis, Integrating Haptic Touch on Android Devices for Emotion Recognition in an Emotionally Stimulated Environment. It is mainly built following the experiment procedure of collecting haptic data from participants who were emotionally stimulated using the LIRIS-ACCEDE dataset.

GetEmotion is developed using the Kotlin programming language in Android Studio, with the integration of Firebase Firestore and Authentication.

The next section details how to run GetEmotion on an Android smartphone. It is recommended that the open-source project is run only through Android Studio, and that an external smartphone device is ready for usage.

Guide

The guide explains the compatibility, installations, and step-by-step process in order to run GetEmotion application in an Android Smartphone. Please check each of the subsections below:

1. Smartphone Compatibility
2. Android Studio Processes
3. Firebase Processes
4. Running the Application

Smartphone Compatibility

By default, GetEmotion application will only work on at least SDK 30/Android Platform Version 11 due to its capability for wireless debugging, which is used to run the app on a smartphone without needing a connecting wire.

Please ensure that the Android version of your device uses at least Android 11.

Android Studio Processes

Download the latest version of Android Studio. By the initial version of this application, GetEmotion is runnable on Android Studio Koala 2024.1.1. It also runs on Gradle 8.5 as per project publishing.

Firebase Processes

GetEmotion highly depends on using Firebase Firestore and Authentication for its data management and storage. Please follow the instructions below to ensure that the application is runnable without errors:

Account Creation

Go to Firebase Console and create an account.

Create a Project

1. Click create a project.

2. Set project name to GetEmotion.

3. Proceed to next until you confirm your creation.

Connect GetEmotion application to Firebase through a series of instructions in the screenshots below:

1. Click the Android icon as shown.

2. On the Android package name field, type com.opensource.getemotion.

3. Download the google-services.json file.

4. In the next steps, click next until the setup is finished.

Configure Firebase Firestore through these instructions:

1. Find the Firestore Database.

2. (Optional) You can set a location based on your preference.

3. Choose Start in Test Mode. Please don't use production mode.

4. Click the Rules tab.

5. Set the timestamp.date() to a date of your preference, and click publish.

6. It is crucial to add two collections in order for GetEmotion to work: Users and Interactions. Click Start collection.

7. Firstly, enter Users for the collection ID.

8. Then, you can indicate the document ID as Test for a test document. Click save.

9. Repeat Steps 6 to 8 for the Interactions collection.

Configure Firebase Authentication by following these steps:

1. Find the Authentication.

2. Under Native Providers, choose Email/Password.

3. Only enable Email/Password. Then, click save.

Completing the Program

Move google-services.json to your module (app-level) root directory

1. Make sure that you are under Project view.
2. Move the google-services.json under the app folder.

Connect your device to Android Studio

1. Find the Device Manager button at the top of the Android Studio IDE. It can also be found on the right side of Android Studio.
2. Click Pair Devices Using WiFi to pair your device wireless.

3. On your device, enable Developer Options. Then, go to Wireless Debugging.
4. You can pair using a QR code or a pairing code.

Note: You can also connect your device using a connector wire by enabling USB Debugging under the Developer Options.

Running the Application

To run the GetEmotion application, click the Run button at the top of the Android Studio IDE or go to the Run tab.