From 9f3c951ff56e2cf22eed970d8aa00ffcfd881b83 Mon Sep 17 00:00:00 2001 From: fhemzap Date: Sun, 14 Feb 2016 13:08:05 +0000 Subject: [PATCH] HMCCU: moved to FHEM directory git-svn-id: https://svn.fhem.de/fhem/trunk@10836 2b470e98-0d58-463d-a4d8-8e2adae1ed80 --- fhem/contrib/HMCCU/88_HMCCU.pm | 2406 -------------------------------- 1 file changed, 2406 deletions(-) delete mode 100644 fhem/contrib/HMCCU/88_HMCCU.pm diff --git a/fhem/contrib/HMCCU/88_HMCCU.pm b/fhem/contrib/HMCCU/88_HMCCU.pm deleted file mode 100644 index 2213a0309..000000000 --- a/fhem/contrib/HMCCU/88_HMCCU.pm +++ /dev/null @@ -1,2406 +0,0 @@ -#################################################################### -# -# 88_HMCCU.pm -# -# $Id$ -# -# Version 2.6 -# -# (c) 2016 zap (zap01 t-online de) -# -#################################################################### -# -# define HMCCU [] -# -# set devstate [...] -# set datapoint {|}. [...] -# set var [...] -# set execute -# set hmscript -# set config {|} = [...] -# -# get devicelist [dump] -# get devstate [] -# get vars -# get channel {|}[.][=] -# get datapoint . [] -# get parfile [] -# get config {|} -# get configdesc {|} -# get deviceinfo -# get rpcstate -# get update [ [{ State | Value }]] -# -# attr ccuget { State | Value } -# attr ccureadingfilter -# attr ccureadingformat { name | address } -# attr ccureadings { 0 | 1 } -# attr ccutrace {|} -# attr parfile -# attr rpcinterval { 3 | 5 | 10 } -# attr rpcport -# attr rpcqueue -# attr rpcserver { on | off } -# attr statedatapoint -# attr statevals :[,...] -# attr stripchar -# attr stripnumber { 0 | 1 | 2 } -# attr substitute -# attr updatemode { client | both | hmccu } -# -# subst_rule := [datapoint[,...]]!:[,...][;...] -#################################################################### - -package main; - -use strict; -use warnings; -use SetExtensions; -use RPC::XML::Client; -# use File::Queue; -# use Data::Dumper; -use FindBin qw($Bin); -use lib "$Bin"; -use RPCQueue; - -# CCU Device names, key = CCU device address -my %HMCCU_Devices; -# CCU Device addresses, key = CCU device name -my %HMCCU_Addresses; -# Last update of device list -my $HMCCU_UpdateTime = 0; -# Last event from CCU -my $HMCCU_EventTime = 0; - -# Flags for CCU object specification -my $HMCCU_FLAG_NAME = 1; -my $HMCCU_FLAG_CHANNEL = 2; -my $HMCCU_FLAG_DATAPOINT = 4; -my $HMCCU_FLAG_ADDRESS = 8; -my $HMCCU_FLAG_INTERFACE = 16; -my $HMCCU_FLAG_FULLADDR = 32; - -# Valid flag combinations -my $HMCCU_FLAGS_IACD = $HMCCU_FLAG_INTERFACE | $HMCCU_FLAG_ADDRESS | - $HMCCU_FLAG_CHANNEL | $HMCCU_FLAG_DATAPOINT; -my $HMCCU_FLAGS_IAC = $HMCCU_FLAG_INTERFACE | $HMCCU_FLAG_ADDRESS | - $HMCCU_FLAG_CHANNEL; -my $HMCCU_FLAGS_ACD = $HMCCU_FLAG_ADDRESS | $HMCCU_FLAG_CHANNEL | - $HMCCU_FLAG_DATAPOINT; -my $HMCCU_FLAGS_AC = $HMCCU_FLAG_ADDRESS | $HMCCU_FLAG_CHANNEL; -my $HMCCU_FLAGS_ND = $HMCCU_FLAG_NAME | $HMCCU_FLAG_DATAPOINT; -my $HMCCU_FLAGS_NC = $HMCCU_FLAG_NAME | $HMCCU_FLAG_CHANNEL; -my $HMCCU_FLAGS_NCD = $HMCCU_FLAG_NAME | $HMCCU_FLAG_CHANNEL | - $HMCCU_FLAG_DATAPOINT; - -# Declare functions -sub HMCCU_Define ($$); -sub HMCCU_Undef ($$); -sub HMCCU_Shutdown ($); -sub HMCCU_Set ($@); -sub HMCCU_Get ($@); -sub HMCCU_Attr ($@); -sub HMCCU_ParseObject ($$); -sub HMCCU_GetReadingName ($$$$$$); -sub HMCCU_FormatReadingValue ($$); -sub HMCCU_SetError ($$); -sub HMCCU_SetState ($$); -sub HMCCU_Substitute ($$$$); -sub HMCCU_SubstRule ($$$); -sub HMCCU_UpdateClients ($$$); -sub HMCCU_UpdateClientReading ($@); -sub HMCCU_DeleteDevices ($); -sub HMCCU_StartRPCServer ($); -sub HMCCU_StopRPCServer ($); -sub HMCCU_IsRPCServerRunning ($$$); -sub HMCCU_CheckProcess ($$); -sub HMCCU_GetDeviceInfo ($$$); -sub HMCCU_GetDeviceList ($); -sub HMCCU_GetAddress ($$$); -sub HMCCU_GetCCUObjectAttribute ($$); -sub HMCCU_GetHash ($@); -sub HMCCU_GetAttribute ($$$$); -sub HMCCU_GetSpecialDatapoints ($$$$$); -sub HMCCU_IsValidDevice ($); -sub HMCCU_GetDeviceName ($$); -sub HMCCU_GetChannelName ($$); -sub HMCCU_GetDeviceType ($$); -sub HMCCU_GetDeviceChannels ($); -sub HMCCU_GetDeviceInterface ($$); -sub HMCCU_ReadRPCQueue ($); -sub HMCCU_HMScript ($$); -sub HMCCU_GetDatapoint ($@); -sub HMCCU_SetDatapoint ($$$); -sub HMCCU_GetVariables ($$); -sub HMCCU_SetVariable ($$$); -sub HMCCU_GetUpdate ($$$); -sub HMCCU_GetChannel ($$); -sub HMCCU_RPCGetConfig ($$$); -sub HMCCU_RPCSetConfig ($$$); -sub HMCCU_State ($); -sub HMCCU_Dewpoint ($$$$); - - -##################################### -# Initialize module -##################################### - -sub HMCCU_Initialize ($) -{ - my ($hash) = @_; - - $hash->{DefFn} = "HMCCU_Define"; - $hash->{UndefFn} = "HMCCU_Undef"; - $hash->{SetFn} = "HMCCU_Set"; - $hash->{GetFn} = "HMCCU_Get"; - $hash->{AttrFn} = "HMCCU_Attr"; - $hash->{ShutdownFn} = "HMCCU_Shutdown"; - - $hash->{AttrList} = "stripchar stripnumber:0,1,2 ccureadings:0,1 ccureadingfilter ccureadingformat:name,address rpcinterval:3,5,10 rpcqueue rpcport rpcserver:on,off parfile statedatapoint statevals substitute updatemode:client,both,hmccu ccutrace ccuget:Value,State loglevel:0,1,2,3,4,5,6 ". $readingFnAttributes; -} - -##################################### -# Define device -##################################### - -sub HMCCU_Define ($$) -{ - my ($hash, $def) = @_; - my $name = $hash->{NAME}; - my @a = split("[ \t][ \t]*", $def); - - return "Define CCU hostname or IP address as a parameter" if(@a < 3); - - $hash->{host} = $a[2]; - $hash->{Clients} = ':HMCCUDEV:HMCCUCHN:'; - - $hash->{DevCount} = HMCCU_GetDeviceList ($hash); - $hash->{NewDevices} = 0; - - return undef; -} - -##################################### -# Set attribute -##################################### - -sub HMCCU_Attr ($@) -{ - my ($cmd, $name, $attrname, $attrval) = @_; - my $hash = $defs{$name}; - - if (defined ($attrval) && $cmd eq "set") { - if ($attrname eq "rpcserver") { - if ($attrval eq 'on') { - if (HMCCU_StartRPCServer ($hash)) { - InternalTimer (gettimeofday()+60, - 'HMCCU_ReadRPCQueue', $hash, 0); - } - } - elsif ($attrval eq 'off') { - HMCCU_StopRPCServer ($hash); - RemoveInternalTimer ($hash); - } - } - } - - return undef; -} - -##################################### -# Delete device -##################################### - -sub HMCCU_Undef ($$) -{ - my ($hash, $arg) = @_; - - # Shutdown RPC server - HMCCU_Shutdown ($hash); - - # Delete reference to IO module in client devices - my @keylist = sort keys %defs; - foreach my $d (@keylist) { - if (exists ($defs{$d}) && exists($defs{$d}{IODev}) && - $defs{$d}{IODev} == $hash) { - delete $defs{$d}{IODev}; - } - } - - return undef; -} - -##################################### -# Shutdown FHEM -##################################### - -sub HMCCU_Shutdown ($) -{ - my ($hash) = @_; - - # Shutdown RPC server - HMCCU_StopRPCServer ($hash); - RemoveInternalTimer ($hash); - - return undef; -} - -##################################### -# Set commands -##################################### - -sub HMCCU_Set ($@) -{ - my ($hash, @a) = @_; - my $name = shift @a; - my $opt = shift @a; - my $options = "devstate datapoint var execute hmscript config"; - my $host = $hash->{host}; - - my $stripchar = AttrVal ($name, "stripchar", ''); - my $statedatapoint = AttrVal ($name, "statedatapoint", 'STATE'); - my $statevals = AttrVal ($name, "statevals", ''); - my $ccureadings = AttrVal ($name, "ccureadings", 'name'); - my $readingformat = AttrVal ($name, "ccureadingformat", 'name'); - my $substitute = AttrVal ($name, "substitute", ''); - - if ($opt eq 'devstate' || $opt eq 'datapoint' || $opt eq 'var') { - my $objname = shift @a; - my $objvalue = join ('%20', @a); - my $result; - - if (!defined ($objname) || !defined ($objvalue)) { - return HMCCU_SetError ($hash, "Usage: set $name $opt {ccuobject} {value} [...]"); - } - - $objname =~ s/$stripchar$// if ($stripchar ne ''); - $objvalue = HMCCU_Substitute ($objvalue, $statevals, 1, ''); - - if ($opt eq 'var') { - $result = HMCCU_SetVariable ($hash, $objname, $objvalue); - } - elsif ($opt eq 'devstate') { - $result = HMCCU_SetDatapoint ($hash, $objname.'.'.$statedatapoint, $objvalue); - } - else { - $result = HMCCU_SetDatapoint ($hash, $objname, $objvalue); - } - - return HMCCU_SetError ($hash, $result) if ($result < 0); - return HMCCU_SetState ($hash, "OK"); - } - elsif ($opt eq "execute") { - my $program = shift @a; - my $response; - - return HMCCU_SetError ($hash, "Usage: set $name execute {program-name}") if (!defined ($program)); - - my $url = qq(http://$host:8181/do.exe?r1=dom.GetObject("$program").ProgramExecute()); - $response = GetFileFromURL ($url); - $response =~ m/(.*)<\/r1>/; - my $value = $1; - if (defined ($value) && $value ne '' && $value ne 'null') { - return HMCCU_SetState ($hash, "OK"); - } - else { - return HMCCU_SetError ($hash, "Program execution error"); - } - } - elsif ($opt eq 'hmscript') { - my $scrfile = shift @a; - my $script; - my $response; - - return HMCCU_SetError ($hash, "Usage: set $name hmscript {scriptfile}") if (!defined ($scrfile)); - if (open (SCRFILE, "<$scrfile")) { - my @lines = ; - $script = join ("\n", @lines); - close (SCRFILE); - } - else { - return HMCCU_SetError ($hash, "Can't open file $scrfile"); - } - - $response = HMCCU_HMScript ($host, $script); - return HMCCU_SetError ($hash, -2) if ($response eq ''); - - HMCCU_SetState ($hash, "OK"); - return $response if (! $ccureadings); - - foreach my $line (split /\n/, $response) { - my @tokens = split /=/, $line; - next if (@tokens != 2); - my $reading; - my ($int, $add, $chn, $dpt, $nam, $flags) = HMCCU_ParseObject ($tokens[0], $HMCCU_FLAG_INTERFACE); - ($add, $chn) = HMCCU_GetAddress ($nam, '', '') if ($flags == $HMCCU_FLAGS_NCD); - if ($flags == $HMCCU_FLAGS_IACD || $flags == $HMCCU_FLAGS_NCD) { - $reading = HMCCU_GetReadingName ($int, $add, $chn, $dpt, $nam, $readingformat); - HMCCU_UpdateClientReading ($hash, $add, $chn, $reading, $tokens[1]); - } - else { - my $Value = HMCCU_Substitute ($tokens[1], $substitute, 0, $tokens[0]); - readingsSingleUpdate ($hash, $tokens[0], $Value, 1); - } - } - - return undef; - } - elsif ($opt eq 'config') { - my $ccuobj = shift @a; - - return HMCCU_SetError ($hash, - "Usage: set $name config {devicename|deviceaddress|channelname|channeladdress} {param=value} [...]") if (!defined ($ccuobj) || @a < 1); - my $rc = HMCCU_RPCSetConfig ($hash, $ccuobj, \@a); - - return HMCCU_SetError ($hash, $rc) if ($rc < 0); - return HMCCU_SetState ($hash, "OK"); - } - else { - return "HMCCU: Unknown argument $opt, choose one of ".$options; - } -} - -##################################### -# Get commands -##################################### - -sub HMCCU_Get ($@) -{ - my ($hash, @a) = @_; - my $name = shift @a; - my $opt = shift @a; - my $options = "devicelist:noArg devstate datapoint vars channel update parfile config configdesc rpcstate:noArg deviceinfo"; - my $host = $hash->{host}; - - my $ccureadingformat = AttrVal ($name, "ccureadingformat", 'name'); - my $ccureadings = AttrVal ($name, "ccureadings", 1); - my $parfile = AttrVal ($name, "parfile", ''); - my $statedatapoint = AttrVal ($name, "statedatapoint", 'STATE'); - my $substitute = AttrVal ($name, 'substitute', ''); - my $rpcport = AttrVal ($name, 'rpcport', '2001'); - - my $readname; - my $readaddr; - my $result = ''; - my $rc; - - if ($opt eq 'devstate') { - my $ccuobj = shift @a; - my $reading = shift @a; - - if (!defined ($ccuobj)) { - return HMCCU_SetError ($hash, - "Usage: get $name devstate {channel-name|channel-address} [reading]"); - } - $reading = '' if (!defined ($reading)); - - ($rc, $result) = HMCCU_GetDatapoint ($hash, $ccuobj.'.'.$statedatapoint, $reading); - return HMCCU_SetError ($hash, $rc) if ($rc < 0); - return HMCCU_SetState ($hash, "OK"); - } - elsif ($opt eq 'datapoint') { - my $ccuobj = shift @a; - my $reading = shift @a; - - return HMCCU_SetError ($hash, - "Usage: get $name datapoint {channel-name|channel-address}.{datapoint} [reading]") if (!defined ($ccuobj)); - $reading = '' if (!defined ($reading)); - - ($rc, $result) = HMCCU_GetDatapoint ($hash, $ccuobj, $reading); - return HMCCU_SetError ($hash, $rc) if ($rc < 0); - - HMCCU_SetState ($hash, "OK"); - return $ccureadings ? undef : $result; - } - elsif ($opt eq 'vars') { - my $varname = shift @a; - - return HMCCU_SetError ($hash, "Usage: get $name vars {regexp}[,...]") if (!defined ($varname)); - - ($rc, $result) = HMCCU_GetVariables ($hash, $varname); - return HMCCU_SetError ($hash, $rc) if ($rc < 0); - - HMCCU_SetState ($hash, "OK"); - return $ccureadings ? undef : $result; - } - elsif ($opt eq 'channel') { - my @chnlist; - - foreach my $objname (@a) { - last if (!defined ($objname)); - if ($objname =~ /^.*=/) { - $objname =~ s/=/ /; - } - push (@chnlist, $objname); - } - if (@chnlist == 0) { - return HMCCU_SetError ($hash, "Usage: get $name channel {channel-name|channel-address}[.{datapoint-expr}] [...]"); - } - - ($rc, $result) = HMCCU_GetChannel ($hash, \@chnlist); - return HMCCU_SetError ($hash, $rc) if ($rc < 0); - - HMCCU_SetState ($hash, "OK"); - return $ccureadings ? undef : $result; - } - elsif ($opt eq 'update') { - my $devexp = shift @a; - $devexp = '.*' if (!defined ($devexp)); - my $ccuget = shift @a; - $ccuget = 'Attr' if (!defined ($ccuget)); - if ($ccuget !~ /^(Attr|State|Value)$/) { - return HMCCU_SetError ($hash, "Usage: get $name update [device-expr [{'State'|'Value'}]]"); - } - - my ($c_ok, $c_err) = HMCCU_UpdateClients ($hash, $devexp, $ccuget); - - return "$c_ok client devices successfully updated. Update for $c_err client devices failed"; - } - elsif ($opt eq 'parfile') { - my $par_parfile = shift @a; - my @parameters; - my $parcount; - - if (defined ($par_parfile)) { - $parfile = $par_parfile; - } - else { - return HMCCU_SetError ($hash, "No parameter file specified") if ($parfile eq ''); - } - - # Read parameter file - if (open (PARFILE, "<$parfile")) { - @parameters = ; - $parcount = scalar @parameters; - close (PARFILE); - } - else { - return HMCCU_SetError ($hash, "Can't open file $parfile"); - } - - return HMCCU_SetError ($hash, "Empty parameter file") if ($parcount < 1); - - ($rc, $result) = HMCCU_GetChannel ($hash, \@parameters); - return HMCCU_SetError ($hash, $rc) if ($rc < 0); - - HMCCU_SetState ($hash, "OK"); - return $ccureadings ? undef : $result; - } - elsif ($opt eq 'deviceinfo') { - my $device = shift @a; - - return HMCCU_SetError ($hash, "Usage: get $name deviceinfo {device-name|device-address} [{'State'|'Value'}]") if (!defined ($device)); - - my $ccuget = shift @a; - $ccuget = 'Attr' if (!defined ($ccuget)); - if ($ccuget !~ /^(Attr|State|Value)$/) { - return HMCCU_SetError ($hash, "Usage: get $name deviceinfo {device-name|device-address} [{'State'|'Value'}]"); - } - - $result = HMCCU_GetDeviceInfo ($hash, $device, $ccuget); - return HMCCU_SetError ($hash, -2) if ($result eq ''); - return $result; - } - elsif ($opt eq 'rpcstate') { - my @pidlist; - foreach my $port (split (',', $rpcport)) { - my $pid = HMCCU_CheckProcess ($hash, $port); - push (@pidlist, $pid) if ($pid > 0); - } - if (@pidlist > 0) { - return "RPC process(es) running with pid(s) ".join (',', @pidlist);; - } - else { - return "RPC process not running"; - } - } - elsif ($opt eq 'devicelist') { - my $dumplist = shift @a; - - $hash->{DevCount} = HMCCU_GetDeviceList ($hash); - - if ($hash->{DevCount} < 0) { - return HMCCU_SetError ($hash, -2); - } - elsif ($hash->{DevCount} == 0) { - return HMCCU_SetError ($hash, "No devices received from CCU"); - } - - HMCCU_SetState ($hash, "OK"); - - if (defined ($dumplist) && $dumplist eq 'dump') { - foreach my $add (sort keys %HMCCU_Devices) { - $result .= $HMCCU_Devices{$add}{name}."\n"; - } - return $result; - } - - return "Read ".$hash->{DevCount}." devices/channels from CCU"; - } - elsif ($opt eq 'config') { - my $ccuobj = shift @a; - - return HMCCU_SetError ($hash, - "Usage: get $name config {devicename|deviceaddress|channelname|channeladdress}") if (!defined ($ccuobj)); - my ($rc, $res) = HMCCU_RPCGetConfig ($hash, $ccuobj, "getParamset"); - return HMCCU_SetError ($hash, $rc) if ($rc < 0); - - HMCCU_SetState ($hash, "OK"); - return $ccureadings ? undef : $result; - } - elsif ($opt eq 'configdesc') { - my $ccuobj = shift @a; - - return HMCCU_SetError ($hash, - "Usage: get $name configdesc {devicename|deviceaddress|channelname|channeladdress}") if (!defined ($ccuobj)); - my ($rc, $res) = HMCCU_RPCGetConfig ($hash, $ccuobj, "getParamsetDescription"); - return HMCCU_SetError ($hash, $rc) if ($rc < 0); - - HMCCU_SetState ($hash, "OK"); - return $res; - } - else { - return "HMCCU: Unknown argument $opt, choose one of ".$options; - } -} - -################################################################## -# Parse CCU object specification -# -# Possible syntax for datapoints: -# Interface.Address:Channel.Datapoint -# Address:Channel.Datapoint -# Channelname.Datapoint -# -# Possible syntax for channels: -# Interface.Address:Channel -# Address:Channel -# Channelname -# -# If object name doesn't match the rules above object is treated -# as name. -# -# Return list of detected attributes: -# (Interface, Address, Channel, Datapoint, Name, Flags) -################################################################## - -sub HMCCU_ParseObject ($$) -{ - my ($object, $flags) = @_; - my ($i, $a, $c, $d, $n, $f) = ('', '', '', '', '', '', 0); - - if ($object =~ /^(.+?)\.([A-Z]{3,3}[0-9]{7,7}):([0-9]{1,2})\.(.+)$/) { - # - # Interface.Address:Channel.Datapoint [30=11110] - # - $f = $HMCCU_FLAGS_IACD; - ($i, $a, $c, $d) = ($1, $2, $3, $4); - } - elsif ($object =~ /^(.+)\.([A-Z]{3,3}[0-9]{7,7}):([0-9]{1,2})$/) { - # - # Interface.Address:Channel [26=11010] - # - $f = $HMCCU_FLAGS_IAC | ($flags & $HMCCU_FLAG_DATAPOINT); - ($i, $a, $c, $d) = ($1, $2, $3, $flags & $HMCCU_FLAG_DATAPOINT ? '.*' : ''); - } - elsif ($object =~ /^([A-Z]{3,3}[0-9]{7,7}):([0-9]){1,2}\.(.+)$/) { - # - # Address:Channel.Datapoint [14=01110] - # - $f = $HMCCU_FLAGS_ACD | ($flags & $HMCCU_FLAG_INTERFACE); - ($i, $a, $c, $d) = ($flags & $HMCCU_FLAG_INTERFACE ? 'BidCos-RF' : '', $1, $2, $3); - } - elsif ($object =~ /^([A-Z]{3,3}[0-9]{7,7}):([0-9]){1,2}$/) { - # - # Address:Channel [10=01010] - # - $f = $HMCCU_FLAGS_AC | ($flags & $HMCCU_FLAG_DATAPOINT) | ($flags & $HMCCU_FLAG_INTERFACE); - ($i, $a, $c, $d) = ($flags & $HMCCU_FLAG_INTERFACE ? 'BidCos-RF' : '', $1, $2, - $flags & $HMCCU_FLAG_DATAPOINT ? '.*' : ''); - } - elsif ($object =~ /^([A-Z]{3,3}[0-9]{7,7})$/) { - # - # Address - # - $f = $HMCCU_FLAG_ADDRESS; - ($i, $a) = ($flags & $HMCCU_FLAG_INTERFACE ? 'BidCos-RF' : '', $1); - } - elsif ($object =~ /^(.+?)\.(.+)$/) { - # - # Name.Datapoint - # - $f = $HMCCU_FLAGS_ND; - ($n, $d) = ($1, $2); - } - elsif ($object =~ /^.+$/) { - # - # Name [1=00001] - # - $f = $HMCCU_FLAG_NAME | ($flags & $HMCCU_FLAG_DATAPOINT); - ($n, $d) = ($object, $flags & $HMCCU_FLAG_DATAPOINT ? '.*' : ''); - } - else { - $f = 0; - } - - # Check if name is a valid channel name - if ($f & $HMCCU_FLAG_NAME) { - my ($add, $chn) = HMCCU_GetAddress ($n, '', ''); - if ($chn ne '') { - $f = $f | $HMCCU_FLAG_CHANNEL; - } - if ($flags & $HMCCU_FLAG_FULLADDR) { - ($i, $a, $c) = (HMCCU_GetDeviceInterface ($add, 'BidCos-RF'), $add, $chn); - $f |= $HMCCU_FLAG_INTERFACE; - $f |= $HMCCU_FLAG_ADDRESS if ($add ne ''); - $f |= $HMCCU_FLAG_CHANNEL if ($chn ne ''); - } - } - - return ($i, $a, $c, $d, $n, $f); -} - -################################################################## -# Build reading name -# -# Parameters: -# -# Interface,Address,ChannelNo,Datapoint,ChannelNam,ReadingFormat -# -# ReadingFormat := { name | datapoint | address } -# -# Valid combinations: -# -# ChannelNam,Datapoint -# Address,Datapoint -# Address,ChannelNo,Datapoint -################################################################## - -sub HMCCU_GetReadingName ($$$$$$) -{ - my ($i, $a, $c, $d, $n, $rf) = @_; - my $rn = ''; - - # Datapoint is mandatory - return '' if ($d eq ''); - - if ($rf eq 'datapoint') { - $rn = $d; - } - elsif ($rf eq 'name') { - if ($n eq '') { - if ($a ne '' && $c ne '') { - $n = HMCCU_GetChannelName ($a.':'.$c, ''); - } - elsif ($a ne '' && $c eq '') { - $n = HMCCU_GetDeviceName ($a, ''); - } - else { - return ''; - } - } - - $n =~ s/\:/\./g; - $n =~ s/[^A-Za-z\d_\.-]+/_/g; - - $rn = $n ne '' ? $n.'.'.$d : ''; - } - elsif ($rf eq 'address') { - if ($a eq '' && $n ne '') { - ($a, $c) = HMCCU_GetAddress ($n, '', ''); - } - - if ($a ne '') { - my $t = $a; - $i = HMCCU_GetDeviceInterface ($a, '') if ($i eq ''); - $t = $i.'.'.$t if ($i ne ''); - $t = $t.'.'.$c if ($c ne ''); - - $rn = $t.'.'.$d; - } - } - - return $rn; -} - -################################################################## -# Format reading value depending attribute stripnumber. -################################################################## - -sub HMCCU_FormatReadingValue ($$) -{ - my ($hash, $value) = @_; - - my $stripnumber = AttrVal ($hash->{NAME}, 'stripnumber', 0); - - if ($stripnumber == 1) { - $value =~ s/(\.[0-9])[0-9]+/$1/; - } - elsif ($stripnumber == 2) { - $value =~ s/[0]+$//; - $value =~ s/\.$//; - } - - return $value; -} - -################################################################## -# Set error state and write log file message -################################################################## - -sub HMCCU_SetError ($$) -{ - my ($hash, $text) = @_; - my $name = $hash->{NAME}; - my $msg; - my %errlist = ( - -1 => 'Channel name or address invalid', - -2 => 'Execution of CCU script or command failed', - -3 => 'Cannot detect IO device', - -4 => 'Device deleted in CCU' - ); - - $msg = exists ($errlist{$text}) ? $errlist{$text} : $text; - $msg = "HMCCU: ".$name." ". $msg; - - HMCCU_SetState ($hash, "Error"); - Log 1, $msg; - return $msg; -} - -################################################################## -# Set state -################################################################## - -sub HMCCU_SetState ($$) -{ - my ($hash, $text) = @_; - - if (defined ($hash) && defined ($text)) { - readingsSingleUpdate ($hash, "state", $text, 1); - } - - return undef; -} - -################################################################## -# Substitute first occurrence of regular expressions or fixed -# string. Floating point values are ignored. Integer values are -# compared with complete value. -# mode: 0=Substitute regular expression, 1=Substitute text -################################################################## - -sub HMCCU_Substitute ($$$$) -{ - my ($value, $substrule, $mode, $reading) = @_; - my $rc = 0; - my $newvalue; - - return $value if (!defined ($substrule) || $substrule eq ''); - return $value if ($value !~ /^[+-]?\d+$/ && $value =~ /^[+-]?\d*\.?\d+(?:(?:e|E)\d+)?$/); - - $reading =~ s/.+\.(.+)$/$1/; - - my @rulelist = split (';', $substrule); - foreach my $rule (@rulelist) { - my @ruletoks = split ('!', $rule); - if (@ruletoks == 2 && $reading ne '' && $mode == 0) { - my @dptlist = split (',', $ruletoks[0]); - foreach my $dpt (@dptlist) { - if ($dpt eq $reading) { - ($rc, $newvalue) = HMCCU_SubstRule ($value, $ruletoks[1], $mode); - return $newvalue; - } - } - } - elsif (@ruletoks == 1) { - ($rc, $newvalue) = HMCCU_SubstRule ($value, $ruletoks[0], $mode); - return $newvalue if ($rc == 1); - } - } - - return $value; -} - -################################################################## -# Execute substitution -################################################################## - -sub HMCCU_SubstRule ($$$) -{ - my ($value, $substitutes, $mode ) = @_; - my $rc = 0; - - my @sub_list = split /,/,$substitutes; - foreach my $s (@sub_list) { - my ($regexp, $text) = split /:/,$s; - next if (!defined ($regexp) || !defined($text)); - if ($mode == 0 && $value =~ /$regexp/ && $value !~ /^[+-]?\d+$/) { - $value =~ s/$regexp/$text/; - $rc = 1; - last; - } - elsif (($mode == 1 || $value =~/^[+-]?\d+$/) && $value =~ /^$regexp$/) { - $value =~ s/^$regexp$/$text/; - $rc = 1; - last; - } - } - - return ($rc, $value); -} - -################################################################## -# Update all datapoint/readings of all client devices -################################################################## - -sub HMCCU_UpdateClients ($$$) -{ - my ($hash, $devexp, $ccuget) = @_; - my $c_ok = 0; - my $c_err = 0; - - foreach my $d (keys %defs) { - # Get hash of client device - my $ch = $defs{$d}; - next if ($ch->{TYPE} ne 'HMCCUDEV' && $ch->{TYPE} ne 'HMCCUCHN'); - next if ($ch->{NAME} !~ /$devexp/); - next if (!defined ($ch->{IODev}) || !defined ($ch->{ccuaddr})); - - my $rc = HMCCU_GetUpdate ($ch, $ch->{ccuaddr}, $ccuget); - if ($rc <= 0) { - $c_err++; - } - else { - $c_ok++; - } - } - - return ($c_ok, $c_err); -} - -################################################################## -# Update HMCCU readings and client readings. -# -# Parameters: -# hash, devadd, channelno, reading, value, [mode] -# -# Parameter devadd can be a device or a channel address. If -# devadd is a channel address parameter channelno should be ''. -# Valid modes are: hmccu, rpcevent, client. -# Reading values are substituted if attribute substitute is set -# in client device. -################################################################## - -sub HMCCU_UpdateClientReading ($@) -{ - my ($hash, $devadd, $channel, $reading, $value, $mode) = @_; - my $name = $hash->{NAME}; - - my $hmccu_substitute = AttrVal ($name, 'substitute', ''); - my $hmccu_updreadings = AttrVal ($name, 'ccureadings', 1); - my $hmccu_flt = AttrVal ($name, 'ccureadingfilter', '.*'); - my $updatemode = AttrVal ($name, 'updatemode', 'hmccu'); - - # Update mode can be: client, hmccu, both, rpcevent - $updatemode = $mode if (defined ($mode)); - - # Check syntax - return 0 if (!defined ($hash) || !defined ($devadd) || - !defined ($channel) || !defined ($reading) || !defined ($value)); - - my $chnadd = $channel ne '' ? $devadd.':'.$channel : $devadd; - my $hmccu_value = ''; - my $dpt = ''; - if ($reading =~ /.*\.(.+)$/) { - $dpt = $1; - } - - if ($hmccu_updreadings && $updatemode ne 'client') { - $hmccu_value = HMCCU_Substitute ($value, $hmccu_substitute, 0, $reading); - $hmccu_value = HMCCU_FormatReadingValue ($hash, $hmccu_value); - if ($updatemode ne 'rpcevent' && ($dpt eq '' || $dpt =~ /$hmccu_flt/)) { - readingsSingleUpdate ($hash, $reading, $hmccu_value, 1); - } - return $hmccu_value if ($updatemode eq 'hmccu'); - } - - # Update client readings - foreach my $d (keys %defs) { - # Get hash and name of client device - my $ch = $defs{$d}; - my $cn = $ch->{NAME}; - - next if ($ch->{TYPE} ne 'HMCCUDEV' && $ch->{TYPE} ne 'HMCCUCHN'); - next if (!defined ($ch->{IODev}) || !defined ($ch->{ccuaddr})); - next if ($ch->{IODev} != $hash); - next if ($ch->{ccuaddr} ne $devadd && $ch->{ccuaddr} ne $chnadd); - - # Get attributes of client device - my $upd = AttrVal ($cn, 'ccureadings', 1); - my $crf = AttrVal ($cn, 'ccureadingformat', 'name'); - my $flt = AttrVal ($cn, 'ccureadingfilter', '.*'); - my $substitute = AttrVal ($cn, 'substitute', ''); - my ($sc, $st, $cc, $cd) = HMCCU_GetSpecialDatapoints ($ch, 'STATE', '', '', ''); - last if ($upd == 0); - next if ($dpt eq '' || $dpt !~ /$flt/); - - my $clreading = HMCCU_GetReadingName ('', $devadd, $channel, $dpt, '', $crf); - next if ($clreading eq ''); - - # Client substitute attribute has priority - my $cl_value; - if ($substitute ne '') { - $cl_value = HMCCU_Substitute ($value, $substitute, 0, $clreading); - } - else { - $cl_value = HMCCU_Substitute ($value, $hmccu_substitute, 0, $clreading); - } - $cl_value = HMCCU_FormatReadingValue ($ch, $cl_value); - - readingsSingleUpdate ($ch, $clreading, $cl_value, 1); - if ($cd ne '' && $dpt eq $cd && $channel eq $cc) { - readingsSingleUpdate ($ch, 'control', $cl_value, 1); - } - if ($clreading =~ /\.$st$/ && ($sc eq '' || $sc eq $channel)) { - HMCCU_SetState ($ch, $cl_value); - } - } - - return $hmccu_value; -} - -#################################################### -# Mark client devices deleted in CCU as invalid -#################################################### - -sub HMCCU_DeleteDevices ($) -{ - my ($devlist) = @_; - - foreach my $a (@$devlist) { - my $cc = $HMCCU_Devices{$a}{channels}; - $HMCCU_Devices{$a}{valid} = 0; - $HMCCU_Addresses{$HMCCU_Devices{$a}{name}}{valid} = 0; - for (my $i=0; $i<$cc; $i++) { - $HMCCU_Devices{$a.':'.$i}{valid} = 0; - $HMCCU_Addresses{$HMCCU_Devices{$a.':'.$i}{name}}{valid} = 0; - } - foreach my $d (keys %defs) { - my $ch = $defs{$d}; - if ($ch->{TYPE} eq 'HMCCUDEV' && $ch->{ccuaddr} eq $a) { - $ch->{ccudevstate} = 'Deleted'; - readingsSingleUpdate ($ch, 'state', 'Deleted', 1); - } - elsif ($ch->{TYPE} eq 'HMCCUCHN' && $ch->{ccuaddr} =~ /^$a:[0-9]+/) { - $ch->{ccudevstate} = 'Deleted'; - readingsSingleUpdate ($ch, 'state', 'Deleted', 1); - } - } - } -} - -#################################################### -# Start RPC server -#################################################### - -sub HMCCU_StartRPCServer ($) -{ - my ($hash) = @_; - my $name = $hash->{NAME}; - - my $modpath = AttrVal ('global', 'modpath', '/opt/fhem'); - my $logfile = $modpath."/log/ccurpcd"; - my $rpcqueue = AttrVal ($name, 'rpcqueue', '/tmp/ccuqueue'); - my $rpcport = AttrVal ($name, 'rpcport', '2001'); - - my @hm_pids; - my @ex_pids; - HMCCU_IsRPCServerRunning ($hash, \@hm_pids, \@ex_pids); - if (@hm_pids > 0) { - Log 1, "HMCCU: RPC server(s) already running with PIDs ".join (',', @hm_pids); - return scalar (@hm_pids); - } - elsif (@ex_pids > 0) { - Log 1, "HMCCU: Externally launched RPC server(s) detected. Kill process(es) manually with command kill -SIGINT pid for pid=".join (',', @ex_pids); - return 0; - } - - # Check if RPC server exists - my $rpcserver = $modpath."/FHEM/ccurpcd.pl"; - if (! -e $rpcserver) { - Log 1, "HMCCU: RPC server file ccurpcd.pl not found"; - return 0; - } - - # Fork child process(es) - foreach my $port (split (',', $rpcport)) { - my $rpcqueueport = $rpcqueue."_".$port; - my $logfileport = $logfile."_".$port.".log"; - - my $pid = fork (); - if (!defined ($pid)) { - Log 1, "HMCCU: Can't fork child process for CCU port $port"; - next; - } - - if (!$pid) { - # Child process, replace it by RPC server - exec ($rpcserver." ".$hash->{host}." ".$port." ".$rpcqueueport." ".$logfileport); - - # When we reach this line start of RPC server failed and child - # process can exit. - die; - } - - push (@hm_pids, $pid); - Log 1, "HMCCU: RPC server started with pid ".$pid; - } - - $hash->{RPCPID} = join (',', @hm_pids); - $hash->{RPCPRC} = $rpcserver; - - return scalar (@hm_pids); -} - -#################################################### -# Start RPC server -#################################################### - -sub HMCCU_StopRPCServer ($) -{ - my ($hash) = @_; - - my @hm_pids; - my @ex_pids; - HMCCU_IsRPCServerRunning ($hash, \@hm_pids, \@ex_pids); - if (@hm_pids > 0) { - foreach my $pid (@hm_pids) { - Log 1, "HMCCU: Stopping RPC server with PID $pid"; - kill ('INT', $pid); - } - $hash->{RPCPID} = '0'; - $hash->{RPCPRC} = 'none'; - } - else { - Log 1, "HMCCU: RPC server not running"; - return 0; - } - - if (@ex_pids > 0) { - foreach my $pid (@ex_pids) { - Log 1, "HMCCU: Externally launched RPC server detected. Kill process manually with command kill -SIGINT $pid"; - } - return 0; - } - - return 1; -} - -#################################################### -# Check if RPC server is running. Return list of PIDs: -# Empty = No process running. -# >1 = PID of RPC server launched by HMCCU -# <0 = PID of externally launched RPC server -#################################################### - -sub HMCCU_IsRPCServerRunning ($$$) -{ - my ($hash, $hm_pids, $ex_pids) = @_; - - my @rpcpids; - if (defined ($hash->{RPCPID}) && $hash->{RPCPID} ne '0') { - @rpcpids = split (',', $hash->{RPCPID}); - } - - my $rpcport = AttrVal ($hash->{NAME}, 'rpcport', '2001'); - foreach my $port (split (',', $rpcport)) { - my $pid = HMCCU_CheckProcess ($hash, $port); - next if ($pid == 0); - if (grep { $_ eq $pid } @rpcpids) { - if (kill (0, $pid)) { - push (@$hm_pids, $pid); - } - else { - push (@$ex_pids, $pid); - } - } - else { - push (@$ex_pids, $pid); - } - } - - return (@$hm_pids > 0 || @$ex_pids > 0) ? 1 : 0; -} - -#################################################### -# Get PID of RPC server process (0=not running) -#################################################### - -sub HMCCU_CheckProcess ($$) -{ - my ($hash, $port) = @_; - -# return 0 if (!defined ($hash->{RPCPRC}) || $hash->{RPCPRC} eq 'none'); - - my $modpath = AttrVal ('global', 'modpath', '/opt/fhem'); - my $rpcserver = $modpath."/FHEM/ccurpcd.pl"; - my $pdump = `ps -ef | grep $rpcserver | grep -v grep`; - my @plist = split "\n", $pdump; - - foreach my $proc (@plist) { - # Remove leading blanks, fix for MacOS. Thanks to mcdeck - $proc =~ s/^\s+//; - my @procattr = split /\s+/, $proc; - return $procattr[1] if ($procattr[1] != $$ && $procattr[7] =~ /perl$/ && $procattr[8] eq $rpcserver && - $procattr[10] eq "$port"); - } - - return 0; -} - -#################################################### -# Get channel and datapoints of CCU device -#################################################### - -sub HMCCU_GetDeviceInfo ($$$) -{ - my ($hash, $device, $ccuget) = @_; - my $devname = ''; - - my $hmccu_hash = HMCCU_GetHash ($hash); - return '' if (!defined ($hmccu_hash)); - - $ccuget = HMCCU_GetAttribute ($hmccu_hash, $hash, 'ccuget', 'Value') if ($ccuget eq 'Attr'); - my $ccutrace = AttrVal ($hmccu_hash->{NAME}, 'ccutrace', ''); - - my ($int, $add, $chn, $dpt, $nam, $flags) = HMCCU_ParseObject ($device, 0); - if ($flags == $HMCCU_FLAG_ADDRESS) { - $devname = HMCCU_GetDeviceName ($add, ''); - return '' if ($devname eq ''); - } - else { - $devname = $nam; - } - - my $script = qq( -string chnid; -string sDPId; -object odev = dom.GetObject ("$devname"); -if (odev) { - foreach (chnid, odev.Channels()) { - object ochn = dom.GetObject(chnid); - WriteLine("Channel " # ochn.Address() # " " # ochn.Name()); - foreach(sDPId, ochn.DPs()) { - object oDP = dom.GetObject(sDPId); - if (oDP) { - WriteLine (" DP " # oDP.Name() # " = " # oDP.$ccuget()); - } - } - } -} - ); - - my $response = HMCCU_HMScript ($hmccu_hash->{host}, $script); - if ($ccutrace ne '' && ($device =~ /$ccutrace/ || $devname =~ /$ccutrace/)) { - Log 1, "HMCCU: Device=$device Devname=$devname"; - Log 1, "HMCCU: Script response = \n".$response; - Log 1, "HMCCU: Script = ".$script; - } - return $response; -} - -#################################################### -# Read list of CCU devices via Homematic Script. -# Update data of client devices if not current. -#################################################### - -sub HMCCU_GetDeviceList ($) -{ - my ($hash) = @_; - my $count = 0; - - my $script = qq( -string devid; -string chnid; -foreach(devid, root.Devices().EnumUsedIDs()) { - object odev=dom.GetObject(devid); - string intid=odev.Interface(); - string intna=dom.GetObject(intid).Name(); - integer cc=0; - foreach (chnid, odev.Channels()) { - object ochn=dom.GetObject(chnid); - WriteLine("C;" # ochn.Address() # ";" # ochn.Name()); - cc=cc+1; - } - WriteLine("D;" # intna # ";" # odev.Address() # ";" # odev.Name() # ";" # odev.HssType() # ";" # cc); -} - ); - - my $response = HMCCU_HMScript ($hash->{host}, $script); - return -1 if ($response eq ''); - - %HMCCU_Devices = (); - %HMCCU_Addresses = (); - $HMCCU_UpdateTime = time (); - - foreach my $hmdef (split /\n/,$response) { - my @hmdata = split /;/,$hmdef; - if ($hmdata[0] eq 'D') { - # 1=Interface 2=Device-Address 3=Device-Name 4=Device-Type 5=Channel-Count - $HMCCU_Devices{$hmdata[2]}{name} = $hmdata[3]; - $HMCCU_Devices{$hmdata[2]}{type} = $hmdata[4]; - $HMCCU_Devices{$hmdata[2]}{interface} = $hmdata[1]; - $HMCCU_Devices{$hmdata[2]}{channels} = $hmdata[5]; - $HMCCU_Devices{$hmdata[2]}{addtype} = 'dev'; - $HMCCU_Devices{$hmdata[2]}{valid} = 1; - $HMCCU_Addresses{$hmdata[3]}{address} = $hmdata[2]; - $HMCCU_Addresses{$hmdata[3]}{addtype} = 'dev'; - $HMCCU_Addresses{$hmdata[3]}{valid} = 1; - $count++; - } - elsif ($hmdata[0] eq 'C') { - # 1=Channel-Address 2=Channel-Name - $HMCCU_Devices{$hmdata[1]}{name} = $hmdata[2]; - $HMCCU_Devices{$hmdata[1]}{channels} = 1; - $HMCCU_Devices{$hmdata[1]}{addtype} = 'chn'; - $HMCCU_Devices{$hmdata[1]}{valid} = 1; - $HMCCU_Addresses{$hmdata[2]}{address} = $hmdata[1]; - $HMCCU_Addresses{$hmdata[2]}{addtype} = 'chn'; - $HMCCU_Addresses{$hmdata[2]}{valid} = 1; - $count++; - } - } - - # Update client devices - foreach my $d (keys %defs) { - # Get hash of client device - my $ch = $defs{$d}; - next if (!defined ($ch->{IODev}) || !defined ($ch->{ccuaddr})); - my $add = $ch->{ccuaddr}; - my $dadd = $add; - $dadd =~ s/:[0-9]+$//; - - # Update device or channel attributes if it has changed in CCU - $ch->{ccuname} = $HMCCU_Devices{$add}{name} - if (!defined ($ch->{ccuname}) || $ch->{ccuname} ne $HMCCU_Devices{$add}{name}); - $ch->{ccuif} = $HMCCU_Devices{$dadd}{interface} - if (!defined ($ch->{ccuif}) || $ch->{ccuif} ne $HMCCU_Devices{$dadd}{interface}); - $ch->{ccutype} = $HMCCU_Devices{$dadd}{type} - if (!defined ($ch->{ccutype}) || $ch->{ccutype} ne $HMCCU_Devices{$dadd}{type}); - $ch->{channels} = $HMCCU_Devices{$add}{channels} - if (!defined ($ch->{channels}) || $ch->{channels} != $HMCCU_Devices{$add}{channels}); - } - - $hash->{NewDevices} = 0; - - return $count; -} - -#################################################### -# Check if device/channel name or address is valid -#################################################### - -sub HMCCU_IsValidDevice ($) -{ - my ($param) = @_; - - if ($param =~ /^[A-Z]{3,3}[0-9]{7,7}$/ || $param =~ /^[A-Z]{3,3}[0-9]{7,7}:[0-9]+$/) { - return 0 if (! exists ($HMCCU_Devices{$param})); - return $HMCCU_Devices{$param}{valid}; - } - else { - return 0 if (! exists ($HMCCU_Addresses{$param})); - return $HMCCU_Addresses{$param}{valid}; - } -} - -#################################################### -# Get name of a CCU device by address. -# Channel number will be removed if specified. -#################################################### - -sub HMCCU_GetDeviceName ($$) -{ - my ($addr, $default) = @_; - - if ($addr =~ /^[A-Z]{3,3}[0-9]{7,7}$/ || $addr =~ /^[A-Z]{3,3}[0-9]{7,7}:[0-9]+$/) { - $addr =~ s/:[0-9]+$//; - if (exists ($HMCCU_Devices{$addr})) { - return $HMCCU_Devices{$addr}{name}; - } - } - - return $default; -} - -#################################################### -# Get name of a CCU device channel by address. -#################################################### - -sub HMCCU_GetChannelName ($$) -{ - my ($addr, $default) = @_; - - if ($addr =~ /^[A-Z]{3,3}[0-9]{7,7}:[0-9]+$/) { - if (exists ($HMCCU_Devices{$addr})) { - return $HMCCU_Devices{$addr}{name}; - } - } - - return $default; -} - -#################################################### -# Get type of a CCU device by address. -# Channel number will be removed if specified. -#################################################### - -sub HMCCU_GetDeviceType ($$) -{ - my ($addr, $default) = @_; - - if ($addr =~ /^[A-Z]{3,3}[0-9]{7,7}$/ || $addr =~ /^[A-Z]{3,3}[0-9]{7,7}:[0-9]+$/) { - $addr =~ s/:[0-9]+$//; - if (exists ($HMCCU_Devices{$addr})) { - return $HMCCU_Devices{$addr}{type}; - } - } - - return $default; -} - - -#################################################### -# Get number of channels of a CCU device. -# Channel number will be removed if specified. -#################################################### - -sub HMCCU_GetDeviceChannels ($) -{ - my ($addr, $default) = @_; - - if ($addr =~ /^[A-Z]{3,3}[0-9]{7,7}$/ || $addr =~ /^[A-Z]{3,3}[0-9]{7,7}:[0-9]+$/) { - $addr =~ s/:[0-9]+$//; - if (exists ($HMCCU_Devices{$addr})) { - return $HMCCU_Devices{$addr}{channels}; - } - } - - return 0; -} - -#################################################### -# Get interface of a CCU device by address. -# Channel number will be removed if specified. -#################################################### - -sub HMCCU_GetDeviceInterface ($$) -{ - my ($addr, $default) = @_; - - if ($addr =~ /^[A-Z]{3,3}[0-9]{7,7}$/ || $addr =~ /^[A-Z]{3,3}[0-9]{7,7}:[0-9]+$/) { - $addr =~ s/:[0-9]+$//; - if (exists ($HMCCU_Devices{$addr})) { - return $HMCCU_Devices{$addr}{interface}; - } - } - - return $default; -} - -#################################################### -# Get address of a CCU device or channel by name. -# Return array with device address and channel no. -#################################################### - -sub HMCCU_GetAddress ($$$) -{ - my ($name, $defadd, $defchn) = @_; - my $add = $defadd; - my $chn = $defchn; - - if (exists ($HMCCU_Addresses{$name})) { - my $addr = $HMCCU_Addresses{$name}{address}; - if ($addr =~ /^([A-Z]{3,3}[0-9]{7,7}):([0-9]+)$/) { - ($add, $chn) = ($1, $2); - } - elsif ($addr =~ /^[A-Z]{3,3}[0-9]{7,7}$/) { - $add = $addr; - } - } - else { - my $response = HMCCU_GetCCUObjectAttribute ($name, "Address()"); - if (defined ($response)) { - if ($response =~ /^([A-Z]{3,3}[0-9]{7,7}):([0-9]+)$/) { - ($add, $chn) = ($1, $2); - $HMCCU_Addresses{$name}{address} = $response; - $HMCCU_Addresses{$name}{addtype} = 'chn'; - } - elsif ($response =~ /^([A-Z]{3,3}[0-9]{7,7})$/) { - $add = $1; - $HMCCU_Addresses{$name}{address} = $response; - $HMCCU_Addresses{$name}{addtype} = 'dev'; - } - } - } - - return ($add, $chn); -} - -sub HMCCU_GetCCUObjectAttribute ($$) -{ - my ($object, $attr) = @_; - - my $hash = HMCCU_GetHash (0); - my $url = 'http://'.$hash->{host}.':8181/do.exe?r1=dom.GetObject("'.$object.'").'.$attr; - my $response = GetFileFromURL ($url); - if (defined ($response) && $response !~ /null(.+)<\/r1>/) { - return $1; - } - } - - return undef; -} - -#################################################### -# Get hash of HMCCU device -# Useful for client devices. -#################################################### - -sub HMCCU_GetHash ($@) -{ - my ($hash) = @_; - - if (defined ($hash) && $hash != 0) { - if ($hash->{TYPE} eq 'HMCCUDEV' || $hash->{TYPE} eq 'HMCCUCHN') { - return $hash->{IODev} if (exists ($hash->{IODev})); - } - elsif ($hash->{TYPE} eq 'HMCCU') { - return $hash; - } - } - - # Search for HMCCU device - foreach my $dn (sort keys %defs) { - return $defs{$dn} if ($defs{$dn}->{TYPE} eq 'HMCCU'); - } - - return undef; -} - -#################################################### -# Get attribute of client device with fallback to -# attribute of IO device. -#################################################### - -sub HMCCU_GetAttribute ($$$$) -{ - my ($hmccu_hash, $cl_hash, $attr_name, $attr_def) = @_; - - my $value = AttrVal ($cl_hash->{NAME}, $attr_name, ''); - $value = AttrVal ($hmccu_hash->{NAME}, $attr_name, $attr_def) if ($value eq ''); - - return $value; -} - -#################################################### -# Get channels and datapoints from attributes -# statechannel, statedatapoint and controldatapoint. -#################################################### - -sub HMCCU_GetSpecialDatapoints ($$$$$) -{ - my ($hash, $defsd, $defsc, $defcd, $defcc) = @_; - my $name = $hash->{NAME}; - my $type = $hash->{TYPE}; - - my $sd = AttrVal ($name, 'statedatapoint', $defsd); - my $sc = AttrVal ($name, 'statechannel', $defsc); - my $ccd = AttrVal ($name, 'controldatapoint', ''); - if ($type eq 'HMCCUCHN') { - $ccd = $hash->{ccuaddr}.$ccd; - $ccd =~ s/^[A-Z]{3,3}[0-9]{7,7}://; - } - my $cd = $defcd; - my $cc = $defcc; - - if ($ccd =~ /^([0-9]+)\.(.+)$/) { - ($cc, $cd) = ($1, $2); - } - - return ($sc, $sd, $cc, $cd); -} - -#################################################### -# Timer function for reading RPC queue -#################################################### - -sub HMCCU_ReadRPCQueue ($) -{ - my ($hash) = @_; - my $name = $hash->{NAME}; - my $maxevents = 20; - my $eventno = 0; - my $f = 0; - my @newdevices; - my @deldevices; - - my $rpcinterval = AttrVal ($name, 'rpcinterval', 5); - my $ccureadingformat = AttrVal ($name, 'ccureadingformat', 'name'); - my $rpcqueue = AttrVal ($name, 'rpcqueue', '/tmp/ccuqueue'); - my $rpcport = AttrVal ($name, 'rpcport', '2001'); - - my @portlist = split (',', $rpcport); - foreach my $port (@portlist) { - my $queue = new RPCQueue (File => $rpcqueue."_".$port, Mode => 0666); - - my $element = $queue->deq(); - while ($element) { - $HMCCU_EventTime = time () if ($eventno == 0); - my @Tokens = split (/\|/, $element); - if ($Tokens[0] eq 'EV') { - my ($add, $chn) = split (/:/, $Tokens[1]); - my $reading = HMCCU_GetReadingName ('', $add, $chn, $Tokens[2], '', - $ccureadingformat); - HMCCU_UpdateClientReading ($hash, $add, $chn, $reading, $Tokens[3], 'rpcevent'); - $eventno++; - last if ($eventno == $maxevents); - } - elsif ($Tokens[0] eq 'ND') { - if (! exists ($HMCCU_Devices{$Tokens[1]})) { - $hash->{NewDevices} = 0 if (!exists ($hash->{NewDevices})); - $hash->{NewDevices}++; - } - } - elsif ($Tokens[0] eq 'DD') { - push (@deldevices, $Tokens[1]); - } - elsif ($Tokens[0] eq 'EX') { - Log 1, "HMCCU: Received EX event. RPC server terminated."; - $f = 1; - last; - } - else { -# Log 1,"HMCCU: Unknown RPC event type ".$Tokens[0]; - } - - $element = $queue->deq(); - } - } - - if ($HMCCU_EventTime > 0 && time()-$HMCCU_EventTime > 300) { - Log 1, "HMCCU: Received no events from CCU since 300 seconds"; - } - - HMCCU_DeleteDevices (\@deldevices) if (@deldevices > 0); - - my @hm_pids; - my @ex_pids; - HMCCU_IsRPCServerRunning ($hash, \@hm_pids, \@ex_pids); - if ($f == 0 && @hm_pids > 0) { - if (scalar (@hm_pids) != scalar (@portlist)) { - Log 1, "HMCCU: Number of RPC server process differs from number of CCU destination ports"; - } - InternalTimer (gettimeofday()+$rpcinterval, 'HMCCU_ReadRPCQueue', $hash, 0); - } - else { - if (@ex_pids > 0) { - Log 1, "HMCCU: Externally launched RPC server(s) detected. Kill process(es) manually with command kill -SIGINT pid for pids ".join (',', @ex_pids); - } - else { - Log 1, "HMCCU: RPC server has been shut down. f=$f"; - } - $hash->{RPCPID} = '0'; - $hash->{RPCPRC} = 'none'; - $attr{$name}{rpcserver} = "off"; - } -} - -#################################################### -# Execute Homematic script on CCU -#################################################### - -sub HMCCU_HMScript ($$) -{ - # Hostname, Script-Code - my ($host, $hmscript) = @_; - - my $url = "http://".$host.":8181/tclrega.exe"; - my $ua = new LWP::UserAgent (); - my $response = $ua->post($url, Content => $hmscript); - - if (! $response->is_success ()) { - Log 1, "HMCCU: ".$response->status_line(); - return ''; - } - else { - my $output = $response->content; - $output =~ s/.*<\/xml>//; - $output =~ s/\r//g; - return $output; - } -} - -#################################################### -# Get datapoint and update reading. -#################################################### - -sub HMCCU_GetDatapoint ($@) -{ - my ($hash, $param, $reading) = @_; - my $name = $hash->{NAME}; - my $type = $hash->{TYPE}; - my $hmccu_hash; - my $value = ''; - - $hmccu_hash = HMCCU_GetHash ($hash); - return (-3, $value) if (!defined ($hmccu_hash)); - return (-4, $value) if ($type ne 'HMCCU' && $hash->{ccudevstate} eq 'Deleted'); - - my $ccureadings = AttrVal ($name, 'ccureadings', 1); - my $readingformat = AttrVal ($name, 'ccureadingformat', 'name'); - my $substitute = AttrVal ($name, 'substitute', ''); - my ($statechn, $statedpt, $controlchn, $controldpt) = HMCCU_GetSpecialDatapoints ( - $hash, 'STATE', '', '', ''); - - my $ccuget = HMCCU_GetAttribute ($hmccu_hash, $hash, 'ccuget', 'Value'); - my $ccutrace = AttrVal ($hmccu_hash->{NAME}, 'ccutrace', ''); - my $tf = ($ccutrace ne '' && $param =~ /$ccutrace/) ? 1 : 0; - - my $url = 'http://'.$hmccu_hash->{host}.':8181/do.exe?r1=dom.GetObject("'; - my ($int, $add, $chn, $dpt, $nam, $flags) = HMCCU_ParseObject ($param, $HMCCU_FLAG_INTERFACE); - if ($flags == $HMCCU_FLAGS_IACD) { - $url .= $int.'.'.$add.':'.$chn.'.'.$dpt.'").'.$ccuget.'()'; - } - elsif ($flags == $HMCCU_FLAGS_NCD) { - $url .= $nam.'").DPByHssDP("'.$dpt.'").'.$ccuget.'()'; - ($add, $chn) = HMCCU_GetAddress ($nam, '', ''); - } - else { - return (-1, $value); - } - - if ($tf) { - Log 1, "HMCCU: GetDatapoint()"; - Log 1, "HMCCU: URL=$url"; - Log 1, "HMCCU: param=$param"; - Log 1, "HMCCU: ccuget=$ccuget"; - } - - my $rawresponse = GetFileFromURL ($url); - my $response = $rawresponse; - $response =~ m/(.*)<\/r1>/; - $value = $1; - - Log (1, "HMCCU: Response = ".$rawresponse) if ($tf); - - if (defined ($value) && $value ne '' && $value ne 'null') { - if (!defined ($reading) || $reading eq '') { - $reading = HMCCU_GetReadingName ($int, $add, $chn, $dpt, $nam, $readingformat); - } - return (0, $value) if ($reading eq ''); - - if ($type eq 'HMCCU') { - $value = HMCCU_UpdateClientReading ($hmccu_hash, $add, $chn, $reading, - $value); - } - else { - $value = HMCCU_Substitute ($value, $substitute, 0, $reading); - $value = HMCCU_FormatReadingValue ($hash, $value); - readingsSingleUpdate ($hash, $reading, $value, 1) if ($ccureadings); - if ($controldpt ne '' && $dpt eq $controldpt && $chn eq $controlchn) { - readingsSingleUpdate ($hash, 'control', $value, 1); - } - if (($reading =~ /\.$statedpt$/ || $reading eq $statedpt) && $ccureadings) { - if ($statechn eq '' || $statechn eq $chn) { - HMCCU_SetState ($hash, $value); - } - } - } - - return (1, $value); - } - else { - Log 1,"HMCCU: Error URL = ".$url; - return (-2, ''); - } -} - -#################################################### -# Set datapoint -#################################################### - -sub HMCCU_SetDatapoint ($$$) -{ - my ($hash, $param, $value) = @_; - my $type = $hash->{TYPE}; - - my $hmccu_hash = HMCCU_GetHash ($hash);; - return -3 if (!defined ($hmccu_hash)); - return -4 if ($type ne 'HMCCU' && $hash->{ccudevstate} eq 'Deleted'); - - my $url = 'http://'.$hmccu_hash->{host}.':8181/do.exe?r1=dom.GetObject("'; - my ($int, $add, $chn, $dpt, $nam, $flags) = HMCCU_ParseObject ($param, $HMCCU_FLAG_INTERFACE); - if ($flags == $HMCCU_FLAGS_IACD) { - $url .= $int.'.'.$add.':'.$chn.'.'.$dpt.'").State('.$value.')'; - } - elsif ($flags == $HMCCU_FLAGS_NCD) { - $url .= $nam.'").DPByHssDP("'.$dpt.'").State('.$value.')'; - ($add, $chn) = HMCCU_GetAddress ($nam, '', ''); - } - else { - return -1; - } - - my $response = GetFileFromURL ($url); - return -2 if (!defined ($response) || $response =~ /null{NAME}, 'ccureadings', 1); - - my $script = qq( -object osysvar; -string ssysvarid; -foreach (ssysvarid, dom.GetObject(ID_SYSTEM_VARIABLES).EnumUsedIDs()) -{ - osysvar = dom.GetObject(ssysvarid); - WriteLine (osysvar.Name() # "=" # osysvar.Variable() # "=" # osysvar.Value()); -} - ); - - my $response = HMCCU_HMScript ($hash->{host}, $script); - return (-2, $result) if ($response eq ''); - - readingsBeginUpdate ($hash) if ($ccureadings); - - foreach my $vardef (split /\n/, $response) { - my @vardata = split /=/, $vardef; - next if (@vardata != 3); - next if ($vardata[0] !~ /$pattern/); - my $value = HMCCU_FormatReadingValue ($hash, $vardata[2]); - readingsBulkUpdate ($hash, $vardata[0], $value) if ($ccureadings); - $result .= $vardata[0].'='.$vardata[2]."\n"; - $count++; - } - - readingsEndUpdate ($hash, 1) if ($hash->{TYPE} ne 'HMCCU' && $ccureadings); - - return ($count, $result); -} - -#################################################### -# Set CCU system variable -#################################################### - -sub HMCCU_SetVariable ($$$) -{ - my ($hash, $param, $value) = @_; - my $url = 'http://'.$hash->{host}.':8181/do.exe?r1=dom.GetObject("'.$param.'").State("'.$value.'")'; - - my $response = GetFileFromURL ($url); - if (!defined ($response) || $response =~ /null{TYPE}; - - my $hmccu_hash = HMCCU_GetHash ($cl_hash); - return -3 if (!defined ($hmccu_hash)); - return -4 if ($type ne 'HMCCU' && $cl_hash->{ccudevstate} eq 'Deleted'); - - my $nam = ''; - my $script; - - my $cn = $cl_hash->{NAME}; - $ccuget = HMCCU_GetAttribute ($hmccu_hash, $cl_hash, 'ccuget', 'Value') if ($ccuget eq 'Attr'); - my $ccutrace = AttrVal ($hmccu_hash->{NAME}, 'ccutrace', ''); - my $ccureadings = AttrVal ($cn, 'ccureadings', 1); - my $ccureadingfilter = AttrVal ($cn, 'ccureadingfilter', '.*'); - my $readingformat = AttrVal ($cn, 'ccureadingformat', 'name'); - my $substitute = AttrVal ($cn, 'substitute', ''); - my ($statechn, $statedpt, $controlchn, $controldpt) = HMCCU_GetSpecialDatapoints ( - $cl_hash, 'STATE', '', '', ''); - - if ($addr =~ /^[A-Z]{3,3}[0-9]{7,7}:[0-9]{1,2}$/) { - $nam = HMCCU_GetChannelName ($addr, ''); - return -1 if ($nam eq ''); - - $script = qq( -string sDPId; -string sChnName = "$nam"; -object oChannel = dom.GetObject (sChnName); -if (oChannel) { - foreach(sDPId, oChannel.DPs()) { - object oDP = dom.GetObject(sDPId); - if (oDP) { - WriteLine (sChnName # "=" # oDP.Name() # "=" # oDP.$ccuget()); - } - } -} - ); - } - elsif ($addr =~ /^[A-Z]{3,3}[0-9]{7,7}$/) { - $nam = HMCCU_GetDeviceName ($addr, ''); - return -1 if ($nam eq ''); - - $script = qq( -string chnid; -string sDPId; -object odev = dom.GetObject ("$nam"); -if (odev) { - foreach (chnid, odev.Channels()) { - object ochn = dom.GetObject(chnid); - if (ochn) { - foreach(sDPId, ochn.DPs()) { - object oDP = dom.GetObject(sDPId); - if (oDP) { - WriteLine (ochn.Name() # "=" # oDP.Name() # "=" # oDP.$ccuget()); - } - } - } - } -} - ); - } - else { - return -1; - } - - my $response = HMCCU_HMScript ($hmccu_hash->{host}, $script); - if ($ccutrace ne '' && ($addr =~ /$ccutrace/ || $nam =~ /$ccutrace/)) { - Log 1, "HMCCU: Addr=$addr Name=$nam"; - Log 1, "HMCCU: Script response = \n".$response; - Log 1, "HMCCU: Script = \n".$script; - } - return -2 if ($response eq ''); - - readingsBeginUpdate ($cl_hash) if ($ccureadings); - - foreach my $dpdef (split /\n/, $response) { - my @dpdata = split /=/, $dpdef; - next if (@dpdata < 2); - my @adrtoks = split /\./, $dpdata[1]; - next if (@adrtoks != 3); - next if ($adrtoks[2] !~ /$ccureadingfilter/); - - my ($add, $chn) = split /:/, $adrtoks[1]; - my $reading = HMCCU_GetReadingName ($adrtoks[0], $add, $chn, $adrtoks[2], - $dpdata[0], $readingformat); - next if ($reading eq ''); - - my $value = (defined ($dpdata[2]) && $dpdata[2] ne '') ? $dpdata[2] : 'N/A'; - $value = HMCCU_Substitute ($value, $substitute, 0, $reading); - $value = HMCCU_FormatReadingValue ($cl_hash, $value); - if ($ccureadings) { - readingsBulkUpdate ($cl_hash, $reading, $value); - if ($controldpt ne '' && $adrtoks[2] eq $controldpt && $chn eq $controlchn) { - readingsBulkUpdate ($cl_hash, 'control', $value); - } - if ($reading =~ /\.$statedpt$/ && ($statechn eq '' || $statechn eq $chn)) { - readingsBulkUpdate ($cl_hash, "state", $value); - } - } - } - - readingsEndUpdate ($cl_hash, 1) if ($ccureadings); - - return 1; -} - -#################################################### -# Get multiple datapoints of channels and update -# readings. -# If hash points to client device only readings -# of client device will be updated. -# Returncodes: -1 = Invalid channel/datapoint -# -2 = CCU script execution failed -# -3 = Cannot detect IO device -# On success number of updated readings is returned. -#################################################### - -sub HMCCU_GetChannel ($$) -{ - my ($hash, $chnref) = @_; - my $name = $hash->{NAME}; - my $type = $hash->{TYPE}; - my $count = 0; - my %chnpars; - my $chnlist = ''; - my $result = ''; - - my $hmccu_hash = HMCCU_GetHash ($hash); - return (-3, $result) if (!defined ($hmccu_hash));; - return (-4, $result) if ($type ne 'HMCCU' && $hash->{ccudevstate} eq 'Deleted'); - - my $ccuget = HMCCU_GetAttribute ($hmccu_hash, $hash, 'ccuget', 'Value'); - my $ccureadings = AttrVal ($name, 'ccureadings', 1); - my $readingformat = AttrVal ($name, 'ccureadingformat', 'name'); - my $defsubstitute = AttrVal ($name, 'substitute', ''); - my ($statechn, $statedpt, $controlchn, $controldpt) = HMCCU_GetSpecialDatapoints ( - $hash, 'STATE', '', '', ''); - - # Build channel list - foreach my $chndef (@$chnref) { - my ($channel, $substitute) = split /\s+/, $chndef; - next if (!defined ($channel) || $channel =~ /^#/ || $channel eq ''); - $substitute = $defsubstitute if (!defined ($substitute)); - my ($int, $add, $chn, $dpt, $nam, $flags) = HMCCU_ParseObject ($channel, - $HMCCU_FLAG_INTERFACE | $HMCCU_FLAG_DATAPOINT); - if ($flags == $HMCCU_FLAGS_IACD || $flags == $HMCCU_FLAGS_NCD) { - if ($flags == $HMCCU_FLAGS_IACD) { - $nam = HMCCU_GetChannelName ($add.':'.$chn, ''); - } - - $chnlist = $chnlist eq '' ? $nam : $chnlist.','.$nam; - $chnpars{$nam}{sub} = $substitute; - $chnpars{$nam}{dpt} = $dpt; - } - else { - return (-1, $result); - } - } - - return (0, $result) if ($chnlist eq ''); - - # CCU script to query datapoints - my $script = qq( -string sDPId; -string sChannel; -string sChnList = "$chnlist"; -foreach (sChannel, sChnList.Split(",")) { - object oChannel = dom.GetObject (sChannel); - if (oChannel) { - foreach(sDPId, oChannel.DPs()) { - object oDP = dom.GetObject(sDPId); - if (oDP) { - WriteLine (sChannel # "=" # oDP.Name() # "=" # oDP.$ccuget()); - } - } - } -} - ); - - my $response = HMCCU_HMScript ($hmccu_hash->{host}, $script); - return (-2, $result) if ($response eq ''); - - readingsBeginUpdate ($hash) if ($type ne 'HMCCU' && $ccureadings); - - foreach my $dpdef (split /\n/, $response) { - my @dpdata = split /=/, $dpdef; - next if (@dpdata != 3); - my @adrtoks = split /\./, $dpdata[1]; - next if (@adrtoks != 3); - next if ($adrtoks[2] !~ /$chnpars{$dpdata[0]}{dpt}/); - - my ($add, $chn) = split /:/, $adrtoks[1]; - my $reading = HMCCU_GetReadingName ($adrtoks[0], $add, $chn, $adrtoks[2], - $dpdata[0], $readingformat); - next if ($reading eq ''); - - my $value = HMCCU_Substitute ($dpdata[2], $chnpars{$dpdata[0]}{sub}, 0, $reading); - if ($hash->{TYPE} eq 'HMCCU') { - HMCCU_UpdateClientReading ($hmccu_hash, $add, $chn, $reading, $value); - } - else { - $value = HMCCU_FormatReadingValue ($hash, $value); - if ($ccureadings) { - readingsBulkUpdate ($hash, $reading, $value); - if ($controldpt ne '' && $adrtoks[2] eq $controldpt && $chn eq $controlchn) { - readingsBulkUpdate ($hash, 'control', $value); - } - if ($reading =~ /\.$statedpt$/ && ($statechn eq '' || $statechn eq $chn)) { - readingsBulkUpdate ($hash, "state", $value); - } - } - } - - $result .= $reading.'='.$value."\n"; - $count++; - } - - readingsEndUpdate ($hash, 1) if ($type ne 'HMCCU' && $ccureadings); - - return ($count, $result); -} - -#################################################### -# Get RPC paramSet or paramSetDescription -#################################################### - -sub HMCCU_RPCGetConfig ($$$) -{ - my ($hash, $param, $mode) = @_; - - my $addr; - my $result = ''; - - my $ccureadings = AttrVal ($hash->{NAME}, 'ccureadings', 1); - my $readingformat = AttrVal ($hash->{NAME}, 'ccureadingformat', 'name'); - - my $hmccu_hash = HMCCU_GetHash ($hash); - return (-3, $result) if (!defined ($hmccu_hash)); - - my $name = $hmccu_hash->{NAME}; - my $port = AttrVal ($name, 'rpcport', 2001); - - my ($int, $add, $chn, $dpt, $nam, $flags) = HMCCU_ParseObject ($param, $HMCCU_FLAG_FULLADDR); - if ($flags & $HMCCU_FLAG_ADDRESS) { - $addr = $add; - $addr .= ':'.$chn if ($flags & $HMCCU_FLAG_CHANNEL); - } - else { - return (-1, ''); - } - - my $client = RPC::XML::Client->new ("http://".$hmccu_hash->{host}.":".$port."/"); - my $res = $client->simple_request ($mode, $addr, "MASTER"); - if ($res) { - if (exists ($res->{faultString})) { - Log 1, "HMCCU: ".$res->{faultString}; - return (-2, $res->{faultString}); - } - elsif ($res eq '') { - return (-2, ''); - } - } - else { - return (0, ''); - } - - if ($mode eq 'getParamsetDescription') { - foreach my $key (sort keys %$res) { - my $oper = ''; - $oper .= 'R' if ($res->{$key}->{OPERATIONS} & 1); - $oper .= 'W' if ($res->{$key}->{OPERATIONS} & 2); - $oper .= 'E' if ($res->{$key}->{OPERATIONS} & 4); - $result .= $key.": ".$res->{$key}->{TYPE}." [".$oper."]\n"; - } - - return (0, $result); - } - - readingsBeginUpdate ($hash) if ($ccureadings); - - foreach my $key (sort keys %$res) { - my $value = $res->{$key}; - $result .= "$key=$value\n"; - - if ($ccureadings) { - my $reading = HMCCU_GetReadingName ($int, $add, $chn, $key, $nam, - $readingformat); - $reading = "R-".$reading; - readingsBulkUpdate ($hash, $reading, $value); - } - } - - readingsEndUpdate ($hash, 1) if ($ccureadings); - - return (0, $result); -} - -#################################################### -# Set RPC paramSet -#################################################### - -sub HMCCU_RPCSetConfig ($$$) -{ - my ($hash, $param, $parref) = @_; - - my $name = $hash->{NAME}; - my $port = AttrVal ($name, 'rpcport', 2001); - my $addr; - my %paramset; - - my ($int, $add, $chn, $dpt, $nam, $flags) = HMCCU_ParseObject ($param, $HMCCU_FLAG_FULLADDR); - if ($flags & $HMCCU_FLAG_ADDRESS) { - $addr = $add; - $addr .= ':'.$chn if ($flags & $HMCCU_FLAG_CHANNEL); - } - else { - return -1; - } - - # Build param set - foreach my $pardef (@$parref) { - my ($par,$val) = split ("=", $pardef); - next if (!defined ($par) || !defined ($val)); - $paramset{$par} = $val; - } - - my $client = RPC::XML::Client->new ("http://".$hash->{host}.":".$port."/"); - my $res = $client->simple_request ("putParamset", $addr, "MASTER", \%paramset); - if ($res) { - if (exists ($res->{faultString})) { - Log 1, "HMCCU: ".$res->{faultString}; - return -2; - } - elsif ($res eq '') { - return -2; - } - } - - return 0; -} - -#################################################### -# Return string for internal STATE. This function -# can be used in attribute stateFormat. -#################################################### - -sub HMCCU_State ($) -{ - my ($name) = @_; - - my $hash = $defs{$name}; - my $sf = AttrVal ($name, 'ccustate', ''); - - return ReadingsVal ($name, 'state', '') if ($sf eq ''); - - my $st = $sf; - my $r = $hash->{READINGS}; - - if ($r->{state}{VAL} ne "Error") { - $st =~ s/\b([A-Za-z\d_\.\:-]+)\b/($r->{$1} ? $r->{$1}{VAL} : $1)/ge; - } - else { - $st = "Error"; - } - - return $st; -} - -#################################################### -# Calculate dewpoint. Requires reading names of -# temperature and humidity as parameters. -#################################################### - -sub HMCCU_Dewpoint ($$$$) -{ - my ($name, $rtmp, $rhum, $defdp) = @_; - my $a; - my $b; - - my $tmp = ReadingsVal ($name, $rtmp, 100.0); - my $hum = ReadingsVal ($name, $rhum, 0.0); - return $defdp if ($tmp == 100.0 || $hum == 0.0); - - if ($tmp >= 0.0) { - $a = 7.5; - $b = 237.3; - } - else { - $a = 7.6; - $b = 240.7; - } - - my $sdd = 6.1078*(10.0**(($a*$tmp)/($b+$tmp))); - my $dd = $hum/100.0*$sdd; - my $v = log($dd/6.1078)/log(10.0); - my $td = $b*$v/($a-$v); - - return sprintf "%.1f", $td; -} - -1; - - -=pod -=begin html - - -

HMCCU

-
-
    - The module provides an easy get/set interface for Homematic CCU. It acts as an - IO device for HMCCUDEV client devices. The module requires additional Perl modules - XML::Simple and File::Queue. -

    - - Define -
      -
      - define <name> HMCCU <HostOrIP> -

      - Example: -
      - define myccu HMCCU 192.168.1.10 -

      - HostOrIP - Hostname or IP address of Homematic CCU. -
      -
    -
    - - - Set
    -
      -
      -
    • set <name> devstate {[<interface>.]<channel-address>|<channel-name>} <value> [...] -
      - Set state of a CCU device. Specified CCU channel must have a datapoint STATE. -

      - Example:
      - set d_ccu devstate ST-WZ-Bass false
      - set d_ccu devstate BidCos-RF.LEQ1462664:1 false -

      • -
    • set <name> datapoint {[<interface>.]<channel-address>.<datapoint>|<channel-name>.<datapoint>} <value> [...] -
      - Set value of a datapoint of a CCU device channel. -

      - Example:
      - set d_ccu datapoint THERMOSTAT_CHN2.SET_TEMPERATURE 21
      - set d_ccu datapoint LEQ1234567:2.SET_TEMPERATURE 21 -

      • -
    • set <name> var <variable>> <Value> [...] -
      - Set CCU variable value. -

      • -
    • set <name> execute <program> -
      - Execute CCU program. -

      - Example:
      - set d_ccu execute PR-TEST -

      • -
    • set <name> hmscript <script-file> -
      - Execute HM script on CCU. If output of script contains lines in format - Object=Value readings will be set. Object can be the name of a CCU system - variable or a valid datapoint specification. -
      • -
    -
    - - - Get

    -
      -
      -
    • get <name> devstate {[<interface>.]<channel-address>|<channel-name>} [<reading>]
      - Get state of a CCU device. Specified channel must have a datapoint STATE. If <reading> - is specified the value will be stored using this name. -

      • -
    • get <name> vars <regexp>
      - Get CCU system variables matching <regexp> and store them as readings. -

      • -
    • get <name> channel {[<interface>.]<channel-address>[.<datapoint-expr>]|<channel-name>[.<datapoint-expr>]}[=[regexp1:subst1[,...]]] [...] -
      - Get value of datapoint(s). If no datapoint is specified all datapoints of specified - channel are read. <datapoint> can be specified as a regular expression. -

      • -
    • get <name> deviceinfo <device-name> [{'State'|'Value'}]
      - List device channels and datapoints. -

      • -
    • get <name> devicelist [dump]
      - Read list of devices and channels from CCU. This command is executed automatically after device - definition. Must be executed after module HMCCU is reloaded. With option dump devices are displayed - in browser window. -

      • -
    • get <name> parfile [<parfile>]
      - Get values of all channels / datapoints specified in <parfile>. <parfile> can also - be defined as an attribute. The file must contain one channel / datapoint definition per line. - Datapoints are optional (for syntax see command get channel). After the channel definition - a list of string substitution rules for datapoint values can be specified (like attribute - substitute).
      - The syntax of Parfile entries is: -

      - {[<interface>.]<channel-address>[.<datapoint-expr>]|<channel-name>[.<datapoint-expr>]} <regexp>:<subsstr>[,...] -

      - Empty lines or lines starting with a # are ignored. -

      • -
    • get <name> rpcstate
      - Check if RPC server process is running. -

      • -
    • get <name> update [<devexp> [<'State'|'Value'>]]
      - Update all datapoint / readings of client devices with device name matching <devexp> -
      • -
    -
    - - - Attributes
    -
    -
      -
    • ccuget <State | Value>
      - Set read access method for CCU channel datapoints. Method 'State' is slower than 'Value' because - each request is sent to the device. With method 'Value' only CCU is queried. Default is 'Value'. -

      • -
    • ccureadingformat <name | address>
      - Format of reading names (channel name or channel address) -

      • -
    • ccureadings <0 | 1>
      - If set to 1 values read from CCU will be stored as readings. Otherwise output - is displayed in browser window. -

      • -
    • ccutrace <ccu-devname-exp|ccu-address-exp>
      - Turn on trace mode for devices matching specified expression. Will write extended - information into FHEM log (level 1). -

      • -
    • parfile <filename>
      - Define parameter file for command get parfile. -

      • -
    • rpcinterval <3 | 5 | 10>
      - Specifiy how often RPC queue is read. Default is 5 seconds. -

      • -
    • rpcport <value[,...]>
      - Specify list of RPC ports on CCU. Default is 2001. -

      • -
    • rpcqueue <queue-file>
      - Specify name of RPC queue file. This parameter is only a prefix for the - queue files with extension .idx and .dat. Default is /tmp/ccuqueue. -

      • -
    • rpcserver <on | off>
      - Start or stop RPC server. -

      • -
    • statedatapoint <datapoint>
      - Set datapoint for devstate commands. Default is 'STATE'. -

      • -
    • statevals <text:substext[,...]>
      - Define substitutions for values in set devstate/datapoint command. -

      • -
    • substitude <expression>:<substext>[,...]
      - Define substitions for reading values. Substitutions for parfile values must - be specified in parfiles. -

      • -
    • stripchar <character>
      - Strip the specified character from variable or device name in set commands. This - is useful if a variable should be set in CCU using the reading with trailing colon. -

      • -
    • updatemode { client | both | hmccu }
      - Set update mode for readings.
      - 'client' = update only readings of client devices
      - 'both' = update readings of client devices and IO device
      - 'hmccu' = update readings of IO device -
      • -
    -
-
- -=end html -=cut -