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

rewrite commandref

Browse Source
This commit is contained in:
Marko Oldenburg
2021-12-16 18:17:33 +01:00
parent f919bab524
commit 247e0fef54
4 changed files with 60 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
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
@ -267,8 +267,8 @@ sub Initialize {
], ],
"release_status": "stable", "release_status": "stable",
"license": "GPL_2", "license": "GPL_2",
"version": "v2.0.0", "version": "v2.0.1",
"x_apiversion": "1.12.3", "x_apiversion": "1.13.0",
"author": [ "author": [
"Marko Oldenburg <leongaultier@gmail.com>" "Marko Oldenburg <leongaultier@gmail.com>"
], ],

88
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,57 @@ 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>
<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>
<br>
</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 +234,7 @@ sub Initialize {
], ],
"release_status": "stable", "release_status": "stable",
"license": "GPL_2", "license": "GPL_2",
"version": "v2.0.0", "version": "v2.0.1",
"author": [ "author": [
"Marko Oldenburg <leongaultier@gmail.com>" "Marko Oldenburg <leongaultier@gmail.com>"
], ],

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