Dokumentation

This commit is contained in:
chk
2026-06-08 14:04:11 +02:00
parent ad1fc58186
commit 9f840ca5e3
8 changed files with 293 additions and 0 deletions

21
doc/ToDo_5_API.md Normal file
View File

@@ -0,0 +1,21 @@
# ToDo 5 — API und Antwortlogik
## Ziel der Verbesserung
Die Schnittstellen sollen klar und vorhersagbar antworten. Steuerbefehle brauchen eigene Antwortpfade, und Status-/Positionsergebnisse müssen eindeutig getrennt werden.
## Aufgaben
- [ ] WebSocket-Antwortlogik strukturieren
- Steuerbefehle erhalten gezielte Responses
- `Ping`, `M114`, Statusabfragen und Fehlermeldungen getrennt behandeln
- [ ] Broadcasts nur dort verwenden, wo sie sinnvoll sind
- Broadcasts für Status-Updates, nicht für direkte Steuerantworten
- [ ] `InfoServer` um detaillierte Statusinformationen erweitern
- Senderverbindungen
- Health-Checks
- letzte Befehle / Pings
- [ ] API-Endpunkte klar dokumentieren
- `/api/status`
- `/api/position`
- [ ] Fehlermeldungen konsistent und maschinenlesbar machen