mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2026-01-03 15:19:57 +01:00
improve config docu
This commit is contained in:
parent
6891616215
commit
c82a294797
|
|
@ -2,12 +2,59 @@
|
|||
|
||||
Die Konfiguration von BOSWatch 3 ist im YAML Format abgelegt und wird nachfolgend beschrieben.
|
||||
Immer wenn für eine Einstellung ein **Default** Wert angegeben ist, muss diese Einstellung nicht
|
||||
zwingend eingetragen werden.
|
||||
zwingend in die Konfiguration eingetragen werden.
|
||||
|
||||
|
||||
### Client
|
||||
tbd
|
||||
|
||||
#### `client:`
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|name|Name zur Identifizierung der Client Instanz||
|
||||
|inoutSource|Art der zu nutzenden Input Quelle (aktuell nur `sdr`)||
|
||||
|useBroadcast|Verbindungsdaten per Broadcast beziehen|no|
|
||||
|
||||
#### `server:`
|
||||
Der Abschnitt `server:` wird nur genutzt, wenn `useBroadcast: no` gesetzt ist.
|
||||
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|ip|IP Adresse des Servers|127.0.0.1|
|
||||
|port|Port des Sever|8080|
|
||||
|
||||
#### `inputSource:`
|
||||
Aktuell gibt es nur `sdr:` als Input Quelle
|
||||
|
||||
##### `sdr:`
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|device|rtl_fm Device ID|0|
|
||||
|frequency|Frequenz des Empfängers||
|
||||
|error|Frequenz Abweichung in ppm|0|
|
||||
|squelch|Einstellung der Rauschsperre|0|
|
||||
|gain|Verstärkung des Eingangssignals|100|
|
||||
|
||||
Bsp:
|
||||
```yaml
|
||||
inputSource:
|
||||
sdr:
|
||||
device: 0
|
||||
frequency: 85.000M
|
||||
error: 0
|
||||
squelch: 0
|
||||
gain: 100
|
||||
```
|
||||
|
||||
#### `decoder:`
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|fms|FMS Decoder|no|
|
||||
|zvei|ZVEI Decoder|no|
|
||||
|poc512|POCSAG Decoder (Bitrate 512)|no|
|
||||
|poc1200|POCSAG Decoder (Bitrate 1200)|no|
|
||||
|poc2400|POCSAG Decoder (Bitrate 2400)|no|
|
||||
|
||||
---
|
||||
### Server
|
||||
|
||||
#### `server:`
|
||||
|
|
@ -54,4 +101,23 @@ router:
|
|||
config:
|
||||
allowed:
|
||||
- fms
|
||||
```
|
||||
```
|
||||
|
||||
---
|
||||
### Module
|
||||
#### `filter.modeFilter`
|
||||
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|allowed|Liste der erlaubten Paket Typen (fms, zvei, pocsag)||
|
||||
|
||||
Bsp:
|
||||
```yaml
|
||||
config:
|
||||
allowed:
|
||||
- fms
|
||||
- zvei
|
||||
```
|
||||
|
||||
---
|
||||
### Plugins
|
||||
|
|
@ -20,9 +20,9 @@ inputSource:
|
|||
sdr:
|
||||
device: 0
|
||||
frequency: 85.000M
|
||||
PPMError: 0
|
||||
Squelch: 0
|
||||
Gain: 100
|
||||
error: 0
|
||||
squelch: 0
|
||||
gain: 100
|
||||
|
||||
decoder:
|
||||
fms: yes
|
||||
|
|
|
|||
Loading…
Reference in a new issue