2
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-04-24 02:59:22 +00:00

74_XiaomiFlowerSens.pm: new version, change internal routine

git-svn-id: https://svn.fhem.de/fhem/trunk@15316 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
LeonGaultier 2017-10-25 04:14:51 +00:00
parent a94b8704ae
commit 4023a444e7
2 changed files with 452 additions and 346 deletions

View File

@ -1,5 +1,6 @@
# Add changes at the top of the list. Keep it in ASCII, and 80-char wide.
# Do not insert empty lines here, update check depends on it.
- update: 74_74_XiaomiFlowerMonitor: new version, change internal routine
- feature: fhemweb_iconRadio.js: optionally colorize selected icons instead
of its background by prefix use4icon@
- feature: fhemweb_iconButtons.js: optionally colorize selected icons instead

View File

@ -26,6 +26,17 @@
###############################################################################
#$cmd = "qx(gatttool -i $hci -b $mac --char-write-req -a 0x33 -n A01F";
#$cmd = "qx(gatttool -i $hci -b $mac --char-read -a 0x35"; # Sensor Daten
#$cmd = "qx(gatttool -i $hci -b $mac --char-read -a 0x38"; # Firmware und Batterie
# e8 00 00 58 0f 00 00 34 f1 02 02 3c 00 fb 34 9b
package main;
use strict;
@ -36,7 +47,14 @@ use JSON;
use Blocking;
my $version = "1.0.3";
my $version = "1.2.0";
my %CallBatteryFirmwareAge = ( '8h' => 28800,
'16h' => 57600,
'24h' => 86400,
'32h' => 115200,
'40h' => 144000,
'48h' => 172800
);
@ -49,13 +67,25 @@ sub XiaomiFlowerSens_Attr(@);
sub XiaomiFlowerSens_stateRequest($);
sub XiaomiFlowerSens_stateRequestTimer($);
sub XiaomiFlowerSens_Set($$@);
sub XiaomiFlowerSens_Run($);
sub XiaomiFlowerSens_BlockingRun($);
sub XiaomiFlowerSens_callGatttool($@);
sub XiaomiFlowerSens_forRun_encodeJSON($$);
sub XiaomiFlowerSens_forDone_encodeJSON($$$$$$);
sub XiaomiFlowerSens_BlockingDone($);
sub XiaomiFlowerSens_BlockingAborted($);
sub XiaomiFlowerSens_Get($$@);
sub XiaomiFlowerSens_Notify($$);
sub XiaomiFlowerSens_CallBatteryFirmware($);
sub XiaomiFlowerSens_CallSensData($);
sub XiaomiFlowerSens_WriteSensData($);
sub XiaomiFlowerSens_ExecGatttool_Run($);
sub XiaomiFlowerSens_ExecGatttool_Done($);
sub XiaomiFlowerSens_ExecGatttool_Aborted($);
sub XiaomiFlowerSens_ProcessingNotification($@);
sub XiaomiFlowerSens_WriteReadings($$);
sub XiaomiFlowerSens_ProcessingErrors($$);
sub XiaomiFlowerSens_CallBatteryFirmware_IsUpdateTimeAgeToOld($$);
sub XiaomiFlowerSens_CallBatteryFirmware_Timestamp($);
sub XiaomiFlowerSens_CallBatteryFirmware_UpdateTimeAge($);
sub XiaomiFlowerSens_encodeJSON($);
sub XiaomiFlowerSens_Handle0x35($$);
sub XiaomiFlowerSens_Handle0x38($$);
@ -65,13 +95,16 @@ sub XiaomiFlowerSens_Initialize($) {
my ($hash) = @_;
$hash->{SetFn} = "XiaomiFlowerSens_Set";
$hash->{GetFn} = "XiaomiFlowerSens_Get";
$hash->{DefFn} = "XiaomiFlowerSens_Define";
$hash->{NotifyFn} = "XiaomiFlowerSens_Notify";
$hash->{UndefFn} = "XiaomiFlowerSens_Undef";
$hash->{AttrFn} = "XiaomiFlowerSens_Attr";
$hash->{AttrList} = "interval ".
"disable:1 ".
"disabledForIntervals ".
"hciDevice:hci0,hci1,hci2 ".
"batteryFirmwareAge:8h,16h,24h,32h,40h,48h ".
"minFertility ".
"maxFertility ".
"minTemp ".
@ -99,27 +132,19 @@ sub XiaomiFlowerSens_Define($$) {
return "too few parameters: define <name> XiaomiFlowerSens <BTMAC>" if( @a != 3 );
my $name = $a[0];
my $mac = $a[2];
my $name = $a[0];
my $mac = $a[2];
$hash->{BTMAC} = $mac;
$hash->{VERSION} = $version;
$hash->{INTERVAL} = 300;
$hash->{BTMAC} = $mac;
$hash->{VERSION} = $version;
$hash->{INTERVAL} = 300;
$hash->{helper}{CallSensDataCounter} = 0;
$hash->{NOTIFYDEV} = "global";
$modules{XiaomiFlowerSens}{defptr}{$hash->{BTMAC}} = $hash;
readingsSingleUpdate ($hash,"state","initialized", 0);
readingsSingleUpdate($hash,"state","initialized", 0);
$attr{$name}{room} = "FlowerSens" if( !defined($attr{$name}{room}) );
RemoveInternalTimer($hash);
if( $init_done ) {
XiaomiFlowerSens_stateRequestTimer($hash);
} else {
InternalTimer( gettimeofday()+int(rand(30))+15, "XiaomiFlowerSens_stateRequestTimer", $hash, 0 );
}
Log3 $name, 3, "XiaomiFlowerSens ($name) - defined with BTMAC $hash->{BTMAC}";
$modules{XiaomiFlowerSens}{defptr}{$hash->{BTMAC}} = $hash;
@ -146,18 +171,16 @@ sub XiaomiFlowerSens_Attr(@) {
my ( $cmd, $name, $attrName, $attrVal ) = @_;
my $hash = $defs{$name};
my $orig = $attrVal;
if( $attrName eq "disable" ) {
if( $cmd eq "set" and $attrVal eq "1" ) {
RemoveInternalTimer($hash);
readingsSingleUpdate ( $hash, "state", "disabled", 1 );
Log3 $name, 3, "XiaomiFlowerSens ($name) - disabled";
}
elsif( $cmd eq "del" ) {
readingsSingleUpdate ( $hash, "state", "active", 1 );
Log3 $name, 3, "XiaomiFlowerSens ($name) - enabled";
}
}
@ -167,65 +190,104 @@ sub XiaomiFlowerSens_Attr(@) {
return "check disabledForIntervals Syntax HH:MM-HH:MM or 'HH:MM-HH:MM HH:MM-HH:MM ...'"
unless($attrVal =~ /^((\d{2}:\d{2})-(\d{2}:\d{2})\s?)+$/);
Log3 $name, 3, "XiaomiFlowerSens ($name) - disabledForIntervals";
readingsSingleUpdate ( $hash, "state", "Unknown", 1 );
readingsSingleUpdate ( $hash, "state", "disabled", 1 );
}
elsif( $cmd eq "del" ) {
readingsSingleUpdate ( $hash, "state", "active", 1 );
Log3 $name, 3, "XiaomiFlowerSens ($name) - enabled";
readingsSingleUpdate ( $hash, "state", "active", 1 );
}
}
if( $attrName eq "interval" ) {
if( $cmd eq "set" ) {
if( $attrVal < 300 ) {
Log3 $name, 3, "XiaomiFlowerSens ($name) - interval too small, please use something >= 300 (sec), default is 3600 (sec)";
return "interval too small, please use something >= 300 (sec), default is 3600 (sec)";
} else {
$hash->{INTERVAL} = $attrVal;
Log3 $name, 3, "XiaomiFlowerSens ($name) - set interval to $attrVal";
}
}
elsif( $cmd eq "del" ) {
$hash->{INTERVAL} = 300;
Log3 $name, 3, "XiaomiFlowerSens ($name) - set interval to default";
if( $cmd eq "set" ) {
if( $attrVal < 300 ) {
Log3 $name, 3, "XiaomiFlowerSens ($name) - interval too small, please use something >= 300 (sec), default is 3600 (sec)";
return "interval too small, please use something >= 300 (sec), default is 3600 (sec)";
} else {
$hash->{INTERVAL} = $attrVal;
Log3 $name, 3, "XiaomiFlowerSens ($name) - set interval to $attrVal";
}
}
elsif( $cmd eq "del" ) {
$hash->{INTERVAL} = 300;
Log3 $name, 3, "XiaomiFlowerSens ($name) - set interval to default";
}
}
return undef;
}
sub XiaomiFlowerSens_Notify($$) {
my ($hash,$dev) = @_;
my $name = $hash->{NAME};
return if (IsDisabled($name));
my $devname = $dev->{NAME};
my $devtype = $dev->{TYPE};
my $events = deviceEvents($dev,1);
return if (!$events);
XiaomiFlowerSens_stateRequestTimer($hash) if( grep /^INITIALIZED$/,@{$events}
or grep /^DELETEATTR.$name.disable$/,@{$events}
or (grep /^DEFINED.$name$/,@{$events} and $init_done) );
return;
}
sub XiaomiFlowerSens_stateRequest($) {
my ($hash) = @_;
my $name = $hash->{NAME};
my %readings;
if( !IsDisabled($name) ) {
readingsSingleUpdate ( $hash, "state", "active", 1 ) if( (ReadingsVal($name, "state", 0) eq "initialized" or ReadingsVal($name, "state", 0) eq "unreachable" or ReadingsVal($name, "state", 0) eq "corrupted data" or ReadingsVal($name, "state", 0) eq "disabled" or ReadingsVal($name, "state", 0) eq "Unknown" or ReadingsVal($name, "state", 0) eq "charWrite faild") );
if( ReadingsVal($name,'firmware','none') ne 'none') {
return XiaomiFlowerSens_CallBatteryFirmware($hash)
if( XiaomiFlowerSens_CallBatteryFirmware_IsUpdateTimeAgeToOld($hash,$CallBatteryFirmwareAge{AttrVal($name,'BatteryFirmwareAge','24h')}) );
if( ReadingsVal($name, 'firmware', '') eq '2.6.2') {
XiaomiFlowerSens_CallSensData($hash);
} else {
if( $hash->{helper}{CallSensDataCounter} < 1 ) {
XiaomiFlowerSens_WriteSensData($hash);
$hash->{helper}{CallSensDataCounter} = $hash->{helper}{CallSensDataCounter} + 1;
} else {
$readings{'lastGattError'} = 'charWrite faild';
XiaomiFlowerSens_WriteReadings($hash,\%readings);
$hash->{helper}{CallSensDataCounter} = 0;
return;
}
}
} else {
XiaomiFlowerSens_Run($hash);
XiaomiFlowerSens_CallBatteryFirmware($hash);
}
readingsSingleUpdate($hash,"state","fetch sensor data",1);
} else {
readingsSingleUpdate ( $hash, "state", "disabled", 1 );
readingsSingleUpdate($hash,"state","disabled",1);
}
}
sub XiaomiFlowerSens_stateRequestTimer($) {
my ($hash) = @_;
my $name = $hash->{NAME};
if( !IsDisabled($name) ) {
readingsSingleUpdate ( $hash, "state", "active", 1 ) if( (ReadingsVal($name, "state", 0) eq "initialized" or ReadingsVal($name, "state", 0) eq "unreachable" or ReadingsVal($name, "state", 0) eq "corrupted data" or ReadingsVal($name, "state", 0) eq "disabled" or ReadingsVal($name, "state", 0) eq "Unknown" or ReadingsVal($name, "state", 0) eq "charWrite faild") );
if( $init_done and not IsDisabled($name) ) {
XiaomiFlowerSens_Run($hash);
XiaomiFlowerSens_stateRequest($hash);
} else {
readingsSingleUpdate ( $hash, "state", "disabled", 1 );
@ -233,7 +295,46 @@ sub XiaomiFlowerSens_stateRequestTimer($) {
InternalTimer( gettimeofday()+$hash->{INTERVAL}+int(rand(300)), "XiaomiFlowerSens_stateRequestTimer", $hash, 1 );
Log3 $name, 5, "Sub XiaomiFlowerSens_stateRequestTimer ($name) - Request Timer wird aufgerufen";
Log3 $name, 4, "XiaomiFlowerSens ($name) - stateRequestTimer: Call Request Timer";
}
sub XiaomiFlowerSens_CallBatteryFirmware($) {
my $hash = shift;
my $name = $hash->{NAME};
my $mac = $hash->{BTMAC};
$hash->{helper}{RUNNING_PID} = BlockingCall("XiaomiFlowerSens_ExecGatttool_Run", $name."|".$mac."|read|0x38", "XiaomiFlowerSens_ExecGatttool_Done", 60, "XiaomiFlowerSens_ExecGatttool_Aborted", $hash) unless(exists($hash->{helper}{RUNNING_PID}));
Log3 $name, 4, "XiaomiFlowerSens ($name) - CallBatteryFirmware: call function ExecGatttool_Run";
}
sub XiaomiFlowerSens_CallSensData($) {
my $hash = shift;
my $name = $hash->{NAME};
my $mac = $hash->{BTMAC};
$hash->{helper}{RUNNING_PID} = BlockingCall("XiaomiFlowerSens_ExecGatttool_Run", $name."|".$mac."|read|0x35", "XiaomiFlowerSens_ExecGatttool_Done", 60, "XiaomiFlowerSens_ExecGatttool_Aborted", $hash) unless(exists($hash->{helper}{RUNNING_PID}));
Log3 $name, 4, "XiaomiFlowerSens ($name) - CallSensData: call function ExecGatttool_Run";
}
sub XiaomiFlowerSens_WriteSensData($) {
my $hash = shift;
my $name = $hash->{NAME};
my $mac = $hash->{BTMAC};
$hash->{helper}{RUNNING_PID} = BlockingCall("XiaomiFlowerSens_ExecGatttool_Run", $name."|".$mac."|write|0x33|A01F", "XiaomiFlowerSens_ExecGatttool_Done", 60, "XiaomiFlowerSens_ExecGatttool_Aborted", $hash) unless(exists($hash->{helper}{RUNNING_PID}));
Log3 $name, 4, "XiaomiFlowerSens ($name) - WriteSensData: call function ExecGatttool_Run";
}
sub XiaomiFlowerSens_Set($$@) {
@ -242,351 +343,342 @@ sub XiaomiFlowerSens_Set($$@) {
my ($cmd, @args) = @aa;
if( $cmd eq 'clearFirmwareReading' ) {
return "usage: clearFirmwareReading" if( @args != 0 );
readingsSingleUpdate($hash,'firmware','',0);
} else {
my $list = "clearFirmwareReading:noArg";
return "Unknown argument $cmd, choose one of $list";
}
return undef;
}
sub XiaomiFlowerSens_Get($$@) {
my ($hash, $name, @aa) = @_;
my ($cmd, @args) = @aa;
if( $cmd eq 'statusRequest' ) {
return "usage: statusRequest" if( @args != 0 );
XiaomiFlowerSens_stateRequest($hash);
} elsif( $cmd eq 'clearFirmwareReading' ) {
return "usage: clearFirmwareReading" if( @args != 0 );
readingsSingleUpdate($hash,'firmware','',0);
} else {
my $list = "statusRequest:noArg clearFirmwareReading:noArg";
my $list = "statusRequest:noArg";
return "Unknown argument $cmd, choose one of $list";
}
return undef;
}
sub XiaomiFlowerSens_Run($) {
sub XiaomiFlowerSens_ExecGatttool_Run($) {
my ( $hash, $cmd ) = @_;
my $string = shift;
my $name = $hash->{NAME};
my $mac = $hash->{BTMAC};
my $wfr;
if( ReadingsVal($name, 'firmware', '') eq "2.6.2" ) {
$wfr = 0;
} else {
$wfr = 1;
}
my ($name,$mac,$gattCmd,$handle,$value) = split("\\|", $string);
my $sshHost = AttrVal($name,"sshHost","none");
my $gatttool;
my $response_encode = XiaomiFlowerSens_forRun_encodeJSON($mac,$wfr);
$gatttool = qx(which gatttool) if($sshHost eq 'none');
$gatttool = qx(ssh $sshHost 'which gatttool') if($sshHost ne 'none');
chomp $gatttool;
if(-x $gatttool) {
my $cmd;
my $loop;
my @gtResult;
my $wait = 1;
my $sshHost = AttrVal($name,"sshHost","none");
my $hci = AttrVal($name,"hciDevice","hci0");
$hash->{helper}{RUNNING_PID} = BlockingCall("XiaomiFlowerSens_BlockingRun", $name."|".$response_encode, "XiaomiFlowerSens_BlockingDone", 30, "XiaomiFlowerSens_BlockingAborted", $hash) unless(exists($hash->{helper}{RUNNING_PID}));
Log3 $name, 4, "Sub XiaomiFlowerSens_Run ($name) - start blocking call";
readingsSingleUpdate ( $hash, "state", "call data", 1 ) if( ReadingsVal($name, "state", 0) eq "active" );
}
sub XiaomiFlowerSens_BlockingRun($) {
my ($string) = @_;
my ($name,$data) = split("\\|", $string);
my $data_json = decode_json($data);
my $mac = $data_json->{mac};
my $wfr = $data_json->{wfr};
Log3 $name, 4, "Sub XiaomiFlowerSens_BlockingRun ($name) - Running nonBlocking";
##### call sensor data
my ($sensData,$batFwData) = XiaomiFlowerSens_callGatttool($name,$mac,$wfr);
Log3 $name, 4, "Sub XiaomiFlowerSens_BlockingRun ($name) - Processing response data: $sensData";
return "$name|Unknown Error, look at verbose 5 output" # if error in stdout the error will given to $sensData variable
unless( defined($batFwData) );
#### processing sensor respons
my @dataSensor = split(" ",$sensData);
return "$name|charWrite faild"
unless( $dataSensor[0] ne "aa" and $dataSensor[1] ne "bb" and $dataSensor[2] ne "cc" and $dataSensor[3] ne "dd" and $dataSensor[4] ne "ee" and $dataSensor[5] ne "ff");
my $temp;
if( $dataSensor[1] eq "ff" ) {
$temp = hex("0x".$dataSensor[1].$dataSensor[0]) - hex("0xffff");
} else {
$temp = hex("0x".$dataSensor[1].$dataSensor[0]);
}
my $lux = hex("0x".$dataSensor[4].$dataSensor[3]);
my $moisture = hex("0x".$dataSensor[7]);
my $fertility = hex("0x".$dataSensor[9].$dataSensor[8]);
### processing firmware and battery response
my @dataBatFw = split(" ",$batFwData);
my $blevel = hex("0x".$dataBatFw[0]);
my $fw = ($dataBatFw[2]-30).".".($dataBatFw[4]-30).".".($dataBatFw[6]-30);
###### return processing data
return "$name|corrupted data"
if( $temp == 0 and $lux == 0 and $moisture == 0 and $fertility == 0 );
my $response_encode = XiaomiFlowerSens_forDone_encodeJSON($temp,$lux,$moisture,$fertility,$blevel,$fw);
Log3 $name, 4, "Sub XiaomiFlowerSens_BlockingRun ($name) - no dataerror, create encode json: $response_encode";
return "$name|$response_encode";
}
sub XiaomiFlowerSens_callGatttool($@) {
my ($name,$mac,$wfr) = @_;
my $hci = AttrVal($name,"hciDevice","hci0");
my $loop;
my $wresp;
my $sshHost = AttrVal($name,"sshHost","none");
my @readSensData;
my @readBatFwData;
$loop = 0;
if( $sshHost ne 'none') {
while ( (qx(ssh $sshHost 'ps ax | grep -v grep | grep "gatttool -b $mac"') and $loop = 0) or (qx(ssh $sshHost 'ps ax | grep -v grep | grep "gatttool -b $mac"') and $loop < 5) ) {
while($wait) {
Log3 $name, 4, "Sub XiaomiFlowerSens ($name) - check gattool is running at host $sshHost. loop: $loop";
sleep 0.5;
$loop++;
my $grepGatttool;
$grepGatttool = qx(ps ax| grep -E \'gatttool -i $hci -b $mac\' | grep -v grep) if($sshHost eq 'none');
$grepGatttool = qx(ssh $sshHost 'ps ax| grep -E "gatttool -i $hci -b $mac" | grep -v grep') if($sshHost ne 'none');
if(not $grepGatttool =~ /^\s*$/) {
Log3 $name, 5, "XiaomiFlowerSens ($name) - ExecGatttool_Run: another gatttool process is running. waiting...";
sleep(1);
} else {
$wait = 0;
}
}
} else {
while ( (qx(ps ax | grep -v grep | grep "gatttool -b $mac") and $loop = 0) or (qx(ps ax | grep -v grep | grep "gatttool -b $mac") and $loop < 5) ) {
Log3 $name, 4, "Sub XiaomiFlowerSens ($name) - check gattool is running at local host. loop: $loop";
sleep 0.5;
$loop++;
}
}
#### Read Sensor Data
## support for Firmware 2.6.6, man muß erst einen Characterwert schreiben
Log3 $name, 5, "Sub XiaomiFlowerSens_callGatttool ($name) - WFR: $wfr";
if($wfr == 1) {
$cmd .= "ssh $sshHost '" if($sshHost ne 'none');
$cmd .= "gatttool -i $hci -b $mac ";
$cmd .= "--char-read -a $handle" if($gattCmd eq 'read');
$cmd .= "--char-write-req -a $handle -n $value" if($gattCmd eq 'write');
$cmd .= " 2>&1 /dev/null";
$cmd .= "'" if($sshHost ne 'none');
$loop = 0;
do {
if( $sshHost ne 'none' ) {
$wresp = qx(ssh $sshHost 'gatttool -i $hci -b $mac --char-write-req -a 0x33 -n A01F 2>&1 /dev/null');
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - write data to host $sshHost";
} else {
$wresp = qx(gatttool -i $hci -b $mac --char-write-req -a 0x33 -n A01F 2>&1 /dev/null);
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - write data to local host";
}
Log3 $name, 5, "XiaomiFlowerSens ($name) - ExecGatttool_Run: call gatttool with command $cmd and loop $loop";
@gtResult = split(": ",qx($cmd));
Log3 $name, 5, "XiaomiFlowerSens ($name) - ExecGatttool_Run: gatttool loop result ".join(",", @gtResult);
$loop++;
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - call gatttool charWrite loop $loop";
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - charWrite wresp: $wresp" if(defined($wresp) and ($wresp) );
} while( ($loop < 10) and (not $wresp =~ /^Characteristic value was written successfully$/) );
} while( $loop < 5 and $gtResult[0] eq 'connect error' );
Log3 $name, 4, "XiaomiFlowerSens ($name) - ExecGatttool_Run: gatttool result ".join(",", @gtResult);
$gtResult[1] = 'no data response'
unless( defined($gtResult[1]) );
my $json_notification = XiaomiFlowerSens_encodeJSON($gtResult[1]);
if($gtResult[1] =~ /^([0-9a-f]{2}(\s?))*$/) {
return "$name|$mac|ok|$gattCmd|$handle|$json_notification";
} elsif($gtResult[0] ne 'connect error' and $gattCmd eq 'write') {
if( $sshHost ne 'none' ) {
XiaomiFlowerSens_ExecGatttool_Run($name."|".$mac."|read|0x35");
} else {
return "$name|$mac|ok|$gattCmd|$handle|$json_notification";
}
} else {
return "$name|$mac|error|$gattCmd|$handle|$json_notification";
}
} else {
return "$name|$mac|error|$gattCmd|$handle|no gatttool binary found. Please check if bluez-package is properly installed";
}
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - run gatttool";
$loop = 0;
do {
if( $sshHost ne 'none' ) {
@readSensData = split(": ",qx(ssh $sshHost 'gatttool -i $hci -b $mac --char-read -a 0x35 2>&1 /dev/null'));
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - call data from host $sshHost";
} else {
@readSensData = split(": ",qx(gatttool -i $hci -b $mac --char-read -a 0x35 2>&1 /dev/null));
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - call data from local host";
}
$loop++;
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - call gatttool charRead loop $loop";
} while( $loop < 10 and not $readSensData[0] =~ /^Characteristic value\/descriptor$/ );
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - processing gatttool response. sensData[0]: $readSensData[0]";
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - processing gatttool response. sensData: $readSensData[1]";
return ($readSensData[1],undef)
unless( $readSensData[0] =~ /^Characteristic value\/descriptor$/ );
### Read Firmware and Battery Data
$loop = 0;
do {
if( $sshHost ne 'none' ) {
@readBatFwData = split(": ",qx(ssh $sshHost 'gatttool -i $hci -b $mac --char-read -a 0x38 2>&1 /dev/null'));
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - call firm/batt data from host $sshHost";
} else {
@readBatFwData = split(": ",qx(gatttool -i $hci -b $mac --char-read -a 0x38 2>&1 /dev/null));
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - call firm/batt data from host local host";
}
$loop++;
Log3 $name, 4, "Sub XiaomiFlowerSens ($name) - call gatttool readBatFw loop $loop";
} while( $loop < 10 and not $readBatFwData[0] =~ /^Characteristic value\/descriptor$/ );
Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - processing gatttool response. batFwData: $readBatFwData[1]";
return ($readBatFwData[1],undef)
unless( $readBatFwData[0] =~ /^Characteristic value\/descriptor$/ );
### no Error in data string
return ($readSensData[1],$readBatFwData[1])
}
sub XiaomiFlowerSens_forRun_encodeJSON($$) {
sub XiaomiFlowerSens_ExecGatttool_Done($) {
my ($mac,$wfr) = @_;
my %data = (
'mac' => $mac,
'wfr' => $wfr
);
my $string = shift;
my ($name,$mac,$respstate,$gattCmd,$handle,$json_notification) = split("\\|", $string);
return encode_json \%data;
}
sub XiaomiFlowerSens_forDone_encodeJSON($$$$$$) {
my ($temp,$lux,$moisture,$fertility,$blevel,$fw) = @_;
my %response = (
'temp' => $temp,
'lux' => $lux,
'moisture' => $moisture,
'fertility' => $fertility,
'blevel' => $blevel,
'firmware' => $fw
);
return encode_json \%response;
}
sub XiaomiFlowerSens_BlockingDone($) {
my ($string) = @_;
my ($name,$response) = split("\\|",$string);
my $hash = $defs{$name};
delete($hash->{helper}{RUNNING_PID});
Log3 $name, 4, "Sub XiaomiFlowerSens_BlockingDone ($name) - Der Helper ist diabled. Daher wird hier abgebrochen" if($hash->{helper}{DISABLED});
Log3 $name, 5, "XiaomiFlowerSens ($name) - ExecGatttool_Done: Helper is disabled. Stop processing" if($hash->{helper}{DISABLED});
return if($hash->{helper}{DISABLED});
Log3 $name, 4, "XiaomiFlowerSens ($name) - ExecGatttool_Done: gatttool return string: $string";
readingsBeginUpdate($hash);
if( $response eq "corrupted data" ) {
readingsBulkUpdate($hash,"state","corrupted data");
readingsEndUpdate($hash,1);
return undef;
} elsif( $response eq "charWrite faild") {
readingsBulkUpdate($hash,"state","charWrite faild");
readingsEndUpdate($hash,1);
return undef;
} elsif( $response eq "Unknown Error, look at verbose 5 output" ) {
readingsBulkUpdate($hash,"lastGattError","$response");
readingsBulkUpdate($hash,"state","unreachable");
readingsEndUpdate($hash,1);
return undef;
} elsif( ref($response) eq "HASH" ) {
readingsBulkUpdate($hash,"lastGattError","$response");
readingsBulkUpdate($hash,"state","unreachable");
readingsEndUpdate($hash,1);
return undef;
my $decode_json = eval{decode_json($json_notification)};
if($@){
Log3 $name, 5, "XiaomiFlowerSens ($name) - ExecGatttool_Done: JSON error while request: $@";
}
my $response_json = decode_json($response);
readingsBulkUpdate($hash, "batteryLevel", $response_json->{blevel});
readingsBulkUpdate($hash, "battery", ($response_json->{blevel}>20?"ok":"low") );
readingsBulkUpdate($hash, "temperature", $response_json->{temp}/10);
readingsBulkUpdate($hash, "lux", $response_json->{lux});
readingsBulkUpdate($hash, "moisture", $response_json->{moisture});
readingsBulkUpdate($hash, "fertility", $response_json->{fertility});
readingsBulkUpdate($hash, "firmware", $response_json->{firmware});
readingsBulkUpdate($hash, "state", "active") if( ReadingsVal($name,"state", 0) eq "call data" or ReadingsVal($name,"state", 0) eq "unreachable" or ReadingsVal($name,"state", 0) eq "corrupted data" );
readingsEndUpdate($hash,1);
DoTrigger($name, 'minFertility ' . ($response_json->{fertility}<AttrVal($name,'minFertility',0)?'low':'ok')) if( AttrVal($name,'minFertility','none') ne 'none' );
DoTrigger($name, 'maxFertility ' . ($response_json->{fertility}>AttrVal($name,'maxFertility',0)?'high':'ok')) if( AttrVal($name,'maxFertility','none') ne 'none' );
DoTrigger($name, 'minTemp ' . ($response_json->{temp}/10<AttrVal($name,'minTemp',0)?'low':'ok')) if( AttrVal($name,'minTemp','none') ne 'none' );
DoTrigger($name, 'maxTemp ' . ($response_json->{temp}/10>AttrVal($name,'maxTemp',0)?'high':'ok')) if( AttrVal($name,'maxTemp','none') ne 'none' );
DoTrigger($name, 'minMoisture ' . ($response_json->{moisture}<AttrVal($name,'minMoisture',0)?'low':'ok')) if( AttrVal($name,'minMoisture','none') ne 'none' );
DoTrigger($name, 'maxMoisture ' . ($response_json->{moisture}>AttrVal($name,'maxMoisture',0)?'high':'ok')) if( AttrVal($name,'maxMoisture','none') ne 'none' );
DoTrigger($name, 'minLux ' . ($response_json->{lux}<AttrVal($name,'minLux',0)?'low':'ok')) if( AttrVal($name,'minLux','none') ne 'none' );
DoTrigger($name, 'maxLux ' . ($response_json->{lux}>AttrVal($name,'maxLux',0)?'high':'ok')) if( AttrVal($name,'maxLux','none') ne 'none' );
Log3 $name, 4, "Sub XiaomiFlowerSens_BlockingDone ($name) - Abschluss!";
if( $respstate eq 'ok' and $gattCmd eq 'read' ) {
XiaomiFlowerSens_ProcessingNotification($hash,$handle,$decode_json->{gtResult});
} elsif( $respstate eq 'ok' and $gattCmd eq 'write' ) {
XiaomiFlowerSens_CallSensData($hash);
} else {
XiaomiFlowerSens_ProcessingErrors($hash,$decode_json->{gtResult});
}
}
sub XiaomiFlowerSens_BlockingAborted($) {
sub XiaomiFlowerSens_ExecGatttool_Aborted($) {
my ($hash) = @_;
my $name = $hash->{NAME};
my %readings;
delete($hash->{helper}{RUNNING_PID});
readingsSingleUpdate($hash,"state","unreachable", 1);
Log3 $name, 3, "($name) Sub XiaomiFlowerSens_BlockingAborted - The BlockingCall Process terminated unexpectedly. Timedout";
$readings{'lastGattError'} = 'The BlockingCall Process terminated unexpectedly. Timedout';
XiaomiFlowerSens_WriteReadings($hash,\%readings);
Log3 $name, 4, "XiaomiFlowerSens ($name) - ExecGatttool_Aborted: The BlockingCall Process terminated unexpectedly. Timedout";
}
sub XiaomiFlowerSens_ProcessingNotification($@) {
my ($hash,$handle,$notification) = @_;
my $name = $hash->{NAME};
my $readings;
Log3 $name, 5, "XiaomiFlowerSens ($name) - ProcessingNotification";
if( $handle eq '0x38' ) {
### Read Firmware and Battery Data
Log3 $name, 4, "XiaomiFlowerSens ($name) - ProcessingNotification: handle 0x38";
$readings = XiaomiFlowerSens_Handle0x38($hash,$notification);
} elsif( $handle eq '0x35' ) {
### Read Sensor Data
Log3 $name, 4, "XiaomiFlowerSens ($name) - ProcessingNotification: handle 0x35";
$readings = XiaomiFlowerSens_Handle0x35($hash,$notification);
}
XiaomiFlowerSens_WriteReadings($hash,$readings);
}
sub XiaomiFlowerSens_Handle0x38($$) {
### Read Firmware and Battery Data
my ($hash,$notification) = @_;
my $name = $hash->{NAME};
my %readings;
Log3 $name, 5, "XiaomiFlowerSens ($name) - Handle0x38";
my @dataBatFw = split(" ",$notification);
my $blevel = hex("0x".$dataBatFw[0]);
my $fw = ($dataBatFw[2]-30).".".($dataBatFw[4]-30).".".($dataBatFw[6]-30);
$readings{'batteryLevel'} = $blevel;
$readings{'battery'} = ($blevel > 20?"ok":"low");
$readings{'firmware'} = $fw;
$hash->{helper}{CallBatteryFirmware} = 1;
XiaomiFlowerSens_CallBatteryFirmware_Timestamp($hash);
return \%readings;
}
sub XiaomiFlowerSens_Handle0x35($$) {
### Read Sensor Data
my ($hash,$notification) = @_;
my $name = $hash->{NAME};
my %readings;
Log3 $name, 5, "XiaomiFlowerSens ($name) - Handle0x35";
my @dataSensor = split(" ",$notification);
return XiaomiFlowerSens_stateRequest($hash)
unless( $dataSensor[0] ne "aa" and $dataSensor[1] ne "bb" and $dataSensor[2] ne "cc" and $dataSensor[3] ne "dd" and $dataSensor[4] ne "ee" and $dataSensor[5] ne "ff");
my $temp;
if( $dataSensor[1] eq "ff" ) {
$temp = hex("0x".$dataSensor[1].$dataSensor[0]) - hex("0xffff");
} else {
$temp = hex("0x".$dataSensor[1].$dataSensor[0]);
}
my $lux = hex("0x".$dataSensor[4].$dataSensor[3]);
my $moisture = hex("0x".$dataSensor[7]);
my $fertility = hex("0x".$dataSensor[9].$dataSensor[8]);
$readings{'temperature'} = $temp/10;
$readings{'lux'} = $lux;
$readings{'moisture'} = $moisture;
$readings{'fertility'} = $fertility;
$hash->{helper}{CallBatteryFirmware} = 0;
return \%readings;
}
sub XiaomiFlowerSens_WriteReadings($$) {
my ($hash,$readings) = @_;
my $name = $hash->{NAME};
readingsBeginUpdate($hash);
while( my ($r,$v) = each %{$readings} ) {
readingsBulkUpdate($hash,$r,$v);
}
readingsBulkUpdateIfChanged($hash, "state", ($readings->{'lastGattError'}?'error':'active'));
readingsEndUpdate($hash,1);
if( defined($readings->{temperature}) ) {
DoTrigger($name, 'minFertility ' . ($readings->{fertility}<AttrVal($name,'minFertility',0)?'low':'ok')) if( AttrVal($name,'minFertility','none') ne 'none' );
DoTrigger($name, 'maxFertility ' . ($readings->{fertility}>AttrVal($name,'maxFertility',0)?'high':'ok')) if( AttrVal($name,'maxFertility','none') ne 'none' );
DoTrigger($name, 'minTemp ' . ($readings->{temperature}<AttrVal($name,'minTemp',0)?'low':'ok')) if( AttrVal($name,'minTemp','none') ne 'none' );
DoTrigger($name, 'maxTemp ' . ($readings->{temperature}>AttrVal($name,'maxTemp',0)?'high':'ok')) if( AttrVal($name,'maxTemp','none') ne 'none' );
DoTrigger($name, 'minMoisture ' . ($readings->{moisture}<AttrVal($name,'minMoisture',0)?'low':'ok')) if( AttrVal($name,'minMoisture','none') ne 'none' );
DoTrigger($name, 'maxMoisture ' . ($readings->{moisture}>AttrVal($name,'maxMoisture',0)?'high':'ok')) if( AttrVal($name,'maxMoisture','none') ne 'none' );
DoTrigger($name, 'minLux ' . ($readings->{lux}<AttrVal($name,'minLux',0)?'low':'ok')) if( AttrVal($name,'minLux','none') ne 'none' );
DoTrigger($name, 'maxLux ' . ($readings->{lux}>AttrVal($name,'maxLux',0)?'high':'ok')) if( AttrVal($name,'maxLux','none') ne 'none' );
}
Log3 $name, 4, "XiaomiFlowerSens ($name) - WriteReadings: Readings were written";
$hash->{helper}{CallSensDataCounter} = 0;
XiaomiFlowerSens_stateRequest($hash) if( $hash->{helper}{CallBatteryFirmware} == 1 );
}
sub XiaomiFlowerSens_ProcessingErrors($$) {
my ($hash,$notification) = @_;
my $name = $hash->{NAME};
my %readings;
Log3 $name, 5, "XiaomiFlowerSens ($name) - ProcessingErrors";
$readings{'lastGattError'} = $notification;
XiaomiFlowerSens_WriteReadings($hash,\%readings);
}
#### my little Helper
sub XiaomiFlowerSens_encodeJSON($) {
my $gtResult = shift;
my %response = (
'gtResult' => $gtResult
);
return encode_json \%response;
}
## Routinen damit Firmware und Batterie nur alle X male statt immer aufgerufen wird
sub XiaomiFlowerSens_CallBatteryFirmware_Timestamp($) {
my $hash = shift;
# get timestamp
$hash->{helper}{updateTimeCallBatteryFirmware} = gettimeofday(); # in seconds since the epoch
$hash->{helper}{updateTimestampCallBatteryFirmware} = FmtDateTime(gettimeofday());
}
sub XiaomiFlowerSens_CallBatteryFirmware_UpdateTimeAge($) {
my $hash = shift;
$hash->{helper}{updateTimeCallBatteryFirmware} = 0 if( not defined($hash->{helper}{updateTimeCallBatteryFirmware}) );
my $UpdateTimeAge = gettimeofday() - $hash->{helper}{updateTimeCallBatteryFirmware};
return $UpdateTimeAge;
}
sub XiaomiFlowerSens_CallBatteryFirmware_IsUpdateTimeAgeToOld($$) {
my ($hash,$maxAge) = @_;;
return (XiaomiFlowerSens_CallBatteryFirmware_UpdateTimeAge($hash)>$maxAge ? 1:0);
}
@ -645,11 +737,17 @@ sub XiaomiFlowerSens_BlockingAborted($) {
<a name="XiaomiFlowerSensset"></a>
<b>Set</b>
<ul>
<li>statusRequest - retrieves the current state of the Xiaomi Flower Monitor.</li>
<li>clearFirmwareReading - clear firmware reading for new begin.</li>
<br>
</ul>
<br><br>
<a name="XiaomiFlowerSensget"></a>
<b>Get</b>
<ul>
<li>statusRequest - retrieves the current state of the Xiaomi Flower Monitor.</li>
<br>
</ul>
<br><br>
<a name="XiaomiFlowerSensattribut"></a>
<b>Attributes</b>
<ul>
@ -712,11 +810,17 @@ sub XiaomiFlowerSens_BlockingAborted($) {
<a name="XiaomiFlowerSensset"></a>
<b>Set</b>
<ul>
<li>statusRequest - aktive Abfrage des aktuellen Status des Xiaomi Flower Monitor und seiner Werte</li>
<li>clearFirmwareReading - l&ouml;scht das Reading firmware f&uuml;r/nach Upgrade</li>
<br />
</ul>
<br /><br />
<a name="XiaomiFlowerSensGet"></a>
<b>Get</b>
<ul>
<li>statusRequest - aktive Abfrage des aktuellen Status des Xiaomi Flower Monitor und seiner Werte</li>
<br />
</ul>
<br /><br />
<a name="XiaomiFlowerSensattribut"></a>
<b>Attribute</b>
<ul>
@ -734,6 +838,7 @@ sub XiaomiFlowerSens_BlockingAborted($) {
2017-03-16 11:08:05 XiaomiFlowerSens Dracaena minMoisture low<br />
2017-03-16 11:08:06 XiaomiFlowerSens Dracaena maxTemp high<br /><br /></li>
<li>sshHost - FQDN oder IP-Adresse eines entfernten SSH-Systems. Das SSH-System ist auf eine Zertifikat basierte Authentifizierung zu konfigurieren. Am elegantesten geschieht das mit einer .ssh/config Datei auf dem SSH-Client.</li>
<li>batteryFirmwareAge - how old can the reading befor fetch new data</li>
</ul>
</ul>