Skip to Content
This documentation is provided with the HEAT environment and describes this HEAT instance.

Configure the Tobii module

Settings are edited in HEAT Capture’s module settings UI, under HEAT.TobiiModule.

⚠️

Every session applies the same bundled default calibration blob - there is no per-user or per-session calibration step. If your deployment needs calibration accurate to a specific operator, that has to be handled outside this module; gaze accuracy from this module reflects the default calibration, not that operator.

License and screen geometry

SettingTypeDefaultWhat it controls
LicenceFilefile pathemptyPath to the Tobii license file for the connected device. Required - see Troubleshooting if the module fails to start.
ScreenWidthfloat (mm)527.0Physical width of the screen the tracker is mounted to. Feeds Tobii’s own display-area calculation together with the tracker’s own reported mounting geometry.
ScreenHeightfloat (mm)296.0Physical height of the screen.
TrackerOffsetXfloat (mm)0.0How far the tracker sits from the screen’s horizontal center. Tobii’s calculation has no equivalent Y or Z offset setting - only this one.

Getting ScreenWidth/ScreenHeight/TrackerOffsetX wrong does not produce an error; it produces a display area calculation that is internally consistent but physically wrong, and therefore gaze-to-screen mapping that is off in a way that is easy to mistake for a tracking problem.

Video capture

SettingTypeDefaultWhat it controls
CaptureVideoFeedbooleantrueCaptures the tracker’s infrared camera feed as H264 video, alongside gaze/pupillometry/head pose. See Data produced for how the video is published.

The output frequency Tobii’s own SDK is asked to run at, and the video’s frame rate, are both fixed at 33Hz in source - there is no setting for either. If the connected device requires a Config-level Tobii license to honor a custom output frequency and doesn’t have one, it falls back to its own default frequency instead, without failing the module.

This module also exposes the generic settings every HEAT Capture module has (Enabled, Interval, OverrideNodeId/NodeId, Timeout) - see Manage capture modules.

🚫

Gaze, pupillometry and head pose are only published at Interval cadence, left at the SDK default of 1000 ms - there is no native-rate publish path or SendAtNativeRate toggle for this data, unlike the other eye-tracking modules in this catalogue. Tobii’s own callbacks update a cache continuously at the device’s native rate (33Hz by default), but that cache is only snapshotted and published once per Interval. At the default setting, gaze publishes at 1Hz, not 33Hz. Lower Interval if your scenario needs gaze data anywhere near the device’s actual rate. Video, published separately, is not affected by this - see Data produced.

Opens your browser's print dialog. Choose "Save as PDF" as the destination.