Refresh GUI documentation and profile synchronization

This commit is contained in:
2026-07-24 10:35:47 +02:00
parent 08db94bb6b
commit 7d381218f3
15 changed files with 226 additions and 35 deletions
+22 -5
View File
@@ -10,9 +10,10 @@ nicht zum aktuellen Scope.
## Voraussetzungen
- Windows 10/11
- .NET SDK
- .NET 7 SDK mit Windows-Desktop-Unterstützung
- geflashte `VersaMCU`-Firmware
- Board per USB als CDC-Device verbunden
- Board per USB als Composite Device (Keyboard-HID, Consumer-HID und CDC)
verbunden
## Starten
@@ -27,7 +28,9 @@ dotnet run --project src/VersaGUI.csproj
- liest beim Verbinden zuerst die Config und danach die Makros
- validiert Chunkzahl, eindeutige Indizes, Vollständigkeit, CRC und Feldwerte
- zeigt MX-Buttons und Encoder-Aktionen an
- bearbeitet alle drei Profile über die Profilauswahl
- schreibt Config und Makros getrennt, aber in einem UI-Vorgang auf das Board
- sendet einen Protokoll-Ping und zeigt die Antwort an
## Aktueller Datenstand
@@ -40,6 +43,10 @@ dotnet run --project src/VersaGUI.csproj
- globale Helligkeit
- per-LED-Helligkeit
Globale Helligkeit und Encoder-Sensitivität werden bytegenau erhalten, besitzen
aber derzeit keine eigenen Bedienelemente. Per-LED-Helligkeit kann über JSON
gesetzt werden.
### MacroTable
- 32 Slots
@@ -73,7 +80,8 @@ wait for ACK/NACK
- HID-Key-Zuweisung inklusive Modifier
- Consumer-Keys
- Host-Commands
- Host-Command-IDs konfigurieren und empfangen; Desktop-Aktionen werden noch
nicht ausgeführt
- Makros mit bis zu 8 Steps
- Profilwechsel als ActionType
- LED-Farbe, Animation und Periode pro MX-Button
@@ -90,6 +98,7 @@ VersaGUI/
|-- Program.cs
|-- TrayApp.cs
|-- SerialManager.cs
|-- ChunkTransferBuffer.cs
|-- DeviceConfig.cs
|-- ConfigForm.cs
|-- ActionDialog.cs
@@ -109,13 +118,21 @@ dotnet run --project tests/VersaGUI.ContractTests/VersaGUI.ContractTests.csproj
- die App ist Windows-only
- Host-Command-Events enthalten Command-ID, Key-/Encoder-ID und Richtung; ein
sicheres Mapping auf konkrete Desktop-Aktionen ist noch nicht implementiert
- der ActionDialog bietet aktuell vier der sieben vom Binärformat unterstützten
LED-Animationen an
- ein vollständig ausbleibendes Dump-Ende besitzt noch keinen Empfangs-Timeout
Die vollständige Liste steht in
[`doc/07_known_limitations.md`](doc/07_known_limitations.md).
## Einstieg für Coding-LLMs
Repository-Anweisungen, gemeinsame Binärverträge und Verifikation stehen in
[`AGENTS.md`](AGENTS.md).
## Weiterfuehrende Doku
## Weiterführende Doku
- [doc/02_device_config.md](doc/02_device_config.md)
- [Dokumentationsindex](doc/INDEX.md)
- [Datenlayout](doc/02_device_config.md)
- [Bekannte Einschränkungen](doc/07_known_limitations.md)
- [../VersaMCU/doc/07_serial_protocol.md](../VersaMCU/doc/07_serial_protocol.md)