NUKI

NUKI
Zweck / Funktion
	Steuern von Nuki Smartlocks über die Nuki Bridge HW/APP
Allgemein
Typ	Gerätemodul
Details
Dokumentation	EN / DE
Support (Forum)	Sonstige Systeme
Modulname	73_NUKIBridge.pm, 73_NUKIDevice.pm
Ersteller	CoolTux ; (Forum / Wiki)
	Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!

NUKIBridge

NUKIBridge - Steuert das Nuki Smartlock über die Nuki Bridge Das Nuki Bridge Modul verbindet FHEM mit der Nuki Bridge und liest dann alle auf der Bridge verfügbaren Smartlocks ein. Desweiteren werden automatisch die erkannten Smartlocks als eigenständige Devices an gelegt.

Definition

define <name> NUKIBridge <HOST> <API-TOKEN>

Beispiel:

define NBridge1 NUKIBridge 192.168.0.23 F34HK6

Diese Anweisung erstellt ein NUKIBridge Device mit Namen NBridge1 und der IP 192.168.0.23 sowie dem Token F34HK6. Nach dem anlegen des Bridge Devices werden alle zur verfügung stehende Smartlock automatisch in FHEM an gelegt.

Readings

0_nukiId - ID des ersten gefundenen Nuki Smartlocks
0_name - Name des ersten gefunden Nuki Smartlocks
smartlockCount - Anzahl aller gefundenen Smartlock
bridgeAPI - API Version der Bridge
bridgeType - Hardware oder Software/App Bridge
currentTime - aktuelle Zeit auf der Bridge zum zeitpunkt des Info holens
firmwareVersion - aktuell auf der Bridge verwendete Firmwareversion
hardwareId - ID der Hardware Bridge
lastError - gibt die letzte HTTP Errormeldung wieder
serverConnected - true/false gibt an ob die Hardwarebridge Verbindung zur Nuki-Cloude hat.
serverId - gibt die ID des Cloudeservers wieder
uptime - Uptime der Bridge in Sekunden
wifiFirmwareVersion- Firmwareversion des Wifi Modules der Bridge
Die vorangestellte Zahl ist forlaufend und gibt beginnend bei 0 die Eigenschaften Eines Smartlocks wieder.

Set

autocreate - Veranlasst ein erneutes Einlesen aller Smartlocks von der Bridge und falls noch nicht in FHEM vorhanden das autimatische anlegen.
callbackRemove - Löschen einer Callback Instanz auf der Bridge. Die Instanz ID kann mittels get callbackList ermittelt werden
clearLog - löscht das Logfile auf der Bridge
fwUpdate - schaut nach einer neueren Firmware und installiert diese sofern vorhanden
info - holt aktuellen Informationen über die Bridge
reboot - veranlässt ein reboot der Bridge

Get

callbackList - Gibt die Liste der eingetragenen Callback URL's wieder. Die Bridge nimmt maximal 3 auf.
logFile - Zeigt das Logfile der Bridge an

Attribute

disable - deaktiviert die Nuki Bridge

NUKIDevice

NUKIDevice - Steuert das Nuki Smartlock Das Nuki Modul verbindet FHEM über die Nuki Bridge mit einem Nuki Smartlock. Es ist dann möglich das Schloss zu ver- und entriegeln. In der Regel werden die Nuki Devices automatisch durch das Bridgemodul angelegt.

Definition

define <name> NUKIDevice <Nuki-Id> <IODev-Device>

Beispiel:

define Haustür NUKIDevice 1 NBridge1

Diese Anweisung erstellt ein NUKIDevice mit Namen Haustür, der NukiId 1 sowie dem IODev Device NBridge1. Nach dem anlegen des Devices wird automatisch der aktuelle Zustand des Smartlocks aus der Bridge gelesen.

Readings

state - Status des Smartlock bzw. Fehlermeldung von Fehler vorhanden.
lockState - aktueller Schließstatus uncalibrated, locked, unlocked, unlocked (lock ‘n’ go), unlatched, locking, unlocking, unlatching, motor blocked, undefined.
succes - true, false Gibt des Status des letzten Schließbefehles wieder. Geklappt oder nicht geklappt.
batteryCritical - Ist die Batterie in einem kritischen Zustand? true, false
battery - Status der Batterie, ok/low

Set

statusRequest - ruft den aktuellen Status des Smartlocks von der Bridge ab.
lock - verschließen
unlock - aufschließen
unlatch - entriegeln/Falle öffnen.
locknGo - verschließen wenn gegangen
locknGoWithUnlatch - verschließen nach dem die Falle geöffnet wurde.

Attribute

disable - deaktiviert das Nuki Device
webhookFWinstance - zu verwendene Webinstanz für den Callbackaufruf
webhookHttpHostname - IP oder FQDN vom FHEM Server für den Callbackaufruf

Ich sage Danke

Der größte Dank geht an meinen Mentor Andre (justme1968), er hat mir mit hilfreichen Tips geholfen Perlcode zu verstehen und Spaß am programmieren zu haben.

Auch möchte ich mich bei Jens bedanken (jensb) welcher mir ebenfalls mit hilfreichen Tips bei meinen aller ersten Gehversuchen beim Perlcode schreiben unterstützt hat.

So und nun noch ein besonderer Dank an pah (Prof. Dr. Peter Henning ), ohne seine Aussage "Keine Ahnung hatten wir alle mal, das ist keine Ausrede" hätte ich bestimmt nicht angefangen Interesse an Modulentwicklung zu zeigen :-)

Danke an John Doe(fred_feuerstein) der sich um die Übersetzung der Commandref ins Englische gekümmert haben

Und einen richtig großen Dank geht an das Forenmitglied Cobra, welcher mir selbstlos sein Nuki Smartlock samt Bridge zum testen überlassen hat. Damit konnte ein großes Problem gelöst werden