Plugin ‚webpush‘ Konfiguration

plugin logo

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin webpush 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.

ACHTUNG: Dieses Plugin ist als develop gekennzeichnet. Es kann daher sein, dass es noch nicht sämtliche Funktionen unterstützt oder noch fehlerhaft ist.

Beschreibung

Anforderungen

  • Minimum SmartHomeNG Version: 1.8

Konfiguration

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

grouplist

  • Datentyp: list

  • Standardwert: [‚alarm‘, ‚info‘]

varpath

  • Datentyp: str

  • Standardwert: /usr/local/smarthome/var

Item Attribute

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

webpush_communication

  • Datentyp: str

  • Mögliche Werte:

    • fromclient

webpush_config

  • Datentyp: str

  • Mögliche Werte:

    • grouplist

    • publickey

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.

basic

Default Webpush Template

  • basic (foo, Default Webpush Template)
    • config (foo, Config items)

      • grouplist (list, group list item)

      • publickey (str, public key item)

    • comunication (foo, Communication items)

      • fromclient (str, from client item)

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.

sendPushNotification(msg, group, title= ‚‘, url= ‚‘, requireInteraction=, icon= ‚‘, badge= ‚‘, image= ‚‘, silent=False, vibrate=[], ttl=604800, highpriority=True, returnval=True, timestamp=True)

  • Die Funktion liefert kein Ergebnis

msg

  • Datentyp: str

group

  • Datentyp: str

title

  • Datentyp: str

url

  • Datentyp: str

requireInteraction

  • Datentyp: bool

icon

  • Datentyp: str

badge

  • Datentyp: str

image

  • Datentyp: str

silent

  • Datentyp: bool

  • Standardwert: False

vibrate

  • Datentyp: list

  • Standardwert: []

ttl

  • Datentyp: int

  • Standardwert: 604800

highpriority

  • Datentyp: bool

  • Standardwert: True

returnval

  • Datentyp: any

  • Standardwert: True

timestamp

  • Datentyp: bool

  • Standardwert: True