aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThéo de la Hogue2024-04-17 11:20:30 +0200
committerThéo de la Hogue2024-04-17 11:20:30 +0200
commitddd980d4494f8a0a716cfea6e764711eb2fe05d2 (patch)
tree15aa23230472197bb7f54f3b0c58e832eee81caf /docs
parent7c04745f1f4303af4b478f73ac549efac2fb7d84 (diff)
parent34b7a55a681c7eda017a0b491cf465421b8a5530 (diff)
downloadargaze-ddd980d4494f8a0a716cfea6e764711eb2fe05d2.zip
argaze-ddd980d4494f8a0a716cfea6e764711eb2fe05d2.tar.gz
argaze-ddd980d4494f8a0a716cfea6e764711eb2fe05d2.tar.bz2
argaze-ddd980d4494f8a0a716cfea6e764711eb2fe05d2.tar.xz
Merge branch 'main' into dev/min_detected_markers
Diffstat (limited to 'docs')
-rw-r--r--docs/user_guide/utils/demonstrations_scripts.md30
-rw-r--r--docs/user_guide/utils/ready-made_scripts.md29
2 files changed, 59 insertions, 0 deletions
diff --git a/docs/user_guide/utils/demonstrations_scripts.md b/docs/user_guide/utils/demonstrations_scripts.md
index f344eaf..f3f2b9e 100644
--- a/docs/user_guide/utils/demonstrations_scripts.md
+++ b/docs/user_guide/utils/demonstrations_scripts.md
@@ -84,3 +84,33 @@ Then, execute this command:
```shell
python -m argaze ./src/argaze/utils/demo/tobii_post_processing_context.json
```
+
+## Pupil Invisible
+
+### Pupil Invisible live stream context
+
+!!! note
+ this demonstration requires to print **A3_demo.pdf** file located in *./src/argaze/utils/demo/* folder on A3 paper sheet.
+
+Edit **pupillabs_live_stream_context.json** file as below with your own parameters values:
+
+```json
+{
+ "argaze.utils.contexts.PupilLabs.LiveStream" : {
+ "name": "PupilLabs",
+ "pipeline": "aruco_markers_pipeline.json",
+ "catch_exceptions": true,
+ "image_parameters": {
+ "draw_times": true,
+ "draw_exceptions": true
+ }
+ }
+}
+```
+
+Then, execute this command:
+
+```shell
+python -m argaze ./src/argaze/utils/demo/pupillabs_live_stream_context.json
+```
+
diff --git a/docs/user_guide/utils/ready-made_scripts.md b/docs/user_guide/utils/ready-made_scripts.md
index 92a4502..a7b3057 100644
--- a/docs/user_guide/utils/ready-made_scripts.md
+++ b/docs/user_guide/utils/ready-made_scripts.md
@@ -17,6 +17,35 @@ Load and execute any ArContext from a JSON CONFIGURATION file
python -m argaze CONFIGURATION
```
+### Send command
+
+Use -p option to enable pipe communication at given address:
+
+```shell
+python -m argaze post_processing_context.json -p /tmp/argaze
+```
+
+Then, in another console window, you can send any Python command into the pipe.
+
+For example:
+
+* Print context:
+```shell
+echo "print(context)" > /tmp/argaze
+```
+
+* Pause context processing:
+
+```shell
+echo "context.pause()" > /tmp/argaze
+```
+
+* Resume context processing:
+
+```shell
+echo "context.resume()" > /tmp/argaze
+```
+
## ArUco markers group exporter
Detect DICTIONARY and SIZE ArUco markers inside a MOVIE frame then, export detected ArUco markers group as .obj file into an OUTPUT folder.