FHEM/mod-NUKI
1
0
Fork 0
Code Issues Pull Requests Releases 3 Wiki Activity

patch-expandCommandref #24

Merged
marko merged 4 commits from patch-expandCommandref into dev 2021-12-17 11:08:50 +00:00
Conversation 0 Commits 4 Files Changed 5 +166 -87
5 changed files with 166 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
FHEM/73_NUKIBridge.pm
View File

@ -1,6 +1,6 @@
############################################################################### ###############################################################################
# #
# Developed with VSCodium # Developed with VSCodium and richterger perl plugin
# #
# (c) 2016-2021 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net) # (c) 2016-2021 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net)
# All rights reserved # All rights reserved
@ -93,13 +93,27 @@ sub Initialize {
<a name="NUKIBridge"></a> <a name="NUKIBridge"></a>
<h3>NUKIBridge</h3> <h3>NUKIBridge</h3>
<ul> <ul>
<u><b>NUKIBridge - controls the Nuki Smartlock over the Nuki Bridge</b></u> <u><b>NUKIBridge - controls Nuki Devices (Smartlock, Opener and so on) over the Nuki Bridge</b></u>
<br> <br>
The Nuki Bridge module connects FHEM to the Nuki Bridge and then reads all the smartlocks available on the bridge. Furthermore, the detected Smartlocks are automatically created as independent devices. The Nuki Bridge module connects FHEM to the Nuki Bridge and then reads all the Nuki devices available on the bridge. Furthermore, the detected Nuki smart devices are automatically created as independent devices.
<br><br> <br><br>
<a name="NUKIBridgedefine"></a> <a name="NUKIBridgedefine"></a>
<b>Define</b> <b>Define</b><br>
<ul><br> There a two ways to define the bridge for use in fhem.<br>
<b>first:</b>
<ul>
<code>define &lt;name&gt; NUKIBridge</code>
<br><br>
Example:
<ul><br>
<code>define NBridge1 NUKIBridge</code><br>
</ul>
<br>
This statement creates a NUKIBridge device and activated the Bridge discovery and API activation. Once a bridge has been discovered on the LAN the API done be activated and the API token retrieved. You has to confirm this request by pressing the button on the bridge.<br>
After the bridge device is setting up, all available Smartlocks are automatically placed in FHEM.
</ul><br>
<b>second:</b>
<ul>
<code>define &lt;name&gt; NUKIBridge &lt;HOST&gt; &lt;API-TOKEN&gt;</code> <code>define &lt;name&gt; NUKIBridge &lt;HOST&gt; &lt;API-TOKEN&gt;</code>
<br><br> <br><br>
Example: Example:
@ -114,16 +128,18 @@ sub Initialize {
<a name="NUKIBridgereadings"></a> <a name="NUKIBridgereadings"></a>
<b>Readings</b> <b>Readings</b>
<ul> <ul>
<li>bridgeAPI - API Version of bridge</li>
<li>bridgeType - Hardware bridge / Software bridge</li> <li>bridgeType - Hardware bridge / Software bridge</li>
<li>currentTime - Current timestamp</li> <li>configAuthSuccess - state of command activat/deactiviate bridge discovery</li>
<li>currentGMTime - Current timestamp</li>
<li>firmwareVersion - Version of the bridge firmware</li> <li>firmwareVersion - Version of the bridge firmware</li>
<li>hardwareId - Hardware ID</li> <li>hardwareId - Hardware ID</li>
<li>lastError - Last connected error</li> <li>lastError - Last connected error</li>
<li>serverConnected - Flag indicating whether or not the bridge is connected to the Nuki server</li> <li>serverConnected - Flag indicating whether or not the bridge is connected to the Nuki server</li>
<li>serverId - Server ID</li> <li>serverId - Server ID</li>
<li>state - state of the bridge device, mostly online</li>
<li>uptime - Uptime of the bridge in seconds</li> <li>uptime - Uptime of the bridge in seconds</li>
<li>wifiFirmwareVersion- Version of the WiFi modules firmware</li> <li>wifiFirmwareVersion- Version of the WiFi modules firmware</li>
<li>wlanConnected - wifi connect?</li>
<br> <br>
The preceding number is continuous, starts with 0 und returns the properties of <b>one</b> Smartlock. The preceding number is continuous, starts with 0 und returns the properties of <b>one</b> Smartlock.
</ul> </ul>
@ -186,16 +202,18 @@ sub Initialize {
<a name="NUKIBridgereadings"></a> <a name="NUKIBridgereadings"></a>
<b>Readings</b> <b>Readings</b>
<ul> <ul>
<li>bridgeAPI - API Version der Bridge</li>
<li>bridgeType - Hardware oder Software/App Bridge</li> <li>bridgeType - Hardware oder Software/App Bridge</li>
<li>currentTime - aktuelle Zeit auf der Bridge zum zeitpunkt des Info holens</li> <li>configAuthSuccess - status des Kommandos zum aktivieren/deaktivieren des bridge discovery</li>
<li>currentGMTime - aktuelle Zeit auf der Bridge zum zeitpunkt des Info holens</li>
<li>firmwareVersion - aktuell auf der Bridge verwendete Firmwareversion</li> <li>firmwareVersion - aktuell auf der Bridge verwendete Firmwareversion</li>
<li>hardwareId - ID der Hardware Bridge</li> <li>hardwareId - ID der Hardware Bridge</li>
<li>lastError - gibt die letzte HTTP Errormeldung wieder</li> <li>lastError - gibt die letzte HTTP Errormeldung wieder</li>
<li>serverConnected - true/false gibt an ob die Hardwarebridge Verbindung zur Nuki-Cloude hat.</li> <li>serverConnected - true/false gibt an ob die Hardwarebridge Verbindung zur Nuki-Cloude hat.</li>
<li>serverId - gibt die ID des Cloudeservers wieder</li> <li>serverId - gibt die ID des Cloudeservers wieder</li>
<li>state - status der bridge zu fhem, zu meist online :-)</li>
<li>uptime - Uptime der Bridge in Sekunden</li> <li>uptime - Uptime der Bridge in Sekunden</li>
<li>wifiFirmwareVersion- Firmwareversion des Wifi Modules der Bridge</li> <li>wifiFirmwareVersion- Firmwareversion des Wifi Modules der Bridge</li>
<li>wlanConnected - Wlan verbunden?</li>
<br> <br>
Die vorangestellte Zahl ist forlaufend und gibt beginnend bei 0 die Eigenschaften <b>Eines</b> Smartlocks wieder. Die vorangestellte Zahl ist forlaufend und gibt beginnend bei 0 die Eigenschaften <b>Eines</b> Smartlocks wieder.
</ul> </ul>
@ -249,8 +267,8 @@ sub Initialize {
], ],
"release_status": "stable", "release_status": "stable",
"license": "GPL_2", "license": "GPL_2",
"version": "v2.0.0", "version": "v2.0.2",
"x_apiversion": "1.12.3", "x_apiversion": "1.13.0",
"author": [ "author": [
"Marko Oldenburg <leongaultier@gmail.com>" "Marko Oldenburg <leongaultier@gmail.com>"
], ],
@ -264,7 +282,7 @@ sub Initialize {
"runtime": { "runtime": {
"requires": { "requires": {
"FHEM": 5.00918799, "FHEM": 5.00918799,
"perl": 5.016, "perl": 5.024,
"Meta": 0, "Meta": 0,
"JSON": 0, "JSON": 0,
"Date::Parse": 0 "Date::Parse": 0

199
FHEM/74_NUKIDevice.pm
View File

@ -1,6 +1,6 @@
############################################################################### ###############################################################################
# #
# Developed with VSCodium # Developed with VSCodium and richterger perl plugin
# #
# (c) 2016-2021 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net) # (c) 2016-2021 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net)
# All rights reserved # All rights reserved
@ -79,7 +79,7 @@ sub Initialize {
<ul> <ul>
<u><b>NUKIDevice - Controls the Nuki Smartlock</b></u> <u><b>NUKIDevice - Controls the Nuki Smartlock</b></u>
<br> <br>
The Nuki module connects FHEM over the Nuki Bridge with a Nuki Smartlock or Nuki Opener. After that, it´s possible to lock and unlock the Smartlock.<br> The Nuki module connects FHEM over the Nuki Bridge with a Nuki Smartlock or Nuki Opener. After that, it´s possible to control your Nuki devices<br>
Normally the Nuki devices are automatically created by the bridge module. Normally the Nuki devices are automatically created by the bridge module.
<br><br> <br><br>
<a name="NUKIDevicedefine"></a> <a name="NUKIDevicedefine"></a>
@ -87,7 +87,7 @@ sub Initialize {
<ul><br> <ul><br>
<code>define &lt;name&gt; NUKIDevice &lt;Nuki-Id&gt; &lt;IODev-Device&gt; &lt;Device-Type&gt;</code> <code>define &lt;name&gt; NUKIDevice &lt;Nuki-Id&gt; &lt;IODev-Device&gt; &lt;Device-Type&gt;</code>
<br><br> <br><br>
Device-Type is 0 for the Smartlock and 2 for the Opener. Device-Type is 0/4 for the Smartlock and 2 for the Opener.
<br><br> <br><br>
Example: Example:
<ul><br> <ul><br>
@ -100,35 +100,66 @@ sub Initialize {
<br><br> <br><br>
<a name="NUKIDevicereadings"></a> <a name="NUKIDevicereadings"></a>
<b>Readings</b> <b>Readings</b>
<ul> <br>Smartlock
<li>state - Status of the Smartlock or error message if any error.</li> <ul>
<li>lockState - current lock status uncalibrated, locked, unlocked, unlocked (lock ‘n’ go), unlatched, locking, unlocking, unlatching, motor blocked, undefined.</li> <li>batteryCharging - is the battery charging true/false.</li>
<li>name - name of the device</li> <li>batteryPercent - current battry state in percent.</li>
<li>paired - paired information false/true</li> <li>batteryState - battery state ok/low</li>
<li>rssi - value of rssi</li> <li>deviceType - type name of nuki device smartlock/smartlock3/opener</li>
<li>succes - true, false Returns the status of the last closing command. Ok or not Ok.</li> <li>firmwareVersion - version of device firmware</li>
<li>batteryCritical - Is the battery in a critical state? True, false</li> <li>name - name of the device</li>
<li>batteryState - battery status, ok / low</li> <li>nukiid - id of the nuki device</li>
</ul> <li>paired - paired information false/true</li>
<br><br> <li>rssi - value of rssi</li>
<a name="NUKIDeviceset"></a> <li>state - Status of the Smartlock or error message if any error.</li>
<b>Set</b> <li>stateName - Status of the Smartlock or error message if any error.</li>
<ul> <li>succes - true, false Returns the status of the last closing command. Ok or not Ok.</li>
<li>statusRequest - retrieves the current state of the smartlock from the bridge.</li> </ul>
<li>lock - lock</li> <br>Opener
<li>unlock - unlock</li> <ul>
<li>unlatch - unlock / open Door</li> <li>batteryState - battery state ok/low</li>
<li>unpair - Removes the pairing with a given Smart Lock</li> <li>deviceType - type name of nuki device smartlock/smartlock3/opener</li>
<li>locknGo - lock when gone</li> <li>firmwareVersion - version of device firmware</li>
<li>locknGoWithUnlatch - lock after the door has been opened</li> <li>mode - Operation mode (door mode/continuous mode)</li>
<br> <li>name - name of the device</li>
</ul> <li>nukiid - id of the nuki device</li>
<br><br> <li>paired - paired information false/true</li>
<a name="NUKIDeviceattribut"></a> <li>ringactionState - state of ring (0/1)</li>
<b>Attributes</b> <li>ringactionTimestamp - timestamp of ring</li>
<ul> <li>rssi - value of rssi</li>
<li>disable - disables the Nuki device</li> <li>state - Status of the Smartlock or error message if any error.</li>
<br> <li>stateName - Status of the Smartlock or error message if any error.</li>
<li>succes - true, false Returns the status of the last closing command. Ok or not Ok.</li>
</ul>
<br><br>
<a name="NUKIDeviceset"></a>
<b>Set</b>
<br>Smartlock
<ul>
<li>statusRequest - retrieves the current state of the smartlock from the bridge.</li>
<li>lock - lock</li>
<li>unlock - unlock</li>
<li>unlatch - unlock / open Door</li>
<li>unpair - Removes the pairing with a given Smart Lock</li>
<li>locknGo - lock when gone</li>
<li>locknGoWithUnlatch - lock after the door has been opened</li>
</ul>
<br>Opener
<ul>
<li>statusRequest - retrieves the current state of the smartlock from the bridge.</li>
<li>activateRto - activate ring to open mode / ringing the bell activates the electric strike actuation </li>
<li>deactivateRto - deactivate ring to open mode</li>
<li>electricStrikeActuation - electric strike actuation</li>
<li>activateContinuousMode - activate Nuki Opener Mode with Ring to Open continuously</li>
<li>deactivateContinuousMode - deactivate Ring to Open continuously</li>
</ul>
<br><br>
<a name="NUKIDeviceattribut"></a>
<b>Attributes</b>
<ul>
<li>disable - disables the Nuki device</li>
<br>
</ul>
</ul> </ul>
</ul> </ul>
@ -138,21 +169,21 @@ sub Initialize {
<a name="NUKIDevice"></a> <a name="NUKIDevice"></a>
<h3>NUKIDevice</h3> <h3>NUKIDevice</h3>
<ul> <ul>
<u><b>NUKIDevice - Steuert das Nuki Smartlock</b></u> <u><b>NUKIDevice - Zur Steuerung von Nuki Ger&auml;te</b></u>
<br> <br>
Das Nuki Modul verbindet FHEM über die Nuki Bridge mit einem Nuki Smartlock oder Nuki Opener. Es ist dann m&ouml;glich das Schloss zu ver- und entriegeln.<br> Das Nuki Modul verbindet FHEM &uuml;ber die Nuki Bridge mit einem Nuki Smartlock oder Opener. Nach der Einrichtung k&ouml;nnen diese Ger&auml;te gesteuert werden.<br>
In der Regel werden die Nuki Devices automatisch durch das Bridgemodul angelegt. Die Nuki Ger&auml;te werden automatisch nach dem erstellen der Nuki Bridge in FHEM eingerichtet.
<br><br> <br><br>
<a name="NUKIDevicedefine"></a> <a name="NUKIDevicedefine"></a>
<b>Define</b> <b>Define</b>
<ul><br> <ul><br>
<code>define &lt;name&gt; NUKIDevice &lt;Nuki-Id&gt; &lt;IODev-Device&gt; &lt;Device-Type&gt;</code> <code>define &lt;name&gt; NUKIDevice &lt;Nuki-Id&gt; &lt;IODev-Device&gt; &lt;Device-Type&gt;</code>
<br><br> <br><br>
Device-Type ist 0 f&uuml;r das Smartlock und 2 f&üuml;r den Opener. Der Device-Type kann 0/4 f&uuml;r ein Smartlock sein oder 2 f&uuml;r den Opener.
<br><br> <br><br>
Beispiel: Example:
<ul><br> <ul><br>
<code>define Haust&uuml;r NUKIDevice 1 NBridge1 0</code><br> <code>define Frontdoor NUKIDevice 1 NBridge1 0</code><br>
</ul> </ul>
<br> <br>
Diese Anweisung erstellt ein NUKIDevice mit Namen Haust&uuml;r, der NukiId 1 sowie dem IODev Device NBridge1.<br> Diese Anweisung erstellt ein NUKIDevice mit Namen Haust&uuml;r, der NukiId 1 sowie dem IODev Device NBridge1.<br>
@ -161,35 +192,65 @@ sub Initialize {
<br><br> <br><br>
<a name="NUKIDevicereadings"></a> <a name="NUKIDevicereadings"></a>
<b>Readings</b> <b>Readings</b>
<ul> <br>Smartlock
<li>state - Status des Smartlock bzw. Fehlermeldung von Fehler vorhanden.</li> <ul>
<li>lockState - aktueller Schlie&szlig;status uncalibrated, locked, unlocked, unlocked (lock ‘n’ go), unlatched, locking, unlocking, unlatching, motor blocked, undefined.</li> <li>batteryCharging - wird die Batterie geladen true/false.</li>
<li>name - Name des Smart Locks</li> <li>batteryPercent - aktueller Ladestand der Batterie.</li>
<li>paired - pairing Status des Smart Locks</li> <li>batteryState - Staus der Batterie ok/low</li>
<li>rssi - rssi Wert des Smart Locks</li> <li>deviceType - der Typenname des Nuki Ger&auml;tes smartlock/smartlock3/opener</li>
<li>succes - true, false Gibt des Status des letzten Schlie&szlig;befehles wieder. Geklappt oder nicht geklappt.</li> <li>firmwareVersion - Version der Ger&auml;te Firmware</li>
<li>batteryCritical - Ist die Batterie in einem kritischen Zustand? true, false</li> <li>name - Name des Nuki Ger&auml;tes</li>
<li>batteryState - Status der Batterie, ok/low</li> <li>nukiid - die Ger&auml;te Id</li>
</ul> <li>paired - paired Informationen false/true</li>
<br><br> <li>rssi - Wert f&uuml;r die empfangene Signalst&auml;rke</li>
<a name="NUKIDeviceset"></a> <li>state - Status des Smartlock bzw . Fehlermeldung von Fehler vorhanden.</li>
<b>Set</b> <li>succes - true, false. Gibt den Status des letzen Befehls zur&uuml;ck.</li>
<ul> </ul>
<li>statusRequest - ruft den aktuellen Status des Smartlocks von der Bridge ab.</li> <br>Opener
<li>lock - verschlie&szlig;en</li> <ul>
<li>unlock - aufschlie&szlig;en</li> <li>batteryCharging - wird die Batterie geladen true/false.</li>
<li>unlatch - entriegeln/Falle &ouml;ffnen.</li> <li>batteryPercent - aktueller Ladestand der Batterie.</li>
<li>unpair - entfernt das pairing mit dem Smart Lock</li> <li>batteryState - Staus der Batterie ok/low</li>
<li>locknGo - verschlie&szlig;en wenn gegangen</li> <li>deviceType - der Typenname des Nuki Ger&auml;tes smartlock/smartlock3/opener</li>
<li>locknGoWithUnlatch - verschlie&szlig;en nach dem die Falle ge&ouml;ffnet wurde.</li> <li>firmwareVersion - Version der Ger&auml;te Firmware</li>
<br> <li>name - Name des Nuki Ger&auml;tes</li>
</ul> <li>nukiid - die Ger&auml;te Id</li>
<br><br> <li>paired - paired Informationen false/true</li>
<a name="NUKIDeviceattribut"></a> <li>ringactionState - Status der Klingel. Wurde eben geklingelt (0/1)</li>
<b>Attribute</b> <li>ringactionTimestamp - Zeitstempel des klingelns</li>
<ul> <li>rssi - Wert f &uuml;r die empfangene Signalst &auml;rke</li>
<li>disable - deaktiviert das Nuki Device</li> <li>state - Status des Opener bzw . Fehlermeldung von Fehler vorhanden.</li>
<br> <li>succes - true, false. Gibt den Status des letzen Befehls zur&uuml;ck.</li>
</ul>
<br><br>
<a name="NUKIDeviceset"></a>
<b>Set</b>
<br>Smartlock
<ul>
<li>statusRequest - ruft den aktuellen Status des Smartlocks von der Bridge ab.</li>
<li>lock - verschlie&szlig;en</li>
<li>unlock - aufschlie&szlig;en</li>
<li>unlatch - entriegeln/Falle &ouml;ffnen.</li>
<li>unpair - entfernt das pairing mit dem Smart Lock</li>
<li>locknGo - verschlie&szlig;en wenn gegangen</li>
<li>locknGoWithUnlatch - verschlie&szlig;en nach dem die Falle ge&ouml;ffnet wurde.</li>
</ul>
<br>Opener
<ul>
<li>statusRequest - ruft den aktuellen Status des Opener von der Bridge ab.</li>
<li>activateRto - aktiviert den ring to open Modus / ein klingeln aktiviert den T&uuml;r&ouml;ffner</li>
<li>deactivateRto - deaktiviert den ring to open Modus</li>
<li>electricStrikeActuation - aktiviert den T&uuml;r&ouml;ffner</li>
<li>activateContinuousMode - aktiviert dauerhaft &ouml;ffnen der T&uuml;r durch klingeln Modus</li>
<li>deactivateContinuousMode - deaktiviert diesen Modus</li>
</ul>
<br><br>
<a name="NUKIDeviceattribut"></a>
<b>Attributes</b>
<ul>
<li>disable - disables the Nuki device</li>
<br>
</ul>
</ul> </ul>
</ul> </ul>
@ -212,7 +273,7 @@ sub Initialize {
], ],
"release_status": "stable", "release_status": "stable",
"license": "GPL_2", "license": "GPL_2",
"version": "v2.0.0", "version": "v2.0.2",
"author": [ "author": [
"Marko Oldenburg <leongaultier@gmail.com>" "Marko Oldenburg <leongaultier@gmail.com>"
], ],
@ -226,7 +287,7 @@ sub Initialize {
"runtime": { "runtime": {
"requires": { "requires": {
"FHEM": 5.00918799, "FHEM": 5.00918799,
"perl": 5.016, "perl": 5.024,
"Meta": 0, "Meta": 0,
"JSON": 0, "JSON": 0,
"Date::Parse": 0 "Date::Parse": 0

8
controls_NukiSmart.txt
View File

@ -1,4 +1,4 @@
UPD 2021-12-10_20:47:57 9332 FHEM/73_NUKIBridge.pm UPD 2021-12-17_11:56:40 10358 FHEM/73_NUKIBridge.pm
UPD 2021-12-10_20:47:57 7681 FHEM/74_NUKIDevice.pm UPD 2021-12-17_11:56:38 11116 FHEM/74_NUKIDevice.pm
UPD 2021-12-10_21:46:37 42734 lib/FHEM/Devices/Nuki/Bridge.pm UPD 2021-12-11_19:37:43 42761 lib/FHEM/Devices/Nuki/Bridge.pm
UPD 2021-12-10_21:57:25 16311 lib/FHEM/Devices/Nuki/Device.pm UPD 2021-12-11_19:37:43 16338 lib/FHEM/Devices/Nuki/Device.pm

2
lib/FHEM/Devices/Nuki/Bridge.pm
View File

@ -1,6 +1,6 @@
############################################################################### ###############################################################################
# #
# Developed with VSCodium # Developed with VSCodium and richterger perl plugin
# #
# (c) 2016-2021 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net) # (c) 2016-2021 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net)
# All rights reserved # All rights reserved

2
lib/FHEM/Devices/Nuki/Device.pm
View File

@ -1,6 +1,6 @@
############################################################################### ###############################################################################
# #
# Developed with VSCodium # Developed with VSCodium and richterger perl plugin
# #
# (c) 2016-2021 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net) # (c) 2016-2021 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net)
# All rights reserved # All rights reserved