Plugin slack

protocol plugin

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

Beschreibung

Slack messaging Dienst

Anforderungen

  • Minimum SmartHomeNG Version: 1.4

Konfiguration

Im folgenden ist beschrieben, wie das Plugin slack 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:

instance

Eindeutiger Identifier für die Instanz des Plugins. Kann bei nur einer konfigurierten Instanz des Plugins entfallen.

  • Datentyp: str

token

Slack-Token für den API-Zugriff auf einen oder mehrere Kanäle in einem Slack-Workspace

  • Datentyp: str

Item Attribute

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

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.

notify(channel, text, color= ‚normal‘)

Absetzen einer Messaging-Nachricht an den Slack Workspace

  • Ergebnistyp der Funktion: foo

channel

Slack-Kanal, in den gepostet wird

  • Datentyp: str

text

Text der Nachricht

  • Datentyp: str

color

Typ der Nachricht (=Farbe)

  • Datentyp: str
  • Standardwert: normal
  • Mögliche Werte:
    • normal
    • good
    • warning
    • danger
[1]Diese Seite wurde aus den Metadaten des Plugins erzeugt. Für den Fall, dass diese Seite nicht alle benötigten Informationen enthält, bitte auf die englischsprachige README Datei des Plugins zugreifen.