Dokumentation
This commit is contained in:
21
doc/ToDo_5_API.md
Normal file
21
doc/ToDo_5_API.md
Normal 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
|
||||
Reference in New Issue
Block a user