add descriptor module and docu

docu/docs/modul/descriptor.md

@@ -0,0 +1,65 @@
+# <center>Descriptor</center> 
+---
+
+## Beschreibung
+Mit diesem Modul können einem Alarmpaket beliebige Beschreibung in Abhänigkeit der enthaltenen Informationen im Paket hinzugefügt werden.
+
+## Resource
+`descriptor`
+
+## Konfiguration
+
+Informationen zum Aufbau eines [BOSWatch Pakets](../develop/packet.md)
+
+|Feld|Beschreibung|Default|
+|----|------------|-------|
+|scanField|Feld des BW Pakets welches geprüft werden soll||
+|descrField|Name des Feldes im BW Paket in welchem die Beschreibung gespeichert werden soll||
+|wildcard|Optional: Es kann für das angelegte `descrField` automatisch ein Wildcard registriert werden|None|
+|descriptions|Liste der Beschreibungen||
+
+#### `descriptions:`
+
+|Feld|Beschreibung|Default|
+|----|------------|-------|
+|for|Inhalt im `scanField` auf welchem geprüft werden soll||
+|add|Beschreibungstext welcher im `descrField` hinterlegt werden soll||
+
+**Beispiel:**
+```yaml
+- type: module
+  res: descriptor
+  config:
+    - scanField: zvei
+      descrField: description
+      wildcard: "{DESCR}"
+      descriptions:
+        - for: 12345
+          add: FF DescriptorTest
+        - for: 45678
+          add: FF TestDescription
+    - scanField: status
+      descrField: fmsStatDescr
+      wildcard: "{STATUSTEXT}"
+      descriptions:
+        - for: 1
+          add: Frei (Funk)
+        - for: 2
+          add: Frei (Wache)
+        - ...
+```
+
+---
+## Abhängigkeiten
+
+- keine
+
+---
+## Paket Modifikationen
+
+- Wenn im Paket das Feld `scanField` vorhanden ist, wird das Feld `descrField` dem Paket hinzugefügt
+
+---
+## Zusätzliche Wildcards
+
+- Von der Konfiguration abhängig

docu/mkdocs.yml

@@ -20,6 +20,7 @@ nav:
   - Module:
       - Mode Filter: modul/mode_filter.md
       - Regex Filter: modul/regex_filter.md
+      - Descriptor: modul/descriptor.md
   - Plugins: tbd.md
   - Entwickler:
     - Eigenes Modul/Plugin schreiben: develop/ModulPlugin.md