From 2f96e4aa9bfa7e6bc2a54f5d651d0630b62e05be Mon Sep 17 00:00:00 2001
From: B-Watch <b-watch@forceweb.de>
Date: Fri, 10 Jul 2020 21:35:08 +0200
Subject: [PATCH] added documentation

---
 docu/docs/modul/double_filter.md | 49 ++++++++++++++++++++++++++++++++
 docu/mkdocs.yml                  |  1 +
 2 files changed, 50 insertions(+)
 create mode 100644 docu/docs/modul/double_filter.md

diff --git a/docu/docs/modul/double_filter.md b/docu/docs/modul/double_filter.md
new file mode 100644
index 0000000..7fb28f8
--- /dev/null
+++ b/docu/docs/modul/double_filter.md
@@ -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
+
diff --git a/docu/mkdocs.yml b/docu/mkdocs.yml
index df708b9..ff4f904 100644
--- a/docu/mkdocs.yml
+++ b/docu/mkdocs.yml
@@ -22,6 +22,7 @@ nav:
       - Geocoding: modul/geocoding.md
       - Mode Filter: modul/mode_filter.md
       - Regex Filter: modul/regex_filter.md
+      - Double Filter: modul/double_filter.md
   - Plugins:
       - Http: plugin/http.md
       - Telegram: plugin/telegram.md