From 35c0df8f883da7c53cee7070a45fbb712fd77eb3 Mon Sep 17 00:00:00 2001 From: Jimmy Date: Mon, 25 May 2026 22:00:20 +1200 Subject: [PATCH] docs: update readme for serial baud and deploy paths Co-authored-by: Cursor --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1f22a21..fb163d5 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,14 @@ Connection is always via **`-p` / `--port`** (default `/dev/ttyACM0`). There is | `-o`, `--order` | LED colour order (`rgb`, `grb`, …) | | `--preset` / `--pattern` | Create or replace a named preset in **led-driver** `presets.json` | | `--default` | Startup preset name | -| `--transport` | `espnow` or `wifi` (`transport_type` on device) | +| `--transport` | `espnow` or `wifi` (`transport_type` on led-driver) | +| `--serial-baudrate` | Bridge UART1 baud for Pi serial link (e.g. `921600`; also sets GPIO UART pins) | | `--ssid`, `--wifi-password`, `--wifi-channel` | Wi-Fi / channel fields for the driver | | `-r`, `--reset` | Reset the device | | `-f`, `--follow` | Follow serial output (optional timeout seconds) | | `--pause` | Sleep N seconds (for chained actions) | | `-u`, `--upload` | Recursive upload: `-u SRC [DEST]` (skips unchanged files via `file_hashes.json` on device) | -| `--src`, `--lib`, `--all` | Deploy led-driver trees to flash root, `patterns/`, and `lib/` | +| `--src`, `--lib`, `--all` | Deploy `src/` to device root and `lib/` to `/lib` (led-driver, espnow-sender, …) | | `--force-upload` | Upload every file; ignore `file_hashes.json` | | `-e`, `--erase` | Erase everything at device root (including `settings.json` and `presets.json`) | | `--rm` | Remove a path on the device | @@ -51,7 +52,7 @@ python web.py # open http://:5000/editor ``` -**Embedded in led-controller:** open **LED Tool** in the main UI, or visit **`/led-tool/editor`**. +**Embedded in led-controller:** open **Settings → LED Tool** in the main UI (Edit mode), or visit **`/led-tool/editor`**. Legacy Flask form UI remains at **`/`** on port 5000; prefer **`/editor`** for Web Serial support.