From e7cace52a6c1e0af88b715fce99c46fd48aa8bcc Mon Sep 17 00:00:00 2001 From: Damien Mouratille Date: Fri, 23 Aug 2024 15:35:37 +0200 Subject: Add Pupil Labs Neon device --- .../context_modules/pupil_labs.md | 32 ---------------------- .../context_modules/pupil_labs_invisible.md | 32 ++++++++++++++++++++++ .../context_modules/pupil_labs_neon.md | 32 ++++++++++++++++++++++ .../context_modules/tobii_pro_glasses_3.md | 32 ++++++++++++++++++++++ 4 files changed, 96 insertions(+), 32 deletions(-) delete mode 100644 docs/user_guide/eye_tracking_context/context_modules/pupil_labs.md create mode 100644 docs/user_guide/eye_tracking_context/context_modules/pupil_labs_invisible.md create mode 100644 docs/user_guide/eye_tracking_context/context_modules/pupil_labs_neon.md create mode 100644 docs/user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_3.md (limited to 'docs') diff --git a/docs/user_guide/eye_tracking_context/context_modules/pupil_labs.md b/docs/user_guide/eye_tracking_context/context_modules/pupil_labs.md deleted file mode 100644 index d2ec336..0000000 --- a/docs/user_guide/eye_tracking_context/context_modules/pupil_labs.md +++ /dev/null @@ -1,32 +0,0 @@ -Pupil Labs -========== - -ArGaze provides a ready-made context to work with Pupil Labs devices. - -To select a desired context, the JSON samples have to be edited and saved inside an [ArContext configuration](../configuration_and_execution.md) file. -Notice that the *pipeline* entry is mandatory. - -```json -{ - JSON sample - "pipeline": ... -} -``` - -Read more about [ArContext base class in code reference](../../../argaze.md/#argaze.ArFeatures.ArContext). - -## Live Stream - -::: argaze.utils.contexts.PupilLabs.LiveStream - -### JSON sample - -```json -{ - "argaze.utils.contexts.PupilLabs.LiveStream": { - "name": "Pupil Labs live stream", - "project": "my_experiment", - "pipeline": ... - } -} -``` diff --git a/docs/user_guide/eye_tracking_context/context_modules/pupil_labs_invisible.md b/docs/user_guide/eye_tracking_context/context_modules/pupil_labs_invisible.md new file mode 100644 index 0000000..1f4a94f --- /dev/null +++ b/docs/user_guide/eye_tracking_context/context_modules/pupil_labs_invisible.md @@ -0,0 +1,32 @@ +Pupil Labs Invisible +========== + +ArGaze provides a ready-made context to work with Pupil Labs Invisible device. + +To select a desired context, the JSON samples have to be edited and saved inside an [ArContext configuration](../configuration_and_execution.md) file. +Notice that the *pipeline* entry is mandatory. + +```json +{ + JSON sample + "pipeline": ... +} +``` + +Read more about [ArContext base class in code reference](../../../argaze.md/#argaze.ArFeatures.ArContext). + +## Live Stream + +::: argaze.utils.contexts.PupilLabsInvisible.LiveStream + +### JSON sample + +```json +{ + "argaze.utils.contexts.PupilLabsInvisible.LiveStream": { + "name": "Pupil Labs Invisible live stream", + "project": "my_experiment", + "pipeline": ... + } +} +``` diff --git a/docs/user_guide/eye_tracking_context/context_modules/pupil_labs_neon.md b/docs/user_guide/eye_tracking_context/context_modules/pupil_labs_neon.md new file mode 100644 index 0000000..535f5d5 --- /dev/null +++ b/docs/user_guide/eye_tracking_context/context_modules/pupil_labs_neon.md @@ -0,0 +1,32 @@ +Pupil Labs Neon +========== + +ArGaze provides a ready-made context to work with Pupil Labs Neon device. + +To select a desired context, the JSON samples have to be edited and saved inside an [ArContext configuration](../configuration_and_execution.md) file. +Notice that the *pipeline* entry is mandatory. + +```json +{ + JSON sample + "pipeline": ... +} +``` + +Read more about [ArContext base class in code reference](../../../argaze.md/#argaze.ArFeatures.ArContext). + +## Live Stream + +::: argaze.utils.contexts.PupilLabsNeon.LiveStream + +### JSON sample + +```json +{ + "argaze.utils.contexts.PupilLabsNeon.LiveStream": { + "name": "Pupil Labs Neon live stream", + "project": "my_experiment", + "pipeline": ... + } +} +``` diff --git a/docs/user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_3.md b/docs/user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_3.md new file mode 100644 index 0000000..3d37fcc --- /dev/null +++ b/docs/user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_3.md @@ -0,0 +1,32 @@ +Tobii Pro Glasses 3 +=================== + +ArGaze provides a ready-made context to work with Tobii Pro Glasses 3 devices. + +To select a desired context, the JSON samples have to be edited and saved inside an [ArContext configuration](../configuration_and_execution.md) file. +Notice that the *pipeline* entry is mandatory. + +```json +{ + JSON sample + "pipeline": ... +} +``` + +Read more about [ArContext base class in code reference](../../../argaze.md/#argaze.ArFeatures.ArContext). + +## Live Stream + +::: argaze.utils.contexts.TobiiProGlasses3.LiveStream + +### JSON sample + +```json +{ + "argaze.utils.contexts.TobiiProGlasses3.LiveStream": { + "name": "Tobii Pro Glasses 3 live stream", + "pipeline": ... + } +} +``` + -- cgit v1.1