HUBII REC
HUBIIRec is an open-source software to record and distribute a bandwith of data useful to infer emotions or mental states during studies.
Feature Overview
- Mousetracking: Record mouse movement and clicks
- Eyetracking: Record Eye movement
- Heart Signals: Record heartrate and interbeat intervals
- Online distribution: Send live signals using a webhook and/or a websocket
Getting started
HUBIIRec is installed and ready to use in a few steps:
-
-
-
Get the latest release from this respostiory by downloading
HUBIIRec.zip. Information: You can always generate your own release by cloning the repository, installing the appropriate dependencies and executing theReleaseprofile. Make sure to selectx64as CPU profile. -
Extract the downloaded folder. The extracted folder should be named
Release. -
To start HUBIIRec, navigate into
Release, and executeHUBIIRec.exe.
-
-
How to record data
You can record data with HUBIIRec by following a simple workflow:
-
-
-
Select a user name. Most likely, this will be the participant ID of your study participant
-
Select a directory in which the data will be stored. You can do this by pressing the folder icon and selecting the corresponding folder.
-
Connect sensors. HUBIIRec supports different sensors. Consider the section How to connect a sensor for more information.
-
Select the data to record by selecting the corresponding checkboxes.
-
(Optional) Configure live data transmission using a webhook and/or a websocket. Consirder the section How to set up web connections for more information.
-
Start the recording by pressing the “Start Recording” button.
-
Stop the recording by pressing the “Stop Recording” button. You can find the recorded data within the directory you specified in step 2.
-
-
How to connect a sensor
HUBIIRec currently supports two types of sensors: Polar heart rate sensors and tobii eye tracking devices.
How to connect Polar heart rate sensors
Before trying to connect a Polar heart rate sensor to HUBIIRec, make sure that Bluetooth is enabled on your device and that the corresponsing sensor is up and running. Also make sure, that the sensor name starts with `Polar’.
There are two different ways to connect a Polar heart rate sensor: By specifically entering the sensor name, or by starting a bluetooth device discorvery. Per default, the UI provides a text area, in which you can insert the sensor name. To connect to the sensor with the specified name, click “Connect” after inserting the name into the textarea.
If you do not know the exact sensor name, you can alternatively search for all available Polar sensors in your environment. To start a device discovery, click the “Switch” button. HUBIIRec will start the discovery automatically. To view all available Polar sensors, expand the drop down menu.
Important: You will only be able to select heart signal checkboxes if a Heart Rate sensor is connected.
How to connect an eye tracking device
To set up an tobii eyetracking device, you simply have to press “Calibrate Eye Tracker”.
TO BE EXPANDED
How to set up web connections
To transmit live data, HUBII rec provides two mechanisms: By establishing a webhook or a by creating a websocket. To establish a webhook, you have to select the corresponding checkbox. After that, you have to enter the destination URI to which the data should be sent into the corresponding text area.
To create a websocket, you also have to select the corresponding checkbox. After that, you have to configure the port under which you wish to make the websocket accessible. To start the websocket before starting the recording, press “Open Websocket”. It might be advisable to open the websocket before starting the recording so that the client can connect to the websocket beforehand. Otherwise, the client might miss the first data points transmitted before connecting to the websocket.
If you do not start the websocket manually, HUBIIRec will start it automatically when you start the data recording.
Important: Make sure that the specified port is not already occupied and that your firewall settings do not block incomming connections.
