edit docu

This commit is contained in:
Bastian Schroll 2019-09-19 22:27:46 +02:00
parent f4125ce9fb
commit ace663f348
5 changed files with 37 additions and 34 deletions

View file

@ -7,7 +7,6 @@ zwingend in die Konfiguration eingetragen werden.
---
## Client
### `client:`
|Feld|Beschreibung|Default|
|----|------------|-------|
@ -25,7 +24,7 @@ Ansonsten wird versucht die Verbindungsdaten per Broadcast Paket direkt vom Serv
|ip|IP Adresse des Servers|127.0.0.1|
|port|Port des Sever|8080|
Bsp:
**Beispiel:**
```yaml
server:
ip: 10.10.10.2
@ -44,7 +43,7 @@ Aktuell gibt es nur `sdr:` als Input Quelle
|squelch|Einstellung der Rauschsperre|0|
|gain|Verstärkung des Eingangssignals|100|
Bsp:
**Beispiel:**
```yaml
inputSource:
sdr:
@ -80,7 +79,7 @@ Nachfolgend alle Paramater der Server Konfiguration
### `alarmRouter:`
Enthält eine Liste der Router Namen, welche bei einem Alarm direkt gestartet werden sollen.
Bsp:
**Beispiel:**
```yaml
alarmRouter:
- Name des Routers
@ -106,7 +105,7 @@ Jeder Router kann eine beliebige Anzahl einzelner Routenpunkte enthalten. Diese
|name|Zu ladende Resource (Siehe weiter unten)||
|config|Konfigurationseinstellungen des Routenpunktes (Siehe weiter unten)||
Bsp:
**Beispiel:**
```yaml
router:
- name: Router 1
@ -119,24 +118,6 @@ router:
```
---
## Module
Nachfolgend alle Paramater der Modul Konfigurationen
### `filter.modeFilter`
|Feld|Beschreibung|Default|
|----|------------|-------|
|allowed|Liste der erlaubten Paket Typen `fms` `zvei` `pocsag`||
Bsp:
```yaml
config:
allowed:
- fms
- zvei
```
---
## Plugins
Nachfolgend alle Paramater der Plugin Konfigurationen
## Module/Plugins
Für die Konfiguration der Module und Plugins ist in den entsprechenden Kategorien eine ausführliche Beschreibung zu finden.

View file

@ -1,3 +1,24 @@
# <center>Mode Filter</center>
## Beschreibung
Mit diesem Modul ist es Möglich, die Pakete auf bestimmte Modes (FMS, POCSAG, ZVEI) zu Filtern. Je nach Konfiguration werden Pakete eines bestimmten Modes im aktuellen Router weitergeleitet oder verworfen.
---
## Resource
`filter.modeFilter`
## Konfiguration
|Feld|Beschreibung|Default|
|----|------------|-------|
|allowed|Liste der erlaubten Paket Typen `fms` `zvei` `pocsag` `msg`||
**Beispiel:**
```yaml
- type: module
name: filter.modeFilter
config:
allowed:
- fms
- pocsag
```