3.4 KiB
Konfiguration
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 in die Konfiguration eingetragen werden.
Client
client:
| Feld | Beschreibung | Default |
|---|---|---|
| name | Name zur Identifizierung der Client Instanz | |
| inputSource | Art der zu nutzenden Input Quelle (aktuell nur sdr) |
sdr |
| useBroadcast | Verbindungsdaten per Broadcast beziehen | no |
| reconnectDelay | Verzögerung für erneuten Verbindungsversuch zum Server | 3 |
| sendTries | Anzahl der Sendeversuche eines Pakets | 3 |
| sendDelay | Verzögerung für einen erneuten Sendeversuch | 3 |
server:
Der Abschnitt server: wird nur genutzt, wenn useBroadcast: no gesetzt ist.
Ansonsten wird versucht die Verbindungsdaten per Broadcast Paket direkt vom Server zu beziehen.
| Feld | Beschreibung | Default |
|---|---|---|
| ip | IP Adresse des Servers | 127.0.0.1 |
| port | Port des Sever | 8080 |
Beispiel:
server:
ip: 10.10.10.2
port: 9123
inputSource:
Aktuell gibt es nur sdr: als Input Quelle
sdr:
| Feld | Beschreibung | Default |
|---|---|---|
| device | rtl_fm Device ID | 0 |
| frequency | Zu empfangende Frequenz | |
| error | Frequenz Abweichung in ppm | 0 |
| squelch | Einstellung der Rauschsperre | 1 |
| gain | Verstärkung des Eingangssignals | 100 |
Beispiel:
inputSource:
sdr:
device: 0
frequencies:
- 85.000M
- 86.0000M
error: 0
squelch: 1
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
Nachfolgend alle Paramater der Server Konfiguration
server:
| Feld | Beschreibung | Default |
|---|---|---|
| port | Port auf dem der Server lauscht | 8080 |
| name | Name zur Identifizierung der Server Instanz | |
| useBroadcast | Verbindungsdaten per Broadcast Server bereitstellen | no |
alarmRouter:
Enthält eine Liste der Router Namen, welche bei einem Alarm direkt gestartet werden sollen.
Beispiel:
alarmRouter:
- Name des Routers
- ein weiter Router
router:
Mit den Routern kann der Verarbeitungsweg eines Alarm-Paketes festgelegt werden. DEs können beliebig viele Router in Form einer Liste angegeben werden.
| Feld | Beschreibung | Default |
|---|---|---|
| name | Name des Routers | |
| route | Definiten des Routenverlaufs |
route:
Jeder Router kann eine beliebige Anzahl einzelner Routenpunkte enthalten. Diese werden innerhalb des Routers sequentiel abgearbeitet. Mögliche Typen der Routenpunkte sind dabei ein Modul, ein Plugin oder ein anderer Router. Sie werden ebenfalls in Form einer Liste definiert.
| Feld | Beschreibung | Default |
|---|---|---|
| type | Art des Routenpunktes (module, plugin, router) | |
| name | Zu ladende Resource (Siehe entsprechende Kapitel) | |
| config | Konfigurationseinstellungen des Routenpunktes (Siehe entsprechende Kapitel) |
Beispiel:
router:
- name: Router 1
route:
- type: module
name: filter.modeFilter
config:
allowed:
- fms
Module/Plugins
| Feld | Beschreibung | Default |
|---|---|---|
| allowed | Liste der erlaubten Paket Typen fms zvei pocsag |