mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-02-01 19:30:31 +00:00
362 lines
9.2 KiB
Perl
362 lines
9.2 KiB
Perl
################################################################
|
|
#
|
|
# 88_HMCCUDEV.pm
|
|
#
|
|
# $Id:$
|
|
#
|
|
# Version 1.0
|
|
#
|
|
# (c) 2015 zap (zap01 <at> t-online <dot> de)
|
|
#
|
|
################################################################
|
|
#
|
|
# define <name> HMCCUDEV <hmccu> <ccudev> [ readonly ]
|
|
#
|
|
# set <name> datapoint <channel>.<datapoint> <value>
|
|
# set <name> devstate <value>
|
|
# set <name> <stateval_cmds>
|
|
#
|
|
# get <name> datapoint <channel>.<datapoint>
|
|
# get <name> update
|
|
#
|
|
# attr <name> ccureadings { 0 | 1 }
|
|
# attr <name> statechannel <channel>
|
|
# attr <name> stateval <text1>:<subtext1>[,...]
|
|
# attr <name> substitute <regexp1>:<subtext1>[,...]
|
|
#
|
|
################################################################
|
|
# Requires module 88_HMCCU
|
|
################################################################
|
|
|
|
package main;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use SetExtensions;
|
|
|
|
sub HMCCUDEV_Define ($$);
|
|
sub HMCCUDEV_Set ($@);
|
|
sub HMCCUDEV_Get ($@);
|
|
sub HMCCUDEV_Attr ($@);
|
|
sub HMCCUDEV_SetError ($$);
|
|
|
|
#####################################
|
|
# Initialize module
|
|
#####################################
|
|
|
|
sub HMCCUDEV_Initialize ($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
$hash->{DefFn} = "HMCCUDEV_Define";
|
|
$hash->{SetFn} = "HMCCUDEV_Set";
|
|
$hash->{GetFn} = "HMCCUDEV_Get";
|
|
$hash->{AttrFn} = "HMCCUDEV_Attr";
|
|
|
|
$hash->{AttrList} = "IODev ccureadings:0,1 stateval substitute statechannel:0,1,2,3 loglevel:0,1,2,3,4,5,6 ". $readingFnAttributes;
|
|
}
|
|
|
|
#####################################
|
|
# Define device
|
|
#####################################
|
|
|
|
sub HMCCUDEV_Define ($$)
|
|
{
|
|
my ($hash, $def) = @_;
|
|
my $name = $hash->{NAME};
|
|
my @a = split("[ \t][ \t]*", $def);
|
|
|
|
return "Specifiy the CCU device name as parameters" if(@a < 3);
|
|
return "Channel or datapoint not allowed in CCU device name" if ($a[2] =~ /^(.*):/);
|
|
|
|
$attr{$name}{ccureadings} = 1;
|
|
|
|
# Keep name of CCU device
|
|
$hash->{ccudev} = $a[2];
|
|
|
|
# Set commands / values
|
|
if (defined ($a[3]) && $a[3] eq 'readonly') {
|
|
$hash->{statevals} = $a[3];
|
|
}
|
|
else {
|
|
$hash->{statevals} = 'devstate';
|
|
}
|
|
|
|
# Inform HMCCU device about client device
|
|
Log 1, "HMCCUDEV: Assigning IO Port";
|
|
AssignIoPort ($hash);
|
|
|
|
readingsSingleUpdate ($hash, "state", "Initialized", 1);
|
|
|
|
return undef;
|
|
}
|
|
|
|
#####################################
|
|
# Set attribute
|
|
#####################################
|
|
|
|
sub HMCCUDEV_Attr ($@)
|
|
{
|
|
my ($cmd, $name, $attrname, $attrval) = @_;
|
|
|
|
if (defined ($attrval) && $cmd eq "set") {
|
|
if ($attrname eq "IODev") {
|
|
$defs{$name}{IODev} = $defs{$attrval};
|
|
}
|
|
elsif ($attrname eq "stateval") {
|
|
$defs{$name}{statevals} = "devstate";
|
|
my @states = split /,/,$attrval;
|
|
foreach my $st (@states) {
|
|
my @statesubs = split /:/,$st;
|
|
next if (@statesubs != 2);
|
|
$defs{$name}{statevals} .= '|'.$statesubs[0];
|
|
}
|
|
}
|
|
}
|
|
|
|
return undef;
|
|
}
|
|
|
|
#####################################
|
|
# Set commands
|
|
#####################################
|
|
|
|
sub HMCCUDEV_Set ($@)
|
|
{
|
|
my ($hash, @a) = @_;
|
|
my $name = shift @a;
|
|
my $opt = shift @a;
|
|
|
|
if (!defined ($hash->{IODev})) {
|
|
return HMCCUDEV_SetError ($hash, "No IO device defined");
|
|
}
|
|
if ($hash->{statevals} eq 'readonly') {
|
|
return undef;
|
|
}
|
|
|
|
my $statechannel = AttrVal ($name, "statechannel", '');
|
|
my $stateval = AttrVal ($name, "stateval", '');
|
|
my $substitute = AttrVal ($name, "substitute", '');
|
|
|
|
my $hmccu_hash = $hash->{IODev};
|
|
my $hmccu_name = $hash->{IODev}->{NAME};
|
|
my $ccudev = $hash->{ccudev};
|
|
|
|
# process set <name> command par1 ...
|
|
if ($opt eq 'datapoint') {
|
|
my $objname = shift @a;
|
|
my $objvalue = join ('%20', @a);
|
|
|
|
if (!defined ($objname) || $objname !~ /^[0-9]+\..*$/ || !defined ($objvalue)) {
|
|
return HMCCUDEV_SetError ($hash, "Usage: set <device> datapoint <channel>.<datapoint> <value>");
|
|
}
|
|
|
|
$objname = $ccudev.':'.$objname;
|
|
|
|
my ($dev, $chn, $dpt, $flags) = HMCCU_ParseCCUDev ($objname);
|
|
if ($flags != 7) {
|
|
return HMCCUDEV_SetError ($hash, "Format for objname is channel.datapoint");
|
|
}
|
|
|
|
$objvalue = HMCCU_Substitute ($objvalue, $substitute);
|
|
HMCCU_Set ($hmccu_hash, $hmccu_name, 'datapoint', $objname, $objvalue);
|
|
usleep (100000);
|
|
HMCCU_Get ($hmccu_hash, $hmccu_name, 'datapoint', $objname);
|
|
|
|
return undef;
|
|
}
|
|
elsif ($opt =~ /($hash->{statevals})/) {
|
|
my $cmd = $1;
|
|
my $objvalue = ($cmd ne 'devstate') ? $cmd : join ('%20', @a);
|
|
|
|
if ($statechannel eq '') {
|
|
return undef;
|
|
# return HMCCUDEV_SetError ($hash, "No STATE channel specified");
|
|
}
|
|
if (!defined ($objvalue)) {
|
|
return HMCCUDEV_SetError ($hash, "Usage: set <device> devstate <value>");
|
|
}
|
|
|
|
my $objname = $ccudev.':'.$statechannel.'.STATE';
|
|
$objvalue = HMCCU_Substitute ($objvalue, $stateval);
|
|
HMCCU_Set ($hmccu_hash, $hmccu_name, 'datapoint', $objname, $objvalue);
|
|
usleep (100000);
|
|
HMCCU_Get ($hmccu_hash, $hmccu_name, 'datapoint', $objname);
|
|
|
|
return undef;
|
|
}
|
|
else {
|
|
my $retmsg = "HMCCUDEV: Unknown argument $opt, choose one of datapoint devstate";
|
|
return undef if ($hash->{statevals} eq 'readonly');
|
|
|
|
if ($stateval ne '') {
|
|
my @cmdlist = split /\|/,$hash->{statevals};
|
|
shift @cmdlist;
|
|
$retmsg .= ':'.join(',',@cmdlist);
|
|
foreach my $sv (@cmdlist) {
|
|
$retmsg .= ' '.$sv.':noArg';
|
|
}
|
|
}
|
|
|
|
return $retmsg;
|
|
}
|
|
}
|
|
|
|
#####################################
|
|
# Get commands
|
|
#####################################
|
|
|
|
sub HMCCUDEV_Get ($@)
|
|
{
|
|
my ($hash, @a) = @_;
|
|
my $name = shift @a;
|
|
my $opt = shift @a;
|
|
|
|
if (!defined ($hash->{IODev})) {
|
|
return HMCCUDEV_SetError ($hash, "No IO device defined");
|
|
}
|
|
|
|
my $hmccu_hash = $hash->{IODev};
|
|
my $hmccu_name = $hash->{IODev}->{NAME};
|
|
my $ccudev = $hash->{ccudev};
|
|
|
|
if ($opt eq 'datapoint') {
|
|
my $objname = shift @a;
|
|
if (!defined ($objname) || $objname !~ /^[0-9]+\..*$/) {
|
|
return HMCCUDEV_SetError ($hash, "Usage: get <device> datapoint <channel>.<datapoint>");
|
|
}
|
|
|
|
$objname = $ccudev.':'.$objname;
|
|
my ($dev, $chn, $dpt, $flags) = HMCCU_ParseCCUDev ($objname);
|
|
if ($flags != 7) {
|
|
return HMCCUDEV_SetError ($hash, "Format for objname is channel.datapoint");
|
|
}
|
|
|
|
HMCCU_Get ($hmccu_hash, $hmccu_name, 'datapoint', $objname);
|
|
|
|
return undef;
|
|
}
|
|
elsif ($opt eq 'update') {
|
|
foreach my $r (keys %{$hash->{READINGS}}) {
|
|
if ($r =~ /^$ccudev:[0-9]\..+/) {
|
|
HMCCU_Get ($hmccu_hash, $hmccu_name, 'datapoint', $r);
|
|
}
|
|
}
|
|
}
|
|
else {
|
|
return "HMCCUDEV: Unknown argument $opt, choose one of datapoint update:noArg";
|
|
}
|
|
}
|
|
|
|
sub HMCCUDEV_SetError ($$)
|
|
{
|
|
my ($hash, $text) = @_;
|
|
my $name = $hash->{NAME};
|
|
|
|
$text = "HMCCUDEV: ".$name." ". $text;
|
|
readingsSingleUpdate ($hash, "state", "Error", 1);
|
|
Log 1, $text;
|
|
return $text;
|
|
}
|
|
|
|
1;
|
|
|
|
=pod
|
|
=begin html
|
|
|
|
<a name="HMCCUDEV"></a>
|
|
<h3>HMCCUDEV</h3>
|
|
<div style="width:800px">
|
|
<ul>
|
|
The module implements client devices for HMCCU.
|
|
</br></br>
|
|
<a name="HMCCUDEVdefine"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<br/>
|
|
<code>define <name> HMCCUDEV <<i>CCU_Device</i>> [readonly]</code>
|
|
<br/><br/>
|
|
If <i>readonly</i> parameter is specified no set command will be available.
|
|
<br/>
|
|
Examples:
|
|
<br/>
|
|
<code>define window_living HMCCUDEV WIN-LIV-1 readonly</code>
|
|
<code>define temp_control HMCCUDEV TEMP-CONTROL</code>
|
|
<br/><br/>
|
|
<i>CCU_Device</i> - Name of device in CCU without channel or datapoint.
|
|
<br/>
|
|
</ul>
|
|
<br/>
|
|
|
|
<a name="HMCCUDEVset"></a>
|
|
<b>Set</b><br/>
|
|
<ul>
|
|
<br/>
|
|
<li>set <<i>Name</i>> devstate <<i>Value</i>>
|
|
<br/>
|
|
Set state of a CCU device channel. Channel must be defined as attribute
|
|
statechannel.
|
|
<br/><br/>
|
|
Example:<br/>
|
|
<code>set light_entrance devstate on</code>
|
|
</li><br/>
|
|
<li>set <<i>Name</i>> <<i>StateValue</i>>
|
|
<br/>
|
|
State of a CCU device channel is set to state value. Channel must
|
|
be defined as attribute statechannel. State values can
|
|
be replaced by setting attribute stateval.
|
|
</li><br/>
|
|
<li>set <<i>Name</i>> datapoint <<i>channel</i>.<i>datapoint</i>> <<i>Value</i>>
|
|
<br/>
|
|
Set value of a datapoint of a CCU device channel.
|
|
<br/><br/>
|
|
Example:<br/>
|
|
<code>set temp_control datapoint TEMP_CONTROL:2.SET_TEMPERATURE 21</code>
|
|
</li><br/>
|
|
</ul>
|
|
<br/>
|
|
|
|
<a name="HMCCUDEVget"></a>
|
|
<b>Get</b><br/>
|
|
<ul>
|
|
<br/>
|
|
<li>get <<i>Name</i>> datapoint <<i>Device</i>:<i>Channel</i>.<i>datapoint</i>>
|
|
<br/>
|
|
Get state of a CCU device datapoint.
|
|
</li><br/>
|
|
<li>get <<i>Name</i>> update
|
|
<br/>
|
|
Update current readings matching CCU device name.
|
|
</li><br/>
|
|
</ul>
|
|
<br/>
|
|
|
|
<a name="HMCCUDEVattr"></a>
|
|
<b>Attributes</b><br/>
|
|
<br/>
|
|
<ul>
|
|
<li>ccureadings <0 | 1>
|
|
<br/>
|
|
If set to 1 values read from CCU will be stored as readings.
|
|
</li><br/>
|
|
<li>statechannel <<i>Channel</i>>
|
|
<br/>
|
|
Channel for setting device state by devstate command.
|
|
</li><br/>
|
|
<li>stateval <<i>text</i>:<i>text</i>[,...]>
|
|
<br/>
|
|
Define substitution for set commands values.
|
|
</li><br/>
|
|
<li>substitude <<i>expression</i>:<i>string</i>[,...]>
|
|
<br/>
|
|
Define substitions for reading values. Substitutions for parfile values must
|
|
be specified in parfiles.
|
|
</li><br/>
|
|
</ul>
|
|
</ul>
|
|
</div>
|
|
|
|
=end html
|
|
=cut
|
|
|