Metainformationen zur Seite

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung		Vorhergehende Überarbeitung
plugins:nuki_smartlock:start [2023/01/09 08:33] – V0.4.0 Release Christian Fenzlplugins:nuki_smartlock:start [2023/10/20 17:29] (aktuell) – Struct-Daten geändert Michael Schlenstedt
Zeile 1: Zeile 1:
-====== Nuki Smartlock  ====== +====== Nuki Smartlock ======
  
 ++++ Version History...| ++++ Version History...|
 +
 +**Version 0.5.0 PRE-RELEASE**
 +
 +  * LoxBerry 3.0 Kompatibilität
 +  * Diese Version erfordert zumindest LoxBerry 2.0
 +
 +**Version 0.4.1 RELEASE**
 +
 +  * Limitiert die Installation auf LoxBerry 1.4.x bis LoxBerry 2.x (kann nicht unter LoxBerry 3.0 installiert werden)
 +  * Dies ist die letzte Version, die mit LoxBerry 1.4.x funktioniert (die nächste Version benötigt zumindest LoxBerry 2.0)
  
 **Version 0.4.0 PRE-RELEASE** **Version 0.4.0 PRE-RELEASE**
Zeile 66: Zeile 75:
  
   * erste öffentliche Version   * erste öffentliche Version
-++++ 
- 
  
 +++++
  
 ---- ----
Zeile 76: Zeile 84:
 Direkter Download-Link: Siehe //Tabelle oben// Direkter Download-Link: Siehe //Tabelle oben//
  
-Letzter Entwicklungsstand im Repo: https://github.com/mschlenstedt/LoxBerry-Plugin-Nuki+Letzter Entwicklungsstand im Repo: [[https://github.com/mschlenstedt/LoxBerry-Plugin-Nuki]]
  
 ===== Funktion des Plugins ===== ===== Funktion des Plugins =====
Zeile 83: Zeile 91:
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
 +
 == SecurePIN == == SecurePIN ==
  
 Aus Sicherheitsgründen ist das Webinterface des NUKI Smartlock Plugins mit dem [[haufig_gestellte_fragen_faq:was_ist_der_securepin|SecurePIN]] geschützt. Aus Sicherheitsgründen ist das Webinterface des NUKI Smartlock Plugins mit dem [[haufig_gestellte_fragen_faq:was_ist_der_securepin|SecurePIN]] geschützt.
 +
 </WRAP> </WRAP>
  
 ===== Kompatibilität mit Nuki-Geräten ===== ===== Kompatibilität mit Nuki-Geräten =====
  
-^Gerät                                  ^Kompatibel^ +^ Gerät  ^ Kompatibel ^ 
-|Nuki Smartlock 1.0 mit Bridge          |YES       | +| Nuki Smartlock 1.0 mit Bridge  | YES  | 
-|Nuki Smartlock 2.0 mit Bridge          |YES       | +| Nuki Smartlock 2.0 mit Bridge  | YES  | 
-|Nuki Smartlock 3.0 mit Bridge          |YES       | +| Nuki Smartlock 3.0 mit Bridge  | YES  | 
-|Nuki Smartlock 3.0 PRO (ohne Bridge)   |NO        | +| Nuki Smartlock 3.0 PRO (ohne Bridge)  | NO -> [[#nuki_smartlock_30_pro_ohne_bridge|Native Nuki MQTT Support from ~Q2/2023]]  | 
-|Nuki Smartlock 3.0 PRO (**mit Bridge**)|YES       | +| Nuki Smartlock 3.0 PRO (**mit Bridge**) | YES  | 
-|Nuki Opener                            |YES       | +| Nuki Opener  | YES  | 
-|Nuki Box                               |UNKNOWN   | +| Nuki Box  | UNKNOWN  | 
-|Nuki Smart Door                        |UNKNOWN   |+| Nuki Smart Door  | UNKNOWN  |
  
  
Zeile 108: Zeile 118:
  
 ==== Installieren des MQTT Gateway Plugins ==== ==== Installieren des MQTT Gateway Plugins ====
 +
 +Nicht erforderlich ab LoxBerry 3.0.
  
 Im MQTT Gateway Plugin: Im MQTT Gateway Plugin:
Zeile 119: Zeile 131:
 === NUKI Smartlock Plugin: Bridges suchen === === NUKI Smartlock Plugin: Bridges suchen ===
  
-{{plugins:nuki_smartlock:1236862248.png?w=200}}+{{plugins:nuki_smartlock:1236862248.png?200}}
  
 Auf dem "Bridges" Tab drücke den Button "Search for Bridges" ("Suche nach Bridges"). Es werden der Plugin-Konfiguration automatisch alle Bridges hinzugefügt, die sich in deinem Netzwerk befinden: Auf dem "Bridges" Tab drücke den Button "Search for Bridges" ("Suche nach Bridges"). Es werden der Plugin-Konfiguration automatisch alle Bridges hinzugefügt, die sich in deinem Netzwerk befinden:
  
-{{plugins:nuki_smartlock:1236862249.png?w=600}}+{{plugins:nuki_smartlock:1236862249.png?600}}
  
 Der **Token** ist - wie du siehst - noch unbekannt. Dieser wird für den Zugriff des Plugins auf die Bridge benötigt. Der **Token** ist - wie du siehst - noch unbekannt. Dieser wird für den Zugriff des Plugins auf die Bridge benötigt.
Zeile 131: Zeile 143:
 Dafür musst du ein Pairing durchführen. Dafür wird es gleich notwendig, auf den Knopf der Bridge zu drücken. Dafür musst du ein Pairing durchführen. Dafür wird es gleich notwendig, auf den Knopf der Bridge zu drücken.
  
-Klicke also auf das Pairing-Symbol {{plugins:nuki_smartlock:1236862438.png?w=16}}. Es erscheint ein Fenster mit folgendem Hinweis:+Klicke also auf das Pairing-Symbol {{plugins:nuki_smartlock:1236862438.png?16}}. Es erscheint ein Fenster mit folgendem Hinweis:
  
-{{plugins:nuki_smartlock:1236862250.png?w=250}}+{{plugins:nuki_smartlock:1236862250.png?250}}
  
 Unten steht nun Waiting, und du hast 30 Sekunden Zeit dafür, den Knopf in der Mitte der Bridge zu drücken. Unten steht nun Waiting, und du hast 30 Sekunden Zeit dafür, den Knopf in der Mitte der Bridge zu drücken.
Zeile 139: Zeile 151:
 War das erfolgreich, erscheint der Token in der Bridge-Übersicht. War das erfolgreich, erscheint der Token in der Bridge-Übersicht.
  
-Alternativ ist es möglich, den Token mit der NUKI App auszulesen (siehe NUKI [[https://developer.nuki.io/t/how-to-get-api-key-and-ip-address-calling-url-for-brdige-service/1031/2|Webseite]]) und mit dem Bearbeiten-Symbol {{plugins:nuki_smartlock:1236862439.png?w=16}} manuell einzutragen.+Alternativ ist es möglich, den Token mit der NUKI App auszulesen (siehe NUKI [[https://developer.nuki.io/t/how-to-get-api-key-and-ip-address-calling-url-for-brdige-service/1031/2|Webseite]]) und mit dem Bearbeiten-Symbol {{plugins:nuki_smartlock:1236862439.png?16}} manuell einzutragen.
  
 === Devices suchen === === Devices suchen ===
Zeile 153: Zeile 165:
 Setze ein Topic, unter dem alle NUKI SmartLocks ihre Daten senden. Standard ist ''%%nuki%%''. Setze ein Topic, unter dem alle NUKI SmartLocks ihre Daten senden. Standard ist ''%%nuki%%''.
  
-{{plugins:nuki_smartlock:1236862251.png?w=500}}+{{plugins:nuki_smartlock:1236862251.png?500}}
  
 Wenn auf diesem LoxBerry das MQTT-Gateway Plugin installiert ist, aktiviere die Checkbox "Use MQTT Gateway credentials". Alle weiteren Felder sind dann unerheblich, weil diese Informationen direkt aus der MQTT Gateway Plugin-Konfiguration gelesen werden. Solltest du diese Checkbox nicht sehen, hast du das MQTT Gateway Plugin noch nicht installiert. Wenn auf diesem LoxBerry das MQTT-Gateway Plugin installiert ist, aktiviere die Checkbox "Use MQTT Gateway credentials". Alle weiteren Felder sind dann unerheblich, weil diese Informationen direkt aus der MQTT Gateway Plugin-Konfiguration gelesen werden. Solltest du diese Checkbox nicht sehen, hast du das MQTT Gateway Plugin noch nicht installiert.
Zeile 165: Zeile 177:
 Die Übertragung der Statusänderung erfolgt, sobald der Sperrbefehl vom Smartlock **fertig durchgeführt** ist. Die Übertragung der Statusänderung erfolgt, sobald der Sperrbefehl vom Smartlock **fertig durchgeführt** ist.
  
-{{plugins:nuki_smartlock:1236862252.png?w=500}}+{{plugins:nuki_smartlock:1236862252.png?500}}
  
 Hinweis: Aus eigenen Tests sowie Feedback aus dem Loxforum und NUKI Developer Forum wissen wir, dass es bei der Rückmeldung zu einer Verzögerung von bis zu ca. 20 Sekunden kommen kann. Ursache dafür ist die späte Rückmeldung der NUKI Bridge (Stand: 17.09.2019, Bridge-Firmware 2.2.13). Hinweis: Aus eigenen Tests sowie Feedback aus dem Loxforum und NUKI Developer Forum wissen wir, dass es bei der Rückmeldung zu einer Verzögerung von bis zu ca. 20 Sekunden kommen kann. Ursache dafür ist die späte Rückmeldung der NUKI Bridge (Stand: 17.09.2019, Bridge-Firmware 2.2.13).
Zeile 171: Zeile 183:
 ==== Einrichten von virtuellen Eingängen und Ausgängen mit Templates ==== ==== Einrichten von virtuellen Eingängen und Ausgängen mit Templates ====
  
-Öffne dafür die Devices-Ansicht und klicke das Virtual In / Virtual Out Symbol {{plugins:nuki_smartlock:1236862440.png?w=16}} des Gerätes. +Öffne dafür die Devices-Ansicht und klicke das Virtual In / Virtual Out Symbol {{plugins:nuki_smartlock:1236862440.png?16}} des Gerätes. 
  
-{{plugins:nuki_smartlock:1236862426.png?w=350}}+{{plugins:nuki_smartlock:1236862426.png?350}}
  
 Oben findest du Downloads für Virtuelle Ausgänge und Virtuelle Eingänge. Verwende die Vorlagen-Import-Funktion der Loxone Config, um diese zu importieren ([[https://loxwiki.atlassian.net/wiki/spaces/LOX/pages/1522696312/Templates+in+Loxone+Config+einbinden|Templates in Loxone Config einbinden]]). Oben findest du Downloads für Virtuelle Ausgänge und Virtuelle Eingänge. Verwende die Vorlagen-Import-Funktion der Loxone Config, um diese zu importieren ([[https://loxwiki.atlassian.net/wiki/spaces/LOX/pages/1522696312/Templates+in+Loxone+Config+einbinden|Templates in Loxone Config einbinden]]).
Zeile 192: Zeile 204:
 ==== Darstellung in LoxoneConfig ==== ==== Darstellung in LoxoneConfig ====
  
-{{plugins:nuki_smartlock:1236862550.png?h=250}}+{{plugins:nuki_smartlock:1236862550.png?600}} 
  
 ==== Darstellung in der Loxone App ==== ==== Darstellung in der Loxone App ====
  
-{{plugins:nuki_smartlock:1236862558.png?h=250}}  {{plugins:nuki_smartlock:1236862559.png?h=250}}+{{plugins:nuki_smartlock:1236862558.png?250}}  {{plugins:nuki_smartlock:1236862559.png?250}} 
 + 
 +===== Nuki Smartlock 3.0 PRO ohne Bridge ===== 
 + 
 +Stand 09.01.2023 
 + 
 +Das Nuki Smartlock 3.0 PRO kann aktuell ohne Bridge nicht eingebunden werden (das Pro besitzt keine lokalen Schnittstellen), jedoch läuft derzeit von Nuki eine Closed-Beta Phase für native MQTT-Unterstützung des 3.0 Pro. Es gibt noch keinen Release-Termin, jedoch ist für 2023 der Release geplant. 
 + 
 +Mit der nativen MQTT-Schnittstelle wird das Nuki Smartlock Plugin nicht mehr benötigt, jedoch weiterhin das MQTT Gateway am LoxBerry. Voraussichtlich wird man dann in der Nuki-App die MQTT Server Einstellungen vornehmen. Im MQTT Gateway ist dann nur noch die Subscription einzurichten.
  
 ===== Technische Informationen ===== ===== Technische Informationen =====
Zeile 202: Zeile 223:
 ==== Zurückgelieferte Informationen in den Virtuellen Eingängen ==== ==== Zurückgelieferte Informationen in den Virtuellen Eingängen ====
  
-^Feld               ^Im Input Template^Mögliche Werte                                                                                                                                      ^ +^ Feld  ^ Im Input Template ^ Mögliche Werte  ^ 
-|batteryCritical    |x                |0 → Batterie ok\\ 1 → Batterie kritisch                                                                                                             | +| batteryCritical  | x  | 0 → Batterie ok\\ 1 → Batterie kritisch  | 
-|deviceType         |                 |0 → NUKI Smart Lock\\ 2 → NUKI Opener                                                                                                               | +| deviceType  |   | 0 → NUKI Smart Lock\\ 2 → NUKI Opener  | 
-|doorsensorState    |                 |Türsensor (ab Nuki SmartLock 2.0)\\ 0 → unavailable\\ 1 → deactivated\\ 2 → door closed\\ 3 → door opened\\ 4 → door state unknown\\ 5 → calibrating| +| doorsensorState  |   | Türsensor (ab Nuki SmartLock 2.0)\\ 0 → unavailable\\ 1 → deactivated\\ 2 → door closed\\ 3 → door opened\\ 4 → door state unknown\\ 5 → calibrating | 
-|doorsensorStateName|                 |Türsensor (Text von //doorsensorState//)                                                                                                            | +| doorsensorStateName |   | Türsensor (Text von //doorsensorState//)  | 
-|mode               |x                |Beim Smart Lock immer → 2\\ Beim Opener: 2 → Door Mode 3 → Ring to Open permanently active                                                          | +| mode  | x  | Beim Smart Lock immer → 2\\ Beim Opener: 2 → Door Mode 3 → Ring to Open permanently active  | 
-|nukiId             |x                |The ID of the device                                                                                                                                | +| nukiId  | x  | The ID of the device  | 
-|state              |x                |-1 bis 255 (siehe Tabelle unten)                                                                                                                    | +| state  | x  | -1 bis 255 (siehe Tabelle unten)  | 
-|stateName          |                 |Textbezeichnung des state                                                                                                                           | +| stateName  |   | Textbezeichnung des state  | 
-|sentBy             |x                |Wordurch wurde diese Statusmeldung ausgelöst\\ 1 → Callback\\ 2 → Cronjob\\ 3 → Manuell\\ 254 → Test                                                | +| sentBy  | x  | Wordurch wurde diese Statusmeldung ausgelöst\\ 1 → Callback\\ 2 → Cronjob\\ 3 → Manuell\\ 254 → Test  | 
-|sentByName         |                 |Textuelle Bezeichnung von sentBy                                                                                                                    | +| sentByName  |   | Textuelle Bezeichnung von sentBy   | 
-|sentAtTimeISO      |                 |Zeitstempel im Human Readable Format, wann die Übertragung stattgefunden hat                                                                        | +| sentAtTimeISO  |   | Zeitstempel im Human Readable Format, wann die Übertragung stattgefunden hat  | 
-|sentAtTimeLox      |x                |Loxone Zeitstempel, wann die Übertragung stattgefunden hat (kann in den Loxone Eigenschaften mit <v.u> als Zeit angezeigt werden)                   | +| sentAtTimeLox  | x  | Loxone Zeitstempel, wann die Übertragung stattgefunden hat (kann in den Loxone Eigenschaften mit <v.u> als Zeit angezeigt werden)  |
  
 === State-Tabelle === === State-Tabelle ===
  
-^ID ^smartlock (deviceType 0)                      ^opener (deviceType 2)^ +^ ID ^ smartlock (deviceType 0)  ^ opener (deviceType 2) ^ 
-|-1 |Plugin-Fehler oder Smart Lock nicht erreichbar|                     | +| -1 | Plugin-Fehler oder Smart Lock nicht erreichbar |   | 
-|0  |uncalibrated                                  |untrained            | +| 0  | uncalibrated  | untrained  | 
-|1  |locked                                        |online               | +| 1  | locked  | online  | 
-|2  |unlocking                                     |-                    | +| 2  | unlocking  | -  | 
-|3  |unlocked                                      |rto active           | +| 3  | unlocked  | rto active  | 
-|4  |locking                                       |-                    | +| 4  | locking  | -  | 
-|5  |unlatched                                     |open                 | +| 5  | unlatched  | open  | 
-|6  |unlocked (lock ‘n’ go)                        |-                    | +| 6  | unlocked (lock ‘n’ go)  | -  | 
-|7  |unlatching                                    |opening              | +| 7  | unlatching  | opening  | 
-|253|-                                             |boot run             | +| 253 | -  | boot run  | 
-|254|motor blocked                                 |-                    | +| 254 | motor blocked  | -  | 
-|255|undefined                                     |undefined            | +| 255 | undefined  | undefined  |
  
 Der Status -1 wird vom Plugin bei jeglichen Fehlern gesetzt, die den Zugriff auf die Bridge oder das Smart Lock verhindern. Zum Beispiel Der Status -1 wird vom Plugin bei jeglichen Fehlern gesetzt, die den Zugriff auf die Bridge oder das Smart Lock verhindern. Zum Beispiel
Zeile 265: Zeile 284:
 Die Daten werden dabei in die gleichen Eigenschaften übertragen. Die Daten werden dabei in die gleichen Eigenschaften übertragen.
  
-{{plugins:nuki_smartlock:1236862427.png?w=500}}+{{plugins:nuki_smartlock:1236862427.png?500}}
  
 Die stündliche Aktualisierung ist erkennbar an''%% sentBy=2%%'' bzw. ''%%sentByName=cron%%'', während die Echtzeit-Rückmeldung mit ''%%sentBy=1%%'' bzw. ''%%sentByName=callback%%'' übermittelt wird. Die stündliche Aktualisierung ist erkennbar an''%% sentBy=2%%'' bzw. ''%%sentByName=cron%%'', während die Echtzeit-Rückmeldung mit ''%%sentBy=1%%'' bzw. ''%%sentByName=callback%%'' übermittelt wird.
Zeile 299: Zeile 318:
 ===== Links ===== ===== Links =====
  
-  * Versionen der Bridge Firmware (Release-Versionen): https://developer.nuki.io/t/nuki-bridge-firmware-release-notes-public-releases/2797 +  * Versionen der Bridge Firmware (Release-Versionen): [[https://developer.nuki.io/t/nuki-bridge-firmware-release-notes-public-releases/2797]] 
-  * Versionen der NUKI Smartlock 2.0 Firmware (Release-Versionen): https://developer.nuki.io/t/nuki-smart-lock-2-0-release-notes-public-releases/2685 +  * Versionen der NUKI Smartlock 2.0 Firmware (Release-Versionen): [[https://developer.nuki.io/t/nuki-smart-lock-2-0-release-notes-public-releases/2685]] 
-  * Versionen der NUKI Smartlock 1.0 Firmware (Release-Versionen): https://developer.nuki.io/t/nuki-smart-lock-1-0-release-notes-public-releases/2801 +  * Versionen der NUKI Smartlock 1.0 Firmware (Release-Versionen): [[https://developer.nuki.io/t/nuki-smart-lock-1-0-release-notes-public-releases/2801]] 
-  * Versionen der NUKI Opener Firmware (Release-Versionen): https://developer.nuki.io/t/nuki-opener-release-notes-public-releases/2858+  * Versionen der NUKI Opener Firmware (Release-Versionen): [[https://developer.nuki.io/t/nuki-opener-release-notes-public-releases/2858]]
  
 ===== Fragen stellen und Fehler melden ===== ===== Fragen stellen und Fehler melden =====
  
-Im Loxforum in diesem Thread: https://www.loxforum.com/forum/projektforen/loxberry/plugins/210944-nuki-smartlock-plugin+Im Loxforum in diesem Thread: [[https://www.loxforum.com/forum/projektforen/loxberry/plugins/210944-nuki-smartlock-plugin]] 
  
 ---- struct data ---- ---- struct data ----
Zeile 312: Zeile 332:
 pluginuebersicht.logo : :plugins:nuki_smartlock:1236862126.png pluginuebersicht.logo : :plugins:nuki_smartlock:1236862126.png
 pluginuebersicht.status : STABLE pluginuebersicht.status : STABLE
-pluginuebersicht.version : 0.4.0 +pluginuebersicht.version : 0.5.0 
-pluginuebersicht.min_lb_version : 1.4.2 +pluginuebersicht.min_lb_version : 2.0.0 
-pluginuebersicht.url_release : https://github.com/mschlenstedt/LoxBerry-Plugin-Nuki/archive/0.4.0.zip +pluginuebersicht.url_release : https://github.com/mschlenstedt/LoxBerry-Plugin-Nuki/archive/refs/tags/0.5.0.zip 
-pluginuebersicht.url_prerelease : https://codeload.github.com/mschlenstedt/LoxBerry-Plugin-Nuki/zip/0.4.0+pluginuebersicht.url_prerelease : 
 pluginuebersicht.description : Bindet NUKI-Devices (Smartlock, Opener) über die NUKI-Bridge und MQTT an den Miniserver an. pluginuebersicht.description : Bindet NUKI-Devices (Smartlock, Opener) über die NUKI-Bridge und MQTT an den Miniserver an.
 pluginuebersicht.languages : EN, DE pluginuebersicht.languages : EN, DE