Merge pull request 'patch-expandCommandref' (#24) from patch-expandCommandref into dev
fixe: #7 Reviewed-on: #24
This commit is contained in:
commit
a8970a93e7
@ -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)
|
||||
# All rights reserved
|
||||
@ -93,13 +93,27 @@ sub Initialize {
|
||||
<a name="NUKIBridge"></a>
|
||||
<h3>NUKIBridge</h3>
|
||||
<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>
|
||||
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>
|
||||
<a name="NUKIBridgedefine"></a>
|
||||
<b>Define</b>
|
||||
<ul><br>
|
||||
<b>Define</b><br>
|
||||
There a two ways to define the bridge for use in fhem.<br>
|
||||
<b>first:</b>
|
||||
<ul>
|
||||
<code>define <name> 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 <name> NUKIBridge <HOST> <API-TOKEN></code>
|
||||
<br><br>
|
||||
Example:
|
||||
@ -114,16 +128,18 @@ sub Initialize {
|
||||
<a name="NUKIBridgereadings"></a>
|
||||
<b>Readings</b>
|
||||
<ul>
|
||||
<li>bridgeAPI - API Version of 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>hardwareId - Hardware ID</li>
|
||||
<li>lastError - Last connected error</li>
|
||||
<li>serverConnected - Flag indicating whether or not the bridge is connected to the Nuki server</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>wifiFirmwareVersion- Version of the WiFi modules firmware</li>
|
||||
<li>wlanConnected - wifi connect?</li>
|
||||
<br>
|
||||
The preceding number is continuous, starts with 0 und returns the properties of <b>one</b> Smartlock.
|
||||
</ul>
|
||||
@ -186,16 +202,18 @@ sub Initialize {
|
||||
<a name="NUKIBridgereadings"></a>
|
||||
<b>Readings</b>
|
||||
<ul>
|
||||
<li>bridgeAPI - API Version der 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>hardwareId - ID der Hardware Bridge</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>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>wifiFirmwareVersion- Firmwareversion des Wifi Modules der Bridge</li>
|
||||
<li>wlanConnected - Wlan verbunden?</li>
|
||||
<br>
|
||||
Die vorangestellte Zahl ist forlaufend und gibt beginnend bei 0 die Eigenschaften <b>Eines</b> Smartlocks wieder.
|
||||
</ul>
|
||||
@ -249,8 +267,8 @@ sub Initialize {
|
||||
],
|
||||
"release_status": "stable",
|
||||
"license": "GPL_2",
|
||||
"version": "v2.0.0",
|
||||
"x_apiversion": "1.12.3",
|
||||
"version": "v2.0.2",
|
||||
"x_apiversion": "1.13.0",
|
||||
"author": [
|
||||
"Marko Oldenburg <leongaultier@gmail.com>"
|
||||
],
|
||||
@ -264,7 +282,7 @@ sub Initialize {
|
||||
"runtime": {
|
||||
"requires": {
|
||||
"FHEM": 5.00918799,
|
||||
"perl": 5.016,
|
||||
"perl": 5.024,
|
||||
"Meta": 0,
|
||||
"JSON": 0,
|
||||
"Date::Parse": 0
|
||||
|
||||
@ -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)
|
||||
# All rights reserved
|
||||
@ -79,7 +79,7 @@ sub Initialize {
|
||||
<ul>
|
||||
<u><b>NUKIDevice - Controls the Nuki Smartlock</b></u>
|
||||
<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.
|
||||
<br><br>
|
||||
<a name="NUKIDevicedefine"></a>
|
||||
@ -87,7 +87,7 @@ sub Initialize {
|
||||
<ul><br>
|
||||
<code>define <name> NUKIDevice <Nuki-Id> <IODev-Device> <Device-Type></code>
|
||||
<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>
|
||||
Example:
|
||||
<ul><br>
|
||||
@ -100,35 +100,66 @@ sub Initialize {
|
||||
<br><br>
|
||||
<a name="NUKIDevicereadings"></a>
|
||||
<b>Readings</b>
|
||||
<ul>
|
||||
<li>state - Status of the Smartlock or error message if any error.</li>
|
||||
<li>lockState - current lock status uncalibrated, locked, unlocked, unlocked (lock ‘n’ go), unlatched, locking, unlocking, unlatching, motor blocked, undefined.</li>
|
||||
<li>name - name of the device</li>
|
||||
<li>paired - paired information false/true</li>
|
||||
<li>rssi - value of rssi</li>
|
||||
<li>succes - true, false Returns the status of the last closing command. Ok or not Ok.</li>
|
||||
<li>batteryCritical - Is the battery in a critical state? True, false</li>
|
||||
<li>batteryState - battery status, ok / low</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>
|
||||
<br>Smartlock
|
||||
<ul>
|
||||
<li>batteryCharging - is the battery charging true/false.</li>
|
||||
<li>batteryPercent - current battry state in percent.</li>
|
||||
<li>batteryState - battery state ok/low</li>
|
||||
<li>deviceType - type name of nuki device smartlock/smartlock3/opener</li>
|
||||
<li>firmwareVersion - version of device firmware</li>
|
||||
<li>name - name of the device</li>
|
||||
<li>nukiid - id of the nuki device</li>
|
||||
<li>paired - paired information false/true</li>
|
||||
<li>rssi - value of rssi</li>
|
||||
<li>state - Status of the Smartlock or error message if any error.</li>
|
||||
<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>Opener
|
||||
<ul>
|
||||
<li>batteryState - battery state ok/low</li>
|
||||
<li>deviceType - type name of nuki device smartlock/smartlock3/opener</li>
|
||||
<li>firmwareVersion - version of device firmware</li>
|
||||
<li>mode - Operation mode (door mode/continuous mode)</li>
|
||||
<li>name - name of the device</li>
|
||||
<li>nukiid - id of the nuki device</li>
|
||||
<li>paired - paired information false/true</li>
|
||||
<li>ringactionState - state of ring (0/1)</li>
|
||||
<li>ringactionTimestamp - timestamp of ring</li>
|
||||
<li>rssi - value of rssi</li>
|
||||
<li>state - Status of the Smartlock or error message if any error.</li>
|
||||
<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>
|
||||
|
||||
@ -138,21 +169,21 @@ sub Initialize {
|
||||
<a name="NUKIDevice"></a>
|
||||
<h3>NUKIDevice</h3>
|
||||
<ul>
|
||||
<u><b>NUKIDevice - Steuert das Nuki Smartlock</b></u>
|
||||
<u><b>NUKIDevice - Zur Steuerung von Nuki Geräte</b></u>
|
||||
<br>
|
||||
Das Nuki Modul verbindet FHEM über die Nuki Bridge mit einem Nuki Smartlock oder Nuki Opener. Es ist dann möglich das Schloss zu ver- und entriegeln.<br>
|
||||
In der Regel werden die Nuki Devices automatisch durch das Bridgemodul angelegt.
|
||||
Das Nuki Modul verbindet FHEM über die Nuki Bridge mit einem Nuki Smartlock oder Opener. Nach der Einrichtung können diese Geräte gesteuert werden.<br>
|
||||
Die Nuki Geräte werden automatisch nach dem erstellen der Nuki Bridge in FHEM eingerichtet.
|
||||
<br><br>
|
||||
<a name="NUKIDevicedefine"></a>
|
||||
<b>Define</b>
|
||||
<ul><br>
|
||||
<code>define <name> NUKIDevice <Nuki-Id> <IODev-Device> <Device-Type></code>
|
||||
<br><br>
|
||||
Device-Type ist 0 für das Smartlock und 2 f&üuml;r den Opener.
|
||||
Der Device-Type kann 0/4 für ein Smartlock sein oder 2 für den Opener.
|
||||
<br><br>
|
||||
Beispiel:
|
||||
Example:
|
||||
<ul><br>
|
||||
<code>define Haustür NUKIDevice 1 NBridge1 0</code><br>
|
||||
<code>define Frontdoor NUKIDevice 1 NBridge1 0</code><br>
|
||||
</ul>
|
||||
<br>
|
||||
Diese Anweisung erstellt ein NUKIDevice mit Namen Haustür, der NukiId 1 sowie dem IODev Device NBridge1.<br>
|
||||
@ -161,35 +192,65 @@ sub Initialize {
|
||||
<br><br>
|
||||
<a name="NUKIDevicereadings"></a>
|
||||
<b>Readings</b>
|
||||
<ul>
|
||||
<li>state - Status des Smartlock bzw. Fehlermeldung von Fehler vorhanden.</li>
|
||||
<li>lockState - aktueller Schließstatus uncalibrated, locked, unlocked, unlocked (lock ‘n’ go), unlatched, locking, unlocking, unlatching, motor blocked, undefined.</li>
|
||||
<li>name - Name des Smart Locks</li>
|
||||
<li>paired - pairing Status des Smart Locks</li>
|
||||
<li>rssi - rssi Wert des Smart Locks</li>
|
||||
<li>succes - true, false Gibt des Status des letzten Schließbefehles wieder. Geklappt oder nicht geklappt.</li>
|
||||
<li>batteryCritical - Ist die Batterie in einem kritischen Zustand? true, false</li>
|
||||
<li>batteryState - Status der Batterie, ok/low</li>
|
||||
</ul>
|
||||
<br><br>
|
||||
<a name="NUKIDeviceset"></a>
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<li>statusRequest - ruft den aktuellen Status des Smartlocks von der Bridge ab.</li>
|
||||
<li>lock - verschließen</li>
|
||||
<li>unlock - aufschließen</li>
|
||||
<li>unlatch - entriegeln/Falle öffnen.</li>
|
||||
<li>unpair - entfernt das pairing mit dem Smart Lock</li>
|
||||
<li>locknGo - verschließen wenn gegangen</li>
|
||||
<li>locknGoWithUnlatch - verschließen nach dem die Falle geöffnet wurde.</li>
|
||||
<br>
|
||||
</ul>
|
||||
<br><br>
|
||||
<a name="NUKIDeviceattribut"></a>
|
||||
<b>Attribute</b>
|
||||
<ul>
|
||||
<li>disable - deaktiviert das Nuki Device</li>
|
||||
<br>
|
||||
<br>Smartlock
|
||||
<ul>
|
||||
<li>batteryCharging - wird die Batterie geladen true/false.</li>
|
||||
<li>batteryPercent - aktueller Ladestand der Batterie.</li>
|
||||
<li>batteryState - Staus der Batterie ok/low</li>
|
||||
<li>deviceType - der Typenname des Nuki Gerätes smartlock/smartlock3/opener</li>
|
||||
<li>firmwareVersion - Version der Geräte Firmware</li>
|
||||
<li>name - Name des Nuki Gerätes</li>
|
||||
<li>nukiid - die Geräte Id</li>
|
||||
<li>paired - paired Informationen false/true</li>
|
||||
<li>rssi - Wert für die empfangene Signalstärke</li>
|
||||
<li>state - Status des Smartlock bzw . Fehlermeldung von Fehler vorhanden.</li>
|
||||
<li>succes - true, false. Gibt den Status des letzen Befehls zurück.</li>
|
||||
</ul>
|
||||
<br>Opener
|
||||
<ul>
|
||||
<li>batteryCharging - wird die Batterie geladen true/false.</li>
|
||||
<li>batteryPercent - aktueller Ladestand der Batterie.</li>
|
||||
<li>batteryState - Staus der Batterie ok/low</li>
|
||||
<li>deviceType - der Typenname des Nuki Gerätes smartlock/smartlock3/opener</li>
|
||||
<li>firmwareVersion - Version der Geräte Firmware</li>
|
||||
<li>name - Name des Nuki Gerätes</li>
|
||||
<li>nukiid - die Geräte Id</li>
|
||||
<li>paired - paired Informationen false/true</li>
|
||||
<li>ringactionState - Status der Klingel. Wurde eben geklingelt (0/1)</li>
|
||||
<li>ringactionTimestamp - Zeitstempel des klingelns</li>
|
||||
<li>rssi - Wert f ür die empfangene Signalst ärke</li>
|
||||
<li>state - Status des Opener bzw . Fehlermeldung von Fehler vorhanden.</li>
|
||||
<li>succes - true, false. Gibt den Status des letzen Befehls zurü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ßen</li>
|
||||
<li>unlock - aufschließen</li>
|
||||
<li>unlatch - entriegeln/Falle öffnen.</li>
|
||||
<li>unpair - entfernt das pairing mit dem Smart Lock</li>
|
||||
<li>locknGo - verschließen wenn gegangen</li>
|
||||
<li>locknGoWithUnlatch - verschließen nach dem die Falle geö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üröffner</li>
|
||||
<li>deactivateRto - deaktiviert den ring to open Modus</li>
|
||||
<li>electricStrikeActuation - aktiviert den Türöffner</li>
|
||||
<li>activateContinuousMode - aktiviert dauerhaft öffnen der Tü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>
|
||||
|
||||
@ -212,7 +273,7 @@ sub Initialize {
|
||||
],
|
||||
"release_status": "stable",
|
||||
"license": "GPL_2",
|
||||
"version": "v2.0.0",
|
||||
"version": "v2.0.2",
|
||||
"author": [
|
||||
"Marko Oldenburg <leongaultier@gmail.com>"
|
||||
],
|
||||
@ -226,7 +287,7 @@ sub Initialize {
|
||||
"runtime": {
|
||||
"requires": {
|
||||
"FHEM": 5.00918799,
|
||||
"perl": 5.016,
|
||||
"perl": 5.024,
|
||||
"Meta": 0,
|
||||
"JSON": 0,
|
||||
"Date::Parse": 0
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
UPD 2021-12-10_20:47:57 9332 FHEM/73_NUKIBridge.pm
|
||||
UPD 2021-12-10_20:47:57 7681 FHEM/74_NUKIDevice.pm
|
||||
UPD 2021-12-10_21:46:37 42734 lib/FHEM/Devices/Nuki/Bridge.pm
|
||||
UPD 2021-12-10_21:57:25 16311 lib/FHEM/Devices/Nuki/Device.pm
|
||||
UPD 2021-12-17_11:56:40 10358 FHEM/73_NUKIBridge.pm
|
||||
UPD 2021-12-17_11:56:38 11116 FHEM/74_NUKIDevice.pm
|
||||
UPD 2021-12-11_19:37:43 42761 lib/FHEM/Devices/Nuki/Bridge.pm
|
||||
UPD 2021-12-11_19:37:43 16338 lib/FHEM/Devices/Nuki/Device.pm
|
||||
|
||||
@ -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)
|
||||
# All rights reserved
|
||||
|
||||
@ -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)
|
||||
# All rights reserved
|
||||
|
||||
Loading…
Reference in New Issue
Block a user