diff --git a/_info/config.md b/_info/config.md index d36a866..187c34c 100644 --- a/_info/config.md +++ b/_info/config.md @@ -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 -``` \ No newline at end of file +``` + +--- +### Module +#### `filter.modeFilter` + +|Feld|Beschreibung|Default| +|----|------------|-------| +|allowed|Liste der erlaubten Paket Typen (fms, zvei, pocsag)|| + +Bsp: +```yaml +config: + allowed: + - fms + - zvei +``` + +--- +### Plugins \ No newline at end of file diff --git a/config/client.yaml b/config/client.yaml index 2f9b09a..a3e33c1 100644 --- a/config/client.yaml +++ b/config/client.yaml @@ -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