revision of the commandref from bridge modul

This commit is contained in:
Marko Oldenburg 2021-12-11 19:10:53 +01:00
parent ae799856fe
commit f919bab524
2 changed files with 30 additions and 12 deletions

View File

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

View File

@ -1,4 +1,4 @@
UPD 2021-12-10_20:47:57 9332 FHEM/73_NUKIBridge.pm UPD 2021-12-11_19:09:00 10331 FHEM/73_NUKIBridge.pm
UPD 2021-12-10_20:47:57 7681 FHEM/74_NUKIDevice.pm UPD 2021-12-10_22:25:04 7681 FHEM/74_NUKIDevice.pm
UPD 2021-12-10_21:46:37 42734 lib/FHEM/Devices/Nuki/Bridge.pm UPD 2021-12-10_22:25:04 42734 lib/FHEM/Devices/Nuki/Bridge.pm
UPD 2021-12-10_21:57:25 16311 lib/FHEM/Devices/Nuki/Device.pm UPD 2021-12-10_22:25:04 16311 lib/FHEM/Devices/Nuki/Device.pm