added documentation

This commit is contained in:
B-Watch 2020-07-10 21:35:08 +02:00
parent 8bd9e26fe1
commit 2f96e4aa9b
2 changed files with 50 additions and 0 deletions

View file

@ -0,0 +1,49 @@
# <center>Double Filter</center>
---
## Beschreibung
Mit diesem Modul ist es möglich, die Pakete auf Duplikate zu Filtern. Je nach Konfiguration werden doppelte Pakete im aktuellen Router weitergeleitet oder verworfen.
## Unterstütze Alarmtypen
- Fms
- Pocsag
- Zvei
## Resource
`filter.doubleFilter`
## Konfiguration
|Feld|Beschreibung|Default|
|----|------------|-------|
|ignoreTime|Zeitfenster für doppelte Pakte in Sekunden|10|
|maxEntry|Maximale Anzahl an Paketen in der Vergleichsliste|20|
|pocsagFields|Liste der Pocsag Felder zum Vergleichen: `ric`, `subric` und/oder `message`|`ric`|
**Beispiel:**
```yaml
- type: module
res: filter.doubleFilter
config:
ignoreTime: 30
maxEntry: 10
pocsagFields:
- ric
- subric
```
---
## Modul Abhängigkeiten
- keine
---
## Externe Abhängigkeiten
- keine
---
## Paket Modifikationen
- keine
---
## Zusätzliche Wildcards
- keine

View file

@ -22,6 +22,7 @@ nav:
- Geocoding: modul/geocoding.md - Geocoding: modul/geocoding.md
- Mode Filter: modul/mode_filter.md - Mode Filter: modul/mode_filter.md
- Regex Filter: modul/regex_filter.md - Regex Filter: modul/regex_filter.md
- Double Filter: modul/double_filter.md
- Plugins: - Plugins:
- Http: plugin/http.md - Http: plugin/http.md
- Telegram: plugin/telegram.md - Telegram: plugin/telegram.md