Skip to content

Commit 4d6f25a

Browse files
committed
More examples in the readme
Signed-off-by: Daniel Schaefer <[email protected]>
1 parent 67726d6 commit 4d6f25a

File tree

5 files changed

+23
-3
lines changed

5 files changed

+23
-3
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,6 @@ target/
1414
!.vscode/settings.json
1515

1616
*.uf2
17+
18+
# Panic dump
19+
message.bin

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Lotus LED Matrix Module
22

33
It's a 9x34 (306) LED matrix, controlled by RP2040 MCU and IS31FL3741A LED controller.
4+
45
Connection to the host system is via USB 2.0 and currently there is a USB Serial API to control it without reflashing.
56

67
Rust project setup based off of: https://github.com/rp-rs/rp2040-project-template
78

89
## Features
910

1011
- Reset into bootloader when firmware crashes/panics
11-
- API over USB ACM Serial Port - Requires not Drivers on Windows and Linux
12+
- API over USB ACM Serial Port - Requires no Drivers on Windows and Linux
1213
- Display various pre-programmed patterns
1314
- Light up a percentage of the screen
1415
- Change brightness
@@ -29,7 +30,7 @@ Future features:
2930

3031
## Control from the host
3132

32-
Requirements: Python and [PySimpleGUI](https://www.pysimplegui.org).
33+
Requirements: Python, [PySimpleGUI](https://www.pysimplegui.org) and optionally [pillow](https://pillow.readthedocs.io/en/stable/index.html)
3334

3435
Use `control.py`. Either the commandline, see `control.py --help` or the graphical version: `control.py --gui`
3536

@@ -52,6 +53,23 @@ options:
5253
--panic Crash the firmware (TESTING ONLY)
5354
```
5455

56+
Examples
57+
58+
```sh
59+
# Launch graphical application
60+
./control.py --gui
61+
62+
# Show current time and keep updating it
63+
./control.py --clock
64+
65+
# Draw PNG or GIF
66+
./control.py --image stripe.gif
67+
./control.py --image stripe.png
68+
69+
# Change brightness (0-255)
70+
./control.py --brightness 50
71+
```
72+
5573
## Building
5674

5775
Dependencies: Rust

control.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,6 @@ def number(num):
350350
0, 0, 0, 0, 0,
351351
]
352352
}
353-
print(numbers[num])
354353
return numbers[num]
355354

356355

stripe.gif

77 Bytes
Loading

stripe.png

596 Bytes
Loading

0 commit comments

Comments
 (0)