Update SRanipal authored by Jonathan Ehret's avatar Jonathan Ehret
:warning: **Eye Tracking will only work on Windows right now and only with a Vive Pro Eye** :warning: Just head orientation tracking will always work! :warning: **Eye Tracking with SRanipal will only work on Windows right now and only with a Vive Pro Eye** (and was only tested with UE 4.27) :warning: Just head orientation tracking will always work!
There is a GazeTest map in the [Study Framework Demo](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/study-framework-demo) project. There is a GazeTest map in the [Study Framework Demo](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/study-framework-demo) project.
...@@ -14,16 +14,14 @@ There is a GazeTest map in the [Study Framework Demo](https://git-ce.rwth-aachen ...@@ -14,16 +14,14 @@ There is a GazeTest map in the [Study Framework Demo](https://git-ce.rwth-aachen
* ``LaunchCalibration()`` to launch a calibration from code. * ``LaunchCalibration()`` to launch a calibration from code.
* logs the currently gaze at target name and the gaze direction per frame into a separate file per participant. The participant's gaze tracking logs are located in the StudyLogs/GazeTrackingLogs folder. For head rotation logs, please refer to the [Logging the Position of the Player](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/unreal-study-framework/-/wikis/Logging#example-logging-the-position-of-the-player-in-vr) section of the wiki. * logs the currently gaze at target name and the gaze direction per frame into a separate file per participant. The participant's gaze tracking logs are located in the StudyLogs/GazeTrackingLogs folder. For head rotation logs, please refer to the [Logging the Position of the Player](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/unreal-study-framework/-/wikis/Logging#example-logging-the-position-of-the-player-in-vr) section of the wiki.
# Prerequisite # Prerequisite for using SRanipal
If you just want to use ``HeadRotationOnly`` as tracking mode, the following is not required. * You have to add the ``SRanipal`` plugin to your project it can be downloaded as part of the SDK [here](https://developer-express.vive.com/resources/vive-sense/eye-and-facial-tracking-sdk/download/latest/) (HTC Vive account required)\
To add eye tracking you have to add the ``SRanipal`` plugin to your project it can be downloaded as part of the SDK [here](https://developer-express.vive.com/resources/vive-sense/eye-and-facial-tracking-sdk/download/latest/) (HTC Vive account required)\
:warning: Make sure that the ``Plugins/SRanipal/Binaries`` folder is commited to your project. In case it is ignored by default do ``git add -f Plugins/SRanipal/Binaries`` :warning: Make sure that the ``Plugins/SRanipal/Binaries`` folder is commited to your project. In case it is ignored by default do ``git add -f Plugins/SRanipal/Binaries``
Furthermore ``Vive SRAnipal`` needs to be installed. Currently this can be done via Steam installing ``Vive Console``. I had problems starting calibration, since the firmware seemed not to be updated, starting ``Tobii Pro Lab`` automatically started a firmware update. * Furthermore ``Vive SRAnipal`` needs to be installed. Currently this can be done via Steam installing ``Vive Console``. I had problems starting calibration, since the firmware seemed not to be updated, starting ``Tobii Pro Lab`` automatically started a firmware update.
Also in your project you have to have the ``SRanpial`` plugin activated in the .uproject file * Also in your project you have to have the ``SRanpial`` plugin activated in the .uproject file
``` ```
"Plugins": [ "Plugins": [
{ {
...@@ -33,7 +31,7 @@ Also in your project you have to have the ``SRanpial`` plugin activated in the . ...@@ -33,7 +31,7 @@ Also in your project you have to have the ``SRanpial`` plugin activated in the .
], ],
``` ```
# Starting # Starting with SRanipal
For any HTC Vive Pro Eye eye tracking to work: For any HTC Vive Pro Eye eye tracking to work:
* Steam (VR) for me needed to be started as admin * Steam (VR) for me needed to be started as admin
... ...
......