Macros | |
#define | OK_RESULT 0 |
#define | NO_REPLY 1000 |
#define | LINK_TERMINATED_RESULT -100 |
#define | ABORT_RESULT 27 |
#define | UNEXPECTED_EOL_RESULT -1 |
#define | SYNTAX_ERROR_RESULT -2 |
#define | BAD_VALUE_RESULT -3 |
#define | EXTRA_CHARACTERS_RESULT -4 |
#define | IN_DISCONNECT_MODE 16384 |
#define | IN_UNKNOWN_MODE 0 |
#define | IN_IDLE_MODE 1 |
#define | IN_SETUP_MODE 2 |
#define | IN_RECORD_MODE 4 |
#define | IN_TARGET_MODE 8 |
#define | IN_DRIFTCORR_MODE 16 |
#define | IN_IMAGE_MODE 32 |
#define | IN_USER_MENU 64 |
#define | IN_PLAYBACK_MODE 256 |
Functions | |
INT16 | eyelink_current_mode (void) |
INT16 | eyelink_tracker_mode (void) |
INT16 | eyelink_wait_for_mode_ready (UINT32 maxwait) |
INT16 | eyelink_user_menu_selection (void) |
void | set_offline_mode (void) |
#define ABORT_RESULT 27 |
EyeLink TRACKER RETURN CODES: operation aborted (calibration)
#define BAD_VALUE_RESULT -3 |
COMMAND PARSE ERRORS: value is not right for command or tracker state
#define EXTRA_CHARACTERS_RESULT -4 |
COMMAND PARSE ERRORS: bad format or too many values
#define IN_DISCONNECT_MODE 16384 |
Tracker state bit: disconnected.
#define IN_DRIFTCORR_MODE 16 |
Tracker state bit: drift correction
#define IN_IDLE_MODE 1 |
Tracker state bit: off-line
#define IN_IMAGE_MODE 32 |
Tracker state bit: image-display mode
#define IN_PLAYBACK_MODE 256 |
Tracker state bit: tracker sending playback data
#define IN_RECORD_MODE 4 |
Tracker state bit: data flowing
#define IN_SETUP_MODE 2 |
Tracker state bit: setup or cal/val/dcorr
#define IN_TARGET_MODE 8 |
Tracker state bit: some mode that needs fixation targets
#define IN_UNKNOWN_MODE 0 |
Tracker state bit: mode fits no class (i.e setup menu)
#define IN_USER_MENU 64 |
Tracker state bit: user menu
#define LINK_TERMINATED_RESULT -100 |
LINK RETURN CODES: can't send or link closed
#define NO_REPLY 1000 |
LINK RETURN CODES: no reply yet (for polling test)
#define OK_RESULT 0 |
LINK RETURN CODES: OK
#define SYNTAX_ERROR_RESULT -2 |
COMMAND PARSE ERRORS: unknown command, unknown variable etc.
#define UNEXPECTED_EOL_RESULT -1 |
COMMAND PARSE ERRORS: not enough data
INT16 eyelink_current_mode | ( | void | ) |
This function tests the current tracker mode, and returns a set of flags based of what the mode is doing. The most useful flag using the EXPTSPPT toolkit is IN_USER_MENU
to test if the EyeLink Abort menu has been activated.
IN_DISCONNECT_MODE
if disconnected. IN_IDLE_MODE
if off-line (Idle mode). IN_SETUP_MODE
if in Setup-menu related mode. IN_RECORD_MODE
if tracking is in progress. IN_PLAYBACK_MODE
if currently playing back data. IN_TARGET_MODE
if in mode that requires a fixation target. IN_DRIFTCORR_MODE
if in drift-correction. IN_IMAGE_MODE
if displaying grayscale camera image. IN_USER_MENU
if displaying Abort or user-defined menu.\b Example: See \c echo_key() \sa \c echo_key(), \c eyelink_tracker_mode() and \c eyelink_user_menu_selection()
INT16 eyelink_tracker_mode | ( | void | ) |
Returns raw EyeLink mode numbers, defined in eyelink.h as EL_xxxx definitions.
-1
if link disconnectedExample:
eyelink_current_mode()
and eyelink_is_connected()
INT16 eyelink_user_menu_selection | ( | void | ) |
Checks for a user-menu selection, clears response for next call.
0
if no selection made since last call, else code of selection.Example:
eyelink_current_mode()
INT16 eyelink_wait_for_mode_ready | ( | UINT32 | maxwait | ) |
After a mode-change command is given to the EyeLink tracker, an additional 5 to 30 milliseconds may be needed to complete mode setup. Call this function after mode change functions.
0
, assume a tracker error has occurred. maxwait | Maximum milliseconds to wait for the mode to change. |
0
if mode switching is done, else still waiting.Example: See eyelink_data_start()
eyelink_data_start()
and set_offline_mode()
void set_offline_mode | ( | void | ) |
Places EyeLink tracker in off-line (idle) mode. Wait till the tracker has finished the mode transition.
Example:
eyelink_abort()