Plugin ‚telegram‘ Konfiguration

plugin logo

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin telegram konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann. [1]

Es handelt sich bei diesem Plugin um ein web Plugin.

Beschreibung

Anforderungen

  • Minimum SmartHomeNG Version: 1.10

  • Minimum Python Version: 3.6

Konfiguration

Im folgenden ist beschrieben, wie das Plugin telegram konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann.

Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/plugin.yaml konfiguriert werden:

bye_msg

  • Datentyp: str

  • Standardwert: SmartHomeNG Telegram Plugin stops

long_polling_timeout

  • Datentyp: num

  • Standardwert: 120

name

  • Datentyp: str

  • Standardwert: SmartHomeNG Telegram Gateway

no_access_msg

  • Datentyp: str

  • Standardwert: This bot does not know your chat id and thus does not trust it, you are not allowed to use this bot

no_write_access_msg

  • Datentyp: str

  • Standardwert: This bot knows your chat id but you are not allowed to use this bot to write to items

pause_item

  • Datentyp: str

pretty_thread_names

  • Datentyp: bool

  • Standardwert: True

resend_attemps

  • Datentyp: num

  • Standardwert: 10

resend_delay

  • Datentyp: num

  • Standardwert: 60

token

  • Datentyp: str

welcome_msg

  • Datentyp: str

  • Standardwert: SmarthomeNG Telegram Plugin is up and running

Item Attribute

Das Plugin unterstützt folgende Item Attribute, die in den Dateien im Verzeichnis ../items verwendet werden:

telegram_chat_ids

  • Datentyp: foo

telegram_condition

  • Datentyp: str

  • Standardwert: on_update

  • Mögliche Werte:

    • on_update

    • on_change

telegram_control

  • Datentyp: str

telegram_info

  • Datentyp: str

telegram_message

  • Datentyp: str

telegram_message_chat_id

  • Datentyp: num

telegram_text

  • Datentyp: str

telegram_value_match_regex

  • Datentyp: str

Item-Structs

Das Plugin stellt die folgenden Item-Structs zur Verfügung. Diese Informationen sind aus der plugin.yaml entnommen und möglicherweise nicht vollständig.

Keine

Logik Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/logic.yaml konfiguriert werden:

Keine Logik Parameter in den Metadaten beschrieben - Bitte in der README nachsehen (siehe Fußnote)

Plugin Functions

Das Plugin verfügt über folgende öffentliche Funktionen, die z.B. in Logiken aufgerufen werden können.

msg_broadcast(msg, chat_id)

  • Ergebnistyp der Funktion: str

msg

  • Datentyp: str

chat_id

  • Datentyp: int

photo_broadcast(photofile_or_url, caption, chat_id)

  • Ergebnistyp der Funktion: str

photofile_or_url

  • Datentyp: str

caption

  • Datentyp: str

chat_id

  • Datentyp: int