mod-XiaomiBTLESens/74_XiaomiFlowerSens.pm

772 lines
26 KiB
Perl
Raw Normal View History

2016-11-13 09:47:15 +00:00
###############################################################################
#
# Developed with Kate
#
2017-01-14 13:54:22 +00:00
# (c) 2016-2017 Copyright: Marko Oldenburg (leongaultier at gmail dot com)
2016-11-13 09:47:15 +00:00
# All rights reserved
#
# This script is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# any later version.
#
# The GNU General Public License can be found at
# http://www.gnu.org/copyleft/gpl.html.
# A copy is found in the textfile GPL.txt and important notices to the license
# from the author is found in LICENSE.txt distributed with these scripts.
#
# This script is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# $Id$
#
###############################################################################
2017-09-30 11:18:21 +00:00
#$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
2016-11-13 09:47:15 +00:00
package main;
use strict;
use warnings;
use POSIX;
use JSON;
use Blocking;
2017-03-23 07:10:08 +00:00
2017-09-30 11:18:21 +00:00
my $version = "1.1.39";
my %readings = ();
2016-11-13 09:47:15 +00:00
# Declare functions
sub XiaomiFlowerSens_Initialize($);
sub XiaomiFlowerSens_Define($$);
sub XiaomiFlowerSens_Undef($$);
sub XiaomiFlowerSens_Attr(@);
sub XiaomiFlowerSens_stateRequest($);
sub XiaomiFlowerSens_stateRequestTimer($);
sub XiaomiFlowerSens_Set($$@);
2017-09-30 11:18:21 +00:00
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($$);
2016-11-13 09:47:15 +00:00
sub XiaomiFlowerSens_Initialize($) {
my ($hash) = @_;
2017-01-24 09:53:14 +00:00
$hash->{SetFn} = "XiaomiFlowerSens_Set";
$hash->{DefFn} = "XiaomiFlowerSens_Define";
$hash->{UndefFn} = "XiaomiFlowerSens_Undef";
$hash->{AttrFn} = "XiaomiFlowerSens_Attr";
$hash->{AttrList} = "interval ".
"disable:1 ".
"disabledForIntervals ".
"hciDevice:hci0,hci1,hci2 ".
"minFertility ".
2017-03-17 16:54:59 +00:00
"maxFertility ".
"minTemp ".
"maxTemp ".
"minMoisture ".
2017-03-17 16:54:59 +00:00
"maxMoisture ".
2017-03-27 09:02:59 +00:00
"minLux ".
"maxLux ".
2017-03-17 16:54:59 +00:00
"sshHost ".
2017-01-24 09:53:14 +00:00
$readingFnAttributes;
2016-11-13 09:47:15 +00:00
foreach my $d(sort keys %{$modules{XiaomiFlowerSens}{defptr}}) {
2017-03-23 07:10:08 +00:00
my $hash = $modules{XiaomiFlowerSens}{defptr}{$d};
$hash->{VERSION} = $version;
2016-11-13 09:47:15 +00:00
}
}
sub XiaomiFlowerSens_Define($$) {
my ( $hash, $def ) = @_;
my @a = split( "[ \t][ \t]*", $def );
return "too few parameters: define <name> XiaomiFlowerSens <BTMAC>" if( @a != 3 );
2017-01-24 09:53:14 +00:00
my $name = $a[0];
my $mac = $a[2];
2016-11-13 09:47:15 +00:00
2017-01-24 09:53:14 +00:00
$hash->{BTMAC} = $mac;
2016-11-13 09:47:15 +00:00
$hash->{VERSION} = $version;
$hash->{INTERVAL} = 300;
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
readingsSingleUpdate($hash,"state","initialized", 0);
2016-11-13 09:47:15 +00:00
$attr{$name}{room} = "FlowerSens" if( !defined($attr{$name}{room}) );
RemoveInternalTimer($hash);
if( $init_done ) {
XiaomiFlowerSens_stateRequestTimer($hash);
} else {
2016-11-16 11:20:28 +00:00
InternalTimer( gettimeofday()+int(rand(30))+15, "XiaomiFlowerSens_stateRequestTimer", $hash, 0 );
2016-11-13 09:47:15 +00:00
}
Log3 $name, 3, "XiaomiFlowerSens ($name) - defined with BTMAC $hash->{BTMAC}";
$modules{XiaomiFlowerSens}{defptr}{$hash->{BTMAC}} = $hash;
return undef;
}
sub XiaomiFlowerSens_Undef($$) {
my ( $hash, $arg ) = @_;
my $mac = $hash->{BTMAC};
my $name = $hash->{NAME};
RemoveInternalTimer($hash);
2017-01-28 15:38:35 +00:00
BlockingKill($hash->{helper}{RUNNING_PID}) if(defined($hash->{helper}{RUNNING_PID}));
2016-11-13 09:47:15 +00:00
delete($modules{XiaomiFlowerSens}{defptr}{$mac});
Log3 $name, 3, "Sub XiaomiFlowerSens_Undef ($name) - delete device $name";
2016-11-13 09:47:15 +00:00
return undef;
}
sub XiaomiFlowerSens_Attr(@) {
my ( $cmd, $name, $attrName, $attrVal ) = @_;
2017-01-24 09:53:14 +00:00
my $hash = $defs{$name};
2017-09-30 11:18:21 +00:00
2016-11-13 09:47:15 +00:00
if( $attrName eq "disable" ) {
2017-01-12 13:44:23 +00:00
if( $cmd eq "set" and $attrVal eq "1" ) {
readingsSingleUpdate ( $hash, "state", "disabled", 1 );
Log3 $name, 3, "XiaomiFlowerSens ($name) - disabled";
2017-01-12 13:44:23 +00:00
}
2017-09-30 11:18:21 +00:00
2017-01-12 13:44:23 +00:00
elsif( $cmd eq "del" ) {
readingsSingleUpdate ( $hash, "state", "active", 1 );
Log3 $name, 3, "XiaomiFlowerSens ($name) - enabled";
}
}
if( $attrName eq "disabledForIntervals" ) {
2017-01-12 13:44:23 +00:00
if( $cmd eq "set" ) {
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 );
2017-01-12 13:44:23 +00:00
}
2016-11-13 09:47:15 +00:00
2017-01-12 13:44:23 +00:00
elsif( $cmd eq "del" ) {
readingsSingleUpdate ( $hash, "state", "active", 1 );
Log3 $name, 3, "XiaomiFlowerSens ($name) - enabled";
2016-11-13 09:47:15 +00:00
}
}
if( $attrName eq "interval" ) {
2017-09-30 11:18:21 +00:00
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";
XiaomiFlowerSens_stateRequestTimer($hash) if($init_done);
}
}
elsif( $cmd eq "del" ) {
$hash->{INTERVAL} = 300;
Log3 $name, 3, "XiaomiFlowerSens ($name) - set interval to default";
XiaomiFlowerSens_stateRequestTimer($hash) if($init_done);
2016-11-13 09:47:15 +00:00
}
}
return undef;
}
sub XiaomiFlowerSens_stateRequest($) {
my ($hash) = @_;
2016-11-13 11:39:48 +00:00
my $name = $hash->{NAME};
2016-11-13 09:47:15 +00:00
2016-11-26 23:07:44 +00:00
2017-01-12 13:44:23 +00:00
if( !IsDisabled($name) ) {
2017-09-30 11:18:21 +00:00
if( ReadingsVal($name,'firmware','none') ne 'none') {
return XiaomiFlowerSens_CallBatteryFirmware($hash)
if( XiaomiFlowerSens_CallBatteryFirmware_IsUpdateTimeAgeToOld($hash,'90000') );
2017-09-30 11:18:21 +00:00
if( ReadingsVal($name, 'firmware', '') eq '2.6.2') {
XiaomiFlowerSens_CallSensData($hash);
} else {
XiaomiFlowerSens_WriteSensData($hash);
}
} else {
2017-01-12 13:44:23 +00:00
2017-09-30 11:18:21 +00:00
XiaomiFlowerSens_CallBatteryFirmware($hash);
}
2017-01-12 13:44:23 +00:00
2017-09-30 11:18:21 +00:00
readingsSingleUpdate($hash,"state","fetch sensor data",1);
2017-01-12 13:44:23 +00:00
} else {
2017-09-30 11:18:21 +00:00
readingsSingleUpdate($hash,"state","disabled",1);
2017-01-12 13:44:23 +00:00
}
2016-11-13 09:47:15 +00:00
}
sub XiaomiFlowerSens_stateRequestTimer($) {
my ($hash) = @_;
2017-09-30 11:18:21 +00:00
2016-11-13 09:47:15 +00:00
my $name = $hash->{NAME};
2017-09-30 11:18:21 +00:00
RemoveInternalTimer($hash);
if( not IsDisabled($name) ) {
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
#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 "disabled" or ReadingsVal($name, "state", 0) eq "Unknown") );
2017-01-12 13:44:23 +00:00
2017-09-30 11:18:21 +00:00
XiaomiFlowerSens_stateRequest($hash);
2017-01-12 13:44:23 +00:00
} else {
readingsSingleUpdate ( $hash, "state", "disabled", 1 );
}
2016-11-26 23:07:44 +00:00
2017-01-14 13:54:22 +00:00
InternalTimer( gettimeofday()+$hash->{INTERVAL}+int(rand(300)), "XiaomiFlowerSens_stateRequestTimer", $hash, 1 );
2017-09-30 11:18:21 +00:00
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";
2016-11-13 09:47:15 +00:00
}
sub XiaomiFlowerSens_Set($$@) {
2017-01-24 09:53:14 +00:00
my ($hash, $name, @aa) = @_;
2017-02-13 20:36:50 +00:00
my ($cmd, @args) = @aa;
2016-11-13 09:47:15 +00:00
if( $cmd eq 'statusRequest' ) {
2017-02-13 20:36:50 +00:00
return "usage: statusRequest" if( @args != 0 );
XiaomiFlowerSens_stateRequest($hash);
2017-02-13 20:36:50 +00:00
} elsif( $cmd eq 'clearFirmwareReading' ) {
return "usage: clearFirmwareReading" if( @args != 0 );
readingsSingleUpdate($hash,'firmware','',0);
2016-11-13 09:47:15 +00:00
} else {
2017-02-13 20:36:50 +00:00
my $list = "statusRequest:noArg clearFirmwareReading:noArg";
2016-11-13 09:47:15 +00:00
return "Unknown argument $cmd, choose one of $list";
}
return undef;
}
2017-09-30 11:18:21 +00:00
sub XiaomiFlowerSens_ExecGatttool_Run($) {
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my $string = shift;
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my ($name,$mac,$gattCmd,$handle,$value) = split("\\|", $string);
my $sshHost = AttrVal($name,"sshHost","none");
my $gatttool = qx(which gatttool);
chomp $gatttool;
2017-09-29 05:51:43 +00:00
2017-09-30 11:18:21 +00:00
if(-x $gatttool) {
2016-11-13 14:54:10 +00:00
2017-09-30 11:18:21 +00:00
my $cmd;
my $loop;
my @gtResult;
my $wait = 1;
my $sshHost = AttrVal($name,"sshHost","none");
my $hci = AttrVal($name,"hciDevice","hci0");
while($wait) {
my $grepGatttool;
$grepGatttool = qx(ps ax| grep -E \'gatttool -b $mac\' | grep -v grep);
$grepGatttool = qx(ssh $sshHost 'ps ax| grep -E \'gatttool -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;
}
}
$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 {
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++;
} while( $loop < 5 and $gtResult[0] eq 'connect error' );
Log3 $name, 4, "XiaomiFlowerSens ($name) - ExecGatttool_Run: gatttool result ".join(",", @gtResult);
$gtResult[1] = 'none'
unless( defined($gtResult[1]) );
my $json_notification = XiaomiFlowerSens_encodeJSON($gtResult[1]);
if($gtResult[0] ne 'connect error') {
return "$name|$mac|ok|$gattCmd|$handle|$json_notification";
} else {
return "$name|$mac|error|$gattCmd|$handle|$json_notification";
}
2017-09-29 05:51:43 +00:00
} else {
2017-09-30 11:18:21 +00:00
return "$name|$mac|error|$gattCmd|$handle|no gatttool binary found. Please check if bluez-package is properly installed";
2017-09-29 05:51:43 +00:00
}
2016-11-13 09:47:15 +00:00
}
2017-09-30 11:18:21 +00:00
sub XiaomiFlowerSens_ExecGatttool_Done($) {
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my $string = shift;
my ($name,$mac,$respstate,$gattCmd,$handle,$json_notification) = split("\\|", $string);
2017-09-30 11:18:21 +00:00
my $hash = $defs{$name};
2017-09-30 11:18:21 +00:00
delete($hash->{helper}{RUNNING_PID});
2017-09-30 11:18:21 +00:00
Log3 $name, 5, "XiaomiFlowerSens ($name) - ExecGatttool_Done: Helper is disabled. Stop processing" if($hash->{helper}{DISABLED});
return if($hash->{helper}{DISABLED});
2017-09-30 11:18:21 +00:00
Log3 $name, 4, "XiaomiFlowerSens ($name) - ExecGatttool_Done: gatttool return string: $string";
2017-09-30 11:18:21 +00:00
my $decode_json = eval{decode_json($json_notification)};
if($@){
Log3 $name, 5, "XiaomiFlowerSens ($name) - ExecGatttool_Done: JSON error while request: $@";
}
2017-09-30 11:18:21 +00:00
XiaomiFlowerSens_ProcessingNotification($hash,$handle,$decode_json->{gtResult})
if( $respstate eq 'ok' and $gattCmd eq 'read' );
2017-09-30 11:18:21 +00:00
XiaomiFlowerSens_ProcessingErrors($hash,$decode_json->{gtResult})
unless( $respstate eq 'ok' );
2017-09-30 11:18:21 +00:00
XiaomiFlowerSens_CallSensData($hash)
unless( $gattCmd eq 'read' );
}
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
sub XiaomiFlowerSens_ExecGatttool_Aborted($) {
my ($hash) = @_;
my $name = $hash->{NAME};
delete($hash->{helper}{RUNNING_PID});
readingsSingleUpdate($hash,"state","unreachable", 1);
Log3 $name, 3, "XiaomiFlowerSens ($name) - ExecGatttool_Aborted: The BlockingCall Process terminated unexpectedly. Timedout";
2016-11-13 09:47:15 +00:00
}
2017-09-30 11:18:21 +00:00
sub XiaomiFlowerSens_ProcessingNotification($@) {
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my ($hash,$handle,$notification) = @_;
2017-09-29 05:51:43 +00:00
2017-09-30 11:18:21 +00:00
my $name = $hash->{NAME};
2017-03-17 16:54:59 +00:00
2017-09-30 11:18:21 +00:00
Log3 $name, 5, "XiaomiFlowerSens ($name) - ProcessingNotification";
2017-03-17 16:54:59 +00:00
2017-09-30 11:18:21 +00:00
if( $handle eq '0x38' ) {
### Read Firmware and Battery Data
Log3 $name, 4, "XiaomiFlowerSens ($name) - ProcessingNotification: handle 0x38";
2017-03-17 16:54:59 +00:00
2017-09-30 11:18:21 +00:00
XiaomiFlowerSens_Handle0x38($hash,$notification);
2017-03-17 16:54:59 +00:00
2017-09-30 11:18:21 +00:00
} elsif( $handle eq '0x35' ) {
### Read Sensor Data
Log3 $name, 4, "XiaomiFlowerSens ($name) - ProcessingNotification: handle 0x35";
2017-09-30 11:18:21 +00:00
XiaomiFlowerSens_Handle0x35($hash,$notification);
}
2017-09-30 11:18:21 +00:00
}
2017-03-23 07:10:08 +00:00
2017-09-30 11:18:21 +00:00
sub XiaomiFlowerSens_Handle0x38($$) {
### Read Firmware and Battery Data
2017-09-30 11:18:21 +00:00
my ($hash,$notification) = @_;
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my $name = $hash->{NAME};
2016-11-13 09:47:15 +00:00
2017-09-29 05:51:43 +00:00
2017-09-30 11:18:21 +00:00
Log3 $name, 5, "XiaomiFlowerSens ($name) - Handle0x38";
2017-09-30 11:18:21 +00:00
my @dataBatFw = split(" ",$notification);
my $blevel = hex("0x".$dataBatFw[0]);
my $fw = ($dataBatFw[2]-30).".".($dataBatFw[4]-30).".".($dataBatFw[6]-30);
2017-03-17 16:54:59 +00:00
2017-09-30 11:18:21 +00:00
$readings{'batteryLevel'} = $blevel;
$readings{'battery'} = ($blevel > 20?"ok":"low");
$readings{'firmware'} = $fw;
2017-03-17 16:54:59 +00:00
2017-09-30 11:18:21 +00:00
$hash->{helper}{CallBatteryFirmware} = 1;
XiaomiFlowerSens_WriteReadings($hash);
XiaomiFlowerSens_CallBatteryFirmware_Timestamp($hash);
2017-09-30 11:18:21 +00:00
}
2017-03-23 07:10:08 +00:00
2017-09-30 11:18:21 +00:00
sub XiaomiFlowerSens_Handle0x35($$) {
### Read Sensor Data
2017-09-30 11:18:21 +00:00
my ($hash,$notification) = @_;
2017-09-29 05:51:43 +00:00
2017-09-30 11:18:21 +00:00
my $name = $hash->{NAME};
2017-09-29 05:51:43 +00:00
2017-09-30 11:18:21 +00:00
Log3 $name, 5, "XiaomiFlowerSens ($name) - Handle0x35";
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my @dataSensor = split(" ",$notification);
2017-09-29 05:51:43 +00:00
2017-09-30 11:18:21 +00:00
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");
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
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]);
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
$readings{'temperature'} = $temp/10;
$readings{'lux'} = $lux;
$readings{'moisture'} = $moisture;
$readings{'fertility'} = $fertility;
$hash->{helper}{CallBatteryFirmware} = 0;
XiaomiFlowerSens_WriteReadings($hash);
2016-11-13 09:47:15 +00:00
}
2017-09-30 11:18:21 +00:00
sub XiaomiFlowerSens_WriteReadings($) {
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my ($hash) = @_;
2017-09-30 11:18:21 +00:00
my $name = $hash->{NAME};
readingsBeginUpdate($hash);
2017-09-30 11:18:21 +00:00
while( my ($r,$v) = each %readings ) {
readingsBulkUpdateIfChanged($hash,$r,$v);
2016-11-13 09:47:15 +00:00
}
2017-09-30 11:18:21 +00:00
readingsBulkUpdateIfChanged($hash, "state", "active");
2016-11-13 09:47:15 +00:00
readingsEndUpdate($hash,1);
2017-09-30 11:18:21 +00:00
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
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' );
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
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' );
}
2017-03-27 09:02:59 +00:00
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
Log3 $name, 4, "XiaomiFlowerSens ($name) - WriteReadings: Readings were written";
%readings = ();
XiaomiFlowerSens_stateRequest($hash) if( $hash->{helper}{CallBatteryFirmware} == 1 );
2016-11-13 09:47:15 +00:00
}
2017-09-30 11:18:21 +00:00
sub XiaomiFlowerSens_ProcessingErrors($$) {
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my ($hash,$notification) = @_;
my $name = $hash->{NAME};
Log3 $name, 5, "XiaomiFlowerSens ($name) - ProcessingErrors";
$readings{'lastGattError'} = $notification;
XiaomiFlowerSens_WriteReadings($hash);
}
2016-11-13 09:47:15 +00:00
#### my little Helper
2017-09-30 11:18:21 +00:00
sub XiaomiFlowerSens_encodeJSON($) {
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my $gtResult = shift;
2016-11-13 09:47:15 +00:00
2017-09-30 11:18:21 +00:00
my %response = (
'gtResult' => $gtResult
);
return encode_json \%response;
}
2016-11-13 09:47:15 +00:00
## 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;
2017-09-30 17:38:53 +00:00
$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);
}
2016-11-13 09:47:15 +00:00
1;
=pod
=item device
2017-01-12 13:44:23 +00:00
=item summary Modul to retrieves data from a Xiaomi Flower Monitor
=item summary_DE Modul um Daten vom Xiaomi Flower Monitor aus zu lesen
2016-11-13 09:47:15 +00:00
=begin html
2017-01-12 13:44:23 +00:00
<a name="XiaomiFlowerSens"></a>
<h3>Xiaomi Flower Monitor</h3>
<ul>
<u><b>XiaomiFlowerSens - Retrieves data from a Xiaomi Flower Monitor</b></u>
<br>
With this module it is possible to read the data from a sensor and to set it as reading.</br>
Gatttool and hcitool is required to use this modul. (apt-get install bluez)
<br><br>
<a name="XiaomiFlowerSensdefine"></a>
<b>Define</b>
<ul><br>
<code>define &lt;name&gt; XiaomiFlowerSens &lt;BT-MAC&gt;</code>
<br><br>
Example:
<ul><br>
<code>define Weihnachtskaktus XiaomiFlowerSens C4:7C:8D:62:42:6F</code><br>
</ul>
<br>
This statement creates a XiaomiFlowerSens with the name Weihnachtskaktus and the Bluetooth Mac C4:7C:8D:62:42:6F.<br>
After the device has been created, the current data of the Xiaomi Flower Monitor is automatically read from the device.
</ul>
<br><br>
<a name="XiaomiFlowerSensreadings"></a>
<b>Readings</b>
<ul>
<li>state - Status of the flower sensor or error message if any errors.</li>
<li>battery - current battery state dependent on batteryLevel.</li>
<li>batteryLevel - current battery level in percent.</li>
<li>fertility - Values for the fertilizer content</li>
<li>firmware - current device firmware</li>
<li>lux - current light intensity</li>
<li>moisture - current moisture content</li>
<li>temperature - current temperature</li>
</ul>
<br><br>
<a name="XiaomiFlowerSensset"></a>
<b>Set</b>
<ul>
<li>statusRequest - retrieves the current state of the Xiaomi Flower Monitor.</li>
2017-02-13 20:36:50 +00:00
<li>clearFirmwareReading - clear firmware reading for new begin.</li>
2017-01-12 13:44:23 +00:00
<br>
</ul>
<br><br>
<a name="XiaomiFlowerSensattribut"></a>
2017-01-12 13:44:23 +00:00
<b>Attributes</b>
<ul>
<li>disable - disables the device</li>
2017-01-12 13:44:23 +00:00
<li>interval - interval in seconds for statusRequest</li>
<li>minFertility - min fertility value for low warn event</li>
<li>maxFertility - max fertility value for High warn event</li>
<li>minMoisture - min moisture value for low warn event</li>
<li>maxMoisture - max moisture value for High warn event</li>
<li>minTemp - min temperature value for low warn event</li>
<li>maxTemp - max temperature value for high warn event</li>
<li>minlux - min lux value for low warn event</li>
<li>maxlux - max lux value for high warn event
2017-01-12 13:44:23 +00:00
<br>
Event Example for min/max Value's: 2017-03-16 11:08:05 XiaomiFlowerSens Dracaena minMoisture low<br>
2017-03-17 16:54:59 +00:00
Event Example for min/max Value's: 2017-03-16 11:08:06 XiaomiFlowerSens Dracaena maxTemp high</li>
<li>sshHost - FQD-Name or IP of ssh remote system / you must configure your ssh system for certificate authentication. For better handling you can config ssh Client with .ssh/config file</li>
2017-01-12 13:44:23 +00:00
</ul>
</ul>
2016-11-13 09:47:15 +00:00
2017-01-12 13:44:23 +00:00
=end html
2016-11-13 09:47:15 +00:00
=begin html_DE
<a name="XiaomiFlowerSens"></a>
<h3>Xiaomi Flower Monitor</h3>
<ul>
<u><b>XiaomiFlowerSens - liest Daten von einem Xiaomi Flower Monitor</b></u>
<br />
Dieser Modul liest Daten von einem Sensor und legt sie in den Readings ab.<br />
Auf dem (Linux) FHEM-Server werden gatttool und hcitool vorausgesetzt. (sudo apt install bluez)
<br /><br />
<a name="XiaomiFlowerSensdefine"></a>
<b>Define</b>
<ul><br />
<code>define &lt;name&gt; XiaomiFlowerSens &lt;BT-MAC&gt;</code>
<br /><br />
Beispiel:
<ul><br />
<code>define Weihnachtskaktus XiaomiFlowerSens C4:7C:8D:62:42:6F</code><br />
</ul>
<br />
Der Befehl legt ein Device vom Typ XiaomiFlowerSens an mit dem Namen Weihnachtskaktus und der Bluetooth MAC C4:7C:8D:62:42:6F.<br />
Nach dem Anlegen des Device werden umgehend und automatisch die aktuellen Daten vom betroffenen Xiaomi Flower Monitor gelesen.
</ul>
<br /><br />
<a name="XiaomiFlowerSensreadings"></a>
<b>Readings</b>
<ul>
<li>state - Status des Flower Monitor oder eine Fehlermeldung falls Fehler beim letzten Kontakt auftraten.</li>
<li>battery - aktueller Batterie-Status in Abhängigkeit vom Wert batteryLevel.</li>
<li>batteryLevel - aktueller Ladestand der Batterie in Prozent.</li>
<li>fertility - Wert des Fruchtbarkeitssensors (Bodenleitf&auml;higkeit)</li>
<li>firmware - aktuelle Firmware-Version des Flower Monitor</li>
<li>lux - aktuelle Lichtintensit&auml;t</li>
<li>moisture - aktueller Feuchtigkeitswert</li>
<li>temperature - aktuelle Temperatur</li>
</ul>
<br /><br />
<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="XiaomiFlowerSensattribut"></a>
<b>Attribute</b>
<ul>
<li>disable - deaktiviert das Device</li>
<li>interval - Interval in Sekunden zwischen zwei Abfragen</li>
<li>minFertility - min Fruchtbarkeits-Grenzwert f&uuml;r ein Ereignis minFertility low </li>
<li>maxFertility - max Fruchtbarkeits-Grenzwert f&uuml;r ein Ereignis maxFertility high </li>
<li>minMoisture - min Feuchtigkeits-Grenzwert f&uuml;r ein Ereignis minMoisture low </li>
<li>maxMoisture - max Feuchtigkeits-Grenzwert f&uuml;r ein Ereignis maxMoisture high </li>
<li>minTemp - min Temperatur-Grenzwert f&uuml;r ein Ereignis minTemp low </li>
<li>maxTemp - max Temperatur-Grenzwert f&uuml;r ein Ereignis maxTemp high </li>
<li>minlux - min Helligkeits-Grenzwert f&uuml;r ein Ereignis minlux low </li>
<li>maxlux - max Helligkeits-Grenzwert f&uuml;r ein Ereignis maxlux high
<br /><br />Beispiele f&uuml;r min/max-Ereignisse:<br />
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>
</ul>
</ul>
2016-11-13 09:47:15 +00:00
=end html_DE
2017-01-05 12:57:20 +00:00
=cut