BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2025-12-06 07:12:04 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
BW3-Core/docu/docs/config.md
Bastian Schroll b157f96057 Merge branch 'develop' into process_manager
2019-09-19 10:54:51 +02:00

3.1 KiB
Raw Blame History

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

Nachfolgend alle Paramater der Client Konfiguration

client:

Feld Beschreibung Default
name Name zur Identifizierung der Client Instanz
inputSource 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.
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

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:

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

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.

Bsp:

alarmRouter:
  - Name des Routers
  - ein weiter Router

router:

Mit den Routern kann der Verarbeitungsweg eines Alarm-Paketes festgelegt werden. Diese werden als Liste angegeben

Feld Beschreibung Default
name Name des Routers
route Definiten des Routenverlaufs

Die einzelnen Routen werden wie folgt definiert

Feld Beschreibung Default
type Art des Routenpunktes (module, plugin, router)
name Zu ladende Resource (vollständige Liste siehe !!!TBD!!!)
config Konfigurationseinstellungen des Routenpunktes

Bsp:

router:
  - name: Router 1
    route:
      - type: module
        name: filter.modeFilter
        config:
          allowed:
            - fms

Module

Nachfolgend alle Paramater der Modul Konfigurationen

filter.modeFilter

Feld Beschreibung Default
allowed Liste der erlaubten Paket Typen (fms, zvei, pocsag, msg)

Bsp:

config:
  allowed:
    - fms
    - zvei

Plugins

Nachfolgend alle Paramater der Plugin Konfigurationen