zero-noise-lab / unreal-eyeserver-interface

An Unreal Engine plugin to interface the ESI EyeLinkServer

Unreal Plugin interfacing EyeLinkServer

This is a project plugin for Unreal Engine projects that provides a Blueprint Function Library to interface the ESI EyeServer. The EyeServer is part of the ARCADE suite and allows monitoring the eye position tracked by the free iRecHS2 system or an SR Research Eyelink system.

For the Unreal Engine to be able to start the EyeServer, the iRecServer.exe or EyeLinkServer.exe needs to be on the user's path. The provided Blueprint functions can be mapped to any kinds of events such as BeginPlay, keyboard presses, etc., see for example

It has been developed using Unreal Engine 4.24.2, iRecServer 1.0.4.0 and EyeLinkServer 1.2.2.0.

This plugin is free but copyrighted software, distributed under the terms of the MIT License. See the file LICENSE for more details.

unreal-eyeserver-interface's Issues

Add support for deleting targets

Currently, targets can only be created, not deleted.

Warning when disconnecting

Every time I try to disconnect from the Eyeserver it seems to work but the log gives a warning:
LogTemp: Warning: EyeServer: disconnect may have failed

Full log trace looks like:
LogTemp: Display: EyeServer: starting EyeLinkServer
LogTemp: Display: EyeServer: connecting
LogTemp: Display: EyeServer: starting recording without EDF
LogTemp: Display: EyeServer: stopping recording without EDF
LogTemp: Display: EyeServer: stopping recording without EDF
LogTemp: Display: EyeServer: stopping recording without EDF
LogTemp: Display: EyeServer: stopping recording without EDF
LogTemp: Display: EyeServer: stopping recording without EDF
LogTemp: Display: EyeServer: disconnecting
LogTemp: Warning: EyeServer: disconnect may have failed
LogTemp: Display: EyeServer: stopping EyeLinkServer process

Add support for retreiving EDF file

In order to retreive the recored data via ethernet we need to implement the StartRecording and StopRecording methods with a filename:

[00 0 2 filename] start recording
[00 0 0 filename] stop recording (and copy .edf to the specified file)

Note: This cannot be developed without a real Eyelink system

iRec calibration interface

Now that we've switched to iRecHS2 we need a way to tell it to accept the calibration point. It seems that using Microsoft Spy++ I should be able to figure out which messages it's expecting and send it with c++:
https://stackoverflow.com/questions/33508849/how-to-send-keydown-event-to-inactive-window-in-c

Or I could create some kind of hot key for this:
http://www.cplusplus.com/forum/windows/137836/

Add support for multiple targets

Currently it's only possible to have on target. This limitation was only due to lack of time to implement proper string handling, but should be possible with not too much work.