Add Telegram Plugin and Documentation

This commit is contained in:
Jan Speller 2020-02-18 22:12:53 +01:00
parent ab0af5c61d
commit 7b091fabe4
3 changed files with 180 additions and 1 deletions

View file

@ -0,0 +1,66 @@
# <center>Telegram</center>
---
## 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:
- Mapbox
- Google Maps
## 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|
**Beispiel:**
```yaml
- type: plugin
name: Telegram Plugin
res: telegram
config:
botToken: {{ Telegram Bot Token }}
chatId: {{ Telegram Chat Id }}
geocoding: true
geoRegex: ((?:[^ ]*,)*?)
geoApiProvider: mapbox
geoApiToken: {{ Mapbox Api Key }}
```
---
## Abhängigkeiten
- python-telegram-bot
- geocoder
---
## Paket Modifikationen
- keine
---
## Zusätzliche Wildcards
- keine

View file

@ -21,7 +21,8 @@ nav:
- Mode Filter: modul/mode_filter.md
- Regex Filter: modul/regex_filter.md
- Descriptor: modul/descriptor.md
- Plugins: tbd.md
- Plugins:
- Telegram: plugin/telegram.md
- Entwickler:
- Eigenes Modul/Plugin schreiben: develop/ModulPlugin.md
- BOSWatch Alarmpaket Format: develop/packet.md