Plugin ‚nuki‘ Konfiguration

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]
Es handelt sich bei diesem Plugin um ein interface Plugin.
Beschreibung
Unterstützung für ein NUKI Smart-Lock
Anforderungen
Minimum SmartHomeNG Version: 1.9.0
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. Nur notwendig, wenn die Bridge verwendet wird.
Datentyp: str
bridge_ip
IP-Adresse der NUKI Bridge. Nur notwendig, wenn die Bridge verwendet wird.
Datentyp: ip
bridge_port
Portnummer der NUKI Bridge. Nur notwendig, wenn die Bridge verwendet wird.
Datentyp: int
mode
(optional) Mode in dem das Plugin laufen soll: 1 - MQTT, 2 - Nuki Bridge, 3 - MQTT und Nuki Bridge
Datentyp: num
Standardwert: 2
Mögliche Werte:
1
2
3
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 vier Typen von NUKI Triggern, welche über die Nuki Bridge API bezogen werden können: action, state, doorstate (nur Nuki 2.0!) und battery. Via MQTT gibt es alternative Typen von NUKI Triggern: mqtt_state, mqtt_mode (der alte doorstate), mqtt_battery_critical, mqtt_mqtt_battery_charge_state und mqtt_action Ein Item kann nur einen Trigger gleichzeitig haben.
Datentyp: str
Mögliche Werte:
state
doorstate
battery
action
mqtt_state
mqtt_battery_critical
mqtt_battery_charge_state
mqtt_mode
mqtt_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