FHEM/mod-XiaomiBTLESens
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

clean Code, seperated Sub for read BatFw Data

Browse Source
This commit is contained in:
Marko Oldenburg
2017-04-07 13:04:54 +02:00
parent ea1b33f216
commit 541ca25a65
1 changed files with 131 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
74_XiaomiFlowerSens.pm
View File

@@ -35,7 +35,8 @@ use POSIX;
use JSON; use JSON;
use Blocking; use Blocking;
my $version = "0.9.18";
my $version = "1.1.0";
@@ -50,9 +51,9 @@ sub XiaomiFlowerSens_stateRequestTimer($);
sub XiaomiFlowerSens_Set($$@); sub XiaomiFlowerSens_Set($$@);
sub XiaomiFlowerSens_Run($); sub XiaomiFlowerSens_Run($);
sub XiaomiFlowerSens_BlockingRun($); sub XiaomiFlowerSens_BlockingRun($);
sub XiaomiFlowerSens_callGatttool($@); sub XiaomiFlowerSens_gattSensorData($);
sub XiaomiFlowerSens_forRun_encodeJSON($$); sub XiaomiFlowerSens_gattBatFwData($);
sub XiaomiFlowerSens_forDone_encodeJSON($$$$$$); sub XiaomiFlowerSens_forDone_encodeJSON(@);
sub XiaomiFlowerSens_BlockingDone($); sub XiaomiFlowerSens_BlockingDone($);
sub XiaomiFlowerSens_BlockingAborted($); sub XiaomiFlowerSens_BlockingAborted($);
@@ -77,6 +78,8 @@ sub XiaomiFlowerSens_Initialize($) {
"maxTemp ". "maxTemp ".
"minMoisture ". "minMoisture ".
"maxMoisture ". "maxMoisture ".
"minLux ".
"maxLux ".
"sshHost ". "sshHost ".
$readingFnAttributes; $readingFnAttributes;
@@ -257,13 +260,29 @@ sub XiaomiFlowerSens_Set($$@) {
sub XiaomiFlowerSens_Run($) { sub XiaomiFlowerSens_Run($) {
my ( $hash, $cmd ) = @_; my $hash = shift;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
$hash->{helper}{RUNNING_PID} = BlockingCall("XiaomiFlowerSens_BlockingRun", $name, "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", "read data", 1 ) if( ReadingsVal($name, "state", 0) eq "active" );
}
sub XiaomiFlowerSens_BlockingRun($) {
my $name = shift;
my $hci = AttrVal($name,"hciDevice","hci0");
my $sshHost = AttrVal($name,"sshHost","none");
my $mac = $hash->{BTMAC}; my $mac = $hash->{BTMAC};
my $wresp;
my @readSensData;
my @readBatFwData;
my $wfr; my $wfr;
if( ReadingsVal($name, 'firmware', '') eq "2.6.2" ) { if( ReadingsVal($name, 'firmware', '') eq "2.6.2" ) {
$wfr = 0; $wfr = 0;
} else { } else {
@@ -271,30 +290,12 @@ sub XiaomiFlowerSens_Run($) {
} }
my $response_encode = XiaomiFlowerSens_forRun_encodeJSON($mac,$wfr);
$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"; Log3 $name, 4, "Sub XiaomiFlowerSens_BlockingRun ($name) - Running nonBlocking";
##### call sensor data ##### call sensor data
my ($sensData,$batFwData) = XiaomiFlowerSens_callGatttool($name,$mac,$wfr); my ($sensData,$batFwData) = XiaomiFlowerSens_callGatttool($name);
Log3 $name, 4, "Sub XiaomiFlowerSens_BlockingRun ($name) - Processing response data: $sensData"; Log3 $name, 4, "Sub XiaomiFlowerSens_BlockingRun ($name) - Processing response data: $sensData";
@@ -347,16 +348,12 @@ sub XiaomiFlowerSens_BlockingRun($) {
return "$name|$response_encode"; return "$name|$response_encode";
} }
sub XiaomiFlowerSens_callGatttool($@) { sub XiaomiFlowerSens_gattSensorData($) {
my ($name,$mac,$wfr) = @_; my $name = shift;
my $hci = AttrVal($name,"hciDevice","hci0");
my $loop; my $loop;
my $wresp; my $wresp;
my $sshHost = AttrVal($name,"sshHost","none");
my @readSensData;
my @readBatFwData;
$loop = 0; $loop = 0;
@@ -380,7 +377,6 @@ sub XiaomiFlowerSens_callGatttool($@) {
} }
#### Read Sensor Data #### Read Sensor Data
## support for Firmware 2.6.6, man muß erst einen Characterwert schreiben ## support for Firmware 2.6.6, man muß erst einen Characterwert schreiben
@@ -416,12 +412,12 @@ sub XiaomiFlowerSens_callGatttool($@) {
if( $sshHost ne 'none' ) { if( $sshHost ne 'none' ) {
@readSensData = split(": ",qx(ssh $sshHost 'gatttool -i $hci -b $mac --char-read -a 0x35 2>&1 /dev/null')); @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"; Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - read data from host $sshHost";
} else { } else {
@readSensData = split(": ",qx(gatttool -i $hci -b $mac --char-read -a 0x35 2>&1 /dev/null)); @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"; Log3 $name, 4, "Sub XiaomiFlowerSens_callGatttool ($name) - read data from local host";
} }
$loop++; $loop++;
@@ -436,6 +432,16 @@ sub XiaomiFlowerSens_callGatttool($@) {
unless( $readSensData[0] =~ /^Characteristic value\/descriptor$/ ); unless( $readSensData[0] =~ /^Characteristic value\/descriptor$/ );
### no Error in data string
return $readSensData[1];
}
sub XiaomiFlowerSens_gattBatFwData($) {
my $name = shift;
my $loop;
### Read Firmware and Battery Data ### Read Firmware and Battery Data
$loop = 0; $loop = 0;
do { do {
@@ -462,25 +468,11 @@ sub XiaomiFlowerSens_callGatttool($@) {
unless( $readBatFwData[0] =~ /^Characteristic value\/descriptor$/ ); unless( $readBatFwData[0] =~ /^Characteristic value\/descriptor$/ );
### no Error in data string ### no Error in data string
return ($readSensData[1],$readBatFwData[1]) return $readBatFwData[1];
} }
sub XiaomiFlowerSens_forRun_encodeJSON($$) { sub XiaomiFlowerSens_forDone_encodeJSON(@) {
my ($mac,$wfr) = @_;
my %data = (
'mac' => $mac,
'wfr' => $wfr
);
return encode_json \%data;
}
sub XiaomiFlowerSens_forDone_encodeJSON($$$$$$) {
my ($temp,$lux,$moisture,$fertility,$blevel,$fw) = @_; my ($temp,$lux,$moisture,$fertility,$blevel,$fw) = @_;
@@ -545,7 +537,7 @@ sub XiaomiFlowerSens_BlockingDone($) {
readingsBulkUpdate($hash, "moisture", $response_json->{moisture}); readingsBulkUpdate($hash, "moisture", $response_json->{moisture});
readingsBulkUpdate($hash, "fertility", $response_json->{fertility}); readingsBulkUpdate($hash, "fertility", $response_json->{fertility});
readingsBulkUpdate($hash, "firmware", $response_json->{firmware}); 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" ); readingsBulkUpdate($hash, "state", "active") if( ReadingsVal($name,"state", 0) eq "read data" or ReadingsVal($name,"state", 0) eq "unreachable" or ReadingsVal($name,"state", 0) eq "corrupted data" );
readingsEndUpdate($hash,1); readingsEndUpdate($hash,1);
@@ -559,6 +551,9 @@ sub XiaomiFlowerSens_BlockingDone($) {
DoTrigger($name, 'minMoisture ' . ($response_json->{moisture}<AttrVal($name,'minMoisture',0)?'low':'ok')) if( AttrVal($name,'minMoisture','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, '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!"; Log3 $name, 4, "Sub XiaomiFlowerSens_BlockingDone ($name) - Abschluss!";
} }
@@ -645,18 +640,20 @@ sub XiaomiFlowerSens_BlockingAborted($) {
<a name="XiaomiFlowerSensattribut"></a> <a name="XiaomiFlowerSensattribut"></a>
<b>Attributes</b> <b>Attributes</b>
<ul> <ul>
<li>disable - disables the Nuki device</li> <li>disable - disables the device</li>
<li>interval - interval in seconds for statusRequest</li> <li>interval - interval in seconds for statusRequest</li>
<li>minFertility - min fertility value befor low warn event</li> <li>minFertility - min fertility value for low warn event</li>
<li>maxFertility - max fertility value befor High warn event</li> <li>maxFertility - max fertility value for High warn event</li>
<li>minMoisture - min moisture value befor low warn event</li> <li>minMoisture - min moisture value for low warn event</li>
<li>maxMoisture - max moisture value befor High warn event</li> <li>maxMoisture - max moisture value for High warn event</li>
<li>minTemp - min temperature value befor low warn event</li> <li>minTemp - min temperature value for low warn event</li>
<li>maxTemp - max temperature value befor high warn event <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
<br> <br>
Event Example for min/max Value's: 2017-03-16 11:08:05 XiaomiFlowerSens Dracaena minMoisture low<br> Event Example for min/max Value's: 2017-03-16 11:08:05 XiaomiFlowerSens Dracaena minMoisture low<br>
Event Example for min/max Value's: 2017-03-16 11:08:06 XiaomiFlowerSens Dracaena maxTemp high</li> 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</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>
</ul> </ul>
</ul> </ul>
@@ -664,6 +661,69 @@ sub XiaomiFlowerSens_BlockingAborted($) {
=begin html_DE =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>
=end html_DE =end html_DE
=cut =cut