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

Merge branch 'master' into devel

Browse Source 
Version mit neuer API beginnen
This commit is contained in:
Marko Oldenburg 2016-10-23 10:35:28 +02:00
commit d7f2d379b0
2 changed files with 98 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
73_NUKIBridge.pm
View File

@ -34,7 +34,7 @@ use JSON;
#use Time::HiRes qw(gettimeofday); #use Time::HiRes qw(gettimeofday);
use HttpUtils; use HttpUtils;
my $version = "0.2.0"; my $version = "0.2.1";
my $bridgeAPI = "1.0.2"; my $bridgeAPI = "1.0.2";
@ -102,7 +102,6 @@ sub NUKIBridge_Define($$) {
$hash->{TOKEN} = $token; $hash->{TOKEN} = $token;
$hash->{INTERVAL} = $interval; $hash->{INTERVAL} = $interval;
$hash->{VERSION} = $version; $hash->{VERSION} = $version;
$hash->{BRIDGEAPI} = $bridgeAPI;
@ -465,6 +464,7 @@ sub NUKIBridge_Autocreate($$;$) {
readingsBulkUpdate( $hash, "smartlockCount", $autocreated ); readingsBulkUpdate( $hash, "smartlockCount", $autocreated );
} }
readingsBulkUpdate( $hash, "bridgeAPI", $bridgeAPI );
readingsEndUpdate( $hash, 1 ); readingsEndUpdate( $hash, 1 );
@ -483,7 +483,7 @@ sub NUKIBridge_Autocreate($$;$) {
=pod =pod
=item device =item device
=item summary =item summary Modul to control the Nuki Smartlock's over the Nuki Bridge.
=item summary_DE Modul zur Steuerung des Nuki Smartlock über die Nuki Bridge. =item summary_DE Modul zur Steuerung des Nuki Smartlock über die Nuki Bridge.
=begin html =begin html
@ -491,7 +491,50 @@ sub NUKIBridge_Autocreate($$;$) {
<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>
<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.
<br><br>
<a name="NUKIBridgedefine"></a>
<b>Define</b>
<ul><br>
<code>define &lt;name&gt; NUKIBridge &lt;HOST&gt; &lt;API-TOKEN&gt;</code>
<br><br>
Example:
<ul><br>
<code>define NBridge1 NUKIBridge 192.168.0.23 F34HK6</code><br>
</ul>
<br>
This statement creates a NUKIBridge device with the name NBridge1 and the IP 192.168.0.23 as well as the token F34HK6.<br>
After the bridge device is created, all available Smartlocks are automatically placed in FHEM.
</ul>
<br><br>
<a name="NUKIBridgereadings"></a>
<b>Readings</b>
<ul>
<li>0_nukiId - ID of the first found Nuki Smartlock</li>
<li>0_name - Name of the first found Nuki Smartlock</li>
<li>smartlockCount - number of all found Smartlocks</li>
<li>bridgeAPI - API Version of bridge</li>
<br>
The preceding number is continuous, starts with 0 und returns the properties of <b>one</b> Smartlock.
</ul>
<br><br>
<a name="NUKIBridgeset"></a>
<b>Set</b>
<ul>
<li>autocreate - Prompts to re-read all Smartlocks from the bridge and if not already present in FHEM, create the autimatic.</li>
<li>statusRequest - starts a checkAlive of the bridge, it is determined whether the bridge is still online</li>
<br>
</ul>
<br><br>
<a name="NUKIBridgeattribut"></a>
<b>Attributes</b>
<ul>
<li>disable - disables the Nuki Bridge</li>
<li>interval - changes the interval for the CheckAlive</li>
<br>
</ul>
</ul> </ul>
=end html =end html
@ -524,6 +567,7 @@ sub NUKIBridge_Autocreate($$;$) {
<li>0_nukiId - ID des ersten gefundenen Nuki Smartlocks</li> <li>0_nukiId - ID des ersten gefundenen Nuki Smartlocks</li>
<li>0_name - Name des ersten gefunden Nuki Smartlocks</li> <li>0_name - Name des ersten gefunden Nuki Smartlocks</li>
<li>smartlockCount - Anzahl aller gefundenen Smartlock</li> <li>smartlockCount - Anzahl aller gefundenen Smartlock</li>
<li>bridgeAPI - API Version der Bridge</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>

53
74_NUKIDevice.pm
View File

@ -33,7 +33,7 @@ use warnings;
use JSON; use JSON;
#use Time::HiRes qw(gettimeofday); #use Time::HiRes qw(gettimeofday);
my $version = "0.2.0"; my $version = "0.2.1";
@ -383,7 +383,7 @@ sub NUKIDevice_Parse($$) {
=pod =pod
=item device =item device
=item summary =item summary Modul to control the Nuki Smartlock's
=item summary_DE Modul zur Steuerung des Nuki Smartlocks. =item summary_DE Modul zur Steuerung des Nuki Smartlocks.
=begin html =begin html
@ -391,7 +391,54 @@ sub NUKIDevice_Parse($$) {
<a name="NUKIDevice"></a> <a name="NUKIDevice"></a>
<h3>NUKIDevice</h3> <h3>NUKIDevice</h3>
<ul> <ul>
<u><b>NUKIDevice - Controls the Nuki Smartlock</b></u>
<br>
The Nuki module connects FHEM over the Nuki Bridge with a Nuki Smartlock. After that, it´s possible to lock and unlock the Smartlock.<br>
Normally the Nuki devices are automatically created by the bridge module.
<br><br>
<a name="NUKIDevicedefine"></a>
<b>Define</b>
<ul><br>
<code>define &lt;name&gt; NUKIDevice &lt;Nuki-Id&gt; &lt;IODev-Device&gt;</code>
<br><br>
Example:
<ul><br>
<code>define Frontdoor NUKIDevice 1 NBridge1</code><br>
</ul>
<br>
This statement creates a NUKIDevice with the name Frontdoor, the NukiId 1 and the IODev device NBridge1.<br>
After the device has been created, the current state of the Smartlock is automatically read from the bridge.
</ul>
<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>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>battery - 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>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>
<li>interval - changes the interval for the statusRequest</li>
<br>
</ul>
</ul> </ul>
=end html =end html