mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-01-31 06:39:11 +00:00
90_SIGNALduino_un.pm:
- fix some perlcritic hints - revised commandref git-svn-id: https://svn.fhem.de/fhem/trunk@25483 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
sidey79
parent
c343e2398b
commit
670a669593
@ -1,5 +1,8 @@
|
||||
# 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.
|
||||
- change: 90_SIGNALduino_un.pm
|
||||
fix some PerlCritic hints (#914)
|
||||
revised commandref
|
||||
- feature: 00_SIGNALduino.pm version 3.5.2
|
||||
xFSK processing
|
||||
Added support for directio and none.
|
||||
|
||||
@ -4,8 +4,9 @@
|
||||
# The file is part of the SIGNALduino project
|
||||
# see http://www.fhemwiki.de/wiki/SIGNALduino to support debugging of unknown signal data
|
||||
# The purpos is to use it as addition to the SIGNALduino
|
||||
# S. Butzek, 2015 | HomeAuto_User & elektron-bbs - 2018
|
||||
#
|
||||
# 2015-2018 S.Butzek
|
||||
# 2018-2020 S.Butzek, HomeAutoUser, elektron-bbs
|
||||
|
||||
package main;
|
||||
|
||||
@ -13,37 +14,35 @@ use strict;
|
||||
use warnings;
|
||||
use POSIX;
|
||||
use List::Util qw(any); # for any function
|
||||
use lib::SD_Protocols; # for any function
|
||||
|
||||
my @bitcountlength = (0,0,0); # array min|default|max
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_Initialize($)
|
||||
{
|
||||
sub SIGNALduino_un_Initialize {
|
||||
my ($hash) = @_;
|
||||
|
||||
|
||||
$hash->{Match} = '^[u]\d+(?:.\d)?#.*';
|
||||
$hash->{DefFn} = "SIGNALduino_un_Define";
|
||||
$hash->{UndefFn} = "SIGNALduino_un_Undef";
|
||||
$hash->{AttrFn} = "SIGNALduino_un_Attr";
|
||||
$hash->{SetFn} = "SIGNALduino_un_Set";
|
||||
$hash->{ParseFn} = "SIGNALduino_un_Parse";
|
||||
$hash->{AttrList} = "IODev do_not_notify:0,1 stateFormat showtime:0,1 ignore:0,1 ".$readingFnAttributes;
|
||||
$hash->{DefFn} = \&SIGNALduino_un_Define;
|
||||
$hash->{UndefFn} = \&SIGNALduino_un_Undef;
|
||||
$hash->{AttrFn} = \&SIGNALduino_un_Attr;
|
||||
$hash->{SetFn} = \&SIGNALduino_un_Set;
|
||||
$hash->{ParseFn} = \&SIGNALduino_un_Parse;
|
||||
$hash->{AttrList} = 'IODev do_not_notify:0,1 stateFormat showtime:0,1 ignore:0,1 '.$readingFnAttributes;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_Define($$)
|
||||
{
|
||||
sub SIGNALduino_un_Define {
|
||||
my ($hash, $def) = @_;
|
||||
my @a = split("[ \t][ \t]*", $def);
|
||||
|
||||
return " wrong syntax: define <name> SIGNALduino_un <code> <optional IODEV> (".int(@a).")" if(int(@a) < 3 || int(@a) > 4);
|
||||
return ' wrong syntax: define <name> SIGNALduino_un <code> <optional IODEV> ('.int(@a).')' if(int(@a) < 3 || int(@a) > 4);
|
||||
|
||||
$hash->{lastMSG} = "";
|
||||
$hash->{bitMSG} = "";
|
||||
$hash->{STATE} = "Defined";
|
||||
$hash->{lastMSG} = '';
|
||||
$hash->{bitMSG} = '';
|
||||
$hash->{STATE} = 'Defined';
|
||||
my $name = $hash->{NAME};
|
||||
|
||||
my $iodevice = $a[3] if($a[3]);
|
||||
@ -58,16 +57,15 @@ SIGNALduino_un_Define($$)
|
||||
}
|
||||
|
||||
AssignIoPort($hash, $iodevice);
|
||||
return;
|
||||
}
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_Undef($$)
|
||||
{
|
||||
sub SIGNALduino_un_Undef {
|
||||
my ($hash, $name) = @_;
|
||||
delete($modules{SIGNALduino_un}{defptr}{$hash->{DEF}}) if($hash && $hash->{DEF});
|
||||
delete($modules{SIGNALduino_un}{defptr}{ioname}) if (exists $modules{SIGNALduino_un}{defptr}{ioname});
|
||||
return undef;
|
||||
return;
|
||||
}
|
||||
|
||||
#####################################
|
||||
@ -79,19 +77,17 @@ sub SIGNALduino_un_hex2bin {
|
||||
}
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_Parse($$)
|
||||
{
|
||||
sub SIGNALduino_un_Parse {
|
||||
my ($hash,$msg) = @_;
|
||||
my @a = split("", $msg);
|
||||
my $name = "SIGNALduino_unknown";# $hash->{NAME};
|
||||
my $name = 'SIGNALduino_unknown'; # $hash->{NAME};
|
||||
my $ioname = $hash->{NAME};
|
||||
Log3 $hash, 4, "$name incomming msg: $msg";
|
||||
#my $rawData=substr($msg,2);
|
||||
|
||||
my ($protocol,$rawData) = split("#",$msg);
|
||||
|
||||
my $dummyreturnvalue= "Unknown, please report";
|
||||
my $dummyreturnvalue= 'Unknown, please report';
|
||||
$protocol=~ s/^[uP](\d+)/$1/; # extract protocol
|
||||
|
||||
Log3 $hash, 4, "$name rawData: $rawData";
|
||||
@ -106,28 +102,22 @@ SIGNALduino_un_Parse($$)
|
||||
{
|
||||
Log3 $hash, 4, "$name / Einhell doorshutter received";
|
||||
|
||||
|
||||
my $id = oct("0b".substr($bitData,0,28));
|
||||
|
||||
my $dir = oct("0b".substr($bitData,28,2));
|
||||
|
||||
my $channel = oct("0b".substr($bitData,30,3));
|
||||
|
||||
|
||||
Log3 $hash, 4, "$name found doorshutter from Einhell. id=$id, channel=$channel, direction=$dir";
|
||||
} elsif ($protocol == 23 && length($bitData)>=32) ##Perl Sensor
|
||||
{
|
||||
my $SensorTyp = "perl NC-7367?";
|
||||
my $SensorTyp = 'perl NC-7367?';
|
||||
my $id = oct ("0b".substr($bitData,4,4));
|
||||
my $channel = SIGNALduino_un_bin2dec(substr($bitData,9,3))+1;
|
||||
my $temp = oct ("0b".substr($bitData,20,8))/10;
|
||||
my $bat = int(substr($bitData,8,1)) eq "1" ? "ok" : "critical"; # Eventuell falsch!
|
||||
my $sendMode = int(substr($bitData,4,1)) eq "1" ? "auto" : "manual"; # Eventuell falsch!
|
||||
my $bat = int(substr($bitData,8,1)) eq "1" ? 'ok' : 'critical'; # Eventuell falsch!
|
||||
my $sendMode = int(substr($bitData,4,1)) eq "1" ? 'auto' : 'manual'; # Eventuell falsch!
|
||||
my $type = SIGNALduino_un_bin2dec(substr($bitData,0,4));
|
||||
|
||||
Log3 $hash, 4, "$name decoded protocolid: 7 ($SensorTyp / type=$type) mode=$sendMode, sensor id=$id, channel=$channel, temp=$temp, bat=$bat\n" ;
|
||||
|
||||
|
||||
}
|
||||
|
||||
##############################################################################################
|
||||
@ -135,20 +125,20 @@ SIGNALduino_un_Parse($$)
|
||||
# version 2) message with u..# and development y attribut -> no message for Unknown code
|
||||
##############################################################################################
|
||||
|
||||
my $value = AttrVal($ioname, "development", "");
|
||||
my @delevopmentargs = split (",",$value);
|
||||
my $value = AttrVal($ioname, 'development', '');
|
||||
my @delevopmentargs = split (',',$value);
|
||||
|
||||
if ($value =~ m/([umyp]$protocol|1)/g) { # check for u|m|y|p|1 development (u|m|y|p downwards compatibility)
|
||||
### Help Device + Logfile ###
|
||||
Log3 $hash, 5, "$name: $ioname Protocol $1$protocol found in AttrVal development!";
|
||||
|
||||
my $def;
|
||||
my $devicedef = $name."_".$protocol;
|
||||
my $devicedef = $name.'_'.$protocol;
|
||||
$def = $modules{SIGNALduino_un}{defptr}{$devicedef} if(!$def);
|
||||
$modules{SIGNALduino_un}{defptr}{ioname} = $ioname;
|
||||
|
||||
if(!$def) {
|
||||
Log3 $ioname, 1, "$ioname: $name UNDEFINED sensor " . $devicedef . " detected";
|
||||
Log3 $ioname, 1, "$ioname: $name UNDEFINED sensor " . $devicedef . ' detected';
|
||||
return "UNDEFINED $devicedef SIGNALduino_un $devicedef";
|
||||
}
|
||||
|
||||
@ -174,26 +164,25 @@ SIGNALduino_un_Parse($$)
|
||||
}
|
||||
|
||||
$bitcountlength[1] = $bitcount;
|
||||
readingsSingleUpdate($hash, "bitCountLength", "$bitcountlength[0] to $bitcountlength[2]" ,0);
|
||||
readingsSingleUpdate($hash, 'bitCountLength', "$bitcountlength[0] to $bitcountlength[2]" ,0);
|
||||
}
|
||||
|
||||
my $hexcount = length($rawData);
|
||||
my $bitDataInvert = $bitData;
|
||||
$bitDataInvert =~ tr/01/10/; # invert message and check if it is possible to deocde now
|
||||
my $rawDataInvert = SIGNALduino_b2h($bitDataInvert);
|
||||
|
||||
my $seconds = ReadingsAge($name, "state", 0);
|
||||
my $rawDataInvert = lib::SD_Protocols::binStr2hexStr($bitDataInvert);
|
||||
my $seconds = ReadingsAge($name, 'state', 0);
|
||||
|
||||
readingsBeginUpdate($hash);
|
||||
readingsBulkUpdate($hash, "state", $rawData,0);
|
||||
readingsBulkUpdate($hash, "bitMsg", $bitData);
|
||||
readingsBulkUpdate($hash, "bitMsg_invert", $bitDataInvert);
|
||||
readingsBulkUpdate($hash, "bitCount", $bitcount);
|
||||
readingsBulkUpdate($hash, "hexMsg", $rawData);
|
||||
readingsBulkUpdate($hash, "hexMsg_invert", $rawDataInvert);
|
||||
readingsBulkUpdate($hash, "hexCount_or_nibble", $hexcount);
|
||||
readingsBulkUpdate($hash, "lastInputDev", $ioname);
|
||||
readingsBulkUpdate($hash, "past_seconds", $seconds);
|
||||
readingsBulkUpdate($hash, 'state', $rawData,0);
|
||||
readingsBulkUpdate($hash, 'bitMsg', $bitData);
|
||||
readingsBulkUpdate($hash, 'bitMsg_invert', $bitDataInvert);
|
||||
readingsBulkUpdate($hash, 'bitCount', $bitcount);
|
||||
readingsBulkUpdate($hash, 'hexMsg', $rawData);
|
||||
readingsBulkUpdate($hash, 'hexMsg_invert', $rawDataInvert);
|
||||
readingsBulkUpdate($hash, 'hexCount_or_nibble', $hexcount);
|
||||
readingsBulkUpdate($hash, 'lastInputDev', $ioname);
|
||||
readingsBulkUpdate($hash, 'past_seconds', $seconds);
|
||||
readingsEndUpdate($hash, 1); # Notify is done by Dispatch
|
||||
|
||||
### Example Logfile ###
|
||||
@ -209,100 +198,84 @@ SIGNALduino_un_Parse($$)
|
||||
return $name;
|
||||
} else {
|
||||
### nothing - Info ###
|
||||
my $value = AttrVal($ioname, "development", ""); # read attr development from IODev
|
||||
my $value = AttrVal($ioname, 'development', ''); # read attr development from IODev
|
||||
|
||||
if ($value ne "") {
|
||||
$value .= ","; # some definitions already exist, so prepend a new one
|
||||
if ($value ne '') {
|
||||
$value .= ','; # some definitions already exist, so prepend a new one
|
||||
}
|
||||
$value .= "u$protocol";
|
||||
Log3 $hash, 4, "$name $ioname Protocol:$protocol | To help decode or debug, please add u$protocol! (attr $ioname development $value)" if ($protocol); # To help decode or debug, please add u84! (attr sduino_dummy development u84)
|
||||
}
|
||||
############################
|
||||
|
||||
|
||||
Log3 $hash, 4, $dummyreturnvalue;
|
||||
return undef;
|
||||
return;
|
||||
}
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_Set($$$@)
|
||||
{
|
||||
sub SIGNALduino_un_Set {
|
||||
my ( $hash, $name, @a ) = @_;
|
||||
my $ret = "UserInfo";
|
||||
my $ret = 'UserInfo';
|
||||
|
||||
if ($a[0] ne "?") {
|
||||
if ($a[0] ne '?') {
|
||||
my $input = join " ", @a[1 .. (scalar(@a)-1)]; # Teile der Eingabe zusammenfassen
|
||||
return "wrong argument! please use $ret argument and one comment." if($a[0] ne "UserInfo" || not $a[1]);
|
||||
return "wrong argument! please use $ret argument and one comment." if($a[0] ne 'UserInfo' || not $a[1]);
|
||||
|
||||
readingsBeginUpdate($hash);
|
||||
readingsBulkUpdate($hash, "state" , "UserMSG",0);
|
||||
readingsBulkUpdate($hash, "UserMSG", $input) if (defined($input));
|
||||
readingsBulkUpdate($hash, 'state' , 'UserMSG',0);
|
||||
readingsBulkUpdate($hash, 'UserMSG', $input) if (defined($input));
|
||||
readingsEndUpdate($hash, 1); # Notify is done by Dispatch
|
||||
|
||||
return undef; # undef because user is in same windows without message, better to use
|
||||
#return "Thanks";
|
||||
return; # because user is in same windows without message, better to use
|
||||
}
|
||||
|
||||
return $ret;
|
||||
}
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_Attr(@)
|
||||
{
|
||||
sub SIGNALduino_un_Attr {
|
||||
my @a = @_;
|
||||
|
||||
# Make possible to use the same code for different logical devices when they
|
||||
# are received through different physical devices.
|
||||
return if($a[0] ne "set" || $a[2] ne "IODev");
|
||||
return if($a[0] ne 'set' || $a[2] ne 'IODev');
|
||||
my $hash = $defs{$a[1]};
|
||||
my $iohash = $defs{$a[3]};
|
||||
my $cde = $hash->{DEF};
|
||||
|
||||
#delete($modules{SIGNALduino_un}{defptr}{$cde});
|
||||
#$modules{SIGNALduino_un}{defptr}{$iohash->{NAME} . "." . $cde} = $hash;
|
||||
return undef;
|
||||
return;
|
||||
}
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_binaryToNumber
|
||||
{
|
||||
sub SIGNALduino_un_binaryToNumber {
|
||||
my $binstr=shift;
|
||||
my $fbit=shift;
|
||||
my $lbit=$fbit;
|
||||
$lbit=shift if @_;
|
||||
|
||||
|
||||
return oct("0b".substr($binstr,$fbit,($lbit-$fbit)+1));
|
||||
|
||||
}
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_binaryToBoolean
|
||||
{
|
||||
sub SIGNALduino_un_binaryToBoolean {
|
||||
return int(SIGNALduino_un_binaryToNumber(@_));
|
||||
}
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_bin2dec($)
|
||||
{
|
||||
sub SIGNALduino_un_bin2dec {
|
||||
my $h = shift;
|
||||
my $int = unpack("N", pack("B32",substr("0" x 32 . $h, -32)));
|
||||
return sprintf("%d", $int);
|
||||
}
|
||||
|
||||
#####################################
|
||||
sub
|
||||
SIGNALduino_un_binflip($)
|
||||
{
|
||||
sub SIGNALduino_un_binflip {
|
||||
my $h = shift;
|
||||
my $hlen = length($h);
|
||||
my $i = 0;
|
||||
my $flip = "";
|
||||
my $flip = '';
|
||||
|
||||
for ($i=$hlen-1; $i >= 0; $i--) {
|
||||
$flip = $flip.substr($h,$i,1);
|
||||
@ -322,9 +295,10 @@ SIGNALduino_un_binflip($)
|
||||
<h3>SIGNALduino_un</h3>
|
||||
<ul>
|
||||
The SIGNALduino_un module is a testing and debugging module to decode some devices, it will catch only all messages from the signalduino which can't be send to another module.<br>
|
||||
It can create one help devices after define development attribute on SIGNALduino device. You get a hint from Verbose 4 in the FHEM Log.<br>
|
||||
<u>example:</u> <code>SIGNALduino_unknown sduino_dummy Protocol:40 | To help decode or debug, please add u40! (attr sduino_dummy development u40)</code>
|
||||
It can create one help devices after define development attribute on SIGNALduino device. You get a hint from Verbose 4 in the FHEM Log.
|
||||
<br><br>
|
||||
<u>example:</u> <code>SIGNALduino_unknown sduino_dummy Protocol:40 | To help decode or debug, please add u40! (attr sduino_dummy development u40)</code>
|
||||
<br><br><br>
|
||||
|
||||
<a name="SIGNALduino_undefine"></a>
|
||||
<b>Define</b>
|
||||
@ -336,18 +310,20 @@ SIGNALduino_un_binflip($)
|
||||
The function of this module is only to output some logging at verbose 4 or higher at FHEM-logfile or logging to help device. May some data is decoded correctly but it's also possible that this does not work.
|
||||
The Module will try to process all messages, which where not handled by other modules.<br><br>
|
||||
Created devices / logfiles must be deleted manually after removing the protocol from the attribute <code> development</code>. (example: u40, y84)
|
||||
|
||||
</ul>
|
||||
<br>
|
||||
<br><br>
|
||||
|
||||
<a name="SIGNALduino_unset"></a>
|
||||
<b>Set</b>
|
||||
<ul>write "comment" - the user can put comments in the logfile which are arranged to his bits of the device<br>
|
||||
(example: to write off the digital display of the thermometer at the time of reception or states of switches ...)</ul>
|
||||
<br>
|
||||
<ul>UserInfo "comment" - the user can put comments in the logfile which are arranged to his bits of the device<br>
|
||||
(example: to write off the digital display of the thermometer at the time of reception or states of switches ...)
|
||||
</ul>
|
||||
<br><br>
|
||||
|
||||
<a name="SIGNALduino_unget"></a>
|
||||
<b>Get</b> <ul>N/A</ul><br>
|
||||
<b>Get</b>
|
||||
<ul>N/A</ul>
|
||||
<br><br>
|
||||
|
||||
<a name="SIGNALduino_unattr"></a>
|
||||
<b>Attributes</b>
|
||||
@ -357,6 +333,7 @@ SIGNALduino_un_binflip($)
|
||||
<li><a href="#verbose">verbose</a></li>
|
||||
</ul>
|
||||
<br><br>
|
||||
|
||||
<a name="SIGNALduino_un_readings"></a>
|
||||
<b>Generated readings</b>
|
||||
<ul>
|
||||
@ -368,6 +345,7 @@ SIGNALduino_un_binflip($)
|
||||
<li>hexMsg</li>
|
||||
<li>hexMsg_invert (Message hexadecimal, inverted)</li>
|
||||
<li>lastInputDev (Device at the last reception)</li>
|
||||
<li>past_seconds (Duration in seconds since the readings were last updated)</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
@ -380,9 +358,10 @@ SIGNALduino_un_binflip($)
|
||||
<ul>
|
||||
Das SIGNALduino_un Modul ist ein Hilfsmodul um unbekannte Nachrichten zu debuggen und analysieren zu können.<br><br>
|
||||
Das Modul legt nur eine Hilfsgerät an mit Logfile der Bits sobald man das Attribut <code>development</code> im Empfänger Device auf das entsprechende unbekannte Protokoll setzt.<br>
|
||||
Einen entsprechenden Hinweis erhalten Sie ab Verbose 4 im FHEM Log.<br>
|
||||
<u>Beispiel:</u> <code>SIGNALduino_unknown sduino_dummy Protocol:40 | To help decode or debug, please add u40! (attr sduino_dummy development u40)</code>
|
||||
Einen entsprechenden Hinweis erhalten Sie ab Verbose 4 im FHEM Log.
|
||||
<br><br>
|
||||
<u>Beispiel:</u> <code>SIGNALduino_unknown sduino_dummy Protocol:40 | To help decode or debug, please add u40! (attr sduino_dummy development u40)</code>
|
||||
<br><br><br>
|
||||
|
||||
<a name="SIGNALduino_undefine"></a>
|
||||
<b>Define</b>
|
||||
@ -397,15 +376,19 @@ SIGNALduino_un_binflip($)
|
||||
<br>
|
||||
Angelegte Geräte / Logfiles müssen manuell gelöscht werden nachdem aus dem Attribut <code>development</code> des SIGNALduinos das zu untersuchende Protokoll entfernt wurde. (Beispiel: u40,y84)
|
||||
</ul>
|
||||
<br>
|
||||
<br><br>
|
||||
|
||||
<a name="SIGNALduino_unset"></a>
|
||||
<b>Set</b>
|
||||
<ul>write "Kommentar" - somit kann der User in das Logfile des Hilfsgerät Kommentare setzen welche zeitlich zu seinen Bits des Gerätes eingeordnet werden<br>
|
||||
(Beispiel: um die Digitalanzeige des Thermometers abzuschreiben zum Zeitpunkt des Empfangs oder Zustände von Schaltern ...)</ul>
|
||||
<br>
|
||||
<ul>UserInfo "Kommentar" - somit kann der User in das Logfile des Hilfsgerät Kommentare setzen welche zeitlich zu seinen Bits des Gerätes eingeordnet werden<br>
|
||||
(Beispiel: um die Digitalanzeige des Thermometers abzuschreiben zum Zeitpunkt des Empfangs oder Zustände von Schaltern ...)
|
||||
</ul>
|
||||
<br><br>
|
||||
|
||||
<a name="SIGNALduino_unget"></a>
|
||||
<b>Get</b> <ul>N/A</ul><br>
|
||||
<b>Get</b>
|
||||
<ul>N/A</ul>
|
||||
<br><br>
|
||||
|
||||
<a name="SIGNALduino_unattr"></a>
|
||||
<b>Attributes</b>
|
||||
@ -415,6 +398,7 @@ SIGNALduino_un_binflip($)
|
||||
<li><a href="#verbose">verbose</a></li>
|
||||
</ul>
|
||||
<br><br>
|
||||
|
||||
<a name="SIGNALduino_un_readings"></a>
|
||||
<b>Generierte Readings</b>
|
||||
<ul>
|
||||
@ -426,6 +410,7 @@ SIGNALduino_un_binflip($)
|
||||
<li>hexMsg</li>
|
||||
<li>hexMsg_invert (Nachricht hexadezimal, invertiert)</li>
|
||||
<li>lastInputDev (Device beim letzten Empfang)</li>
|
||||
<li>past_seconds (Dauer in Sekunden seit der letzten Aktualisierung der Readings)</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user