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

44
doc/ToDo_2_Anbindung.md Normal file
View File

@@ -0,0 +1,44 @@
# ToDo 2 — Anbindung
## Ziel der Verbesserung
Die Anbindung soll zuverlässig werden: WebSocket-Eingaben, Steuerlogik und Sender müssen klar verbunden und sauber orchestriert sein.
Dieses ToDo konzentriert sich auf die technische Integration der Komponenten, nicht auf G-Code-Parsing oder Konfiguration.
## Paket 1: Start/Orchestrierung
- [ ] `startRobot.js` als Orchestrator behandeln
- Erzeugung und Verbindung der Module
- keine Geschäftslogik im Start-Skript
- [ ] Bindung der WebSocket-Eingabe an die Steuerlogik
- `InputWS.js` empfängt Nachrichten
- Delegation an den Parser / Controller
- [ ] Sauberes Fehler- und Status-Reporting beim Start
- fehlende Zertifikate
- fehlende Senderverbindungen
## Paket 2: Sender-Schicht (Option C)
- [ ] Sender-Interface definieren
- `connect()`
- `send(command)`
- `getStatus()`
- `disconnect()`
- [ ] `TelnetSenderGRBL` als konkrete Implementierung
- async `connect()`-Methode
- eindeutiger Verbindungsstatus, nicht nur `this.tSocket`
- reconnect/backoff-Strategie
- saubere Fehlerlogs
- [ ] Sender-Schicht testbar und austauschbar machen
- später können andere Sender als `TelnetSenderGRBL` angehängt werden
## Paket 3: Status- und Info-Anbindung
- [ ] `InfoServer.js` meldet nicht nur Weboberfläche, sondern auch Senderstatus
- [ ] `/api/status` erweitert um Senderverbindungen und Health-Informationen
- [ ] `/api/position` liefert aktuelle Roboterposition unabhängig von laufenden Verbindungen
## Hinweis
- Parsing, Konfiguration, Datei-Management und Tests werden getrennt in eigenen `doc/ToDo_*.md`-Dateien behandelt.
- Event-basierte Architektur ist aktuell nicht vorgesehen; die Umsetzung folgt Option A mit einer klaren Sender-Interface-Schicht.