aboutsummaryrefslogtreecommitdiffhomepage
path: root/Stomps/README.md
diff options
context:
space:
mode:
authorThomas Van Iseghem <[email protected]>2023-09-14 17:50:49 +0200
committerThomas Van Iseghem <[email protected]>2023-09-14 17:50:49 +0200
commit3ba4308938bcab5a23ae96b0809895ef28d47720 (patch)
tree899b80068ee8ee67ce8a31f701c8c998fb8a6f36 /Stomps/README.md
parent14fef5db770b3af8668d08524ae6fa19791b2cb3 (diff)
downloadOpenCortex-3ba4308938bcab5a23ae96b0809895ef28d47720.tar.gz
OpenCortex-3ba4308938bcab5a23ae96b0809895ef28d47720.zip
Refactored stomp code + added websocket server for stomp control
Diffstat (limited to 'Stomps/README.md')
-rw-r--r--Stomps/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/Stomps/README.md b/Stomps/README.md
index da4fe92..9d995ec 100644
--- a/Stomps/README.md
+++ b/Stomps/README.md
@@ -1,3 +1,17 @@
+## Installation
+
+1) Take this folder `Stomps` and put it anywhere you like on the QC
+
+## Usage
+
+`cd` into the `Stomps` directory installed on the QC and run any of the Python scripts.
+
+There are a couple of fun things to play around with.
+1) **read_stomp.py:** Allows you to decode and read stomp device traffic
+2) **stomp_control.py:** CLI tool to activate stomps
+3) **stomp_scroll.py:** Just a fun visual effect
+4) **stomp_server.py:** Spawns a websocket server that allows you to control stomps over IP
+
## Stomp message byte examples:
**Action: button | Value: pressed**