diff options
Diffstat (limited to 'Stomps/README.md')
| -rw-r--r-- | Stomps/README.md | 14 |
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** |