diff --git a/docu/docs/modul/descriptor.md b/docu/docs/modul/descriptor.md index dd53b5d..a472b0f 100644 --- a/docu/docs/modul/descriptor.md +++ b/docu/docs/modul/descriptor.md @@ -4,11 +4,16 @@ ## Beschreibung Mit diesem Modul können einem Alarmpaket beliebige Beschreibungen in Abhänigkeit der enthaltenen Informationen hinzugefügt werden. +## Unterstütze Alarmtypen +- Fms +- Pocsag +- Zvei +- Msg + ## Resource `descriptor` ## Konfiguration - Informationen zum Aufbau eines [BOSWatch Pakets](../develop/packet.md) |Feld|Beschreibung|Default| @@ -19,7 +24,6 @@ Informationen zum Aufbau eines [BOSWatch Pakets](../develop/packet.md) |descriptions|Liste der Beschreibungen|| #### `descriptions:` - |Feld|Beschreibung|Default| |----|------------|-------| |for|Inhalt im `scanField` auf welchem geprüft werden soll|| @@ -50,17 +54,18 @@ Informationen zum Aufbau eines [BOSWatch Pakets](../develop/packet.md) ``` --- -## Abhängigkeiten +## Modul Abhängigkeiten +- keine +--- +## Externe Abhängigkeiten - keine --- ## Paket Modifikationen - - Wenn im Paket das Feld `scanField` vorhanden ist, wird das Feld `descrField` dem Paket hinzugefügt - Wenn keine Beschreibung vorhanden ist, wird im Feld `descrField` der Inhalt des Feldes `scanField` hinterlegt --- ## Zusätzliche Wildcards - -- Von der Konfiguration abhängig \ No newline at end of file +- Von der Konfiguration abhängig diff --git a/docu/docs/modul/geocoding.md b/docu/docs/modul/geocoding.md index 0acf43e..f2e69d7 100644 --- a/docu/docs/modul/geocoding.md +++ b/docu/docs/modul/geocoding.md @@ -4,9 +4,6 @@ ## Beschreibung Mit diesem Modul können einem Paket die Koordinaten eines Ortes oder einer Adresse angefügt werden. -## Externe Abhängigkeiten -- geocoder - ## Unterstützte Alarmtypen - Pocsag @@ -14,7 +11,6 @@ Mit diesem Modul können einem Paket die Koordinaten eines Ortes oder einer Adre `geocoding` ## Konfiguration - |Feld|Beschreibung|Default| |----|------------|-------| apiProvider|Der Provider für das Geocoding| @@ -22,7 +18,6 @@ apiToken|Der Api-Token fuer die Geocoding-Api| geoRegex|Regex Capture-Group zum Herausfiltern der Adresse| #### Verfügbare Geocoding Provider - |Name|Einstellungswert| |----|------------| |Mapbox|mapbox| @@ -40,20 +35,21 @@ geoRegex|Regex Capture-Group zum Herausfiltern der Adresse| ``` --- -## Abhängigkeiten - +## Modul Abhängigkeiten - keine --- -## Paket Modifikationen +## Externe Abhängigkeiten +- geocoder +--- +## Paket Modifikationen - `address`: gefundene Adresse - `lat`: Latitude der Adresse - `lon`: Longitude der Adresse --- ## Zusätzliche Wildcards - - `{ADDRESS}`: gefundene Adresse - `{LAT}`: Latitude der Adresse - `{LON}`: Longitude der Adresse \ No newline at end of file diff --git a/docu/docs/modul/mode_filter.md b/docu/docs/modul/mode_filter.md index f805835..e016003 100644 --- a/docu/docs/modul/mode_filter.md +++ b/docu/docs/modul/mode_filter.md @@ -4,11 +4,16 @@ ## 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. +## Unterstütze Alarmtypen +- Fms +- Pocsag +- Zvei +- Msg + ## Resource `filter.modeFilter` ## Konfiguration - |Feld|Beschreibung|Default| |----|------------|-------| |allowed|Liste der erlaubten Paket Typen `fms` `zvei` `pocsag` `msg`|| @@ -24,16 +29,18 @@ Mit diesem Modul ist es möglich, die Pakete auf bestimmte Modes (FMS, POCSAG, Z ``` --- -## Abhängigkeiten +## Modul Abhängigkeiten +- keine +--- +## Externe Abhängigkeiten - keine --- ## Paket Modifikationen - - keine --- ## Zusätzliche Wildcards - - keine + diff --git a/docu/docs/modul/regex_filter.md b/docu/docs/modul/regex_filter.md index f554452..77e0a1d 100644 --- a/docu/docs/modul/regex_filter.md +++ b/docu/docs/modul/regex_filter.md @@ -15,18 +15,22 @@ Folgendes gilt: Vereinfacht kann man sagen, dass einzelnen Router ODER-verknüpft und die jeweiligen Checks UND-verknüpft sind. +## Unterstütze Alarmtypen +- Fms +- Pocsag +- Zvei +- Msg + ## Resource `filter.regexFilter` ## Konfiguration - |Feld|Beschreibung|Default| |----|------------|-------| |name|Beliebiger Name des Filters|| |checks|Liste der einzelnen Checks innerhalb des Filters|| #### `checks:` - |Feld|Beschreibung|Default| |----|------------|-------| |field|Name des Feldes innerhalb des BOSWatch Pakets welches untersucht werden soll|| @@ -50,16 +54,17 @@ Vereinfacht kann man sagen, dass einzelnen Router ODER-verknüpft und die jeweil ``` --- -## Abhängigkeiten +## Modul Abhängigkeiten +- keine +--- +## Externe Abhängigkeiten - keine --- ## Paket Modifikationen - - keine --- ## Zusätzliche Wildcards - -- keine +- keine \ No newline at end of file diff --git a/docu/docs/plugin/http.md b/docu/docs/plugin/http.md index f9051bf..82f5a9f 100644 --- a/docu/docs/plugin/http.md +++ b/docu/docs/plugin/http.md @@ -5,10 +5,6 @@ Mit diesem Plugin ist es moeglich, Http-Anfragen für Alarmierungen zu senden. Wildcards in den Urls werden automatisch ersetzt. -## Externe Abhängigkeiten -- asyncio -- aiohttp - ## Unterstütze Alarmtypen - Fms - Pocsag @@ -19,7 +15,6 @@ Wildcards in den Urls werden automatisch ersetzt. `http` ## Konfiguration - |Feld|Beschreibung|Default| |----|------------|-------| |fms|Liste mit Urls für Fms-Alarmierung|| @@ -41,6 +36,10 @@ Wildcards in den Urls werden automatisch ersetzt. ``` --- -## Abhängigkeiten - +## Modul Abhängigkeiten - keine + +--- +## Externe Abhängigkeiten +- asyncio +- aiohttp diff --git a/docu/docs/plugin/telegram.md b/docu/docs/plugin/telegram.md index 3003bbe..1eb5a01 100644 --- a/docu/docs/plugin/telegram.md +++ b/docu/docs/plugin/telegram.md @@ -3,10 +3,7 @@ ## Beschreibung Mit diesem Plugin ist es moeglich, Telegram-Nachrichten für POCSAG-Alarmierungen zu senden. -Außerdem werden Locations versenden, wenn die Felder `lat` und `lon` im Paket definiert sind. (beispielsweise durch das Geocoding-Modul) - -## Externe Abhängigkeiten -- python-telegram-bot +Außerdem werden Locations versenden, wenn die Felder `lat` und `lon` im Paket definiert sind. (beispielsweise durch das [Geocoding](../modul/geocoding.md) Modul) ## Unterstütze Alarmtypen - Pocsag @@ -35,8 +32,12 @@ Außerdem werden Locations versenden, wenn die Felder `lat` und `lon` im Paket d ``` --- -## Abhängigkeiten +## Modul Abhängigkeiten +Aus dem Modul [Geocoding](../modul/geocoding.md) (optional): -- Modul geocoding (Falls in Paket vorhanden): - - `lat` - - `lon` +- `lat` +- `lon` + +--- +## Externe Abhängigkeiten +- python-telegram-bot diff --git a/docu/mkdocs.yml b/docu/mkdocs.yml index 2a9d54b..df708b9 100644 --- a/docu/mkdocs.yml +++ b/docu/mkdocs.yml @@ -18,7 +18,7 @@ nav: - Routing Mechanismus: information/router.md - Changelog: changelog.md - Module: - - Descriptor: modul/descriptor.md + - Descriptor: modul/descriptor.md - Geocoding: modul/geocoding.md - Mode Filter: modul/mode_filter.md - Regex Filter: modul/regex_filter.md