Added doc

2026-03-30 19:52:37 +02:00
parent 0b3c5f3217
commit 9079fefad8
9 changed files with 567 additions and 0 deletions
@@ -0,0 +1,86 @@
+# Serial-Protokoll (CDC USB)
+
+**Dateien:** `hal/usb_serial.h`, `hal/usb_serial.cpp`
+
+## Grundprinzip
+
+Board erscheint unter Windows als CDC Serial-Port (kein Treiber nötig). Alle Pakete haben feste Größe von **8 Byte** – kein Längen-Header, kein Framing, kein Escape.
+
+```
+Byte 0: Command / Event-ID
+Byte 1: key_id (Button 0–24 oder Encoder 0–3) / Chunk-Index / Chunk-Count
+Byte 2: r / Daten-Byte A
+Byte 3: g / Daten-Byte B
+Byte 4: b
+Byte 5–7: reserviert (0x00)
+```
+
+## Richtungen
+
+| Richtung | ID-Bereich | Verarbeitung |
+|---|---|---|
+| PC → Board (Commands) | 0x01–0x7F | `poll_vendor()` in CMainController |
+| Board → PC (Events) | 0x81–0xFF | `usb_serial_send()` in processEvents |
+
+## Command-Referenz (PC → Board)
+
+| ID | Name | Bedeutung |
+|---|---|---|
+| `0x01` | SET_LED_OVERRIDE | key_id, r, g, b – temporäre Override-Farbe setzen |
+| `0x02` | CLEAR_LED_OVERRIDE | key_id – Override löschen, zurück zu base |
+| `0x03` | SET_LED_BASE | key_id, r, g, b – base-Farbe dauerhaft ändern (kein NVM) |
+| `0x05` | PING | Board antwortet sofort mit PONG (0x85) |
+| `0x10` | CONFIG_BEGIN | Byte[1] = Chunk-Anzahl – neuen Config-Empfang starten |
+| `0x11` | CONFIG_DATA | Byte[1] = Chunk-Index, Byte[2–7] = 6 B Nutzdaten |
+| `0x12` | CONFIG_COMMIT | CRC prüfen → NVM schreiben → Buttons neu laden → ACK/NACK |
+| `0x13` | CONFIG_READ | Board sendet aktuelle NVM-Config zurück (BEGIN/DATA/END) |
+| `0x20` | MACRO_BEGIN | Byte[1] = Chunk-Anzahl – neuen Makro-Empfang starten |
+| `0x21` | MACRO_DATA | Byte[1] = Chunk-Index, Byte[2–7] = 6 B Nutzdaten |
+| `0x22` | MACRO_COMMIT | NVM schreiben + MACRO_ACK zurück |
+| `0x23` | MACRO_READ | Board sendet aktuelle Makro-Tabelle zurück |
+
+## Event-Referenz (Board → PC)
+
+| ID | Name | Bedeutung |
+|---|---|---|
+| `0x81` | KEY_DOWN | key_id – HOST_COMMAND-Button gedrückt |
+| `0x82` | KEY_UP | key_id – (derzeit nicht gesendet) |
+| `0x83` | ENC_CW | enc_id – Encoder-Schritt CW (HOST_COMMAND) |
+| `0x84` | ENC_CCW | enc_id – Encoder-Schritt CCW (HOST_COMMAND) |
+| `0x85` | PONG | Antwort auf PING |
+| `0x90` | CONFIG_ACK | Config erfolgreich in NVM geschrieben |
+| `0x91` | CONFIG_NACK | Config CRC/Magic ungültig – nicht geschrieben |
+| `0x92` | CONFIG_BEGIN | Byte[1] = Chunk-Anzahl (Config-Dump) |
+| `0x93` | CONFIG_DATA | Byte[1] = Index, Byte[2–7] = 6 B (Config-Dump) |
+| `0x94` | CONFIG_END | Config-Dump abgeschlossen |
+| `0x95` | MACRO_ACK | Makro-Tabelle erfolgreich gespeichert |
+| `0x96` | MACRO_BEGIN | Byte[1] = Chunk-Anzahl (Makro-Dump) |
+| `0x97` | MACRO_DATA | Byte[1] = Index, Byte[2–7] = 6 B (Makro-Dump) |
+| `0x98` | MACRO_END | Makro-Dump abgeschlossen |
+
+## Chunked Transfer
+
+Config (223 B) und Makro-Tabelle (256 B) werden in 6-Byte-Chunks übertragen:
+
+```
+Config:  ceil(223 / 6) = 38 Chunks
+Makros:  ceil(256 / 6) = 43 Chunks (letzter Chunk hat 4 Nutzbytes)
+```
+
+Ablauf (PC → Board):
+```
+BEGIN (chunk_count)
+DATA chunk_0  (Bytes 0–5)
+DATA chunk_1  (Bytes 6–11)
+...
+COMMIT
+```
+
+COMMIT bei Config: Board prüft Magic + Version + CRC. Bei Fehler → NACK, kein NVM-Schreiben.
+COMMIT bei Makro: Kein CRC, Board schreibt blind → MACRO_ACK.
+
+## Implementierungsdetails
+
+- **Ring-Buffer**: 256 Byte Eingangspuffer (= 32 vollständige Pakete) in `usb_serial.cpp`
+- **DTR-Check**: `usb_serial_send()` sendet nur wenn `SerialUSB` aktiv ist (verhindert stilles Verwerfen wenn VersaGUI nicht verbunden)
+- **SAMD21 CDC**: Nach SWD-Flash braucht Windows eine physische USB-Reinitialisierung (Kabel abziehen/stecken) damit der CDC-Port neu enumeriert