mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2026-04-05 22:35:43 +00:00
enh(telegram): parse_mode Unterstützung hinzugefügt
- Internationalisierung der Kommentare - parse_mode hinzugefügt (für Formatierungsmöglichkeiten) mit Auswahlmöglichkeit "HTML" und "MarkdownV2" - Ergänzung in Dokumentation - kleinere Korrekturen in Dokumentation - Dokumentation um die Möglichkeit von Block-Strings (|) ergänzt (Danke sm7tix für den Input!)
This commit is contained in:
parent
524efbb0aa
commit
c5015f2160
2 changed files with 52 additions and 34 deletions
|
|
@ -2,16 +2,16 @@
|
|||
---
|
||||
|
||||
## Beschreibung
|
||||
Mit diesem Plugin ist es moeglich, Telegram-Nachrichten für POCSAG-Alarmierungen zu senden.
|
||||
Außerdem werden Locations versendet, wenn die Felder `lat` und `lon` im Paket definiert sind. (beispielsweise durch das [Geocoding](../modul/geocoding.md) Modul)
|
||||
Dieses Plugin ermöglicht das Versenden von Telegram-Nachrichten für verschiedene Alarmierungsarten.
|
||||
Wenn im eingehenden Paket die Felder `lat` und `lon` vorhanden sind (z. B. durch das [Geocoding](../modul/geocoding.md) Modul), wird zusätzlich automatisch der Standort als Telegram-Location gesendet.
|
||||
|
||||
Die abarbeitung der Alarmierungen erfolgt per Queue nach den Limits der Telegram API, damit keine Nachrichten verloren gehen, diese Funktion kann mit dem ```queue``` Parameter deaktiviert werden.
|
||||
Das Senden der Nachrichten erfolgt über eine interne Queue mit Retry-Logik und exponentiellem Backoff, um die Vorgaben der Telegram API einzuhalten und Nachrichtenverluste zu verhindern. Die Retry-Parameter (max_retries, initial_delay, max_delay) können in der Konfiguration angepasst werden.
|
||||
|
||||
## Unterstütze Alarmtypen
|
||||
- Fms
|
||||
- Pocsag
|
||||
- Zvei
|
||||
- Msg
|
||||
- FMS
|
||||
- POCSAG
|
||||
- ZVEI
|
||||
- MSG
|
||||
|
||||
## Resource
|
||||
`telegram`
|
||||
|
|
@ -20,16 +20,17 @@ Die abarbeitung der Alarmierungen erfolgt per Queue nach den Limits der Telegram
|
|||
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|botToken|Der Api-Key des Telegram-Bots||
|
||||
|chatIds|Liste mit Chat-Ids der Empfängers / der Emfänger-Gruppen||
|
||||
|startup_message|Nachricht, dass das Telegram-Plugin erfolgreich geladen wurde|leer|
|
||||
|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||
|
||||
|max_retries|Anzahl der Versuche, bis das Senden abgebrochen wird|5|
|
||||
|initial_delay|Verzögerung des zweiten Sendeversuchs|2 [Sek.]|
|
||||
|max_delay|Maximale Verzögerung|60 [Sek.]|
|
||||
|botToken|Der Api-Key des Telegram-Bots|-|
|
||||
|chatIds|Liste mit Chat-Ids der Empfängers / der Empfänger-Gruppen|-|
|
||||
|startup_message|Nachricht beim erfolgreichen Initialisieren des Plugins|leer|
|
||||
|message_fms|Formatvorlage für FMS-Alarm|`{FMS}`|
|
||||
|message_pocsag|Formatvorlage für POCSAG|`{RIC}({SRIC})\n{MSG}`|
|
||||
|message_zvei|Formatvorlage für ZVEI|`{TONE}`|
|
||||
|message_msg|Formatvorlage für MSG-Nachricht|-|
|
||||
|max_retries|Anzahl Wiederholungsversuche bei Fehlern|5|
|
||||
|initial_delay|Initiale Wartezeit bei Wiederholungsversuchen|2 [Sek.]|
|
||||
|max_delay|Maximale Retry-Verzögerung|300 [Sek.]|
|
||||
|parse_mode|Formatierung ("HTML" oder "MarkdownV2"), Case-sensitive!|leer|
|
||||
|
||||
**Beispiel:**
|
||||
```yaml
|
||||
|
|
@ -37,20 +38,32 @@ Die abarbeitung der Alarmierungen erfolgt per Queue nach den Limits der Telegram
|
|||
name: Telegram Plugin
|
||||
res: telegram
|
||||
config:
|
||||
message_pocsag: "{RIC}({SRIC})\n{MSG}"
|
||||
message_pocsag: |
|
||||
<b>POCSAG Alarm:</b>
|
||||
RIC: <b>{RIC}</b> ({SRIC})
|
||||
{MSG}
|
||||
parse_mode: "HTML"
|
||||
startup_message: "Server up and running!"
|
||||
botToken: "BOT_TOKEN"
|
||||
chatIds:
|
||||
- "CHAT_ID"
|
||||
```
|
||||
|
||||
Hinweis:
|
||||
Über parse_mode kannst du Telegram-Formatierungen verwenden:
|
||||
|
||||
- HTML: `<b>fett</b>`, `<i>kursiv</i>`, `<u>unterstrichen</u>`, `<s>durchgestrichen</s>`, ...
|
||||
- MarkdownV2: `**fett**`, `__unterstrichen__`, `_italic \*text_` usw. (Escape-Regeln beachten)
|
||||
|
||||
Block-Strings (|) eignen sich perfekt für mehrzeilige Nachrichten und vermeiden Escape-Zeichen wie \n
|
||||
|
||||
---
|
||||
## Modul Abhängigkeiten
|
||||
Aus dem Modul [Geocoding](../modul/geocoding.md) (optional/nur POCSAG):
|
||||
OPTIONAL, nur für POCSAG-Locationversand: Aus dem Modul [Geocoding](../modul/geocoding.md):
|
||||
|
||||
- `lat`
|
||||
- `lon`
|
||||
|
||||
---
|
||||
## Externe Abhängigkeiten
|
||||
- python-telegram-bot
|
||||
keine
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue