aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/utils/ready-made_scripts.md
diff options
context:
space:
mode:
authorThéo de la Hogue2024-04-17 10:47:40 +0200
committerThéo de la Hogue2024-04-17 10:47:40 +0200
commita78eb410dc5bc744f783ce02fd5be4d630b6d51e (patch)
treebc3021e725bd362fcc97d2c4f06ae07f1bba4352 /docs/user_guide/utils/ready-made_scripts.md
parent0e6ac153c868992958526513698e406b00bac8fd (diff)
downloadargaze-a78eb410dc5bc744f783ce02fd5be4d630b6d51e.zip
argaze-a78eb410dc5bc744f783ce02fd5be4d630b6d51e.tar.gz
argaze-a78eb410dc5bc744f783ce02fd5be4d630b6d51e.tar.bz2
argaze-a78eb410dc5bc744f783ce02fd5be4d630b6d51e.tar.xz
Documenting pipe communication.
Diffstat (limited to 'docs/user_guide/utils/ready-made_scripts.md')
-rw-r--r--docs/user_guide/utils/ready-made_scripts.md29
1 files changed, 29 insertions, 0 deletions
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.