BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2026-01-20 15:40:24 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

update docs

Browse source
This commit is contained in:
Schrolli91 2020-05-01 23:52:38 +02:00
parent 456efc1116
commit c94938dd3d
No known key found for this signature in database
GPG key ID: 0AE96912A20E9F5F
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docu/docs/plugin/telegram.md
View file

@ -6,7 +6,10 @@ Mit diesem Plugin ist es moeglich, Telegram-Nachrichten für POCSAG-Alarmierunge
Außerdem werden Locations versendet, wenn die Felder `lat` und `lon` im Paket definiert sind. (beispielsweise durch das [Geocoding](../modul/geocoding.md) Modul)
## Unterstütze Alarmtypen
- Fms
- Pocsag
- Zvei
- Msg
## Resource
`telegram`
@ -15,9 +18,12 @@ Außerdem werden Locations versendet, wenn die Felder `lat` und `lon` im Paket d
|Feld|Beschreibung|Default|
|----|------------|-------|
|message|Format der Nachricht||
|botToken|Der Api-Key des Telegram-Bots||
|chatIds|Liste mit Chat-Ids der Empfängers / der Emfänger-Gruppen||
|message_fms|Format der Nachricht für FMS|`{FMS}`|
|message_pocsag|Format der Nachricht für Pocsag|`{RIC}({SRIC})\n{MSG}`|
|message_zvei|Format der Nachricht für ZVEI|`{TONE}`|
|message_msg|Format der Nachricht für MSG||
**Beispiel:**
```yaml
@ -25,7 +31,7 @@ Außerdem werden Locations versendet, wenn die Felder `lat` und `lon` im Paket d
name: Telegram Plugin
res: telegram
config:
message: "{RIC}({SRIC})\n{MSG}"
message_pocsag: "{RIC}({SRIC})\n{MSG}"
botToken: "BOT_TOKEN"
chatIds:
- "CHAT_ID"
@ -33,7 +39,7 @@ Außerdem werden Locations versendet, wenn die Felder `lat` und `lon` im Paket d
---
## Modul Abhängigkeiten
Aus dem Modul [Geocoding](../modul/geocoding.md) (optional):
Aus dem Modul [Geocoding](../modul/geocoding.md) (optional/nur POCSAG):
- `lat`
- `lon`