docs: describe the v2 controller's API, UI and tests
API.md now documents what the firmware serves: groups, combined brightness, beat-driven sequences, import/export, /api/audio, patterns over ESP-NOW, outputs, /ws, driver OTA, and how API calls become driver messages and group commands. The user guide follows the current UI; the in-app audio help describes the microphone instead of input devices. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
bfeeb958df
commit
b2cd242390
5 files changed
+335
-429
No files matched your search
@@ -2,6 +2,8 @@
|
||||
|
||||
ESP32-S3 controller for LED drivers: W5500 Ethernet, web UI, I2S microphone beat detection and an ESP-NOW link to the drivers. The firmware is C (ESP-IDF) at the repository root; see [`docs/BENCH_TEST.md`](docs/BENCH_TEST.md) for the bench tests.
|
||||
|
||||
It keeps profiles, zones, presets, device groups, sequences, palettes, patterns and outputs in its flash, and serves the web UI and JSON API ([`docs/API.md`](docs/API.md)). Zones play to device groups. Sequences advance on the beats the microphone detects, or on a BPM clock while audio is stopped. Profiles, presets and sequences import and export as JSON bundles.
|
||||
|
||||
## Build and flash
|
||||
|
||||
```bash
|
||||
@@ -11,9 +13,11 @@ make ota HOST=<ip> # update firmware (web UI included) over Ethernet, no USB
|
||||
make ota-drivers HOST=<ip> [MAC=..] [BROADCAST=1] # push changed led-driver .py files over ESP-NOW
|
||||
make monitor # serial console
|
||||
make test # driver unit tests and the C/Python envelope cross-check
|
||||
make test-api HOST=<ip> # HTTP API tests against a running controller (its data is restored afterwards)
|
||||
make test-browser HOST=<ip> # Selenium UI tests (needs selenium and chromedriver)
|
||||
```
|
||||
|
||||
`make` lists every target. The web UI sources are in `web/` (`static/`, `templates/`, `audio.html`).
|
||||
`make` lists every target. The web UI sources are in `web/` (`static/`, `templates/`, `audio.html`); `tools/build_web.sh` also packs the led-driver pattern files into the firmware, so the controller can send them to drivers.
|
||||
|
||||
## Other directories
|
||||
|
||||
@@ -21,6 +25,7 @@ make test # driver unit tests and the C/Python envelope cross-check
|
||||
- `led-tool/` (submodule): `led-cli`, configures drivers over serial and updates the controller over Ethernet (`led-cli --ota HOST`).
|
||||
- `led-simulator/` (submodule), `espnow-sender/`: test helpers.
|
||||
- `db/`: stored zones, presets and devices, importable with `PUT /db/<name>`.
|
||||
- `test/api/`: the API tests (`test/api/README.md`); `test/browser/`: the UI tests.
|
||||
|
||||
## Docs
|
||||
|
||||
|
||||
Reference in new issue
Block a user