diff --git a/fhem/FHEM/98_Modbus.pm b/fhem/FHEM/98_Modbus.pm index 3681917d7..4444e88bd 100755 --- a/fhem/FHEM/98_Modbus.pm +++ b/fhem/FHEM/98_Modbus.pm @@ -44,6 +44,7 @@ # 2015-02-26 defaultpoll in poll und defaultpolldelay in polldelay umbenannt # attribute für timing umbenannt # 2015-03-8 added coils / discrete inputs +# # 2015-04-13 Statistics for bus usage # 2015-05-15 fixed bugs in SetIODev # 2015-05-18 alternative statistics / profiling @@ -83,32 +84,39 @@ # 2016-12-27 check for undefined $val in ParseObj and Log with timeoutLogLevel # 2016-12-28 removed RAWBUFFER and added some initiualisation for $ioHash->{helper}{buffer}, fixed logging for timeouts # 2017-01-02 new attribute allowShortResponses -# 2017-01-06 removed misleading log "destination device" at define when IODev Attr is not knon yet. # -# +# 2017-01-06 removed misleading log "destination device" at define when IODev Attr is not knon yet. +# 2017-01-10 call Modbus_Statistics($ioHash, "Timeouts", 0); in EndBusy to keep Reading updated even if no timeout occured +# 2017-01-11 allow reconnect also for serial (add getIOHash in controlSet reconnect) in preparation for a common open +# 2017-01-14 fix timeoutLogLevel usage in ReadAnswer to use physical device attrs instaed of logical device attrs +# use IsDisabled instead of AttrVal, restructure Open calls, +# common NotifyFN for physical and logical devices +# disable for physical devices will even close a serial interface +# fix Module type checking for "Modbus" insted of "MODBUS" +# skip garbage in frames +# 2017-01-18 support for leading zeros in adresses in obj- attributes +# 2017-01-22 check that skipGarbage is only defined for physical device attrs or TCP devices +# parseframes now logs tid only for TCP where it makes sense +# 2017-01-25 changed all expression evals to use a common function and catch warnings +# new attribute ignoreExpr +# 2017-02-11 optimize logging +# 2017-03-12 fix disable for logical attribues (disable ist in PhysAttrs ...) - introduce more global vars for attributes +# # # ToDo / Ideas : -# docu for scanner -# _attr function for physical -> react on disable for serial devices -# catch warnings inside eval of Exprs with $SIG{__WARN__} = (see http://perldoc.perl.org/perlvar.html#%25SIG) -# ignoreExpr um Wert zu ignorieren -# better disabled support - use isDisabled, dont open in define even not physical ... -# don't insist on h1 instead of h001 (check with added 0's)? -# set a flag as soon as one object adr is defined with leading zeros, remember max len of obj with 0s -# if flag is set, modify behavior of ObjInfo +# async output for scan? table? with revregs etc.? +# get object-interpretations h123 -> Alle Variationen mit revregs und bswap und unpacks ... +# nonblocking disable attr für xp # # passive listening to other modbus traffic (state machine, parse requests of others in special queue -# len aus unpack ableiten oder Meldung wenn zu klein # -# nonblocking disable attr für xp # set definition with multiple requests as raw containig opt. readings / input -# attr prüfungen bei attrs, die nur für TCP sinnvoll sind -> ist es ein TCP Device? # map mit spaces wie bei HTTPMOD # :noArg etc. für Hintlist und userattr wie in HTTPMOD optimieren -# Input validation for define if interval is not numeric but TCP ... # -# addToDevAttrList handling for wildcard attributes like in HTTPMOD # Autoconfigure? (Combine testweise erhöhen, Fingerprinting -> DB?, ...?) +# Modbus Slave? separate module? +# Modbus GW feature to translate TCP requests to serial RTU / ASCII requests in Fhem # # @@ -146,17 +154,30 @@ sub ModbusLD_GetUpdate($); sub ModbusLD_GetIOHash($); sub ModbusLD_Send($$$;$$$); -my $Modbus_Version = '3.5.12 - 06.01.2017'; -my $Modbus_PhysAttrs = "queueMax " . +my $Modbus_Version = '3.5.21 - 12.3.2017'; +my $Modbus_PhysAttrs = "queueDelay " . "busDelay " . "clientSwitchDelay " . - "dropQueueDoubles " . + "dropQueueDoubles:0,1 " . "profileInterval " . "openTimeout " . - "timeoutLogLevel " . - "silentReconnect "; + "nextOpenDelay " . + "maxTimeoutsToReconnect " . # for Modbus over TCP/IP only + "skipGarbage:0,1 " . + "timeoutLogLevel:3,4 " . + "silentReconnect:0,1 "; +my $Modbus_LogAttrs = + "queueMax " . + "IODev " . # fhem.pl macht dann $hash->{IODev} = $defs{$ioname} + "alignTime " . + "enableControlSet:0,1 " . + "scanDelay "; + +my $Modbus_CommonAttrs = + "disable:0,1 "; + my %Modbus_errCodes = ( "01" => "illegal function", "02" => "illegal data address", @@ -187,6 +208,7 @@ my %Modbus_defaultFCode = ( ); + ##################################### # _initialize für das physische Basismodul sub Modbus_Initialize($) @@ -195,13 +217,16 @@ sub Modbus_Initialize($) require "$attr{global}{modpath}/FHEM/DevIo.pm"; - $modHash->{ReadFn} = "Modbus_Read"; - $modHash->{ReadyFn} = "Modbus_Ready"; - $modHash->{DefFn} = "Modbus_Define"; - $modHash->{UndefFn} = "Modbus_Undef"; - - $modHash->{AttrList}= "do_not_notify:1,0 " . + $modHash->{ReadFn} = "Modbus_Read"; + $modHash->{ReadyFn} = "Modbus_Ready"; + $modHash->{DefFn} = "Modbus_Define"; + $modHash->{UndefFn} = "Modbus_Undef"; + $modHash->{NotifyFn} = "Modbus_Notify"; + $modHash->{AttrFn} = "Modbus_Attr"; + + $modHash->{AttrList} = "do_not_notify:1,0 " . $Modbus_PhysAttrs . + $Modbus_CommonAttrs . $readingFnAttributes; } @@ -233,10 +258,9 @@ sub Modbus_Define($$) Log 1, "$name: device is none, commands will be echoed only"; return undef; } - $ioHash->{DeviceName} = $dev; # needed by DevIo to get Device, Port, Speed etc. - + $ioHash->{DeviceName} = $dev; # needed by DevIo to get Device, Port, Speed etc. $ioHash->{TIMEOUT} = AttrVal($name, "openTimeout", 3); - DevIo_OpenDev($ioHash, 0, 0); # open physical device blocking (no nonblockingt TCP stuff here) + #DevIo_OpenDev($ioHash, 0, 0); # will be opened later in NotifyFN delete $ioHash->{TIMEOUT}; return; @@ -287,7 +311,7 @@ sub Modbus_Undef($$) # auf das Gerät, obwohl die NotifyFn nicht mehr regisrtiert ist ... # # -sub ModbusLD_Notify($$) +sub Modbus_Notify($$) # both for physical and logical devices { my ($hash, $source) = @_; my $name = $hash->{NAME}; # my Name @@ -298,14 +322,27 @@ sub ModbusLD_Notify($$) return if(!$events); # no events # Log3 $name, 5, "$name: Notify called for source $source->{NAME} with events: @{$events}"; - return if (!grep(m/^INITIALIZED|REREADCFG$/, @{$events})); + return if (!grep(m/^INITIALIZED|REREADCFG|(MODIFIED $name)$/, @{$events})); - if ($hash->{DEST} && !AttrVal($name, "disable", undef)) { - Log3 $name, 5, "$name: Notify for INITIALIZED or REREADCFG -> now opening connection"; + if (IsDisabled($name)) { + Log3 $name, 3, "$name: Notify / Init: device is disabled"; + return; + } + if ($hash->{TYPE} eq "Modbus" || $hash->{DEST}) { # physical device or Modbus TCP -> open connection + Log3 $name, 3, "$name: Notify / Init: opening connection"; Modbus_Open($hash); + } else { # logical device and not Modbus TCP -> check for IO Device + my $ioHash = ModbusLD_GetIOHash($hash); + my $ioName = $ioHash->{NAME}; + if ($ioName) { + Log3 $name, 3, "$name: Notify / Init: using $ioName for communication"; + } else { + Log3 $name, 3, "$name: Notify / Init: no IODev for communication"; + } + } + if ($hash->{TYPE} ne "Modbus") { + ModbusLD_SetTimer($hash, 1); # logical device -> first Update in 1 second or aligned if interval is defined } - ModbusLD_SetTimer($hash, 1); # first Update in 1 second or aligned - return; } @@ -326,22 +363,33 @@ sub ModbusLD_ObjInfo($$$;$$) { return (defined($lastDefault) ? $lastDefault : "") if (!$reading); if (defined($attr{$name})) { - # check for special case: attribute can be name of reading name with prefix like poll-reading - return $attr{$name}{$oName."-".$reading} - if (defined($attr{$name}{$oName."-".$reading})); # check for explicit attribute for this object my $aName = "obj-".$key."-".$oName; return $attr{$name}{$aName} if (defined($attr{$name}{$aName})); + + if ($hash->{LeadingZeros}) { + # attr for object with leading zeros in address detected + if ($key =~ /([cdih])0*([0-9]+)/) { + my $type = $1; + my $adr = $2; + while (length($adr) <= 5) { + $aName = "obj-".$type.$adr."-".$oName; + Log3 $name, 5, "$name: Check $aName"; + return $attr{$name}{$aName} + if (defined($attr{$name}{$aName})); + $adr = '0' . $adr; + } + } + } - # default attribute for all objects (redundant with DevInfo attributes for all types) - #my $adName = "obj-".$oName; - #return $attr{$name}{$adName} - # if (defined($attr{$name}{$adName})); + # check for special case: attribute can be name of reading with prefix like poll-reading + return $attr{$name}{$oName."-".$reading} + if (defined($attr{$name}{$oName."-".$reading})); } - # parseInfo for object + # parseInfo for object $oName if special Fhem module using parseinfoHash return $parseInfo->{$key}{$oName} if (defined($parseInfo->{$key}) && defined($parseInfo->{$key}{$oName})); @@ -418,6 +466,24 @@ sub ModbusLD_ObjKey($$) { } +sub Modbus_CheckEval($$$$$) { + my ($hash, $val, $expr, $context, $eName) = @_; + # context e.g. "ParseObj", eName e.g. "ignoreExpr for $reading" + my $name = $hash->{NAME}; + my $result; + Log3 $name, 5, "$name: $context evaluates $eName, val=$val, expr $expr"; + $SIG{__WARN__} = sub { Log3 $name, 3, "$name: $context warning evaluating $eName, val=$val, expr $expr: @_"; }; + $result = eval($expr); + $SIG{__WARN__} = 'DEFAULT'; + if ($@) { + Log3 $name, 3, "$name: $context error evaluating $eName, val=$val, expr=$expr: $@"; + } else { + Log3 $name, 5, "$name: $context eval result is $result"; + } + return $result; +} + + ################################################# # Parse holding / input register / coil Data # only called from parseframes @@ -434,7 +500,7 @@ sub Modbus_ParseObj($$$;$$) { my $type = substr($objCombi, 0, 1); my $startAdr = substr($objCombi, 1); my $lastAdr = ($quantity ? $startAdr + $quantity -1 : 0); - my ($unpack, $format, $expr, $map, $rest, $len, $encode, $decode); + my ($unpack, $format, $expr, $ignExpr, $map, $rest, $len, $encode, $decode); Log3 $name, 5, "$name: ParseObj called with " . unpack ("H*", $data) . " and start $startAdr" . ($quantity ? ", quantity $quantity" : "") . ($op ? ", op $op" : "");; if ($type =~ "[cd]") { @@ -452,11 +518,11 @@ sub Modbus_ParseObj($$$;$$) { my $key = $type . $startAdr; my $reading = ModbusLD_ObjInfo($logHash, $key, "reading"); # "" if nothing specified - if ($op =~ /scanid([0-9]+)/) { + if ($op =~ /scanid([0-9]+)/) { # scanning for Modbus ID $reading = "scanId-" . $1 . "-Response-$key"; $logHash->{MODBUSID} = $1; Log3 $name, 3, "$name: ScanIds got reply from Id $1 - set internal MODBUSID to $1"; - } elsif ($op eq 'scanobj') { + } elsif ($op eq 'scanobj') { # scan Modbus objects if (!$reading) { $reading = "scan-$key"; CommandAttr(undef, "$name obj-${key}-reading $reading"); @@ -489,6 +555,7 @@ sub Modbus_ParseObj($$$;$$) { }; $format = ModbusLD_ObjInfo($logHash, $key, "format", "defFormat"); # no format if nothing specified $expr = ModbusLD_ObjInfo($logHash, $key, "expr", "defExpr"); + $ignExpr = ModbusLD_ObjInfo($logHash, $key, "ignoreExpr", "defIgnoreExpr"); $map = ModbusLD_ObjInfo($logHash, $key, "map", "defMap"); # no map if not specified Log3 $name, 5, "$name: ParseObj ObjInfo for $key: reading=$reading, unpack=$unpack, expr=$expr, format=$format, map=$map"; @@ -498,26 +565,24 @@ sub Modbus_ParseObj($$$;$$) { my $logLvl = AttrVal($name, "timeoutLogLevel", 3); Log3 $name, $logLvl, "$name: ParseObj unpack of " . unpack ('H*', $rest) . " with $unpack for $reading resulted in undefined value"; } else { - Log3 $name, 5, "$name: ParseObj unpacked " . unpack ('H*', $rest) . " with $unpack to " . unpack ('H*', $val); + Log3 $name, 5, "$name: ParseObj unpacked " . unpack ('H*', $rest) . + " with $unpack to hex " . unpack ('H*', $val) . + ($val =~ /[[:print:]]/ ? " ($val)" : ""); # check for printable characters $val = decode($decode, $val) if ($decode); $val = encode($encode, $val) if ($encode); + # Exp zur Ignorieren der Werte? + my $ignore; + $ignore = Modbus_CheckEval($logHash, $val, $ignExpr, "ParseObj", "ignoreExpr for $reading") if ($ignExpr); + # Exp zur Nachbearbeitung der Werte? - if ($expr) { - Log3 $name, 5, "$name: ParseObj for $reading evaluates $val with expr $expr"; - my $hash = $logHash; - $val = eval($expr); - if ($@) { - Log3 $name, 3, "$name: ParseObj error in expr $expr: $@"; - } else { - Log3 $name, 5, "$name: ParseObj converted value to $val using expr $expr"; - } - } + $val = Modbus_CheckEval($logHash, $val, $expr, "ParseObj", "expr for $reading") if ($expr); + # Map zur Nachbereitung der Werte? if ($map) { my %map = split (/[,: ]+/, $map); - Log3 $name, 5, "$name: ParseObj for $reading maps value $val with " . $map; + Log3 $name, 5, "$name: ParseObj for $reading maps value to $val with " . $map; $val = $map{$val} if ($map{$val}); } # Format angegeben? @@ -527,10 +592,14 @@ sub Modbus_ParseObj($$$;$$) { $val = sprintf($format, $val); Log3 $name, 5, "$name: ParseObj for $reading sprintf result is $val"; } - Log3 $name, 4, "$name: ParseObj for $reading assigns $val"; - readingsBulkUpdate($logHash, $reading, $val); - $logHash->{gotReadings}{$reading} = $val; - $logHash->{lastRead}{$key} = gettimeofday(); + if ($ignore) { + Log3 $name, 4, "$name: ParseObj for $reading ignores $val because of ignoreExpr. Reading not updated"; + } else { + Log3 $name, 4, "$name: ParseObj for $reading assigns $val"; + readingsBulkUpdate($logHash, $reading, $val); + $logHash->{gotReadings}{$reading} = $val; + $logHash->{lastRead}{$key} = gettimeofday(); + } } } else { Log3 $name, 5, "$name: ParseObj has no parseInfo for $key"; @@ -565,7 +634,6 @@ sub Modbus_Statistics($$$) { my ($hash, $key, $value) = @_; my $name = $hash->{NAME}; - #my ($seconds, $minute, $hour, @rest) = localtime (gettimeofday()); my $pInterval = AttrVal($name, "profileInterval", 0); return if (!$pInterval); @@ -695,8 +763,20 @@ sub Modbus_ParseFrames($) return "got data but did not send a request - ignoring" if (!$ioHash->{REQUEST} || !$proto); Log3 $name, 5, "$name: ParseFrames got: " . unpack ('H*', $frame); - use bytes; + use bytes; + + if ($proto eq "RTU") { + if (AttrVal($name, "skipGarbage", 0)) { + my $start = index($frame, pack('C', $reqId)); + if ($start) { + my $skip = substr($frame, 0, $start); + $frame = substr($frame, $start); + Log3 $name, 4, "$name: ParseFrames skipped $start bytes (" . + unpack ('H*', $skip) . " from " . unpack ('H*', $frame) . ")"; + $ioHash->{helper}{buffer} = $frame; + } + } if ($frame =~ /(..)(.+)(..)/s) { # (id fCode) (data) (crc) /s means treat as single line ... ($devAdr, $fCode) = unpack ('CC', $1); $data = $2; @@ -706,6 +786,15 @@ sub Modbus_ParseFrames($) return undef; # data still incomplete - continue reading } } elsif ($proto eq "ASCII") { + if (AttrVal($name, "skipGarbage", 0)) { + my $start = index($frame, ':'); + if ($start) { + my $skip = substr($frame, 0, $start); + $frame = substr($frame, $start); + Log3 $name, 4, "$name: ParseFrames skipped $start bytes ($skip from $frame)"; + $ioHash->{helper}{buffer} = $frame; + } + } if ($frame =~ /:(..)(..)(.+)(..)\r\n/) {# : (id) (fCode) (data) (lrc) \r\n $devAdr = hex($1); $fCode = hex($2); @@ -819,8 +908,10 @@ sub Modbus_ParseFrames($) Log3 $name, 5, "$name: ParseFrames: frame seems incomplete ($actualLen / $headerLen) but checksum is fine and allowShortResponses is set ..."; } return "ParseFrames got wrong Checksum (expect $eCRC, got $CRC)" if ($eCRC != $CRC); - Log3 $name, 4, "$name: ParseFrames got fcode $fCode from $devAdr, tid $tid, ". - "values " . unpack ('H*', $values) . "HeaderLen $headerLen, ActualLen $actualLen, request was for $type$parseAdr ($ioHash->{REQUEST}{READING})". + Log3 $name, 4, "$name: ParseFrames got fcode $fCode from $devAdr" . + ($proto eq "TCP" ? ", tid $tid" : "") . + ", values " . unpack ('H*', $values) . "HeaderLen $headerLen, ActualLen $actualLen" . + ", request was for $type$parseAdr ($ioHash->{REQUEST}{READING})". ", len $reqLen for module $logHash->{NAME}"; if ($fCode < 15) { # nothing to parse after reply to 15 / 16 @@ -847,6 +938,7 @@ sub Modbus_EndBUSY($) $hash->{BUSY} = 0; delete $hash->{REQUEST}; Modbus_Profiler($hash, "Idle"); + Modbus_Statistics($hash, "Timeouts", 0); # damit bei Bedarf das Reading gesetzt wird RemoveInternalTimer ("timeout:$name"); } @@ -885,6 +977,7 @@ sub Modbus_Read($) ########################### # open connection # $hash is physical or both (TCP) +# called from set reconnect, Attr (disable), Notify (initialized, rereadcfg, |(MODIFIED $name)), Ready sub Modbus_Open($;$) { my ($hash, $reopen) = @_; @@ -903,7 +996,14 @@ sub Modbus_Open($;$) return; } } - Log3 $name, 3, "$name: trying to open connection to $hash->{DeviceName}" if (!$reopen); + + if (!$reopen) { # not called from _Ready + DevIo_CloseDev($hash); + delete $hash->{NEXT_OPEN}; + delete $hash->{DevIoJustClosed}; + } + + Log3 $name, 4, "$name: trying to open connection to $hash->{DeviceName}" if (!$reopen); $hash->{IODev} = $hash if ($hash->{DEST}); # for TCP Log-Module itself is IODev (removed during CloseDev) $hash->{BUSY} = 0; $hash->{BUSY_OPENDEV} = 1; @@ -927,14 +1027,14 @@ sub Modbus_Ready($) my $name = $hash->{NAME}; if($hash->{STATE} eq "disconnected") { - if (AttrVal($name, "disable", undef)) { - Log3 $name, 3, "$name: _Reconnect: $name attr disabled was set - don't try to reconnect"; + if (IsDisabled($name)) { + Log3 $name, 3, "$name: _Reconnect: $name is disabled - don't try to reconnect"; DevIo_CloseDev($hash); $hash->{BUSY} = 0; return; } - Modbus_Open($hash, 1); # reopen - return; # a return value only triggers direct read for windows - next round in main loop will select for available data + Modbus_Open($hash, 1); # reopen, dont call DevIoClose before reopening + return; # a return value only triggers direct read for windows - main loop will select for data } # This is relevant for windows/USB only my $po = $hash->{USBDev}; @@ -979,34 +1079,6 @@ sub Modbus_LRC($) { } -################################################### -# reconnect TCP connection (called from ControlSet) -sub Modbus_Reconnect($) -{ - my ($hash) = @_; - my $name = $hash->{NAME}; - my $dest = $hash->{DEST}; - - if (!$dest) { - Log3 $name, 3, "$name: not using a TCP connection, reconnect not supported"; - return; - } - # $hash is logical device with TCP - # so the hash is used as physical device as well - if (AttrVal($name, "disable", undef)) { - Log3 $name, 3, "$name: _Reconnect: $name attr disabled was set - don't try to reconnect"; - DevIo_CloseDev($hash); - $hash->{BUSY} = 0; - return; - } - - DevIo_CloseDev($hash); - delete $hash->{NEXT_OPEN}; - delete $hash->{DevIoJustClosed}; - Modbus_Open($hash); -} - - ####################################### sub Modbus_CountTimeouts($) { @@ -1039,9 +1111,10 @@ sub Modbus_TimeoutSend($) my $ioHash = $defs{$name}; my $logLvl = AttrVal($name, "timeoutLogLevel", 3); Log3 $name, $logLvl, "$name: timeout waiting for fc $ioHash->{REQUEST}{FCODE} " . - "from id $ioHash->{REQUEST}{MODBUSID}, ($ioHash->{REQUEST}{TYPE}$ioHash->{REQUEST}{ADR}), " . - "Request was $ioHash->{REQUESTHEX}, " . - "Buffer contains " . unpack ("H*", $ioHash->{helper}{buffer}); + "from id $ioHash->{REQUEST}{MODBUSID}, " . + "($ioHash->{REQUEST}{TYPE}$ioHash->{REQUEST}{ADR} / $ioHash->{REQUEST}{READING}), " . + "Request was $ioHash->{REQUESTHEX}" . + ($ioHash->{helper}{buffer} ? ", Buffer contains " . unpack ("H*", $ioHash->{helper}{buffer}) : ""); Modbus_Statistics($ioHash, "Timeouts", 1); @@ -1106,7 +1179,7 @@ sub Modbus_HandleSendQueue($;$) delete $ioHash->{QUEUE}; return; } - if (AttrVal($name, "disable", undef)) { + if (IsDisabled($name)) { Log3 $name, 4, "$name: HandleSendQueue called but device is disabled. Dropping requests in queue"; Modbus_Profiler($ioHash, "Idle"); delete $ioHash->{QUEUE}; @@ -1145,7 +1218,7 @@ sub Modbus_HandleSendQueue($;$) my $v1 = $request->{VALUE}; my $logHash = $request->{DEVHASH}; - if (AttrVal($logHash->{NAME}, "disable", undef)) { + if (IsDisabled($logHash->{NAME})) { Log3 $name, 4, "$name: HandleSendQueue called but logical device is disabled. Dropping request"; shift(@{$queue}); # remove first element from queue #Modbus_Profiler($ioHash, "Idle"); @@ -1198,7 +1271,6 @@ sub Modbus_HandleSendQueue($;$) return; } my $pdu = pack ('C', $fCode) . $data; - #Log3 $name, 5, "$ioName: Send fcode $fCode for $reading, pdu : " . unpack ('H*', $pdu); my $frame; my $packedId = pack ('C', $reqId); @@ -1214,7 +1286,6 @@ sub Modbus_HandleSendQueue($;$) my $dlen = bytes::length($pdu)+1; # length of pdu + Id my $header = pack ('nnnC', ($tid, 0, $dlen, $reqId)); $frame = $header.$pdu; - #Log3 $name, 5, "$ioName: Send TCP frame tid=$tid, dlen=$dlen, Id=$reqId, pdu=" . unpack ('H*', $pdu); } $request->{FRAME} = $frame; # frame as data string for echo detection @@ -1224,6 +1295,9 @@ sub Modbus_HandleSendQueue($;$) $ioHash->{REQUESTHEX} = unpack ('H*', $frame); # for debugging / log $ioHash->{BUSY} = 1; # modbus bus is busy until response is received $ioHash->{helper}{buffer} = ""; # clear Buffer for reception + + #Log3 $name, 3, "$name: insert Garbage for testing"; + #$ioHash->{helper}{buffer} = pack ("C",0); # test / debug / todo: remove Log3 $name, 4, "$name: HandleSendQueue sends fc $fCode to id $reqId, tid $tid for $reading ($type$adr), len $len" . ", device $logHash->{NAME} ($proto), pdu " . unpack ('H*', $pdu) . ", V $Modbus_Version"; @@ -1270,22 +1344,13 @@ sub ModbusLD_Initialize($ ) $modHash->{AttrFn} = "ModbusLD_Attr"; $modHash->{SetFn} = "ModbusLD_Set"; $modHash->{GetFn} = "ModbusLD_Get"; - $modHash->{NotifyFn} = "ModbusLD_Notify"; + $modHash->{NotifyFn} = "Modbus_Notify"; $modHash->{AttrList}= - "do_not_notify:1,0 " . - "IODev " . # fhem.pl macht dann $hash->{IODev} = $defs{$ioname} - "alignTime " . - "enableControlSet:0,1 " . - "nextOpenDelay " . - "disable:0,1 " . - "maxTimeoutsToReconnect " . # for Modbus over TCP/IP only - - "scanDelay " . - - #"(get|set)([0-9]+)request([0-9]+) " . - + "do_not_notify:1,0 " . + $Modbus_LogAttrs . + $Modbus_CommonAttrs . $readingFnAttributes; $modHash->{ObjAttrList} = @@ -1305,10 +1370,13 @@ sub ModbusLD_Initialize($ ) "obj-[cdih][0-9]+-decode " . "obj-[cdih][0-9]+-encode " . "obj-[cdih][0-9]+-expr " . + "obj-[cdih][0-9]+-ignoreExpr " . "obj-[cdih][0-9]+-format " . "obj-[cdih][0-9]+-showGet " . "obj-[cdih][0-9]+-poll " . "obj-[cdih][0-9]+-polldelay "; + + #"(get|set)([0-9]+)request([0-9]+) " $modHash->{DevAttrList} = "dev-([cdih]-)*read " . @@ -1323,6 +1391,7 @@ sub ModbusLD_Initialize($ ) "dev-([cdih]-)*defDecode " . "dev-([cdih]-)*defEncode " . "dev-([cdih]-)*defExpr " . + "dev-([cdih]-)*defIgnoreExpr " . "dev-([cdih]-)*defFormat " . "dev-([cdih]-)*defShowGet " . "dev-([cdih]-)*defPoll " . @@ -1365,9 +1434,10 @@ sub ModbusLD_SetIODev($) Log3 $name, 3, "$name: SetIODev found no physical modbus device"; return undef; } - + $ioName = $ioHash->{NAME}; + Log3 $name, 3, "$name: SetIODev registers $name with Id $hash->{MODBUSID} at $ioName"; $hash->{IODev} = $ioHash; # point internal IODev to io device hash - $hash->{IODev}{defptr}{$hash->{MODBUSID}} = $hash; # register this logical device for given id at io hash + $hash->{IODev}{defptr}{$hash->{MODBUSID}} = $hash; # register device for given id at io hash (for removal at undef) Log3 $name, 5, "$name: SetIODev is using $ioHash->{NAME}"; return $ioHash; } @@ -1453,19 +1523,15 @@ sub ModbusLD_Define($$) return "Interval has to be numeric" if ($interval !~ /[0-9.]+/); - $hash->{NOTIFYDEV} = "global"; # NotifyFn nur aufrufen wenn global events (INITIALIZED) - # löschen ist möglich mit $hash->{NOTIFYDEV} = ","; - - $hash->{ModuleVersion} = $Modbus_Version; - $hash->{MODBUSID} = $id; - $hash->{INTERVAL} = $interval; - $hash->{PROTOCOL} = $proto; - $hash->{'.getList'} = ""; - $hash->{'.setList'} = ""; + $hash->{NOTIFYDEV} = "global"; # NotifyFn nur aufrufen wenn global events (INITIALIZED etc.) + $hash->{ModuleVersion} = $Modbus_Version; + $hash->{MODBUSID} = $id; + $hash->{INTERVAL} = $interval; + $hash->{PROTOCOL} = $proto; + $hash->{'.getList'} = ""; + $hash->{'.setList'} = ""; $hash->{".updateSetGet"} = 1; - #Log3 $name, 3, "$name: _define called with destination $dest, protocol $proto"; - if ($dest) { # Modbus über TCP mit IP Adresse angegeben (TCP oder auch RTU/ASCII über TCP) $dest .= ":502" if ($dest !~ /.*:[0-9]/); # add default port if no port specified $hash->{DEST} = $dest; @@ -1475,24 +1541,43 @@ sub ModbusLD_Define($$) $hash->{STATE} = "disconnected"; # initial value my $modHash = $modules{$hash->{TYPE}}; - $modHash->{AttrList} .= $Modbus_PhysAttrs; - - Log3 $name, 3, "$name: defined with id $id, interval $interval, destination $dest, protocol $proto"; - + $modHash->{AttrList} .= $Modbus_PhysAttrs; # affects all devices - even non TCP - sorry ... + #Log3 $name, 3, "$name: added attributes for physical devices for Modbus TCP"; } else { - # logical device that uses a physical Modbus device - $hash->{DEST} = ""; - if (ModbusLD_SetIODev($hash)) { # physical device found and asigned as IODev - $hash->{STATE} = "opened"; - } else { - $hash->{STATE} = "no IO Dev"; - } - Log3 $name, 3, "$name: defined with id $id, interval $interval, protocol $proto"; + $hash->{DEST} = ""; # logical device that uses a physical Modbus device } + Log3 $name, 3, "$name: defined with id $id, interval $interval, protocol $proto" . + ($dest ? ", destination $dest" : ""); return; } +######################################################################### +sub Modbus_Attr(@) +{ + my ($cmd,$name,$aName,$aVal) = @_; + my $hash = $defs{$name}; # hash des physischen Devices + + Log3 $name, 5, "$name: $cmd attr $aName" . (defined($aVal) ? ", $aVal" : ""); + if ($aName eq 'disable' && $init_done) { # only after init_done, otherwise see NotifyFN + # disable on a physical serial device + if ($cmd eq "set" && $aVal) { + Log3 $name, 3, "$name: disable attribute set" . ($hash->{FD} ? ", closing connection" : ""); + DevIo_CloseDev($hash) if ($hash->{FD}); + $hash->{STATE} = "disconnected"; + $hash->{BUSY} = 0; + + } elsif ($cmd eq "del" || ($cmd eq "set" && !$aVal)) { + Log3 $name, 3, "$name: disable attribute removed"; + Modbus_Open($hash); + } + } + return undef; +} + + + + ######################################################################### sub ModbusLD_Attr(@) { @@ -1513,8 +1598,8 @@ sub ModbusLD_Attr(@) } } elsif ($aName eq "IODev") { # defptr housekeeping my $ioHash = $defs{$aVal}; - if ($ioHash && $ioHash->{TYPE} eq "MODBUS") { # gibt es den Geräte hash zum IODev Attribut? - $ioHash->{defptr}{$hash->{MODBUSID}} = $ioHash; # register logical device + if ($ioHash && $ioHash->{TYPE} eq "Modbus") { # gibt es den Geräte-Hash zum IODev Attribut? + $ioHash->{defptr}{$hash->{MODBUSID}} = $ioHash; # register logical device Log3 $name, 5, "$name: Attr IODev - using $aVal"; } else { Log3 $name, 5, "$name: Attr IODev can't use $aVal - device does not exist (yet?) or is not a physical Modbus Device"; @@ -1526,30 +1611,63 @@ sub ModbusLD_Attr(@) $hash->{TimeAlign} = fhemTimeLocal($alSec, $alMin, $alHr, $mday, $mon, $year); $hash->{TimeAlignFmt} = FmtDateTime($hash->{TimeAlign}); ModbusLD_SetTimer($hash); # change timer for alignment + } elsif (" $Modbus_PhysAttrs " =~ / $aName[: ]/) { + if (!$hash->{DEST}) { + Log3 $name, 3, "$name: attribute $aName is only valid for physical Modbus devices or Modbus TCP - please use this attribute for your physical IO device $hash->{IODev}{NAME}"; + return "attribute $aName is only valid for physical Modbus devices or Modbus TCP - please use this attribute for your physical IO device $hash->{IODev}{NAME}"; + } + } elsif ($aName =~ /(obj-[cdih])(0+([0-9]+))-/) { + # leading zero in obj-Attr detected + if (length($2) > 5) { + my $new = $1 . substr("00000", 5 - length ($3)) . $3; + $aName = $new; + Log3 $name, 3, "$name: Address in attribute $aName too long, shortened to $new"; + } + if (!$hash->{LeadingZeros}) { + $hash->{LeadingZeros} = 1; + Log3 $name, 3, "$name: Support for leading zeros in object addresses enabled. This might slow down the fhem modbus module a bit"; + } } addToDevAttrList($name, $aName); - $hash->{".updateSetGet"} = 1; - } else { - $hash->{".updateSetGet"} = 1; - } - - if ($aName eq 'disable') { - if ($hash->{DEST}) { - # take action only for Modbus TCP - if ($cmd eq "set" && $aVal) { - Log3 $name, 5, "$name: disable attribute set on a Modbus TCP connection" . - ($hash->{FD} ? ", closing connection" : ""); - DevIo_CloseDev($hash); - $hash->{BUSY} = 0; - } elsif ($cmd eq "del" || ($cmd eq "set" && !$aVal)) { - Log3 $name, 5, "$name: disable attribute removed on a Modbus TCP connection"; - DevIo_CloseDev($hash); - delete $hash->{NEXT_OPEN}; - delete $hash->{DevIoJustClosed}; - Modbus_Open($hash); + + } elsif ($cmd eq "del") { + #Log3 $name, 5, "$name: del attribute $aName"; + if ($aName =~ /obj-[cdih]0[0-9]+-/) { + if (!(grep !/$aName/, grep (/obj-[cdih]0[0-9]+-/, keys %{$attr{$name}}))) { + delete $hash->{LeadingZeros}; # no more leading zeros } } + } + $hash->{".updateSetGet"} = 1; + + if ($aName eq 'disable' && $init_done) { # if not init_done, nothing to be done here (see NotifyFN) + # disable on a logical device (not physical here!) + if ($cmd eq "set" && $aVal) { + if ($hash->{DEST}) { # Modbus TCP + Log3 $name, 3, "$name: disable attribute set" . + ($hash->{FD} ? ", closing TCP connection" : ""); + DevIo_CloseDev($hash) if ($hash->{FD}); + $hash->{BUSY} = 0; + } + RemoveInternalTimer("update:$name"); + + } elsif ($cmd eq "del" || ($cmd eq "set" && !$aVal)) { + Log3 $name, 3, "$name: disable attribute removed" . + ($hash->{DEST} ? ", opening TCP connection" : ""); + if ($hash->{DEST}) { # Modbus TCP + Modbus_Open($hash); # should be called with hash of physical device but for TCP it's the same + } else { + my $ioHash = ModbusLD_GetIOHash($hash); + my $ioName = $ioHash->{NAME}; + if ($ioName) { + Log3 $name, 3, "$name: using $ioName for communication"; + } else { + Log3 $name, 3, "$name: no IODev for communication"; + } + } + ModbusLD_SetTimer($hash, 1); # first Update in 1 second or aligned if interval is defined + } } return undef; } @@ -1650,10 +1768,8 @@ sub ModbusLD_Get($@) if ($getName ne "?"); return "Unknown argument $a[1], choose one of $hash->{'.getList'}"; } - - if (AttrVal($name, "disable", undef)) { - Log3 $name, 5, "$name: Get called with $getName but device is disabled" - if ($getName ne "?"); + if (IsDisabled($name)) { + Log3 $name, 5, "$name: Get called with $getName but device is disabled"; return undef; } @@ -1702,12 +1818,16 @@ sub ModbusLD_ControlSet($$$) ModbusLD_GetUpdate("reread:$name"); return "0"; - } elsif ($setName eq 'reconnect') { - if (!$hash->{DEST}) { - Log3 $name, 3, "$name: not using a TCP connection, reconnect not supported"; - return "0"; + } elsif ($setName eq 'reconnect') { + if (IsDisabled($name)) { + Log3 $name, 3, "$name: set reconnect called but device is disabled"; + return "set reconnect called but device is disabled"; } - Modbus_Reconnect($hash); + if (!$hash->{DEST}) { + Log3 $name, 3, "$name: set reconnect called but device is not using Modbus TCP and the connection is going through another device so the connection can't be reconnected from here"; + return "set reconnect called but device is connecting through another physical device"; + } + Modbus_Open($hash); # should be called with hash of physical device but for TCP it's the same return "0"; } elsif ($setName eq 'stop') { @@ -1841,7 +1961,7 @@ sub ModbusLD_ScanIds($) { my $ioHash = ModbusLD_GetIOHash($hash); my $queue = $ioHash->{QUEUE}; my $qLen = ($ioHash->{QUEUE} ? scalar(@{$ioHash->{QUEUE}}) : 0); - my $qMax = AttrVal($ioHash->{NAME}, "queueMax", 100) / 2; + my $qMax = AttrVal($name, "queueMax", 100) / 2; RemoveInternalTimer ("scan:$name"); if ($qLen && $qLen > $qMax) { @@ -1881,9 +2001,9 @@ sub ModbusLD_ScanFormat($$) my $i = unpack("s", $val); my $n = unpack("S", $val); my $h = unpack("H*", $val); - Log3 $name, 5, "$name: ScanFormat: hex=$h, len=$len"; + Log3 $name, 5, "$name: ScanFormat: hex=$h, bytes=$len"; - my $ret = "hex=$h, len=$len, string="; + my $ret = "hex=$h, string="; for my $c (split //, $val) { if ($c =~ /[[:graph:]]/) { $ret .= $c; @@ -1920,7 +2040,7 @@ sub ModbusLD_Set($@) if (AttrVal($name, "enableControlSet", undef)) { # spezielle Sets freigeschaltet? my $error = ModbusLD_ControlSet($hash, $setName, $setVal); - return undef if (defined($error) && $error eq "0"); # control set found and done. + return if (defined($error) && $error eq "0"); # control set found and done. return $error if ($error); # error # continue if function returned undef } @@ -1938,14 +2058,13 @@ sub ModbusLD_Set($@) return "Unknown argument $a[1], choose one of $hash->{'.setList'}"; } - if (AttrVal($name, "disable", undef)) { - Log3 $name, 4, "$name: set called with $setName but device is disabled" - if ($setName ne "?"); - return undef; + if (IsDisabled($name)) { + Log3 $name, 4, "$name: set called with $setName but device is disabled"; + return; } my $ioHash = ModbusLD_GetIOHash($hash); # get or reconstruct ioHash. reconnecton is done in Queue handling if necessary - return undef if (!$ioHash); + return if (!$ioHash); my $type = substr($objCombi, 0, 1); my ($err,$result); @@ -2007,11 +2126,8 @@ sub ModbusLD_Set($@) } } - if ($setexpr) { # 3. Schritt: Konvertiere mit setexpr falls definiert - my $val = $rawVal; - $rawVal = eval($setexpr); - Log3 $name, 5, "$name: Set: converted Value $val to $rawVal using expr $setexpr"; - } + # 3. Schritt: Konvertiere mit setexpr falls definiert + $rawVal = Modbus_CheckEval($hash, $rawVal, $setexpr, "Set", "setexpr for $setName") if ($setexpr); my $packedVal = pack ($unpack, $rawVal); Log3 $name, 5, "$name: set packed hex " . unpack ('H*', $rawVal) . " with $unpack to hex " . unpack ('H*', $packedVal); @@ -2019,6 +2135,7 @@ sub ModbusLD_Set($@) $packedVal = Modbus_SwpRegs($hash, $packedVal, $len) if ($swpRegs); ModbusLD_Send($hash, $objCombi, "write", $packedVal, 1); # add at beginning and force send / sleep if necessary + ($err, $result) = ModbusLD_ReadAnswer($hash, $setName); Modbus_EndBUSY ($ioHash); # set BUSY to 0, delete REQUEST, clear Buffer, do Profilig return $err if ($err); @@ -2032,7 +2149,7 @@ sub ModbusLD_Set($@) Modbus_EndBUSY ($ioHash); # set BUSY to 0, delete REQUEST, clear Buffer, do Profilig return "$err (in read after write for FCode 16)" if ($err); } - return undef; # no return code if no error + return; # no return code if no error } @@ -2048,7 +2165,10 @@ sub ModbusLD_ReadAnswer($;$) my $name = $hash->{NAME}; my $now = gettimeofday(); - my $ioHash = ModbusLD_GetIOHash($hash); + my $ioHash = ModbusLD_GetIOHash($hash); + my $ioName = $ioHash->{NAME}; + Log3 $name, 3, "$name: _ReadAnswer called but IO Device is disabled" if (IsDisabled ($ioName)); + return ("IO Device is disabled", undef) if (IsDisabled ($ioName)); return ("No FD", undef) if (!$ioHash); return ("No FD", undef) if ($^O !~ /Win/ && !defined($ioHash->{FD})); @@ -2089,7 +2209,7 @@ sub ModbusLD_ReadAnswer($;$) $ioHash->{USBDev}->read_const_time($to*1000); # set timeout (ms) $buf = $ioHash->{USBDev}->read(999); if(length($buf) == 0) { - my $logLvl = AttrVal($name, "timeoutLogLevel", 3); + my $logLvl = AttrVal($ioHash->{NAME}, "timeoutLogLevel", 3); Log3 $name, $logLvl, "$name: Timeout in ReadAnswer" . ($reading ? " for $reading" : ""); Modbus_CountTimeouts ($ioHash); return ("Timeout reading answer", undef) @@ -2110,7 +2230,7 @@ sub ModbusLD_ReadAnswer($;$) return("Modbus_ReadAnswer error: $err", undef); } if($nfound == 0) { - my $logLvl = AttrVal($name, "timeoutLogLevel", 3); + my $logLvl = AttrVal($ioHash->{NAME}, "timeoutLogLevel", 3); Log3 $name, $logLvl, "$name: Timeout2 in ReadAnswer" . ($reading ? " for $reading" : ""); Modbus_CountTimeouts ($ioHash); return ("Timeout reading answer", undef); @@ -2165,13 +2285,15 @@ sub ModbusLD_GetUpdate($) { my $now = gettimeofday(); my $ioHash = ModbusLD_GetIOHash($hash); + Log3 $name, 5, "$name: GetUpdate called"; + if ($calltype eq "update") { ## todo check if interval > min ModbusLD_SetTimer($hash); } - if (AttrVal($name, "disable", undef)) { + if (IsDisabled($name)) { Log3 $name, 5, "$name: GetUpdate called but device is disabled"; - return undef; + return; } return if (!$ioHash); @@ -2179,7 +2301,6 @@ sub ModbusLD_GetUpdate($) { Log3 $name, 5, "$name: GetUpdate called, but device is disconnected"; return; } - Log3 $name, 5, "$name: GetUpdate called"; Modbus_Profiler($ioHash, "Fhem"); my @ObjList; @@ -2271,25 +2392,23 @@ sub ModbusLD_GetIOHash($){ my $name = $hash->{NAME}; # name of logical device my $ioHash; - if ($hash->{TYPE} eq "MODBUS") { + #Log3 $name, 5, "$name: GetIOHash, TYPE = $hash->{TYPE}" . ($hash->{DEST} ? ", DEST = $hash->{DEST}" : ""); + if ($hash->{TYPE} eq "Modbus") { # physical Device return $hash; } else { # logical Device if ($hash->{DEST}) { - # Modbus TCP/RTU/ASCII über TCP, physical hash = logical hash - return $hash; + return $hash; # Modbus TCP/RTU/ASCII über TCP, physical hash = logical hash } else { - # logical device needs pointer to physical device (IODev) - return $hash->{IODev} if ($hash->{IODev}); - # recreate $hash->{IODev} and defptr registration using attr or usable physical Modbus device + return $hash->{IODev} if ($hash->{IODev}); # logical device needs pointer to physical device (IODev) if (ModbusLD_SetIODev($hash)) { return $hash->{IODev}; } Log3 $name, 3, "$name: no IODev attribute or matching physical Modbus-device found for $hash->{NAME}"; } } - return undef; + return; } @@ -2341,7 +2460,7 @@ sub Modbus_SwpRegs($$$) { # called from logical device fuctions # with log dev hash sub ModbusLD_Send($$$;$$$){ - my ($hash, $objCombi, $op, $v1, $force, $span) = @_; + my ($hash, $objCombi, $op, $v1, $force, $reqLen) = @_; # $hash : the logival Device hash # $objCombi : type+adr # $op : read, write or scanids/scanobj @@ -2355,24 +2474,35 @@ sub ModbusLD_Send($$$;$$$){ my $type = substr($objCombi, 0, 1); my $adr = substr($objCombi, 1); my $reading = ModbusLD_ObjInfo($hash, $objCombi, "reading"); - my $len = ($op =~ /^scanobj/ ? $span : ModbusLD_ObjInfo($hash, $objCombi, "len", "defLen", 1)); - my $fcKey = ($op =~ /^scan/ ? 'read' : $op); + my $objLen = ModbusLD_ObjInfo($hash, $objCombi, "len", "defLen", 1); + my $fcKey = $op; + if ($op =~ /^scan/) { + $objLen = $reqLen; # for scan there is no objLen but reqLen is given - avoid confusing log and set objLen ... + $fcKey = 'read'; + } return if (!$ioHash); my $ioName = $ioHash->{NAME}; my $qlen = ($ioHash->{QUEUE} ? scalar(@{$ioHash->{QUEUE}}) : 0); + + Log3 $name, 3, "$name: _Send called but IO Device is disabled" if (IsDisabled ($ioName)); - Log3 $name, 4, "$name: Send called with $type$adr, len $len / span " . - ($span ? $span : "-") . " to id $devId, op $op, qlen $qlen" . - (defined($v1) ? ", value hex " . unpack ('H*', $v1) : ""); - $len = $span if ($span); # span given as parameter (only for combined read requests from GetUpdate or scans) + Log3 $name, 4, "$name: Send called with $type$adr, objLen $objLen / reqLen " . + ($reqLen ? $reqLen : "-") . " to id $devId, op $op, qlen $qlen" . + (defined($v1) && $op eq 'write' ? ", value hex " . unpack ('H*', $v1) : ""); + $reqLen = $objLen if (!$reqLen); # reqLen given as parameter (only for combined read requests from GetUpdate or scans) + + my $unpack = ModbusLD_ObjInfo($hash, $objCombi, "unpack", "defUnpack", "n"); + if ($objLen < 2 && $unpack =~ 'f') { + Log3 $name, 3, "$name: _Send with unpack containing f but len is too small - please set obj-${objCombi}-Len!"; + } if ($qlen && AttrVal($ioName, "dropQueueDoubles", 0)) { Log3 $name, 5, "$name: Send is checking if request is already in queue ($qlen requests)"; foreach my $elem (@{$ioHash->{QUEUE}}) { - Log3 $name, 5, "$name: is it $elem->{TYPE} $elem->{ADR} len $elem->{LEN} to id $elem->{MODBUSID}?"; + Log3 $name, 5, "$name: is it $elem->{TYPE} $elem->{ADR} reqLen $elem->{LEN} to id $elem->{MODBUSID}?"; if($elem->{ADR} == $adr && $elem->{TYPE} eq $type - && $elem->{LEN} == $len && $elem->{MODBUSID} eq $devId) { + && $elem->{LEN} == $reqLen && $elem->{MODBUSID} eq $devId) { Log3 $name, 4, "$name: request already in queue - dropping"; return; } @@ -2384,7 +2514,7 @@ sub ModbusLD_Send($$$;$$$){ $request{DEVHASH} = $hash; # logical device in charge $request{TYPE} = $type; # type of object (cdih) $request{ADR} = $adr; # address of object - $request{LEN} = $len; # span / number of registers / length of object + $request{LEN} = $reqLen; # number of registers / length of object $request{READING} = $reading; # reading name of the object $request{TID} = $tid; # transaction id for Modbus TCP $request{PROTOCOL} = $proto; # RTU / ASCII / ... @@ -2401,8 +2531,8 @@ sub ModbusLD_Send($$$;$$$){ Log3 $name, 4, "$name: Send queues fc $fCode to $devId" . ($proto eq "TCP" ? ", tid $tid" : "") . ", for $type$adr" . - ($reading ? " ($reading)" : "") . ", len/span $len" . ($force ? ", force" : "") . - (defined($v1) ? ", value hex " . unpack ('H*', $v1) : ""); + ($reading ? " ($reading)" : "") . ", reqLen $reqLen" . ($force ? ", force" : "") . + (defined($v1) && $op eq 'write' ? ", value hex " . unpack ('H*', $v1) : ""); if(!$qlen) { #Log3 $name, 5, "$name: Send is creating new queue"; @@ -2496,13 +2626,14 @@ sub ModbusLD_Send($$$;$$$){ defines a delay that is always enforced between the last read from the bus and the next send to the bus for all connected devices
  • clientSwitchDelay
    • defines a delay that is always enforced between the last read from the bus and the next send to the bus for all connected devices but only if the next send goes to a different device than the last one
    -
  • queueMax
    • - max length of the send queue, defaults to 100
  • dropQueueDoubles
    • prevents new request to be queued if the same request is already in the send queue
    +
  • skipGarbage
    • + if set to 1 this attribute will enhance the way the module treats Modbus response frames (RTU over serial lines) that look as if they have a wrong Modbus id as their first byte. If skipGarbage is set to 1 then the module will skip all bytes until a byte with the expected modbus id is seen. Under normal circumstances this behavior should not do any harm and lead to more robustness. However since it changes the original behavior of this module it has to be turned on explicitely.
    + For Modbus ASCII it skips bytes until the expected starting byte ":" is seen.
  • profileInterval
    • if set to something non zero it is the time period in seconds for which the module will create bus usage statistics. - Pleas note that this number should be at least twice as big as the interval used for requesting values in logical devices that use this physical device
    + Please note that this number should be at least twice as big as the interval used for requesting values in logical devices that use this physical device
    The bus usage statistics create the following readings: @@ -224,9 +232,9 @@ ModbusAttr_Initialize($)
  • alignTime
    • Aligns each periodic read request for the defined interval to this base time. This is typcally something like 00:00 (see the Fhem at command)
  • enableControlSet
    • - enables the built in set commands interval, stop, start and reread - + enables the built in set commands like interval, stop, start and reread (see above)
    + please also notice the attributes for the physical modbus interface as documented in 98_Modbus.pm
    @@ -253,6 +261,9 @@ ModbusAttr_Initialize($)
  • obj-[cdih][1-9][0-9]*-expr
    • defines a perl expression that converts the raw value read from the device. +
    +
  • obj-[cdih][1-9][0-9]*-ignoreExpr
    • + defines a perl expression that returns 1 if a value should be ignored and the existing reading should not be modified
  • obj-[cdih][1-9][0-9]*-map
    • defines a map to convert values read from the device to more convenient values when the raw value is read from the device @@ -328,9 +339,6 @@ ModbusAttr_Initialize($)
  • dev-([cdih]-)*combine
    • defines how many adjacent objects can be read in one request. If not specified, the default is 1
    -
  • dev-([cdih]-)*allowShortResponses
    • - if set to 1 the module will accept a response with valid checksum but data lengh < lengh in header -
  • dev-([cdih]-)*defLen
    • defines the default length for this object type. If not specified, the default is 1
    @@ -339,6 +347,9 @@ ModbusAttr_Initialize($)
  • dev-([cdih]-)*defExpr
    • defines a default Perl expression to use for this object type to convert raw values read. +
    +
  • dev-([cdih]-)*defIgnoreExpr
    • + defines a default Perl expression to decide when values should be ignored.
  • dev-([cdih]-)*defUnpack
    • defines the default unpack code for this object type. @@ -363,6 +374,9 @@ ModbusAttr_Initialize($)
  • dev-([cdih]-)*defShowGet
    • if set to 1 then all objects of this type will have a visible get by default.
    +
  • dev-([cdih]-)*allowShortResponses
    • + if set to 1 the module will accept a response with valid checksum but data lengh < lengh in header +
  • dev-timing-timeout
    • timeout for the device (defaults to 2 seconds)
    @@ -372,6 +386,9 @@ ModbusAttr_Initialize($)
  • dev-timing-commDelay
    • delay between the last read and a next request. Default ist 0.1 seconds.
    +
  • queueMax
    • + max length of the send queue, defaults to 100 +
  • nextOpenDelay
    • delay for Modbus-TCP connections. This defines how long the module should wait after a failed TCP connection attempt before the next reconnection attempt. This defaults to 60 seconds.
  • openTimeout