Update README

Signed-off-by: Daniel Schaefer <[email protected]>

Author: JohnAZoidberg

README.md

@@ -1,13 +1,57 @@
 # Lotus LED Matrix Module
 
-Project setup based off of: https://github.com/rp-rs/rp2040-project-template
+It's a 9x34 (306) LED matrix, controlled by RP2040 MCU and IS31FL3741A LED controller.
+Connection to the host system is via USB 2.0 and currently there is a USB Serial API to control it without reflashing.
 
-## Control
+Rust project setup based off of: https://github.com/rp-rs/rp2040-project-template
+
+## Features
+
+- Reset into bootloader when firmware crashes/panics
+- API over USB ACM Serial Port - Requires not Drivers on Windows and Linux
+  - Display various pre-programmed patterns
+  - Light up a percentage of the screen
+  - Change brightness
+  - Send a black/white image to display
+  - Go to sleep
+  - Reset into bootloader
+  - Scroll and loop the display content vertically
+  - A commandline script and graphical application to control it
+- Sleep Mode
+  - Transition slowly turns off/on the LEDs
+  - Current hardware does not have the SLEEP# GPIO connected, can't sleep automatically
+
+Future features:
+
+- API
+  - Send a greyscale image to display
+  - Read current system state (brightness, sleeping, ...)
+
+## Control from the host
 
 Requirements: Python and [PySimpleGUI](https://www.pysimplegui.org).
 
 Use `control.py`. Either the commandline, see `control.py --help` or the graphical version: `control.py --gui`
 
+```
+options:
+  -h, --help            show this help message and exit
+  --bootloader          Jump to the bootloader to flash new firmware
+  --sleep, --no-sleep   Simulate the host going to sleep or waking up
+  --brightness BRIGHTNESS
+                        Adjust the brightness. Value 0-255
+  --animate, --no-animate
+                        Start/stop vertical scrolling
+  --pattern {full,lotus,gradient,double-gradient,zigzag,panic,lotus2}
+                        Display a pattern
+  --image IMAGE         Display a PNG or GIF image (black and white only)
+  --percentage PERCENTAGE
+                        Fill a percentage of the screen
+  --clock               Display the current time
+  --gui                 Launch the graphical version of the program
+  --panic               Crash the firmware (TESTING ONLY)
+```
+
 ## Building
 
 Dependencies: Rust
@@ -20,7 +64,6 @@ cargo install flip-link
 cargo install elf2uf2-rs --locked
 ```
 
-
 Build:
 
 ```sh
@@ -43,6 +86,9 @@ This can be done by pressing the bootsel button while plugging it in.
 cargo run
 ```
 
+Or by copying the above generated UF2 file to the partition mounted when the
+module is in the bootloder.
+
 ## Panic
 
 On panic the RP2040 resets itself into bootloader mode.