add per-hardware plugin operation guides in docs
This commit is contained in:
62
docs/hardware-tx-control-guide.md
Normal file
62
docs/hardware-tx-control-guide.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# TX Power Control Hardware
|
||||
|
||||
Diese Anleitung beschreibt die TX-Power-Steuerung ueber `rms.tx.control.native`.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
grep -E '^(TX_ENABLE_CMD|TX_DISABLE_CMD|TX_STATUS_CMD|TX_CONTROL_TIMEOUT_MS|TX_STATE_PATH)=' /etc/remotestation-arcg/remotestation-arcg.env
|
||||
sudo systemctl restart remotestation-arcg
|
||||
curl -sS -H "Authorization: Bearer <token>" -X POST http://127.0.0.1:8080/v1/openwebrx/tx/enable
|
||||
curl -sS -H "Authorization: Bearer <token>" http://127.0.0.1:8080/v1/openwebrx/tx/status
|
||||
curl -sS -H "Authorization: Bearer <token>" -X POST http://127.0.0.1:8080/v1/openwebrx/tx/disable
|
||||
```
|
||||
|
||||
## 1) Funktionsprinzip
|
||||
|
||||
- `enableTx` fuehrt `TX_ENABLE_CMD` aus.
|
||||
- `disableTx` fuehrt `TX_DISABLE_CMD` aus.
|
||||
- `getTxState` nutzt bevorzugt `TX_STATUS_CMD`; Fallback ist `TX_STATE_PATH` (JSON).
|
||||
|
||||
Default-Kommandos (wenn nicht ueberschrieben):
|
||||
|
||||
- `/opt/remotestation/bin/tx-control.sh enable`
|
||||
- `/opt/remotestation/bin/tx-control.sh disable`
|
||||
- `/opt/remotestation/bin/tx-control.sh status`
|
||||
|
||||
## 2) Relevante ENV-Keys
|
||||
|
||||
```env
|
||||
TX_ENABLE_CMD=
|
||||
TX_DISABLE_CMD=
|
||||
TX_STATUS_CMD=
|
||||
TX_CONTROL_TIMEOUT_MS=20000
|
||||
TX_STATE_PATH=/opt/remotestation-arcg/shared/data/tx-state.json
|
||||
```
|
||||
|
||||
## 3) Bedienung
|
||||
|
||||
- API:
|
||||
- `POST /v1/openwebrx/tx/enable`
|
||||
- `POST /v1/openwebrx/tx/disable`
|
||||
- `GET /v1/openwebrx/tx/status`
|
||||
|
||||
Hinweis: TX-Power ist getrennt von PTT. PTT wird ueber `rms.microham` verwaltet.
|
||||
|
||||
## 4) Einstellen und Kalibrieren
|
||||
|
||||
1. Enable/Disable-Kommandos zuerst auf Shell-Ebene pruefen.
|
||||
2. `TX_STATUS_CMD` auf klaren Rueckgabewert trimmen (`on/off`, `1/0`, `true/false`).
|
||||
3. Wenn Statuskommando nicht stabil ist, JSON-Fallback (`TX_STATE_PATH`) bewusst nutzen.
|
||||
4. Zeitlimit `TX_CONTROL_TIMEOUT_MS` nur bei echter Hardwarelatenz anpassen.
|
||||
|
||||
## 5) Fehlerbilder
|
||||
|
||||
- `TX enable command missing` / `TX disable command missing`: ENV fehlt.
|
||||
- `TX enable failed` / `TX disable failed`: Kommando liefert Fehler.
|
||||
- Status falsch trotz Schalten: `TX_STATUS_CMD` und Zustandsquelle pruefen.
|
||||
|
||||
## 6) Sicherheitsregeln
|
||||
|
||||
- Verwende fail-safe Standard: bei Unsicherheit TX auf OFF.
|
||||
- Keine produktiven Schalt-Backends oder Zugangsdaten ins Repo committen.
|
||||
Reference in New Issue
Block a user