mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2026-04-05 14:25:45 +00:00
Add Telegram Plugin and Documentation
This commit is contained in:
parent
ab0af5c61d
commit
7b091fabe4
3 changed files with 180 additions and 1 deletions
66
docu/docs/plugin/telegram.md
Normal file
66
docu/docs/plugin/telegram.md
Normal 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
|
||||
Loading…
Add table
Add a link
Reference in a new issue