NUKI: Unterschied zwischen den Versionen

Aus FHEMWiki
(Änderung für libjson-perl)
 
(6 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 23: Zeile 23:
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 angelegt.
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 angelegt.


Voraussetzung für ein fehlerfreies Laden ist die Installation von JSON (libperl-json).
Für eine aktive Callback Funktion müssen noch zwei Attribute der Bridge eingerichtet werden:
* webhookFWinstance - zu verwendende Webinstanz (darf keine Passwortabfrage beinhalten)
* webhookHttpHostname - IP oder FQDN des FHEM Servers


Voraussetzung für ein fehlerfreies Laden ist die Installation von JSON (apt-get install libjson-perl).


===Definition===
===Definition===
<code>define <name> NUKIBridge <HOST> <API-TOKEN></code>
:<code>define <name> NUKIBridge <HOST> <API-TOKEN></code>


'''Beispiel:'''
'''Beispiel:'''
:<code>define NBridge1 NUKIBridge 192.168.0.23 F34HK6</code>


<code>define NBridge1 NUKIBridge 192.168.0.23 F34HK6</code>
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 angelegt.
 
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 angelegt.
 


===Readings===
===Readings===
Zeile 51: Zeile 51:
* uptime - Uptime der Bridge in Sekunden
* uptime - Uptime der Bridge in Sekunden
* wifiFirmwareVersion- Firmwareversion des Wifi Modules der Bridge
* wifiFirmwareVersion- Firmwareversion des Wifi Modules der Bridge
* Die vorangestellte Zahl ist forlaufend und gibt beginnend bei 0 die Eigenschaften Eines Smartlocks wieder.
* Die vorangestellte Zahl ist fortlaufend und gibt beginnend bei 0 die Eigenschaften eines Smartlocks wieder.
 


===Set===
===Set===
* autocreate - Veranlasst ein erneutes Einlesen aller Smartlocks von der Bridge und falls noch nicht in FHEM vorhanden das autimatische anlegen.
* <s>autocreate - veranlasst ein erneutes Einlesen aller Smartlocks von der Bridge und falls noch nicht in FHEM vorhanden das automatische Anlegen.</s>
* callbackRemove - Löschen einer Callback Instanz auf der Bridge. Die Instanz ID kann mittels get callbackList ermittelt werden
* 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
* clearLog - löscht das Logfile auf der Bridge
* fwUpdate - schaut nach einer neueren Firmware und installiert diese sofern vorhanden
* fwUpdate - schaut nach einer neueren Firmware und installiert diese, sofern vorhanden
* info - holt aktuellen Informationen über die Bridge
* info - holt aktuelle Informationen über die Bridge
* reboot - veranlässt ein reboot der Bridge
* reboot - veranlasst einen reboot der Bridge
 


===Get===
===Get===
* callbackList - Gibt die Liste der eingetragenen Callback URL's wieder. Die Bridge nimmt maximal 3 auf.
* callbackList - gibt die Liste der eingetragenen Callback URLs wieder. Die Bridge nimmt maximal drei auf
* logFile - Zeigt das Logfile der Bridge an
* logFile - zeigt das Logfile der Bridge an
 


===Attribute===
===Attribute===
* disable - deaktiviert die Nuki Bridge
* disable - deaktiviert die Nuki Bridge


==NUKIDevice==
==NUKIDevice==
NUKIDevice - Steuert das Nuki Smartlock
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.
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.  
In der Regel werden die Nuki Devices automatisch durch das Bridgemodul angelegt.  
 


===Definition===
===Definition===
<code>define <name> NUKIDevice <Nuki-Id> <IODev-Device></code>
:<code>define <name> NUKIDevice <Nuki-Id> <IODev-Device></code>


'''Beispiel:'''
'''Beispiel:'''
 
:<code>define Haustuer NUKIDevice 1 NBridge1</code>
<code>define Haustuer NUKIDevice 1 NBridge1</code>


Diese Anweisung erstellt ein NUKIDevice mit Namen Haustuer, der NukiId 1 sowie dem IODev Device NBridge1. Nach dem Anlegen des Devices wird automatisch der aktuelle Zustand des Smartlocks aus der Bridge gelesen.
Diese Anweisung erstellt ein NUKIDevice mit Namen Haustuer, der NukiId 1 sowie dem IODev Device NBridge1. Nach dem Anlegen des Devices wird automatisch der aktuelle Zustand des Smartlocks aus der Bridge gelesen.
Damit das NUKIDevice auch Statusänderungen mitbekommt, die beispielsweise aus der nativen NUKI-App oder der manuellen Betätigung des Devices herrühren, ist es notwendig die Attribute webhookFWinstance und webhookHttpHostname zu setzen.
Damit das NUKIDevice auch Statusänderungen mitbekommt, die beispielsweise aus der nativen NUKI-App oder der manuellen Betätigung des Devices herrühren, ist es notwendig, die Attribute webhookFWinstance und webhookHttpHostname zu setzen.
 
<code>
attr Haustuer webhookFWinstance WEB (Name der FHEMWEB Instanz)


attr Haustuer webhookHttpHostname 192.168.0.1 (IP/FQDN vom FHEM
:<code>attr Haustuer webhookFWinstance WEB (Name der FHEMWEB Instanz)</code>
Server)
:attr Haustuer webhookHttpHostname 192.168.0.1 (IP/FQDN vom FHEM Server)
</code>


Zum Überprüfen kann die Funktion
Zum Überprüfen kann die Funktion
<code>get NUKIBridge callbackList</code>
:<code>get NUKIBridge callbackList</code>
aufgerufen werden. Es sollte nur ein Callback eingetragen
aufgerufen werden. Es sollte nur ein Callback eingetragen
sein, der in dieser Form hinterlegt sein sollte.
sein, der in dieser Form hinterlegt sein sollte.
0 http://192.168.0.1:8083/fhem/NUKIDevice-123456789
:<code><nowiki>0 http://192.168.0.1:8083/fhem/NUKIDevice-123456789</nowiki></code>


===Readings===
===Readings===
* state - Status des Smartlock bzw. Fehlermeldung von Fehler vorhanden.
* 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.
* 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.
* 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
* batteryCritical - ist die Batterie in einem kritischen Zustand? true, false
* battery - Status der Batterie, ok/low
* battery - Status der Batterie, ok, low




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


===Attribute===
===Attribute===
Zeile 123: Zeile 111:
* webhookFWinstance - zu verwendene Webinstanz für den Callbackaufruf
* webhookFWinstance - zu verwendene Webinstanz für den Callbackaufruf
* webhookHttpHostname - IP oder FQDN vom FHEM Server für den Callbackaufruf
* webhookHttpHostname - IP oder FQDN vom FHEM Server für den Callbackaufruf
== Links ==
* [https://nuki.io/de/ Webseite des Herstellers]
[[Kategorie:Türschlosssteuerung]]

Aktuelle Version vom 20. Januar 2021, 17:28 Uhr

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


NUKIDevice
Zweck / Funktion
Steuern von Nuki Smartlocks über NUKIBridge
Allgemein
Typ Gerätemodul
Details
Dokumentation EN / DE
Support (Forum) Sonstige Systeme
Modulname 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 angelegt.

Für eine aktive Callback Funktion müssen noch zwei Attribute der Bridge eingerichtet werden:

  • webhookFWinstance - zu verwendende Webinstanz (darf keine Passwortabfrage beinhalten)
  • webhookHttpHostname - IP oder FQDN des FHEM Servers

Voraussetzung für ein fehlerfreies Laden ist die Installation von JSON (apt-get install libjson-perl).

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

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 fortlaufend 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 automatische 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 aktuelle Informationen über die Bridge
  • reboot - veranlasst einen reboot der Bridge

Get

  • callbackList - gibt die Liste der eingetragenen Callback URLs wieder. Die Bridge nimmt maximal drei 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 Haustuer NUKIDevice 1 NBridge1

Diese Anweisung erstellt ein NUKIDevice mit Namen Haustuer, der NukiId 1 sowie dem IODev Device NBridge1. Nach dem Anlegen des Devices wird automatisch der aktuelle Zustand des Smartlocks aus der Bridge gelesen. Damit das NUKIDevice auch Statusänderungen mitbekommt, die beispielsweise aus der nativen NUKI-App oder der manuellen Betätigung des Devices herrühren, ist es notwendig, die Attribute webhookFWinstance und webhookHttpHostname zu setzen.

attr Haustuer webhookFWinstance WEB (Name der FHEMWEB Instanz)
attr Haustuer webhookHttpHostname 192.168.0.1 (IP/FQDN vom FHEM Server)

Zum Überprüfen kann die Funktion

get NUKIBridge callbackList

aufgerufen werden. Es sollte nur ein Callback eingetragen sein, der in dieser Form hinterlegt sein sollte.

0 http://192.168.0.1:8083/fhem/NUKIDevice-123456789

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 nachdem 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

Links

Abgerufen von „http://wiki.fhem.de/w/index.php?title=NUKI&oldid=34641“