Integrating with Eye Tracker Manager

In addition to being a graphical application in which you can browse eye trackers and work with selected eye tracker, you can also launch Eye Tracker Manager with command line arguments to directly trigger its features. This allows you to reuse some of the features of Eye Tracker Manager instead of implementing your own version (using the Tobii Pro SDK).

Command line arguments

Location of executable

Tobii Pro Eye Tracker Manager (ETM) is an Electron based application, which on some systems means it gets installed in a non-standard location.

OS Path
Windows %localappdata%\TobiiProEyeTrackerManager\app-X.Y.Z\TobiiProEyeTrackerManager.exe *
Linux /opt/TobiiProEyeTrackerManager/TobiiProEyeTrackerManager (can be called by alias TobiiProEyeTrackerManager)
MacOS /Applications/TobiiProEyeTrackerManager.app/Contents/MacOS/TobiiProEyeTrackerManager
* Note: On Windows, the folder name "app-X.Y.Z" will depend on the version of Eye Tracker Manager with "X", "Y" and "Z" matching "major", minor", "revision" resp. For example, version 1.2.3 would have the folder "app-1.2.3".

Options

When launching Eye Tracker Manager from command line, you can use the following options and arguments.

Option Description
--device-sn=<serial number> Selects eye tracker based on serial number. Can be used in combination with --mode. Example: --device-sn=IS404-100106045321
--device-adress=<uri> Selects eye tracker based on adress (URI). Can be used in combination with --mode. Example: --device-adress=tobii-ttp://is404-100106045321
--help Show the help text.
--mode=[displayarea|usercalibration|trackstatus] displayarea
Launch the "Physical Eye Tracker Setup" (aka display area configuration) module.
usercalibration
Launch the calibration module.
trackstatus
Launch the track status module.
Needs to be combined with --device-sn or --device-adress. Example: --mode=usercalibration --device-adress=tobii-ttp://is404-100106045321
--screen=<screen nr> Select screen to display on. Can be used in combination with --mode. Example: --mode=usercalibration --device-adress=tobii-ttp://is404-100106045321 --screen 1
--version Show the version of Eye Tracker Manager.

Exit codes

Tho following status codes can be expected to be returned as exit code when Eye Tracker Manager terminates.

Exit code Description
0 EXIT_OK
31 EXIT_ERROR_CALIBRATION_FAILED
32 EXIT_ERROR_DISPLAYAREA_FAILED
33 EXIT_ERROR_DISPLAY_AREA_NOT_SET
44 EXIT_ERROR_NOT_FOUND
51 EXIT_ERROR_INVALID_ARGUMENT
52 EXIT_ERROR_MISSING_ARGUMENT
53 EXIT_ERROR_UNKNOWN_MODE

Invoking from code

In the API reference guide for each binding there are code examples on how to launch Eye Tracker Manager (with CLI options) from within your application. In each binding's API reference guide, expand the Examples node and look for a file called either call_eyetracker_manager or CallEyeTrackerManager.

Launching ETM from .NET

Launching ETM from Python

Launching ETM from Matlab

Launching ETM from C