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

change code to use Dispatch

Browse Source
This commit is contained in:
Marko Oldenburg 2020-01-08 13:26:22 +01:00
parent 98f4cce479
commit 5d24dba71a
2 changed files with 191 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
73_NUKIBridge.pm
View File

@ -2,7 +2,7 @@
# #
# Developed with Kate # Developed with Kate
# #
# (c) 2016-2017 Copyright: Marko Oldenburg (leongaultier at gmail dot com) # (c) 2016-2020 Copyright: Marko Oldenburg (leongaultier at gmail dot com)
# All rights reserved # All rights reserved
# #
# This script is free software; you can redistribute it and/or modify # This script is free software; you can redistribute it and/or modify
@ -46,7 +46,7 @@ use JSON;
use HttpUtils; use HttpUtils;
my $version = "0.6.5"; my $version = "0.7.3";
my $bridgeapi = "1.9"; my $bridgeapi = "1.9";
@ -97,11 +97,11 @@ sub NUKIBridge_CallBlocking($$$);
sub NUKIBridge_Initialize($) { sub NUKIBridge_Initialize($) {
my ($hash) = @_; my ($hash) = @_;
# Provider # Provider
$hash->{ReadFn} = "NUKIBridge_Read"; $hash->{WriteFn} = "NUKIBridge_Call";
$hash->{WriteFn} = "NUKIBridge_Read"; $hash->{Clients} = ':NUKIDevice:';
$hash->{Clients} = ":NUKIDevice:"; $hash->{MatchList} = { '1:NUKIDevice' => '^{"deviceType".*' };
my $webhookFWinstance = join( ",", devspec2array('TYPE=FHEMWEB:FILTER=TEMPORARY!=1') ); my $webhookFWinstance = join( ",", devspec2array('TYPE=FHEMWEB:FILTER=TEMPORARY!=1') );
@ -504,8 +504,8 @@ sub NUKIBridge_Distribution($$$) {
###### Fehler bei Antwort auf Anfrage eines logischen Devices ###### ###### Fehler bei Antwort auf Anfrage eines logischen Devices ######
NUKIDevice_Parse($param->{chash},$param->{code}) if( $param->{code} eq 404 ); # NUKIDevice_Parse($param->{chash},$param->{code}) if( $param->{code} eq 404 );
NUKIDevice_Parse($param->{chash},$param->{code}) if( $param->{code} eq 400 and $hash != $param->{chash} ); # NUKIDevice_Parse($param->{chash},$param->{code}) if( $param->{code} eq 400 and $hash != $param->{chash} );
@ -513,19 +513,6 @@ sub NUKIBridge_Distribution($$$) {
Log3 $name, 4, "NUKIBridge ($name) - nukiId is not known" if( $param->{code} eq 404 ); Log3 $name, 4, "NUKIBridge ($name) - nukiId is not known" if( $param->{code} eq 404 );
Log3 $name, 4, "NUKIBridge ($name) - action is undefined" if( $param->{code} eq 400 and $hash == $param->{chash} ); Log3 $name, 4, "NUKIBridge ($name) - action is undefined" if( $param->{code} eq 400 and $hash == $param->{chash} );
######### Zum testen da ich kein Nuki Smartlock habe ############
#if ( $param->{code} eq 404 ) {
# if( defined($param->{chash}->{helper}{lockAction}) ) {
# Log3 $name, 3, "NUKIBridge ($name) - Test JSON String for lockAction";
# $json = '{"success": true, "batteryCritical": false}';
# } else {
# Log3 $name, 3, "NUKIBridge ($name) - Test JSON String for lockState";
# $json = '{"state": 1, "stateName": "locked", "batteryCritical": false, "success": "true"}';
# }
# NUKIDevice_Parse($param->{chash},$json);
#}
readingsEndUpdate( $hash, 1 ); readingsEndUpdate( $hash, 1 );
return $param->{code}; return $param->{code};
@ -533,16 +520,11 @@ sub NUKIBridge_Distribution($$$) {
if( $hash == $param->{chash} ) { if( $hash == $param->{chash} ) {
# zum testen da ich kein Nuki Smartlock habe
#$json = '[{"nukiId": 1,"name": "Home","lastKnownState": {"state": 1,"stateName": "locked","batteryCritical": false,"timestamp": "2016-10-03T06:49:00+00:00"}},{"nukiId": 2,"name": "Grandma","lastKnownState": {"state": 3,"stateName": "unlocked","batteryCritical": false,"timestamp": "2016-10-03T06:49:00+00:00"}}]' if( $param->{endpoint} eq "list" );
#$json= '{"bridgeType":2,"ids":{"serverId":142667440},"versions":{"appVersion":"0.2.14"},"uptime":1527,"currentTime":"2017-01-17T04:55:58Z","serverConnected":true,"scanResults":[{"nukiId": 1,"name": "Home","rssi": -87,"paired": true},{"nukiId": 2,"name": "Grandma","rssi": -93,"paired": false}]}' if( $param->{endpoint} eq "info" );
NUKIBridge_ResponseProcessing($hash,$json,$param->{endpoint}); NUKIBridge_ResponseProcessing($hash,$json,$param->{endpoint});
} else { } else {
NUKIDevice_Parse($param->{chash},$json); # NUKIDevice_Parse($param->{chash},$json);
} }
readingsEndUpdate( $hash, 1 ); readingsEndUpdate( $hash, 1 );
@ -575,8 +557,45 @@ sub NUKIBridge_ResponseProcessing($$$) {
if( ref($decode_json) eq "ARRAY" and scalar(@{$decode_json}) > 0 and $path eq "list" ) { if( ref($decode_json) eq "ARRAY" and scalar(@{$decode_json}) > 0 and $path eq "list" ) {
NUKIBridge_Autocreate($hash,$decode_json); # NUKIBridge_Autocreate($hash,$decode_json);
NUKIBridge_Call($hash,$hash,"info",undef,undef,undef) if( !IsDisabled($name) );
my @buffer = split( '\[', $json );
my ( $json, $tail ) = NUKIBridge_ParseJSON( $hash, $buffer[1] );
while ($json) {
Log3 $name, 5,
"NUKIBridge ($name) - Decoding JSON message. Length: "
. length($json)
. " Content: "
. $json;
Log3 $name, 5,
"NUKIBridge ($name) - Vor Sub: Laenge JSON: "
. length($json)
. " Content: "
. $json
. " Tail: "
. $tail;
Dispatch( $hash, $json, undef )
unless ( not defined($tail) and not($tail) );
( $json, $tail ) = NUKIBridge_ParseJSON( $hash, $tail );
Log3 $name, 5,
"NUKIBridge ($name) - Nach Sub: Laenge JSON: "
. length($json)
. " Content: "
. $json
. " Tail: "
. $tail;
}
# NUKIBridge_Call($hash,$hash,"info",undef,undef,undef)
# if( !IsDisabled($name) );
} }
elsif( $path eq "info" ) { elsif( $path eq "info" ) {
@ -590,7 +609,8 @@ sub NUKIBridge_ResponseProcessing($$$) {
NUKIBridge_InfoProcessing($hash,$decode_json); NUKIBridge_InfoProcessing($hash,$decode_json);
} else { } else {
Log3 $name, 5, "NUKIBridge ($name) - Rückgabe Path nicht korrekt: $json"; Log3 $name, 5, "NUKIBridge ($name) - Rückgabe Path nicht korrekt:
$json";
return; return;
} }
@ -640,7 +660,8 @@ sub NUKIBridge_CGI() {
$hash->{WEBHOOK_LAST} = TimeNow(); $hash->{WEBHOOK_LAST} = TimeNow();
if ( defined( $modules{NUKIDevice}{defptr} ) ) { if ( defined( $modules{NUKIDevice}{defptr} ) ) {
while ( my ( $key, $value ) = each %{ $modules{NUKIDevice}{defptr} } ) { while ( my ( $key, $value ) = each %{ $modules{NUKIDevice}{defptr} }
) {
$hash = $modules{NUKIDevice}{defptr}{$key}; $hash = $modules{NUKIDevice}{defptr}{$key};
$name = $hash->{NAME}; $name = $hash->{NAME};
@ -648,7 +669,8 @@ sub NUKIBridge_CGI() {
next if ( !$nukiId or $nukiId ne $decode_json->{nukiId} ); next if ( !$nukiId or $nukiId ne $decode_json->{nukiId} );
Log3 $name, 4, "NUKIBridge ($name) - Received webhook for matching NukiId at device $name"; Log3 $name, 4, "NUKIBridge ($name) - Received webhook for
matching NukiId at device $name";
NUKIDevice_Parse($hash,$json); NUKIDevice_Parse($hash,$json);
} }
@ -695,18 +717,21 @@ sub NUKIBridge_Autocreate($$;$) {
my $code = $name ."-".$nukiId; my $code = $name ."-".$nukiId;
if( defined($modules{NUKIDevice}{defptr}{$code}) ) { if( defined($modules{NUKIDevice}{defptr}{$code}) ) {
Log3 $name, 3, "NUKIDevice ($name) - NukiId '$nukiId' already defined as '$modules{NUKIDevice}{defptr}{$code}->{NAME}'"; Log3 $name, 3, "NUKIDevice ($name) - NukiId '$nukiId' already
defined as '$modules{NUKIDevice}{defptr}{$code}->{NAME}'";
next; next;
} }
my $devname = "NUKIDevice" . $nukiId; my $devname = "NUKIDevice" . $nukiId;
my $define= "$devname NUKIDevice $nukiId IODev=$name $nukiType"; my $define= "$devname NUKIDevice $nukiId IODev=$name $nukiType";
Log3 $name, 3, "NUKIDevice ($name) - create new device '$devname' for address '$nukiId'"; Log3 $name, 3, "NUKIDevice ($name) - create new device '$devname' for
address '$nukiId'";
my $cmdret= CommandDefine(undef,$define); my $cmdret= CommandDefine(undef,$define);
if($cmdret) { if($cmdret) {
Log3 $name, 3, "NUKIDevice ($name) - Autocreate: An error occurred while creating device for nukiId '$nukiId': $cmdret"; Log3 $name, 3, "NUKIDevice ($name) - Autocreate: An error occurred
while creating device for nukiId '$nukiId': $cmdret";
} else { } else {
$cmdret= CommandAttr(undef,"$devname alias $nukiName"); $cmdret= CommandAttr(undef,"$devname alias $nukiName");
$cmdret= CommandAttr(undef,"$devname room NUKI"); $cmdret= CommandAttr(undef,"$devname room NUKI");
@ -777,7 +802,7 @@ sub NUKIBridge_InfoProcessing($$) {
Log3 $name, 4, "NUKIDevice ($dname) - Received scanResults for matching NukiID $nukiId at device $dname"; Log3 $name, 4, "NUKIDevice ($dname) - Received scanResults for matching NukiID $nukiId at device $dname";
%response_hash = ('name'=>$scanResults->{name}, 'rssi'=>$scanResults->{rssi},'paired'=>$scanResults->{paired}); %response_hash = ('name'=>$scanResults->{name}, 'rssi'=>$scanResults->{rssi},'paired'=>$scanResults->{paired});
NUKIDevice_Parse($dhash,encode_json \%response_hash); NUKIDevice_Parse($dhash,encode_json \%response_hash);
} }
} }
@ -846,9 +871,11 @@ sub NUKIBridge_getCallbackList($) {
return return
unless ( ref($decode_json) eq 'HASH' ); unless ( ref($decode_json) eq 'HASH' );
Log3 $name, 4, "NUKIBridge ($name) - Callback data is collected and processed"; Log3 $name, 4, "NUKIBridge ($name) - Callback data is collected and
processed";
if( ref($decode_json->{callbacks}) eq "ARRAY" and scalar(@{$decode_json->{callbacks}}) > 0 ) { if( ref($decode_json->{callbacks}) eq "ARRAY" and
scalar(@{$decode_json->{callbacks}}) > 0 ) {
Log3 $name, 4, "NUKIBridge ($name) - created Table with log file"; Log3 $name, 4, "NUKIBridge ($name) - created Table with log file";
my $ret = '<html><table width=100%><tr><td>'; my $ret = '<html><table width=100%><tr><td>';
@ -926,6 +953,59 @@ sub NUKIBridge_CallBlocking($$$) {
return ($decode_json); return ($decode_json);
} }
sub NUKIBridge_ParseJSON($$) {
my ( $hash, $buffer ) = @_;
my $name = $hash->{NAME};
my $open = 0;
my $close = 0;
my $msg = '';
my $tail = '';
if ($buffer) {
foreach my $c ( split //, $buffer ) {
if ( $open == $close and $open > 0 ) {
$tail .= $c;
Log3 $name, 5,
"NUKIBridge ($name) - $open == $close and $open > 0";
}
elsif ( ( $open == $close ) and ( $c ne '{' ) ) {
Log3 $name, 5,
"NUKIBridge ($name) - Garbage character before message: "
. $c;
}
else {
if ( $c eq '{' ) {
$open++;
}
elsif ( $c eq '}' ) {
$close++;
}
$msg .= $c;
}
}
if ( $open != $close ) {
$tail = $msg;
$msg = '';
}
}
Log3 $name, 5,
"NUKIBridge ($name) - return msg: $msg and tail: $tail";
return ( $msg, $tail );
}

115
74_NUKIDevice.pm
View File

@ -33,7 +33,7 @@ use warnings;
use JSON; use JSON;
my $version = "0.6.5"; my $version = "0.7.3";
@ -50,19 +50,31 @@ sub NUKIDevice_Parse($$);
sub NUKIDevice_WriteReadings($$); sub NUKIDevice_WriteReadings($$);
my %deviceTypes = (
0 => 'smartlock',
2 => 'opener'
);
my %deviceTypeIds = reverse(%deviceTypes);
sub NUKIDevice_Initialize($) { sub NUKIDevice_Initialize($) {
my ($hash) = @_; my ($hash) = @_;
$hash->{Match} = '^{"deviceType".*';
$hash->{SetFn} = "NUKIDevice_Set"; $hash->{SetFn} = "NUKIDevice_Set";
$hash->{DefFn} = "NUKIDevice_Define"; $hash->{DefFn} = "NUKIDevice_Define";
$hash->{UndefFn} = "NUKIDevice_Undef"; $hash->{UndefFn} = "NUKIDevice_Undef";
$hash->{AttrFn} = "NUKIDevice_Attr"; $hash->{AttrFn} = "NUKIDevice_Attr";
$hash->{ParseFn} = 'NUKIDevice_Parse';
$hash->{AttrList} = "IODev ". $hash->{AttrList} = "IODev ".
"model:opener,smartlock ".
"disable:1 ". "disable:1 ".
$readingFnAttributes; $readingFnAttributes;
@ -77,65 +89,59 @@ sub NUKIDevice_Initialize($) {
sub NUKIDevice_Define($$) { sub NUKIDevice_Define($$) {
my ( $hash, $def ) = @_; my ( $hash, $def ) = @_;
my @a = split( '[ \t][ \t]*', $def );
my @a = split( "[ \t]+", $def );
splice( @a, 1, 1 );
my $iodev;
my $i = 0;
foreach my $param ( @a ) {
if( $param =~ m/IODev=([^\s]*)/ ) {
$iodev = $1;
splice( @a, $i, 1 );
last;
}
$i++;
}
return "too few parameters: define <name> NUKIDevice <nukiId> <deviceType>" if( @a < 2 ); return "too few parameters: define <name> NUKIDevice <nukiId> <deviceType>" if( @a < 2 );
my ($name,$nukiId,$deviceType) = @a;
my $name = $a[0];
my $nukiId = $a[2];
my $deviceType = (defined $a[3]) ? $a[3] : 0;
$hash->{NUKIID} = $nukiId; $hash->{NUKIID} = $nukiId;
$hash->{DEVICETYPE} = (defined $deviceType) ? $deviceType : 0; $hash->{DEVICETYPE} = (defined $deviceType) ? $deviceType : 0;
$hash->{VERSION} = $version; $hash->{VERSION} = $version;
$hash->{STATE} = 'Initialized'; $hash->{STATE} = 'Initialized';
AssignIoPort($hash,$iodev) if( !$hash->{IODev} );
my $iodev = AttrVal( $name, 'IODev', 'none' );
if(defined($hash->{IODev}->{NAME})) {
AssignIoPort( $hash, $iodev ) if ( !$hash->{IODev} );
Log3 $name, 3, "NUKIDevice ($name) - I/O device is " . $hash->{IODev}->{NAME};
} else { if ( defined( $hash->{IODev}->{NAME} ) ) {
Log3 $name, 3, "NUKIDevice ($name) - I/O device is "
. $hash->{IODev}->{NAME};
}
else {
Log3 $name, 1, "NUKIDevice ($name) - no I/O device"; Log3 $name, 1, "NUKIDevice ($name) - no I/O device";
} }
$iodev = $hash->{IODev}->{NAME}; $iodev = $hash->{IODev}->{NAME};
my $d = $modules{NUKIDevice}{defptr}{$nukiId};
my $code = $hash->{NUKIID};
$code = $iodev ."-". $code if( defined($iodev) );
my $d = $modules{NUKIDevice}{defptr}{$code};
return "NUKIDevice device $hash->{NUKIID} on NUKIBridge $iodev already defined as $d->{NAME}."
if( defined($d)
&& $d->{IODev} == $hash->{IODev}
&& $d->{NAME} ne $name );
$modules{NUKIDevice}{defptr}{$code} = $hash; return
"NUKIDevice device $name on GardenaSmartBridge $iodev already defined."
if ( defined($d)
and $d->{IODev} == $hash->{IODev}
and $d->{NAME} ne $name );
Log3 $name, 3, "NUKIDevice ($name) - defined with Code: $code"; Log3 $name, 3, "NUKIDevice ($name) - defined with NukiId: $nukiId";
Log3 $name, 1, "NUKIDevice ($name) - reading battery a deprecated and will be remove in future"; Log3 $name, 1, "NUKIDevice ($name) - reading battery a deprecated and will be remove in future";
$attr{$name}{room} = "NUKI" if( !defined( $attr{$name}{room} ) ); CommandAttr(undef,$name . ' room NUKI')
if ( AttrVal($name,'room','none') eq 'none');
CommandAttr(undef,$name . ' model ' . $deviceTypes{$deviceType})
if ( AttrVal($name,'model','none') eq 'none');
if( $init_done ) { if( $init_done ) {
InternalTimer( gettimeofday()+int(rand(10)), "NUKIDevice_GetUpdate", $hash, 0 ); InternalTimer( gettimeofday()+int(rand(10)), "NUKIDevice_GetUpdate", $hash, 0 );
} else { } else {
InternalTimer( gettimeofday()+15+int(rand(5)), "NUKIDevice_GetUpdate", $hash, 0 ); InternalTimer( gettimeofday()+15+int(rand(5)), "NUKIDevice_GetUpdate", $hash, 0 );
} }
$modules{NUKIDevice}{defptr}{$nukiId} = $hash;
return undef; return undef;
} }
@ -149,10 +155,8 @@ sub NUKIDevice_Undef($$) {
RemoveInternalTimer($hash); RemoveInternalTimer($hash);
my $code = $hash->{NUKIID}; Log3 $name, 3, "NUKIDevice ($name) - undefined with NukiId: $nukiId";
$code = $hash->{IODev}->{NAME} ."-". $code if( defined($hash->{IODev}->{NAME}) ); delete($modules{NUKIDevice}{defptr}{$nukiId});
Log3 $name, 3, "NUKIDevice ($name) - undefined with Code: $code";
delete($modules{NUKIDevice}{defptr}{$code});
return undef; return undef;
} }
@ -345,10 +349,37 @@ sub NUKIDevice_Parse($$) {
Log3 $name, 2, "NUKIDevice ($name) - got wrong status message for $name: $decode_json"; Log3 $name, 2, "NUKIDevice ($name) - got wrong status message for $name: $decode_json";
return undef; return undef;
} }
elsif ( defined( $decode_json->{nukiId} ) ) {
my $nukiId = $decode_json->{nukiId};
if ( my $hash = $modules{NUKIDevice}{defptr}{$nukiId} ) {
my $name = $hash->{NAME};
WriteReadings( $hash, $decode_json );
Log3 $name, 4,
"NUKIDevice ($name) - find logical device: $hash->{NAME}";
return $hash->{NAME};
}
else {
Log3 $name, 3,
"NUKIDevice ($name) - autocreate new device "
. makeDeviceName( $decode_json->{name} )
. " with nukiId $decode_json->{nukiId}, model $decode_json->{deviceType}";
return
"UNDEFINED "
. makeDeviceName( $decode_json->{name} )
. " NUKIDevice $decode_json->{nukiId} $decode_json->{deviceType}";
}
}
Log3 $name, 5, "NUKIDevice ($name) - parse status message for $name"; Log3 $name, 5, "NUKIDevice ($name) - parse status message for $name";
NUKIDevice_WriteReadings($hash,$decode_json); # NUKIDevice_WriteReadings($hash,$decode_json);
} }
sub NUKIDevice_WriteReadings($$) { sub NUKIDevice_WriteReadings($$) {