add per-hardware plugin operation guides in docs
This commit is contained in:
62
docs/hardware-rfroute-guide.md
Normal file
62
docs/hardware-rfroute-guide.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# RF Route Hardware (Relais / Antennenpfad)
|
||||
|
||||
Diese Anleitung beschreibt die RF-Route-Steuerung ueber `rms.rfroute.shell`.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
grep -E '^(RFROUTE_CMD_TX|RFROUTE_CMD_RX|RFROUTE_CMD_DRAHT|RFROUTE_CMD_BEAM|RFROUTE_CMD_WRTC|RFROUTE_TIMEOUT_MS)=' /etc/remotestation-arcg/remotestation-arcg.env
|
||||
sudo systemctl restart remotestation-arcg
|
||||
```
|
||||
|
||||
## 1) Unterstuetzte Routen
|
||||
|
||||
Das Plugin kennt diese Route-Keys:
|
||||
|
||||
- `tx`, `rx`
|
||||
- `on`, `off`
|
||||
- `draht`, `beam`, `wrtc`
|
||||
|
||||
Je Route wird ein Shell-Kommando aus ENV ausgefuehrt.
|
||||
|
||||
## 2) Relevante ENV-Keys
|
||||
|
||||
```env
|
||||
RFROUTE_CMD_TX=
|
||||
RFROUTE_CMD_RX=
|
||||
RFROUTE_CMD_ON=
|
||||
RFROUTE_CMD_OFF=
|
||||
RFROUTE_CMD_DRAHT=
|
||||
RFROUTE_CMD_BEAM=
|
||||
RFROUTE_CMD_WRTC=
|
||||
RFROUTE_TIMEOUT_MS=15000
|
||||
RFROUTE_DEFAULT=rx
|
||||
```
|
||||
|
||||
## 3) Bedienung
|
||||
|
||||
Die Route wird serverseitig ueber Capability `rfroute.set` gesetzt. In der UI erscheinen die Optionen als Schaltergruppe.
|
||||
|
||||
Wichtig im Betrieb:
|
||||
|
||||
- Umschalten ist bei aktivem TX serverseitig gesperrt (TX-Safety).
|
||||
- Im OpenWebRX-Flow werden Route-Folgen und Fail-Safe-Wechsel (z. B. auf `rx`) zusaetzlich serverseitig erzwungen.
|
||||
|
||||
## 4) Einstellen / Kalibrieren
|
||||
|
||||
1. Jede Route einzeln auf Shell-Ebene verifizieren.
|
||||
2. Sicherstellen, dass `rx` ein echter Empfangspfad ist.
|
||||
3. Sicherstellen, dass `tx` nur im gewuenschten TX-Pfad landet.
|
||||
4. Bei Multi-Antennen (`draht/beam/wrtc`) klare Mapping-Tabelle pflegen.
|
||||
5. Timeouts nur bei echten Geraetelatenzen erhoehen.
|
||||
|
||||
## 5) Fehlerbilder
|
||||
|
||||
- `RFROUTE_CMD_<ROUTE> fehlt`: Kommando fuer angeforderte Route fehlt.
|
||||
- `rfroute command failed`: Shell-Kommando liefert Fehlercode/Stderr.
|
||||
- Route schaltet, aber Wirkung falsch: Relais-Mapping (Hardwareverdrahtung) pruefen.
|
||||
|
||||
## 6) Sicherheitsregeln
|
||||
|
||||
- Keine Schaltkommandos committen, die sensible Host-/Credential-Daten enthalten.
|
||||
- TX/RX-Safety-Pfade regelmaessig mit realer Hardware pruefen.
|
||||
Reference in New Issue
Block a user