aboutsummaryrefslogtreecommitdiff
path: root/client/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'client/readme.md')
-rw-r--r--client/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/client/readme.md b/client/readme.md
new file mode 100644
index 0000000..04471d2
--- /dev/null
+++ b/client/readme.md
@@ -0,0 +1,21 @@
+# puzzle box client
+
+goal (in order of implementation):
+```
+(pbc) help
+ exit exit pbc
+ test send a test puzbus message
+ help show this help
+ send <addr> <data> [debug] send raw message
+ status show global puzzle box state (main controller state)
+ reset reset entire game state
+ ls list connected puzzle modules
+```
+
+
+```
+send 0x39 "Hello world!" de:ad:be:ef 0xff 5 0a 0750
+ ^~~~~~~~~~~~~~ ^~~~~~~~~~~ ~^~~ ~^ ~^ ~~~~^
+ STR_INTP BYTE_ARR UNSIGNED UNSIGNED UNSIGNED UNSIGNED
+ (hex+0x) (dec) (hex) (oct)
+```