From 6ac073f7b373e8f9e6259463ff6874953a0f81f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Weigert?= Date: Fri, 8 Mar 2019 10:05:03 +0100 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 33dd122..6b5c6fa 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Upload tool for an led name tag with USB-HID interface ![LED Mini Board](green_badge.jpg) -# Warning +## Warning There are many different versions of LED Badges on the market. Some even look identical, but are not. @@ -16,7 +16,29 @@ identifies itself on the USB as Mfr=1, Product=2, SerialNumber=0 LSicroelectronics LS32 Custm HID -# Command line parameters +## Command Line Installation and Usage + +Required dependencies on Debian/Ubuntu Systems: + + sudo apt install python3-usb + +#### Examples: + + sudo python3 ./led-badge-11x44.py "Hello World!" + +loads the text 'Hello World!' as the first message, and scrolls it from right to left (default scroll mode=0) and speed 4 (default). After each upload, press the little button next to the USB connector once to see the first message permanently. If you don't press the button, the device shows the message only once and returns to the charging screen. Sudo may or may not be needed, depending on your system. + + sudo python3 ./led-badge-11x44.py -m 6 -s 8 Hello World! + +loads the text 'Hello' as message one and 'World!' as message two. Note the diffrence in quoting. Up to 8 messages can be uploaded. This example uses mode 6, which is dromps the words with a nice little animation vertically into the display area. Speed is set to maximum here, so that the animation is very smooth. Per default you will only see 'Hello'. To get both messages alternating, press the little button next to the USB connector two more times, so that the message 'M1-8' appears. Now the display loops through all uploaded messages. + + sudo python3 ./led-badge-11x44.py -m 5 gfx/fablabnbg_logo_44x11.png + +loads a fullscreen still image. + + sudo python3 ./led-badge-11x44.py -l gfx/heart.png -l gfx/fablab_logo_16x11.png "I^Amy^Bfablab^B" + +preloads two images, a heart and a crude fablab logo as images 1 and two. The images can then be embedded in a message by using control characters. To enter the ^A control character on the shell, press CTRL-V followed by CTRL-A. 
 Usage: led-badge-11x44.py [-h] [-s SPEED] [-m MODE] [-l FILE]