From dd9f33c0e49eb5ac6be9cdc46bd53c03335a5b01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Weigert?= Date: Fri, 8 Mar 2019 00:09:54 +0100 Subject: [PATCH] Update README.md Added usage to README --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9dee5d7..33dd122 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# led-badge-44x11 +# Led-Badge-44x11 Upload tool for an led name tag with USB-HID interface ![LED Mini Board](green_badge.jpg) @@ -16,6 +16,32 @@ identifies itself on the USB as Mfr=1, Product=2, SerialNumber=0 LSicroelectronics LS32 Custm HID +# Command line parameters + +
+Usage: led-badge-11x44.py [-h] [-s SPEED] [-m MODE] [-l FILE]
+                          message [message ...]
+
+./led-badge-11x44.py Version 0.3 -- upload messages to a 44x11 led badge via
+USB HID. https://github.com/jnweiger/led-badge-44x11
+
+positional arguments:
+  message               Up to 8 message texts or image file names
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -s SPEED, --speed SPEED
+                        Scroll speed. Up to 8 comma-seperated values (range
+                        1..8)
+  -m MODE, --mode MODE  Up to 8 mode values: Scroll-left(0) -right(1) -up(2)
+                        -down(3); still-centered(4) -left(5); drop-down(6);
+                        curtain(7); laser(8)
+  -l FILE, --load FILE  Bitmap images, made available as ^A, ^B, ^C, ... in
+                        text messages
+
+
+ + ## References (all USB-Serial) * https://github.com/Caerbannog/led-mini-board