foo 12 and bar off.
+ Data to and from the physical device is processed as is. In particular, if you need to send a line feed you have to explicitely send a \n control character. On the other hand, control characters like line feeds are not stripped from the data received. This needs to be considered when defining a class definition.
For debugging purposes, especially when designing a class definition, it is advisable to turn traffic logging on. Use attr myECMD logTraffic 3 to log all data to and from the physical device at level 3. A typical response might look like 21.2\n, i.e. a floating point number followed by a newline.
- Data received from the physical device is processed as it comes in chunks. If for some reason a datagram from the device is split in transit, pattern matching and processing will most likely fail.
+ Data received from the physical device is processed as it comes in chunks. If for some reason a datagram from the device is split in transit, pattern matching and processing will most likely fail. You can use the partial attribute to make FHEM collect and recombine the chunks.
@@ -714,7 +727,9 @@ ECMD_Write($$$)
set <commandname> expect "<regex>"
get <commandname> expect "<regex>"
- Declares what FHEM expects to receive after the execution of the get or set command <commandname>. <regex> is a Perl regular expression. The double quotes around the regular expression are mandatory and they are not part of the regular expression itself. Particularly, broken connections can only be detected if something is expected (see Connection error handling).
+ Declares what FHEM expects to receive after the execution of the get or set command <commandname>. <regex> is a Perl regular expression. The double quotes around the regular expression are mandatory and they are not part of the regular expression itself.
+ <regex> must match the entire reply, as in m/^<regex>$/.
+ Particularly, broken connections can only be detected if something is expected (see Connection error handling).
@@ -740,6 +755,7 @@ ECMD_Write($$$)
reading <reading> match "<regex>"
Declares a new reading named <reading>. A spontaneous data transmission from the physical device that matches the Perl regular expression <regex> is evaluated to become the value of the named reading. All ECMDDevice devices belonging to the ECMD device with readings with matching regular expressions will receive an update of the said readings.
+ <regex> must match the entire reply, as in m/^<regex>$/.
diff --git a/fhem/FHEM/67_ECMDDevice.pm b/fhem/FHEM/67_ECMDDevice.pm
index cab51c05f..90815b135 100644
--- a/fhem/FHEM/67_ECMDDevice.pm
+++ b/fhem/FHEM/67_ECMDDevice.pm
@@ -264,6 +264,41 @@ ECMDDevice_Parse($$)
my @matches;
my $name= $IOhash->{NAME};
+ my $ts= gettimeofday();
+
+ if(defined(AttrVal($name, "partial", undef))) {
+
+ if(!defined($IOhash->{fhem}{partial})) {
+ $IOhash->{fhem}{partial}{ts}= $ts;
+ $IOhash->{fhem}{partial}{msg}= "";
+ }
+
+ #Debug "$name: partial message \"" . escapeLogLine($IOhash->{fhem}{partial}{msg}) . "\" recorded at $ts";
+ if($IOhash->{fhem}{partial}{msg} ne "") {
+ # clear partial message if expired
+ my $timeout= AttrVal($name, "partial", 1);
+ my $t0= $IOhash->{fhem}{partial}{ts};
+ if($ts-$t0> $timeout) {
+ $IOhash->{fhem}{partial}{msg}= "";
+ #Debug "$name: partial message expired.";
+ }
+ }
+
+ # prepend to recently received message
+ $IOhash->{fhem}{partial}{ts}= $ts;
+ $message= $IOhash->{fhem}{partial}{msg} . $message;
+ $IOhash->{fhem}{partial}{msg}= "";
+
+ } else {
+
+ # clean the partial stuff for clarity
+ if(defined($IOhash->{fhem}{partial})) {
+ delete($IOhash->{fhem}{partial})
+ }
+ }
+
+ #Debug "$name: analyzing \"" . escapeLogLine($message) . "\".";
+
my @msgs;
if(defined(AttrVal($name, "split", undef))) {
@msgs= split(AttrVal($name, "split", undef), $message);
@@ -271,8 +306,13 @@ ECMDDevice_Parse($$)
push @msgs, $message;
}
+ #my @unmatchedMsgs; # future use
+ my $lastMsg= "";
+ my $msgMatched;
+
foreach my $msg (@msgs) {
- #Debug "Trying to find a match for \"" . escapeLogLine($msg) ."\"";
+ #Debug "$name: trying to find a match for \"" . escapeLogLine($msg) ."\"";
+ $msgMatched= 0;
# walk over all clients
foreach my $d (keys %defs) {
my $hash= $defs{$d};
@@ -288,9 +328,10 @@ ECMDDevice_Parse($$)
foreach my $r (keys %{$classDef->{readings}}) {
my $regex= ECMDDevice_ReplaceSpecials($classDef->{readings}{$r}{match}, %specials);
#Debug " Trying to match reading $r with regular expressing \"$regex\".";
- if($msg =~ m/$regex/) {
+ if($msg =~ m/^$regex$/) {
# we found a match
Log3 $IOhash, 5, "$name: match regex $regex for reading $r of device $d with class $classname";
+ $msgMatched++;
push @matches, $d;
my $postproc= $classDef->{readings}{$r}{postproc};
my $value= ECMDDevice_PostProc($hash, $postproc, $msg);
@@ -300,12 +341,28 @@ ECMDDevice_Parse($$)
}
}
}
-
+ #push @unmatchedMsgs, $msg unless($msgMatched); # future use
}
+ $lastMsg= $msgs[$#msgs] unless($msgMatched); # contains the last message if the last message is unmatched
+ if(defined(AttrVal($name, "partial", undef)) && $lastMsg ne "") {
+ # we come here if the last message was unmatched and we want partial messages
+ if($#msgs>= 0) {
+ # we had more messages; therefore the partial message belonged to the first message and needs
+ # to be cleared
+ $IOhash->{fhem}{partial}{msg}= "";
+ }
+ $IOhash->{fhem}{partial}{msg}.= $lastMsg; # append unmatched message
+ #Debug "$name: partial message \"" . escapeLogLine($IOhash->{fhem}{partial}{msg}) . "\" kept.";
+ }
+
return @matches if(@matches);
+
+ # we come here if no match is found
+
# NOTE: In a split message, undefined messages are not reported if there was at least one match.
- return "UNDEFINED ECMDDevice message $message";
+ # return "UNDEFINED ECMDDevice message $message";
+ return "";
}