mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2026-04-04 13:57:44 +00:00
add geocoding module, resolve threads
This commit is contained in:
parent
575e44ae54
commit
4aea7b5d78
6 changed files with 291 additions and 100 deletions
53
docu/docs/modul/geocoding.md
Normal file
53
docu/docs/modul/geocoding.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# <center>Geocoding</center>
|
||||
---
|
||||
|
||||
## Beschreibung
|
||||
Mit diesem Modul können einem Paket die Koordinaten eines Ortes oder einer Adresse angefügt werden.
|
||||
|
||||
## Unterstützte Alarmtypen
|
||||
- Pocsag
|
||||
|
||||
## Resource
|
||||
`geocoding`
|
||||
|
||||
## Konfiguration
|
||||
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
apiProvider|Der Provider für das Geocoding|
|
||||
apiToken|Der Api-Token fuer die Geocoding-Api|
|
||||
geoRegex|Regex Capture-Group zum Herausfiltern der Adresse|
|
||||
|
||||
#### Verfügbare Geocoding Provider
|
||||
|
||||
|Name|Einstellungswert|
|
||||
|----|------------|
|
||||
|Mapbox|mapbox|
|
||||
|Google Maps|google|
|
||||
|
||||
**Beispiel:**
|
||||
```yaml
|
||||
- type: module
|
||||
name: Geocoding Module
|
||||
res: geocoding
|
||||
config:
|
||||
apiProvider: "{{ Provider für Geocoding }}"
|
||||
apiToken: "{{ API-Key für Provider }}"
|
||||
regex: "((?:[^ ]*,)*?)"
|
||||
```
|
||||
|
||||
---
|
||||
## Abhängigkeiten
|
||||
|
||||
- geocoder
|
||||
- re
|
||||
|
||||
---
|
||||
## Paket Modifikationen
|
||||
|
||||
- Im Paket werden die Felder `lat` und `lng` hinterlegt
|
||||
|
||||
---
|
||||
## Zusätzliche Wildcards
|
||||
|
||||
- keine
|
||||
|
|
@ -2,38 +2,20 @@
|
|||
---
|
||||
|
||||
## Beschreibung
|
||||
Mit diesem Plugin ist es moeglich, Telegram-Nachrichten für POCSAG-Alarmierungen zu senden.
|
||||
Außerdem unterstützt das Plugin das Versenden von Location über folgende geocoding-Api's:
|
||||
Mit diesem Plugin ist es moeglich, Telegram-Nachrichten für POCSAG-Alarmierungen zu senden. Außerdem werden Locations versenden, wenn die Felder `lat` und `lng` im Paket definiert sind.
|
||||
|
||||
- Mapbox
|
||||
- Google Maps
|
||||
## Unterstütze Alarmtypen
|
||||
- Pocsag
|
||||
|
||||
## Resource
|
||||
`telegram`
|
||||
|
||||
## Konfiguration
|
||||
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|name|Beliebiger Name des Plugins||
|
||||
|
||||
#### `config:`
|
||||
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|botToken|Der Api-Key des Telegram-Bots||
|
||||
|chatId|Die Chat-Id des Empfängers / der Emfänger-Gruppe||
|
||||
|geocoding|Aktivieren des Geocodings|false|
|
||||
|geoRegex|Regex Capture-Group zum Herausfiltern der Adresse||
|
||||
|geoApiProvider|Der Provider für das Geocoding||
|
||||
|geoApiToken|Der Api-Token fuer die Geocoding-Api||
|
||||
|
||||
#### Verfügbare Geocoding Provider
|
||||
|
||||
|Name|Einstellungswert|
|
||||
|----|------------|
|
||||
|Mapbox|mapbox|
|
||||
|Google Maps|google|
|
||||
|chatIds|Liste mit Chat-Ids der Empfängers / der Emfänger-Gruppen||
|
||||
|
||||
**Beispiel:**
|
||||
```yaml
|
||||
|
|
@ -41,19 +23,15 @@ Außerdem unterstützt das Plugin das Versenden von Location über folgende geoc
|
|||
name: Telegram Plugin
|
||||
res: telegram
|
||||
config:
|
||||
botToken: {{ Telegram Bot Token }}
|
||||
chatId: {{ Telegram Chat Id }}
|
||||
geocoding: true
|
||||
geoRegex: ((?:[^ ]*,)*?)
|
||||
geoApiProvider: mapbox
|
||||
geoApiToken: {{ Mapbox Api Key }}
|
||||
botToken: "{{ Telegram Bot Token }}"
|
||||
chatIds:
|
||||
- "{{ Telegram Chat Id }}"
|
||||
```
|
||||
|
||||
---
|
||||
## Abhängigkeiten
|
||||
|
||||
- python-telegram-bot
|
||||
- geocoder
|
||||
|
||||
---
|
||||
## Paket Modifikationen
|
||||
|
|
|
|||
|
|
@ -21,6 +21,7 @@ nav:
|
|||
- Mode Filter: modul/mode_filter.md
|
||||
- Regex Filter: modul/regex_filter.md
|
||||
- Descriptor: modul/descriptor.md
|
||||
- Geocoding: modul/geocoding.md
|
||||
- Plugins:
|
||||
- Telegram: plugin/telegram.md
|
||||
- Entwickler:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue