Added Macro functionality, updated readme

README.md

@@ -17,6 +17,108 @@ pio run --target upload
 
 Der Upload läuft via OpenOCD über SWD. Kein Bootloader nötig – der Chip wird direkt programmiert.
 
+---
+
+## Funktionsumfang (Anforderungskatalog)
+
+### 1 Hardware-Plattform
+
+| # | Anforderung | Status |
+|---|-------------|--------|
+| 1.1 | Ziel-MCU: **ATSAMD21G17D** (Cortex-M0+, 48 MHz, 128 KB Flash, 16 KB RAM) | ✅ |
+| 1.2 | Framework: **Arduino + PlatformIO**, kein Bootloader (Direktflash via SWD/Atmel-ICE) | ✅ |
+| 1.3 | USB-Enumeration ohne externen Quarz (`-DCRYSTALLESS`, DFLL48M nutzt USB-SOF als Referenz) | ✅ |
+| 1.4 | Benutzerdefiniertes Board-Profil (`versapad_nobl.json`) mit korrekten Flash/RAM-Limits | ✅ |
+
+### 2 Tasten-Matrix
+
+| # | Anforderung | Status |
+|---|-------------|--------|
+| 2.1 | **5×5-Matrix-Scan** (25 Keys, davon 20 MX-Buttons + 4 Encoder-SW + 1 NC) | ✅ |
+| 2.2 | **10 ms Software-Debounce** pro Taste (Flanken-Erkennung) | ✅ |
+| 2.3 | KEY_DOWN- und KEY_UP-Events werden in die Event-Queue geschrieben | ✅ |
+| 2.4 | Matrix-Scan im **Loop-Kontext** (kein ISR, kein Heap) | ✅ |
+
+### 3 Encoder
+
+| # | Anforderung | Status |
+|---|-------------|--------|
+| 3.1 | **4 Quadratur-Encoder** (A/B-Phasen per EIC-Interrupt) | ✅ |
+| 3.2 | **Richtungserkennung**: CW / CCW via 2-Bit-Greycode-Auswertung | ✅ |
+| 3.3 | Encoder-Events im ISR-Kontext direkt in Event-Queue (interrupt-sicher, kein Heap) | ✅ |
+| 3.4 | Encoder-SW-Tasten über Matrix-Scan (gleicher Pfad wie MX-Buttons) | ✅ |
+
+### 4 Aktions-Engine
+
+| # | Anforderung | Status |
+|---|-------------|--------|
+| 4.1 | **ActionType NONE**: kein HID-Event beim Drücken | ✅ |
+| 4.2 | **ActionType HID_KEY**: USB-HID-Tastendruck (Keycode + Modifier-Byte) | ✅ |
+| 4.3 | **ActionType HID_CONSUMER**: USB Consumer Control (Play/Pause, Lautstärke …) | ✅ |
+| 4.4 | **ActionType HOST_COMMAND**: Event-ID an VersaGUI senden, App führt aus | ✅ |
+| 4.5 | **ActionType MACRO**: Sequenz aus bis zu 4 HID-Key-Schritten aus NVM-Tabelle abspielen | ✅ |
+| 4.6 | Jede Aktion ausführbar **ohne laufende VersaGUI** (lokal per HID/Makro) | ✅ |
+
+### 5 Makro-System
+
+| # | Anforderung | Status |
+|---|-------------|--------|
+| 5.1 | **32 Makro-Slots**, je **4 Steps** (Keycode + Modifier-Byte) = 256 Byte gesamt | ✅ |
+| 5.2 | Steps mit `keycode = 0` werden übersprungen (variable Makrolänge 1–4) | ✅ |
+| 5.3 | Timing: 10 ms Key-Down-Dauer + 20 ms Pause zwischen Steps | ✅ |
+| 5.4 | Makro-Tabelle in **separater NVM-Row** (Row 1, 0x1FF00, 256 Byte) | ✅ |
+| 5.5 | Makro-Tabelle wird beim Start aus NVM geladen; gelöschter Flash (0xFF) → leere Tabelle | ✅ |
+
+### 6 LED-System (WS2812)
+
+| # | Anforderung | Status |
+|---|-------------|--------|
+| 6.1 | **20 WS2812-LEDs**, serpentiner Verdrahtung; Adafruit-NeoPixel bit-bang Treiber | ✅ |
+| 6.2 | **2-Schicht-Modell** pro Button: `base` (Idle) + `override` (temporär von GUI) | ✅ |
+| 6.3 | **STATIC**: feste Farbe aus NVM | ✅ |
+| 6.4 | **BLINK**: binäres An/Aus mit konfigurierbarer Halbperiode | ✅ |
+| 6.5 | **PULSE**: lineares Helligkeitsdreieck (0→255→0), kein Float | ✅ |
+| 6.6 | **COLOR_CYCLE** (Regenbogen): Hue-Sweep über 6 Segmente, ignoriert base/override | ✅ |
+| 6.7 | **COLOR_FADE**: einmaliger RGB-Crossfade zu Zielfarbe | ✅ |
+| 6.8 | Phasenversatz beim Start: Regenbogen-LEDs sind gleichmäßig über die Periode verteilt | ✅ |
+| 6.9 | `ws2812_show()` nur bei dirty-Flag aufgerufen (~600 µs Blockzeit vermieden) | ✅ |
+| 6.10 | Alle Animationen in **Integer-Arithmetik** (kein FPU auf M0+) | ✅ |
+
+### 7 Konfigurations-Speicherung (NVM)
+
+| # | Anforderung | Status |
+|---|-------------|--------|
+| 7.1 | Config-Layout **Version 2**, 223 Byte packed, mit Magic `0x56503202` + CRC16-CCITT | ✅ |
+| 7.2 | Config gespeichert in **NVM Row 0** (0x1FE00, 256 Byte, via Linkerscript reserviert) | ✅ |
+| 7.3 | Makro-Tabelle in **NVM Row 1** (0x1FF00, 256 Byte) | ✅ |
+| 7.4 | NVM-Schreiben: Row löschen + 4 Pages à 64 Byte manuell schreiben (MANW=1) | ✅ |
+| 7.5 | Bei ungültigem Magic / falscher Version / CRC-Fehler → **Defaults** laden (kein Crash) | ✅ |
+| 7.6 | Defaults: alle Aktionen NONE, LEDs warm-weiß, Animation Regenbogen 4 s | ✅ |
+
+### 8 Serial-Kommunikation mit VersaGUI
+
+| # | Anforderung | Status |
+|---|-------------|--------|
+| 8.1 | **CDC Serial** (USB), kein Treiber nötig; 8-Byte-Festlängen-Pakete | ✅ |
+| 8.2 | **Ring-Buffer** (256 Byte = 32 Pakete) für eingehende Bytes; kein Datenverlust bei Burst | ✅ |
+| 8.3 | **Ping / Pong** (0x05 / 0x85) zur Verbindungsdiagnose | ✅ |
+| 8.4 | **Config-Transfer PC→Board**: BEGIN(0x10) → 38×DATA(0x11) → COMMIT(0x12) → ACK/NACK | ✅ |
+| 8.5 | **Config-Dump Board→PC**: auf READ(0x13) → BEGIN(0x92) → 38×DATA(0x93) → END(0x94) | ✅ |
+| 8.6 | **Makro-Transfer PC→Board**: BEGIN(0x20) → 43×DATA(0x21) → COMMIT(0x22) → ACK(0x95) | ✅ |
+| 8.7 | **Makro-Dump Board→PC**: auf READ(0x23) → BEGIN(0x96) → 43×DATA(0x97) → END(0x98) | ✅ |
+| 8.8 | Config-COMMIT validiert Magic + Version + CRC; bei Fehler **NACK** ohne NVM-Schreiben | ✅ |
+| 8.9 | Alle Sende-Pakete nur wenn `SerialUSB` aktiv (DTR-Check verhindert stilles Verwerfen) | ✅ |
+
+### 9 Nicht implementiert / Roadmap
+
+| # | Anforderung | Status |
+|---|-------------|--------|
+| 9.1 | **Fader/Potentiometer**: 3× ADC-Kanäle auf Board vorhanden, HAL nicht implementiert | 🔲 TODO |
+| 9.2 | **HOST_COMMAND-Payload**: Board sendet Command-ID, App-Seite führt aus (halbfertig) | 🔲 TODO |
+| 9.3 | **FADE_IN / FADE_OUT** per GUI konfigurierbar (Firmware vorhanden, kein GUI-Eintrag) | 🔲 TODO |
+
+---
+
 ## Projekt-Struktur
 
 ```
@@ -111,25 +213,38 @@ Byte 5–7: reserviert (0x00)
 | 0x85 | Board→PC | Pong |
 | 0x90 | Board→PC | Config-ACK |
 | 0x91 | Board→PC | Config-NACK |
+| 0x20 | PC→Board | Makro-Begin (Chunk-Anzahl = 43) |
+| 0x21 | PC→Board | Makro-Data (Chunk-Index + 6B Nutzdaten) |
+| 0x22 | PC→Board | Makro-Commit (in NVM schreiben) |
+| 0x23 | PC→Board | Makro-Read (Board sendet Tabelle zurück) |
+| 0x90 | Board→PC | Config-ACK |
+| 0x91 | Board→PC | Config-NACK (CRC/Magic/Version ungültig) |
 | 0x92 | Board→PC | Config-Begin (Dump-Start, Chunks-Anzahl) |
 | 0x93 | Board→PC | Config-Data (Chunk-Index + 6B) |
 | 0x94 | Board→PC | Config-End |
+| 0x95 | Board→PC | Makro-ACK |
+| 0x96 | Board→PC | Makro-Begin (Dump-Start) |
+| 0x97 | Board→PC | Makro-Data (Chunk-Index + 6B) |
+| 0x98 | Board→PC | Makro-End |
 
-### NVM-Config-Layout (163 Bytes, packed)
+### NVM-Config-Layout (Version 2, 223 Bytes, packed)
 
 ```
-Offset  0   4B  Magic   0x56503202
-Offset  4   1B  Version 1
-Offset  5   2B  CRC16-CCITT (über Bytes 7–162)
-Offset  7  60B  mx_actions[20]    – je 3B: type(1B) + data(2B)
-Offset 67  36B  enc_actions[4][3] – je 3B
-Offset103  20B  led_r[20]
-Offset123  20B  led_g[20]
-Offset143  20B  led_b[20]
+Offset   0   4B  Magic   0x56503202
+Offset   4   1B  Version 2
+Offset   5   2B  CRC16-CCITT (über Bytes 7–222)
+Offset   7  60B  mx_actions[20]     – je 3B: type(1B) + data(2B)
+Offset  67  36B  enc_actions[4][3]  – je 3B
+Offset 103  20B  led_r[20]
+Offset 123  20B  led_g[20]
+Offset 143  20B  led_b[20]
+Offset 163  20B  led_anim[20]       – LEDAnim-Typ (uint8_t)
+Offset 183  40B  led_period_ms[20]  – Animationsperiode in ms (uint16_t, LE)
 ```
 
-Gespeichert in den letzten 512 Bytes des Flashs (0x1FE00), via Linkerscript reserviert.
-Bei ungültigem Magic/CRC werden Defaults geladen (alle Tasten: NONE, LEDs: warm-weiß).
+**NVM Row 0** (0x1FE00, 256 Byte): Config (223B genutzt, 33B Padding)
+**NVM Row 1** (0x1FF00, 256 Byte): Makro-Tabelle (32 Slots × 4 Steps × 2B)
+Via Linkerscript reserviert. Bei ungültigem Magic/Version/CRC werden Defaults geladen.
 
 ## Bekannte Fallstricke