technicalkiwi/led-driver-8
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: align readme and driver api with tcp/wifi

Browse Source 
Made-with: Cursor
This commit is contained in:
pi
2026-04-12 00:13:49 +12:00
parent a64457a0d5
commit ded6e3d360
2 changed files with 33 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/API.md
View File

@@ -1,10 +1,10 @@
# LED Driver ESPNow API Documentation
# LED Driver API (message format)
This document describes the ESPNow message format for controlling LED driver devices.
This document describes the **JSON message format** for controlling LED driver devices. The same object is accepted from **ESP-NOW** (when that transport is enabled) and as **one JSON value per line** over **TCP** in **Wi-Fi** mode (see `src/main.py` on the device).
## Message Format
All messages are JSON objects sent via ESPNow with the following structure:
All messages are JSON objects with the following structure:
```json
{