Plugin prowl

protocol plugin

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

Beschreibung

Prowl Unterstützung

Anforderungen

  • Minimum SmartHomeNG Version: 1.3

Konfiguration

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

apikey

Der Parameter ist optional. Hier kann ein globaler apikey für den Prowl Service definiert werden

  • 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(event= ‚‘, description= ‚‘, priority=None*, url= ‚None*‘, apikey= ‚None*‘, application= ‚SmartHomeNG‘)

Diese Funktion versendet eine eMail - Beispiel: sh.mail(‚admin@smart.home‘, ‚Testmail‘, ‚Mailtext und Betreff können UTF-8 kodierten Text enthalten‘)

  • Ergebnistyp der Funktion: foo

event

Typ des Ereignisses

  • Datentyp: str

description

Beschreibung des Ereignisses

  • Datentyp: str

priority

Es kann eine Priorität (0-2) angegeben werden, um zwischen Ereignissen auf dem Mobile Device zu differenzieren

  • Datentyp: int
  • Standardwert: None*
  • Minimalwert: 0
  • Maximalwert: 2

url

Diese URL wird mit der Notification verbunden

  • Datentyp: str
  • Standardwert: None*

apikey

Hier kann ein individueller apikey angegeben werden

  • Datentyp: str
  • Standardwert: None*

application

Name der sendenden Applikation

  • Datentyp: str
  • Standardwert: SmartHomeNG
[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.