NUKI einbinden

Owned by Christian Fenzl
Last updated: 25.11 2022 by Michael Schlenstedt
10 min read

Es gibt mehrere Möglichkeiten ein Nuki.io Türschloss in Loxone einzubinden:

  • Nuki Web API (funktioniert direkt nur zum Senden, nicht zum Status abfragen, und nur am MS Gen. 2) 

NUKI Smartlock Plugin für LoxBerry (via NUKI Bridge)

Für den LoxBerry gibt es das Nuki Smartlock Plugin, das mittels Callback kein ständiges Pollen des Status erfordert.

Nuki per Nuki Bridge bzw. Android Bridge einbinden

Einrichtung von NUKI und der NUKI Bridge bzw. Android Bridge

Die Bridge bzw. Android Bridge muss mit dem oder den NUKI's eingerichtet und funktionsfähig sein.

In der Android App auf die Bridge klicken und dort die Entwickleroption aktivieren (siehe https://nuki.io/de/hilfe/bridge-de/b-funktionen/bridge-einstellungen-verwalten/). Dahinter verbirgt dich die benötigte IP-Adresse der Bridge und vor allem der TOKEN.

Für die API ist zudem die ID des NUKI Keyturners (bei mehreren NUKI's entsprechend mehrere IDs) erforderlich.



Wenn kein Android-Gerät zur Hand ist kann man auch, um einen Token zu bekommen, folgenden Befehl in einen Browser eingeben:

http://*IP*:8080/auth

Dann beginnt an der Bridge einige Zeit die LED zu leuchten und man muss innerhalb von 30 Sekunden den Knopf der Bridge drücken.
Anschließend bekommt man dann als Antwort im Browser einen Token und kann dann mit dem nachfolgenden Schritt weitermachen. 

Test der Bridge und Abruf der NUKIID

Im Browser eingeben:

http://*IP*:8080/list?token=*TOKEN*

*IP* und *TOKEN* muss natürlich durch deine Werte ersetzt werden.

Sollte der Webbrowser einen Download anbieten, dann die Datei speichern und im Editor öffnen.

Die angegebene NukiId (die Zahl) muss später bei den Aufrufen eingesetzt werden.

Opensource Software Bridge

Speziell auf den Amazon Fire HD Tablets läuft die Android Bridge nicht immer zu 100% stabil. Eine alternative entsteht hier: https://github.com/Gagi2k/nukibridge
Es wird die selbe http API verwendet (keine Änderungen in Loxone, nötig falls im Moment die Android Bridge verwendet wird) und lässt sich auf einem Rpi installieren.

Einrichtung in Loxone

Downloads

Template für Virtual In: VirtualIn_NUKI_Status.zip

Template für Virtual Out: VirtualOut_NUKI_Aktionen.zip

Beispieldatei: NUKI-Integration.Loxone (Überarbeitung der Stati auf APi V1,5)

So bindest du die Templates ein: Templates in Loxone Config einbinden

Darstellung mit der Loxone Config 8.1.11.11 aus (Fehlerausgänge korrekt)



Sind die Templates eingebunden, müssen bei den virtuellen Ein- und Ausgängen sowie Befehlen ausgetauscht werden:

  • *IP* durch die IP-Adresse der NUKI Bridge

  • *TOKEN* durch den Token der NUKI Bridge

  • *NUKIID* durch die ID des jeweiligen Keyturners

Das geht am schnellsten und verlässlichsten mit einem Editor (z.B. Notepad++ mit der Funktion Suchen und Ersetzen → Strg+F)

Tipp Bitte beachtet, welche Anschlüsse der Eingänge an welchen Anschlüssen der Statusbausteine angeschlossen sind. Für die Fehlererkennung werden auch die Fehlerausgänge verwendet!

Die müssen in den Eigenschaften aktiviert werden.

PS: Im Screenshot und Beispielfile beim "Kombinierten Status" habe ich es gleich selbst falsch gemacht - von "success" gehört der Fehlerausgang an I3 angeschlossen. Ich bessere das hier bei Gelegenheit aus.

Hinweis von chrisboehm (Forum): Wenn das Zurücksetzen des Radiotasten-Bausteins nicht funktioniert, dann einen UNGLEICH-Baustein (ungleich "Null") vor dem Verzögerten Impuls verwenden (Negierung am Verzögerten Impuls dann entfernen) .

Wenn dann alles erfolgreich eingerichtet ist, schaut das ganze in der App wie folgt aus.

Allgemeine Tipps und Best Practices

Abfragehäufigkeit 

Laut Jürgen Pansy, CPO NUKI, wird eine Abfrage des Schloss-Zustands über die API an den Keyturner weitergereicht und dort abgefragt (Link). Das regelmäßige Abfragen von Loxone (das sich leider nicht steuern lässt) wird sich vermutlich negativ auf die Batterielebensdauer auswirken. Eventuell das Abfrageintervall (im Beispiel 60 Sekunden) entsprechend höher stellen. Leider erhält man dadurch kein zeitnahes Feedback mehr, ob eine gesendete Aktion erfolgreich war.

Pairing mit der NUKI Android Bridge

Beim Verbindungsaufbau NUKI Keyturner ↔ NUKI Android Bridge machte es den Anschein, dass das Pairen nicht funktioniert, wenn das Android-Gerät nicht am Ladestecker angeschlossen ist. Ein Hinweis dazu wird in der App nicht angezeigt, und ich habe das auch nicht weiter getestet bzw. verfolgt.

WLAN Passwort NUKI Bridge

Die NUKI Bridge kann keine WLAN Passwörter mit Sonderzeichen verarbeiten.

Nuki per Nuki Bridge mit dem /list Aufruf einbinden

Ich habe eine NUKI Hardware Bridge mit zwei NUKIs im Einsatz und habe seit einigen Tagen bei mir von „/lockstate“ auf „/list“ umgestellt. Dazu habe ich die Dokumentation  der Nuki Bridge HTTP API V1.10.0 verwendet.
Vorteil des „/list“ Befehls ist, dass der aktuelle Zustand (geschlossen oder offen) nicht direkt vom NUKI sondern direkt an der NUKI Bridge abgefragt wird (dort sind die Stati zwischengespeichert).
Hauptvorteil: Die Batterien/Akkus der NUKIs werden geschont!
Bei mir ergab ein 60s Polling über „/lockstate“ außerdem oft die Rückmeldung „nicht erreichbar“.

 Die Polling Variante  „/list“ nutze ich jetzt im 10s Intervall um die Zustände (geschlossen oder offen) beider NUKIs abzufragen.

Einrichtung in Loxone

Die Templates von oben, speziell die des Status Bausteins, können weiterhin (angepasst) verwendet werden.

Statusbausteine mit virtuellen Eingangsbefehlen

Konfiguratio "Virtuelle HTTP Eingänge" und "Virtuelle HTTP Eingangs Befehle"

Ihr müsst die Werte Eures "Token" und die IP-Adressen Eurer Geräte natürlich dementsprechend anpassen.
Hier im Beispiel sind diese wie folgt::

TOKEN: X3Xx33XxX3XxxX3X
IP Adresse der NUKI Hardware Bridge: http://192.168.133.2:8080
IP Adresse des NUKIs Garagentüre: http://192.168.133.3:8080 → nukiId=111111111
IP Adresse des NUKIs Haustüre: http://192.168.133.4:8080 → nukiId=222222222




Konfiguration "Virtueller HTTP Eingang" zur Statusabfrage auf der NUKI Hardware Bridge:



Konfiguration des "Virtuellen HTTP Eingangsbefehls" für das erste NUKI Smartlock (hier im Beispiel "Garage"):



                                                            





OPTIONAL: Konfiguration des"Virtuellen HTTP Eingangsbefehls" für ein weiteres NUKI Smartlock (hier im Beispiel "Haustüre"):

                                                                



So funktioniert es zumindest bei mir zuverlässig , Grüße Alexander (16.04.2020)



Nuki mit Node-RED in Loxone einbinden

Anforderungen

  • Node-RED Installation (z.b. auf einem Raspberry Pi)

  • ein Nuki Türschloss - die Bridge wird NICHT benötigt!

  • Bluetooth (z.b. über ein USB Bluetooth Dongle)




Der node-red-contrib-nukible Node muss auf dem Node-RED installiert werden. Dieser Node basiert auf "nukible" - einer Open Source Anbindung  verfügbar unter https://github.com/as19git67/nukible Danach muss man das Pairing durchführen und die Zugangsdaten in Node-RED eingeben - und schon kann man die Tür öffnen, schließen, verriegeln und natürlich auch den Status abfragen. Die Anbindung an Loxone kann man schlussendlich wieder mit dem Loxone Node-RED Node (siehe Installation node-red auf RPi für node-red-contrib-loxone) erstellen.

Durch die Node-RED Anbindung kann man auch elegant zusätzliche elektronische Türschnapper anbinden (siehe Beispiel oben durch den Baustein "Haustüröffner").  Der Türstatus wird nur abgefragt, wenn zwei Bewegungsmelder innerhalb kurzer Zeit beide aktiv waren - so lässt sich die Anzahl der Abfragen reduzieren.

Weitere Informationen zum Node-Red Nuki Node findet man hier: npmjs und node-red-contrib-nukible



Es gibt mehrere Möglichkeiten ein Nuki.io Türschloss in Loxone einzubinden:

  • Nuki Web API (funktioniert direkt nur zum Senden, nicht zum Status abfragen, und nur am MS Gen. 2) 

NUKI Smartlock Plugin für LoxBerry (via NUKI Bridge)

Für den LoxBerry gibt es das Nuki Smartlock Plugin, das mittels Callback kein ständiges Pollen des Status erfordert.

Nuki per Nuki Bridge bzw. Android Bridge einbinden

Einrichtung von NUKI und der NUKI Bridge bzw. Android Bridge

Die Bridge bzw. Android Bridge muss mit dem oder den NUKI's eingerichtet und funktionsfähig sein.

In der Android App auf die Bridge klicken und dort die Entwickleroption aktivieren (siehe https://nuki.io/de/hilfe/bridge-de/b-funktionen/bridge-einstellungen-verwalten/). Dahinter verbirgt dich die benötigte IP-Adresse der Bridge und vor allem der TOKEN.

Für die API ist zudem die ID des NUKI Keyturners (bei mehreren NUKI's entsprechend mehrere IDs) erforderlich.



Wenn kein Android-Gerät zur Hand ist kann man auch, um einen Token zu bekommen, folgenden Befehl in einen Browser eingeben:

http://*IP*:8080/auth

Dann beginnt an der Bridge einige Zeit die LED zu leuchten und man muss innerhalb von 30 Sekunden den Knopf der Bridge drücken.
Anschließend bekommt man dann als Antwort im Browser einen Token und kann dann mit dem nachfolgenden Schritt weitermachen. 

Test der Bridge und Abruf der NUKIID

Im Browser eingeben:

http://*IP*:8080/list?token=*TOKEN*

*IP* und *TOKEN* muss natürlich durch deine Werte ersetzt werden.

Sollte der Webbrowser einen Download anbieten, dann die Datei speichern und im Editor öffnen.

Die angegebene NukiId (die Zahl) muss später bei den Aufrufen eingesetzt werden.

Opensource Software Bridge

Speziell auf den Amazon Fire HD Tablets läuft die Android Bridge nicht immer zu 100% stabil. Eine alternative entsteht hier: https://github.com/Gagi2k/nukibridge
Es wird die selbe http API verwendet (keine Änderungen in Loxone, nötig falls im Moment die Android Bridge verwendet wird) und lässt sich auf einem Rpi installieren.

Einrichtung in Loxone

Downloads

Template für Virtual In: VirtualIn_NUKI_Status.zip

Template für Virtual Out: VirtualOut_NUKI_Aktionen.zip

Beispieldatei: NUKI-Integration.Loxone (Überarbeitung der Stati auf APi V1,5)

So bindest du die Templates ein: Templates in Loxone Config einbinden

Darstellung mit der Loxone Config 8.1.11.11 aus (Fehlerausgänge korrekt)



Sind die Templates eingebunden, müssen bei den virtuellen Ein- und Ausgängen sowie Befehlen ausgetauscht werden:

  • *IP* durch die IP-Adresse der NUKI Bridge

  • *TOKEN* durch den Token der NUKI Bridge

  • *NUKIID* durch die ID des jeweiligen Keyturners

Das geht am schnellsten und verlässlichsten mit einem Editor (z.B. Notepad++ mit der Funktion Suchen und Ersetzen → Strg+F)

Tipp Bitte beachtet, welche Anschlüsse der Eingänge an welchen Anschlüssen der Statusbausteine angeschlossen sind. Für die Fehlererkennung werden auch die Fehlerausgänge verwendet!

Die müssen in den Eigenschaften aktiviert werden.

PS: Im Screenshot und Beispielfile beim "Kombinierten Status" habe ich es gleich selbst falsch gemacht - von "success" gehört der Fehlerausgang an I3 angeschlossen. Ich bessere das hier bei Gelegenheit aus.

Hinweis von chrisboehm (Forum): Wenn das Zurücksetzen des Radiotasten-Bausteins nicht funktioniert, dann einen UNGLEICH-Baustein (ungleich "Null") vor dem Verzögerten Impuls verwenden (Negierung am Verzögerten Impuls dann entfernen) .

Wenn dann alles erfolgreich eingerichtet ist, schaut das ganze in der App wie folgt aus.

Allgemeine Tipps und Best Practices

Abfragehäufigkeit 

Laut Jürgen Pansy, CPO NUKI, wird eine Abfrage des Schloss-Zustands über die API an den Keyturner weitergereicht und dort abgefragt (Link). Das regelmäßige Abfragen von Loxone (das sich leider nicht steuern lässt) wird sich vermutlich negativ auf die Batterielebensdauer auswirken. Eventuell das Abfrageintervall (im Beispiel 60 Sekunden) entsprechend höher stellen. Leider erhält man dadurch kein zeitnahes Feedback mehr, ob eine gesendete Aktion erfolgreich war.

Pairing mit der NUKI Android Bridge

Beim Verbindungsaufbau NUKI Keyturner ↔ NUKI Android Bridge machte es den Anschein, dass das Pairen nicht funktioniert, wenn das Android-Gerät nicht am Ladestecker angeschlossen ist. Ein Hinweis dazu wird in der App nicht angezeigt, und ich habe das auch nicht weiter getestet bzw. verfolgt.

WLAN Passwort NUKI Bridge

Die NUKI Bridge kann keine WLAN Passwörter mit Sonderzeichen verarbeiten.

Nuki per Nuki Bridge mit dem /list Aufruf einbinden

Ich habe eine NUKI Hardware Bridge mit zwei NUKIs im Einsatz und habe seit einigen Tagen bei mir von „/lockstate“ auf „/list“ umgestellt. Dazu habe ich die Dokumentation  der Nuki Bridge HTTP API V1.10.0 verwendet.
Vorteil des „/list“ Befehls ist, dass der aktuelle Zustand (geschlossen oder offen) nicht direkt vom NUKI sondern direkt an der NUKI Bridge abgefragt wird (dort sind die Stati zwischengespeichert).
Hauptvorteil: Die Batterien/Akkus der NUKIs werden geschont!
Bei mir ergab ein 60s Polling über „/lockstate“ außerdem oft die Rückmeldung „nicht erreichbar“.

 Die Polling Variante  „/list“ nutze ich jetzt im 10s Intervall um die Zustände (geschlossen oder offen) beider NUKIs abzufragen.

Einrichtung in Loxone

Die Templates von oben, speziell die des Status Bausteins, können weiterhin (angepasst) verwendet werden.

Statusbausteine mit virtuellen Eingangsbefehlen

Konfiguratio "Virtuelle HTTP Eingänge" und "Virtuelle HTTP Eingangs Befehle"

Ihr müsst die Werte Eures "Token" und die IP-Adressen Eurer Geräte natürlich dementsprechend anpassen.
Hier im Beispiel sind diese wie folgt::

TOKEN: X3Xx33XxX3XxxX3X
IP Adresse der NUKI Hardware Bridge: http://192.168.133.2:8080
IP Adresse des NUKIs Garagentüre: http://192.168.133.3:8080 → nukiId=111111111
IP Adresse des NUKIs Haustüre: http://192.168.133.4:8080 → nukiId=222222222




Konfiguration "Virtueller HTTP Eingang" zur Statusabfrage auf der NUKI Hardware Bridge:



Konfiguration des "Virtuellen HTTP Eingangsbefehls" für das erste NUKI Smartlock (hier im Beispiel "Garage"):



                                                            





OPTIONAL: Konfiguration des"Virtuellen HTTP Eingangsbefehls" für ein weiteres NUKI Smartlock (hier im Beispiel "Haustüre"):

                                                                



So funktioniert es zumindest bei mir zuverlässig , Grüße Alexander (16.04.2020)



Nuki mit Node-RED in Loxone einbinden

Anforderungen

  • Node-RED Installation (z.b. auf einem Raspberry Pi)

  • ein Nuki Türschloss - die Bridge wird NICHT benötigt!

  • Bluetooth (z.b. über ein USB Bluetooth Dongle)




Der node-red-contrib-nukible Node muss auf dem Node-RED installiert werden. Dieser Node basiert auf "nukible" - einer Open Source Anbindung  verfügbar unter https://github.com/as19git67/nukible Danach muss man das Pairing durchführen und die Zugangsdaten in Node-RED eingeben - und schon kann man die Tür öffnen, schließen, verriegeln und natürlich auch den Status abfragen. Die Anbindung an Loxone kann man schlussendlich wieder mit dem Loxone Node-RED Node (siehe Installation node-red auf RPi für node-red-contrib-loxone) erstellen.

Durch die Node-RED Anbindung kann man auch elegant zusätzliche elektronische Türschnapper anbinden (siehe Beispiel oben durch den Baustein "Haustüröffner").  Der Türstatus wird nur abgefragt, wenn zwei Bewegungsmelder innerhalb kurzer Zeit beide aktiv waren - so lässt sich die Anzahl der Abfragen reduzieren.

Weitere Informationen zum Node-Red Nuki Node findet man hier: npmjs und node-red-contrib-nukible