Plugin nuki

protocol plugin

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

Beschreibung

Unterstützung für ein NUKI Smart-Lock

Anforderungen

  • Minimum SmartHomeNG Version: 1.5b

Konfiguration

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

bridge_api_token

Token für die Authentifizierung mit der API der NUKI Bridge.

  • Datentyp: str

bridge_callback_ip

(optional) IP Adresse, die die Callbacks der NUKI Bridge verarbeitet. Default: Lokale IP Adresse.

  • Datentyp: ip

bridge_callback_port

(optional) Port, über den die Callbacks der NUKI Bridge verarbeitet werden sollen. Default: 8090.

  • Datentyp: int
  • Standardwert: 8090

bridge_ip

IP-Adresse der NUKI Bridge.

  • Datentyp: ip

bridge_port

Portnummer der NUKI Bridge.

  • Datentyp: int

no_wait

(optional) Flag, ob gewartet werden soll, bis die Aktion des Schlosses beendet ist. False kann zu Fehler bei Requests an die NUKI Bridge führen. Default: True

  • Datentyp: bool
  • Standardwert: True

protocol

(optional) Zu verwendendes Protokoll für die Kommunikaton mit der NUKI Bridge. Default: http.

  • Datentyp: str
  • Standardwert: http

Item Attribute

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

nuki_id

Dieses Attribut weist das Item dem jeweiligen NUKI Smart Lock zu. Die nuki_id kann entweder über die REST API der NUKI Bridget (siehe Dokumentation)herausgefunden werden, oder durch Neustart von SmartHomeNG mit dem konfigurierten NUKI Plugin. Der name und die nuki_id werden in das jeweilige Logfile geschrieben.

  • Datentyp: str

nuki_trigger

Es gibt drei Typen von NUKI Triggern, action, state und battery. Ein Item kann nur einen Trigger gleichzeitig haben..

  • Datentyp: str
  • Mögliche Werte:
    • state
    • battery
    • action

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.

Keine

[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.