HUBII REC - HUBII

HUBIIRec – Biosignal Recorder for HUBII Pipelines

HUBIIRec is an open-source tool for recording and streaming mouse, eye-tracking, and heart-rate signals into HUBII biosignal pipelines for emotion and mental-state studies.

Download HUBIIRec for Windows (64-bit)

Download HUBIIRec

HUBIIRec is currently available for Windows (64-bit).

Download the latest release
Download HUBIIRec.zip from the repository’s release page.
(Advanced users can also clone the repository, install the required dependencies, and build their own release by executing the Release profile with x64 as CPU profile.)
Extract the archive
Unzip the downloaded file. The extracted folder will typically be named Release.
Run HUBIIRec
Open the Release folder and start the application by running HUBIIRec.exe.

Note: Bluetooth is required if you want to connect Polar heart-rate sensors. Eye-tracking support requires a compatible Tobii device with drivers installed.

Key Features

Mouse tracking

Record mouse movements and clicks for interaction and behavior analysis.

Eye tracking

Record eye movements from supported Tobii eye-tracking devices.

Heart signals

Record heart rate and inter-beat intervals from Polar heart-rate sensors.

Online distribution

Send live signals via HTTP webhook and/or WebSocket to your own applications or HUBII pipelines.

Supported Sensors & Data

HUBIIRec currently supports the following signals and devices:

Mouse input

HUBIIRec can record cursor position and clicks as part of each session.

Mouse data is time-stamped and aligned with other signals, making it suitable for interaction and behavioral analysis.

Tobii eye-tracking devices

HUBIIRec can connect to compatible Tobii eye trackers (assuming the required drivers and software are installed).

After successful connection and calibration, eye-tracking data (e.g., gaze position) can be recorded alongside other signals.

Polar heart-rate sensors

HUBIIRec supports Polar heart-rate sensors (e.g., Polar H10) via Bluetooth.

Once connected, you can record heart rate and, where available, inter-beat intervals (IBI).

Heart-signal checkboxes in the interface are only enabled after a Polar device has been successfully connected.

Record Data: Quick Start

You can record data with HUBIIRec by following this workflow:

Select a user name
Enter a user name, typically the participant ID in your study.
Choose a data directory
Select the folder where the recorded data should be stored by clicking the folder icon and choosing the desired directory.
Connect sensors
Connect the sensors you need for this session. See Supported Sensors & Data and How to connect a sensor for details.
Select the data to record
Use the checkboxes to choose which signals (mouse, heart signals, eye tracking) should be recorded.
(Optional) Configure live data transmission
If you want to stream data while recording, configure a webhook and/or WebSocket (see Live Streaming & Integration).
Start recording
Click Start Recording to begin capturing data.
Stop recording
Click Stop Recording to end the session.
The recorded files will be stored in the directory you selected in step 2.

How to Connect Sensors

HUBIIRec currently supports two types of external sensors: Polar heart-rate sensors and Tobii eye-tracking devices.

How to Connect Polar Heart-Rate Sensors

Before connecting a Polar sensor to HUBIIRec, please ensure that:

Bluetooth is enabled on your computer
The sensor is worn correctly and active
The sensor name starts with Polar

There are two ways to connect a Polar heart-rate sensor:

Connect by sensor name

Enter the exact sensor name into the text field.
Click Connect to connect to that sensor.

Discover available sensors

Click the Switch button to start a Bluetooth device discovery.
HUBIIRec will automatically search for available Polar sensors.
Open the drop-down menu to view and select one of the discovered devices.

Important: Heart-signal checkboxes (for heart rate and inter-beat interval) are only enabled after a Polar heart-rate sensor has been successfully connected.

How to Connect an Eye-Tracking Device

To use a Tobii eye-tracking device with HUBIIRec:

Make sure your Tobii device is connected and the required drivers/software are installed.
In HUBIIRec, press Calibrate Eye Tracker and follow the on-screen instructions to complete calibration.

Live Streaming & Integration

In addition to saving data to disk, HUBIIRec can stream signals in real time so that you can visualise data live, integrate it into your own applications, or feed it into HUBII pipelines.

HUBIIRec supports two streaming mechanisms:

Webhook (HTTP POST)
WebSocket

Webhook (HTTP POST)

Tick the Webhook checkbox in the HUBIIRec interface.
Enter the destination URI (the URL of your server endpoint) into the text field.
Start recording. During the recording, HUBIIRec will send HTTP POST requests with live data to this URI.

On your server side, you can parse the incoming JSON, store it in a database, or forward it to other tools.

WebSocket Streaming

Tick the WebSocket checkbox.
Enter the port number under which the WebSocket server should be accessible.
To start the WebSocket server before you begin recording, click Open WebSocket.
This is recommended so that your client can connect before data transmission starts and does not miss the first data points.
If you do not start the WebSocket manually, HUBIIRec will start it automatically when you start recording.

Important: Make sure that the specified port is not already in use and that your firewall settings allow incoming connections on this port.

FAQ

Why is my Polar device not found?
- Make sure Bluetooth is enabled and the Polar sensor is active and worn correctly. Try refreshing the device list or restarting HUBIIRec.

Why is no eye-tracking data being recorded?
- Ensure that your Tobii device is connected, turned on, and properly calibrated using the Tobii tools. Restart HUBIIRec and enable eye-tracking again.