mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-05-01 20:20:10 +00:00
ee64f17191
git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@2521 2b470e98-0d58-463d-a4d8-8e2adae1ed80
807 lines
37 KiB
Perl
Executable File
807 lines
37 KiB
Perl
Executable File
##############################################
|
|
# $Id$
|
|
# Written by Matthias Gehre, M.Gehre@gmx.de, 2012
|
|
package main;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use MIME::Base64;
|
|
|
|
sub MAX_Define($$);
|
|
sub MAX_Undef($$);
|
|
sub MAX_Initialize($);
|
|
sub MAX_Parse($$);
|
|
sub MAX_Set($@);
|
|
sub MAX_MD15Cmd($$$);
|
|
sub MAX_DateTime2Internal($);
|
|
|
|
my @ctrl_modes = ( "auto", "manual", "temporary", "boost" );
|
|
|
|
use vars qw(%device_types);
|
|
use vars qw(%msgId2Cmd);
|
|
use vars qw(%msgCmd2Id);
|
|
|
|
%device_types = (
|
|
0 => "Cube",
|
|
1 => "HeatingThermostat",
|
|
2 => "HeatingThermostatPlus",
|
|
3 => "WallMountedThermostat",
|
|
4 => "ShutterContact",
|
|
5 => "PushButton"
|
|
);
|
|
|
|
my %boost_durations = (0 => 0, 1 => 5, 2 => 10, 3 => 15, 4 => 20, 5 => 25, 6 => 30, 7 => 60);
|
|
my %boost_durationsInv = reverse %boost_durations;
|
|
|
|
my %decalcDays = (0 => "Sat", 1 => "Sun", 2 => "Mon", 3 => "Tue", 4 => "Wed", 5 => "Thu", 6 => "Fri");
|
|
my %decalcDaysInv = reverse %decalcDays;
|
|
|
|
sub validTemperature { return $_[0] eq "on" || $_[0] eq "off" || ($_[0] ~~ /^\d+(\.[05])?$/ && $_[0] >= 5 && $_[0] <= 30); }
|
|
sub validWindowOpenDuration { return $_[0] ~~ /^\d+$/ && $_[0] >= 0 && $_[0] <= 60; }
|
|
sub validMeasurementOffset { return $_[0] ~~ /^-?\d+(\.[05])?$/ && $_[0] >= -3.5 && $_[0] <= 3.5; }
|
|
sub validBoostDuration { return $_[0] ~~ /^\d+$/ && exists($boost_durationsInv{$_[0]}); }
|
|
sub validValveposition { return $_[0] ~~ /^\d+$/ && $_[0] >= 0 && $_[0] <= 100; }
|
|
sub validDecalcification { my ($decalcDay, $decalcHour) = ($_[0] =~ /^(...) (\d{1,2}):00$/);
|
|
return defined($decalcDay) && defined($decalcHour) && exists($decalcDaysInv{$decalcDay}) && 0 <= $decalcHour && $decalcHour < 24; }
|
|
|
|
my %readingDef = ( #min/max/default
|
|
"maximumTemperature" => [ \&validTemperature, 30.5],
|
|
"minimumTemperature" => [ \&validTemperature, 4.5],
|
|
"comfortTemperature" => [ \&validTemperature, 21],
|
|
"ecoTemperature" => [ \&validTemperature, 17],
|
|
"windowOpenTemperature" => [ \&validTemperature, 12],
|
|
"windowOpenDuration" => [ \&validWindowOpenDuration, 15],
|
|
"measurementOffset" => [ \&validMeasurementOffset, 0],
|
|
"boostDuration" => [ \&validBoostDuration, 5 ],
|
|
"boostValveposition" => [ \&validValveposition, 80 ],
|
|
"decalcification" => [ \&validDecalcification, "Sat, 12:00" ],
|
|
"maxValveSetting" => [ \&validValveposition, 100 ],
|
|
"valveOffset" => [ \&validValveposition, 00 ],
|
|
);
|
|
|
|
%msgId2Cmd = (
|
|
"00" => "PairPing",
|
|
"01" => "PairPong",
|
|
"02" => "Ack",
|
|
"03" => "TimeInformation",
|
|
"10" => "ConfigWeekProfile",
|
|
"11" => "ConfigTemperatures", #like eco/comfort etc
|
|
"12" => "ConfigValve",
|
|
"30" => "ShutterContactState",
|
|
"42" => "WallThermostatState", #by WallMountedThermostat
|
|
"50" => "PushButtonState",
|
|
"60" => "ThermostatState", #by HeatingThermostat
|
|
"40" => "SetTemperature", #to thermostat
|
|
"20" => "AddLinkPartner",
|
|
"21" => "RemoveLinkPartner",
|
|
"22" => "SetGroupId",
|
|
"23" => "RemoveGroupId",
|
|
"82" => "SetDisplayActualTemperature",
|
|
"F1" => "WakeUp",
|
|
"F0" => "Reset",
|
|
);
|
|
%msgCmd2Id = reverse %msgId2Cmd;
|
|
|
|
my %interfaces = (
|
|
"Cube" => undef,
|
|
"HeatingThermostat" => "thermostat;battery;temperature",
|
|
"HeatingThermostatPlus" => "thermostat;battery;temperature",
|
|
"WallMountedThermostat" => "thermostat;temperature;battery",
|
|
"ShutterContact" => "switch_active;battery",
|
|
"PushButton" => "switch_passive;battery"
|
|
);
|
|
|
|
sub
|
|
MAX_Initialize($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
Log 5, "Calling MAX_Initialize";
|
|
$hash->{Match} = "^MAX";
|
|
$hash->{DefFn} = "MAX_Define";
|
|
$hash->{UndefFn} = "MAX_Undef";
|
|
$hash->{ParseFn} = "MAX_Parse";
|
|
$hash->{SetFn} = "MAX_Set";
|
|
$hash->{AttrList} = "IODev do_not_notify:1,0 ignore:0,1 dummy:0,1 " .
|
|
"showtime:1,0 loglevel:0,1,2,3,4,5,6 ".
|
|
$readingFnAttributes;
|
|
return undef;
|
|
}
|
|
|
|
#############################
|
|
sub
|
|
MAX_Define($$)
|
|
{
|
|
my ($hash, $def) = @_;
|
|
my @a = split("[ \t][ \t]*", $def);
|
|
my $name = $hash->{NAME};
|
|
return "wrong syntax: define <name> MAX addr"
|
|
if(int(@a)!=4 || $a[3] !~ m/^[A-F0-9]{6}$/i);
|
|
|
|
my $type = $a[2];
|
|
my $addr = lc($a[3]); #all addr should be lowercase
|
|
if(exists($modules{MAX}{defptr}{$addr})) {
|
|
my $msg = "MAX_Define: Device with addr $addr is already defined";
|
|
Log 1, $msg;
|
|
return $msg;
|
|
}
|
|
Log 5, "Max_define $type with addr $addr ";
|
|
$hash->{type} = $type;
|
|
$hash->{addr} = $addr;
|
|
$modules{MAX}{defptr}{$addr} = $hash;
|
|
|
|
$hash->{internals}{interfaces} = $interfaces{$type};
|
|
|
|
AssignIoPort($hash);
|
|
return undef;
|
|
}
|
|
|
|
sub
|
|
MAX_Undef($$)
|
|
{
|
|
my ($hash,$name) = @_;
|
|
delete($modules{MAX}{defptr}{$hash->{addr}});
|
|
}
|
|
|
|
sub
|
|
MAX_DateTime2Internal($)
|
|
{
|
|
my($day, $month, $year, $hour, $min) = ($_[0] =~ /^(\d{2}).(\d{2})\.(\d{4}) (\d{2}):(\d{2})$/);
|
|
return (($month&0xE) << 20) | ($day << 16) | (($month&1) << 15) | (($year-2000) << 8) | ($hour*2 + int($min/30));
|
|
}
|
|
|
|
sub
|
|
MAX_TypeToTypeId($)
|
|
{
|
|
foreach (keys %device_types) {
|
|
return $_ if($_[0] eq $device_types{$_});
|
|
}
|
|
Log 1, "MAX_TypeToTypeId: Invalid type $_[0]";
|
|
return 0;
|
|
}
|
|
|
|
sub
|
|
MAX_CheckIODev($)
|
|
{
|
|
my $hash = shift;
|
|
return !defined($hash->{IODev}) || ($hash->{IODev}{TYPE} ne "MAXLAN" && $hash->{IODev}{TYPE} ne "CUL_MAX");
|
|
}
|
|
|
|
sub
|
|
MAX_ParseTemperature($)
|
|
{
|
|
return $_[0] eq "on" ? 30.5 : ($_[0] eq "off" ? 4.5 :$_[0]);
|
|
}
|
|
|
|
sub
|
|
MAX_Validate(@)
|
|
{
|
|
my ($name,$val) = @_;
|
|
return 1 if(!exists($readingDef{$name}));
|
|
return $readingDef{$name}[0]->($val);
|
|
}
|
|
|
|
sub
|
|
MAX_ReadingsVal(@)
|
|
{
|
|
my ($hash,$name) = @_;
|
|
|
|
my $val = MAX_ParseTemperature(ReadingsVal($hash->{NAME},$name,""));
|
|
#$readingDef{$name} array is [validatingFunc, defaultValue]
|
|
if(exists($readingDef{$name}) and !$readingDef{$name}[0]->($val)) {
|
|
#Error: invalid value
|
|
Log 2, "MAX: Invalid value $val for READING $name. Forcing to $readingDef{$name}[1]";
|
|
$val = $readingDef{$name}[1];
|
|
|
|
#Save default value to READINGS
|
|
if(exists($hash->{".updateTimestamp"})) {
|
|
readingsBulkUpdate($hash,$name,$val);
|
|
} else {
|
|
readingsSingleUpdate($hash,$name,$val,0);
|
|
}
|
|
}
|
|
return $val;
|
|
}
|
|
|
|
#############################
|
|
sub
|
|
MAX_Set($@)
|
|
{
|
|
my ($hash, $devname, @a) = @_;
|
|
my ($setting, @args) = @a;
|
|
|
|
return "Invalid IODev" if(MAX_CheckIODev($hash));
|
|
|
|
if($setting eq "desiredTemperature" and $hash->{type} ~~ ["HeatingThermostat","WallMountedThermostat"]) {
|
|
return "missing a value" if(@args == 0);
|
|
|
|
my $temperature;
|
|
my $until = undef;
|
|
my $ctrlmode = 1; #0=auto, 1=manual; 2=temporary
|
|
|
|
if($args[0] eq "auto") {
|
|
#This enables the automatic/schedule mode where the thermostat follows the weekly program
|
|
$temperature = @args > 1 ? MAX_ParseTemperature($args[1]) : 0;
|
|
$ctrlmode = 0; #auto
|
|
} elsif($args[0] eq "boost") {
|
|
$temperature = 0;
|
|
$ctrlmode = 3;
|
|
#TODO: auto mode with temperature is also possible
|
|
} elsif($args[0] eq "eco") {
|
|
$temperature = MAX_ReadingsVal($hash,"ecoTemperature");
|
|
return "No ecoTemperature defined" if(!$temperature);
|
|
} elsif($args[0] eq "comfort") {
|
|
$temperature = MAX_ReadingsVal($hash,"comfortTemperature");
|
|
return "No comfortTemperature defined" if(!$temperature);
|
|
}else{
|
|
$temperature = MAX_ParseTemperature($args[0]);
|
|
}
|
|
|
|
if(@args > 1 and ($args[1] eq "until") and ($ctrlmode == 1)) {
|
|
$ctrlmode = 2; #temporary
|
|
$until = sprintf("%06x",MAX_DateTime2Internal($args[2]." ".$args[3]));
|
|
}
|
|
|
|
my $payload = sprintf("%02x",int($temperature*2.0) | ($ctrlmode << 6));
|
|
$payload .= $until if(defined($until));
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"SetTemperature",$hash->{addr},$payload);
|
|
|
|
}elsif($setting ~~ ["boostDuration", "boostValveposition", "decalcification","maxValveSetting","valveOffset"]
|
|
and $hash->{type} eq "HeatingThermostat"){
|
|
|
|
my $val = join(" ",@args); #decalcification contains a space
|
|
|
|
if(!MAX_Validate($setting, $val)) {
|
|
my $msg = "Invalid value $args[0] for $setting";
|
|
Log 1, $msg;
|
|
return $msg;
|
|
}
|
|
|
|
readingsSingleUpdate($hash, $setting, $val, 0);
|
|
|
|
my $boostDuration = MAX_ReadingsVal($hash,"boostDuration");
|
|
my $boostValveposition = MAX_ReadingsVal($hash,"boostValveposition");
|
|
my $decalcification = MAX_ReadingsVal($hash,"decalcification");
|
|
my $maxValveSetting = MAX_ReadingsVal($hash,"maxValveSetting");
|
|
my $valveOffset = MAX_ReadingsVal($hash,"valveOffset");
|
|
|
|
my ($decalcDay, $decalcHour) = ($decalcification =~ /^(...) (\d{1,2}):00$/);
|
|
my $decalc = ($decalcDaysInv{$decalcDay} << 5) | $decalcHour;
|
|
my $boost = ($boost_durationsInv{$boostDuration} << 5) | int($boostValveposition/5);
|
|
|
|
my $payload = sprintf("%02x%02x%02x%02x", $boost, $decalc, int($maxValveSetting*255/100), int($valveOffset*255/100));
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"ConfigValve",$hash->{addr},$payload);
|
|
|
|
}elsif($setting eq "groupid"){
|
|
return "argument needed" if(@args == 0);
|
|
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"SetGroupId",$hash->{addr}, sprintf("%02x",$args[0]) );
|
|
|
|
}elsif( $setting ~~ ["ecoTemperature", "comfortTemperature", "measurementOffset", "maximumTemperature", "minimumTemperature", "windowOpenTemperature", "windowOpenDuration" ] and ($hash->{type} eq "HeatingThermostat" or $hash->{type} eq "WallMountedThermostat")) {
|
|
return "Cannot set without IODev" if(!exists($hash->{IODev}));
|
|
|
|
if(!MAX_Validate($setting, $args[0])) {
|
|
my $msg = "Invalid value $args[0] for $setting";
|
|
Log 1, $msg;
|
|
return $msg;
|
|
}
|
|
|
|
readingsSingleUpdate($hash, $setting, $args[0], 0);
|
|
|
|
my $comfortTemperature = MAX_ReadingsVal($hash,"comfortTemperature");
|
|
my $ecoTemperature = MAX_ReadingsVal($hash,"ecoTemperature");
|
|
my $maximumTemperature = MAX_ReadingsVal($hash,"maximumTemperature");
|
|
my $minimumTemperature = MAX_ReadingsVal($hash,"minimumTemperature");
|
|
my $windowOpenTemperature = MAX_ReadingsVal($hash,"windowOpenTemperature");
|
|
my $windowOpenDuration = MAX_ReadingsVal($hash,"windowOpenDuration");
|
|
my $measurementOffset = MAX_ReadingsVal($hash,"measurementOffset");
|
|
|
|
my $comfort = int(MAX_ParseTemperature($comfortTemperature)*2);
|
|
my $eco = int(MAX_ParseTemperature($ecoTemperature)*2);
|
|
my $max = int(MAX_ParseTemperature($maximumTemperature)*2);
|
|
my $min = int(MAX_ParseTemperature($minimumTemperature)*2);
|
|
my $offset = int(($measurementOffset + 3.5)*2);
|
|
my $windowOpenTemp = int(MAX_ParseTemperature($windowOpenTemperature)*2);
|
|
my $windowOpenTime = int($windowOpenDuration/5);
|
|
|
|
my $payload = sprintf("%02x%02x%02x%02x%02x%02x%02x",$comfort,$eco,$max,$min,$offset,$windowOpenTemp,$windowOpenTime);
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"ConfigTemperatures",$hash->{addr},$payload)
|
|
|
|
} elsif($setting eq "displayActualTemperature" and $hash->{type} eq "WallMountedThermostat") {
|
|
return "Invalid arg" if($args[0] ne "0" and $args[0] ne "1");
|
|
|
|
readingsSingleUpdate($hash, $setting, $args[0], 0);
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"SetDisplayActualTemperature",$hash->{addr},sprintf("%02x",$args[0] ? 4 : 0));
|
|
|
|
} elsif($setting eq "fake") {
|
|
#Resolve first argument to address
|
|
return "Invalid number of arguments" if(@args == 0);
|
|
my $dest = $args[0];
|
|
if(exists($defs{$dest})) {
|
|
return "Destination is not a MAX device" if($defs{$dest}{TYPE} ne "MAX");
|
|
$dest = $defs{$dest}{addr};
|
|
} else {
|
|
return "No MAX device with address $dest" if(!exists($modules{MAX}{defptr}{$dest}));
|
|
}
|
|
|
|
if($hash->{type} eq "ShutterContact") {
|
|
return "Invalid number of arguments" if(@args != 2);
|
|
my $state = $args[1] ? "12" : "10";
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"ShutterContactState",$dest,$state,"06",undef,undef,$hash->{addr});
|
|
} elsif($hash->{type} eq "WallMountedThermostat") {
|
|
return "Invalid number of arguments" if(@args != 3);
|
|
my $desiredTemperature = $args[1];
|
|
my $measuredTemperature = $args[2];
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"WallThermostatState",$dest,
|
|
sprintf("%02x%02x",int($desiredTemperature*2),int($measuredTemperature*10)),"04",undef,undef,$hash->{addr});
|
|
} else {
|
|
return "fake does not work for device type $hash->{type}";
|
|
}
|
|
|
|
} elsif($setting ~~ ["associate", "deassociate"]) {
|
|
my $dest = $args[0];
|
|
if(exists($defs{$dest})) {
|
|
return "Destination is not a MAX device" if($defs{$dest}{TYPE} ne "MAX");
|
|
#return "Destination is not a thermostat" if($defs{$dest}{type} ne "HeatingThermostat" and $defs{$dest}{type} ne "WallMountedThermostat");
|
|
$dest = $defs{$dest}{addr};
|
|
} else {
|
|
return "No MAX device with address $dest" if(!exists($modules{MAX}{defptr}{$dest}));
|
|
}
|
|
my $destType = MAX_TypeToTypeId($modules{MAX}{defptr}{$dest}{type});
|
|
Log 2, "Warning: Device do not have same groupid" if($hash->{groupid} != $modules{MAX}{defptr}{groupid});
|
|
Log 5, "Using dest $dest, destType $destType";
|
|
if($setting eq "associate") {
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"AddLinkPartner",$hash->{addr},sprintf("%s%02x", $dest, $destType));
|
|
} else {
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"RemoveLinkPartner",$hash->{addr},sprintf("%s%02x", $dest, $destType));
|
|
}
|
|
|
|
|
|
} elsif($setting eq "factoryReset") {
|
|
|
|
if(exists($hash->{IODev}{RemoveDevice})) {
|
|
#MAXLAN
|
|
return ($hash->{IODev}{RemoveDevice})->($hash->{IODev},$hash->{addr});
|
|
} else {
|
|
#CUL_MAX
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"Reset",$hash->{addr});
|
|
}
|
|
|
|
} elsif($setting eq "wakeUp") {
|
|
return ($hash->{IODev}{Send})->($hash->{IODev},"WakeUp",$hash->{addr}, 0x3F);
|
|
|
|
}else{
|
|
my $templist = "off,".join(",",map { sprintf("%2.1f",$_/2) } (10..60)) . ",on";
|
|
my $ret = "Unknown argument $setting, choose one of wakeUp factoryReset groupid";
|
|
|
|
my $assoclist;
|
|
#Build list of devices which this device can be associated to
|
|
if($hash->{type} eq "HeatingThermostat") {
|
|
$assoclist = join(",", map { defined($_->{type}) && $_->{type} ~~ ["HeatingThermostat", "WallMountedThermostat", "ShutterContact"] ? $_->{NAME} : () } values %{$modules{MAX}{defptr}});
|
|
} elsif($hash->{type} ~~ ["ShutterContact", "WallMountedThermostat"]) {
|
|
$assoclist = join(",", map { defined($_->{type}) && $_->{type} eq "HeatingThermostat" ? $_->{NAME} : () } values %{$modules{MAX}{defptr}});
|
|
}
|
|
|
|
if($hash->{type} eq "HeatingThermostat") {
|
|
#Create numbers from 4.5 to 30.5
|
|
my $templistOffset = join(",",map { sprintf("%2.1f",($_-7)/2) } (0..14));
|
|
my $boostDurVal = join(",", values(%boost_durations));
|
|
return "$ret associate:$assoclist deassociate:$assoclist desiredTemperature:eco,comfort,boost,auto,$templist ecoTemperature:$templist comfortTemperature:$templist measurementOffset:$templistOffset maximumTemperature:$templist minimumTemperature:$templist windowOpenTemperature:$templist windowOpenDuration boostDuration:$boostDurVal boostValveposition decalcification maxValveSetting valveOffset";
|
|
|
|
} elsif($hash->{type} eq "WallMountedThermostat") {
|
|
return "$ret associate:$assoclist deassociate:$assoclist displayActualTemperature:0,1 desiredTemperature:eco,comfort,boost,auto,$templist ecoTemperature:$templist comfortTemperature:$templist maximumTemperature:$templist";
|
|
} elsif($hash->{type} eq "ShutterContact") {
|
|
return "$ret associate:$assoclist deassociate:$assoclist";
|
|
} else {
|
|
return $ret;
|
|
}
|
|
}
|
|
}
|
|
|
|
#############################
|
|
sub
|
|
MAX_ParseDateTime($$$)
|
|
{
|
|
my ($byte1,$byte2,$byte3) = @_;
|
|
my $day = $byte1 & 0x1F;
|
|
my $month = (($byte1 & 0xE0) >> 4) | ($byte2 >> 7);
|
|
my $year = $byte2 & 0x3F;
|
|
my $time = ($byte3 & 0x3F);
|
|
if($time%2){
|
|
$time = int($time/2).":30";
|
|
}else{
|
|
$time = int($time/2).":00";
|
|
}
|
|
return { "day" => $day, "month" => $month, "year" => $year, "time" => $time, "str" => "$day.$month.$year $time" };
|
|
}
|
|
|
|
#############################
|
|
sub
|
|
MAX_Parse($$)
|
|
{
|
|
my ($hash, $msg) = @_;
|
|
my ($MAX,$isToMe,$msgtype,$addr,@args) = split(",",$msg);
|
|
#$isToMe is 1 if the message was direct at the device $hash, and 0
|
|
#if we just snooped a message directed at a different device (by CUL_MAX).
|
|
return if($MAX ne "MAX");
|
|
|
|
Log 5, "MAX_Parse $msg";
|
|
#Find the device with the given addr
|
|
my $shash = $modules{MAX}{defptr}{$addr};
|
|
|
|
if(!$shash)
|
|
{
|
|
my $devicetype = undef;
|
|
$devicetype = $args[0] if($msgtype eq "define");
|
|
$devicetype = "ShutterContact" if($msgtype eq "ShutterContactState");
|
|
$devicetype = "Cube" if($msgtype eq "CubeClockState" or $msgtype eq "CubeConnectionState");
|
|
if($devicetype) {
|
|
return "UNDEFINED MAX_$addr MAX $devicetype $addr";
|
|
} else {
|
|
Log 2, "Got message for undefined device, and failed to guess type from msg '$msgtype' - ignoring";
|
|
return $hash->{NAME};
|
|
}
|
|
}
|
|
|
|
#if $isToMe is true, then the message was directed at device $hash, thus we can also use it for sending
|
|
if($isToMe) {
|
|
$shash->{IODev} = $hash;
|
|
$shash->{backend} = $hash->{NAME}; #for user information
|
|
}
|
|
|
|
readingsBeginUpdate($shash);
|
|
if($msgtype eq "define"){
|
|
my $devicetype = $args[0];
|
|
Log 1, "Device changed type from $shash->{type} to $devicetype" if($shash->{type} ne $devicetype);
|
|
if(@args > 1){
|
|
my $serial = $args[1];
|
|
Log 1, "Device changed serial from $shash->{serial} to $serial" if($shash->{serial} and ($shash->{serial} ne $serial));
|
|
$shash->{serial} = $serial;
|
|
}
|
|
$shash->{groupid} = $args[2];
|
|
$shash->{IODev} = $hash;
|
|
|
|
} elsif($msgtype eq "ThermostatState") {
|
|
|
|
my ($bits2,$valveposition,$desiredTemperature,$until1,$until2,$until3) = unpack("aCCCCC",pack("H*",$args[0]));
|
|
my $mode = vec($bits2, 0, 2); #
|
|
my $dstsetting = vec($bits2, 3, 1); #is automatically switching to DST activated
|
|
my $langateway = vec($bits2, 4, 1); #??
|
|
my $panel = vec($bits2, 5, 1); #1 if the heating thermostat is locked for manually setting the temperature at the device
|
|
my $rferror = vec($bits2, 6, 1); #communication with link partner (what does that mean?)
|
|
my $batterylow = vec($bits2, 7, 1); #1 if battery is low
|
|
|
|
my $untilStr = defined($until3) ? MAX_ParseDateTime($until1,$until2,$until3)->{str} : "";
|
|
my $measuredTemperature = defined($until2) ? $until2/10 : 0;
|
|
#If the control mode is not "temporary", the cube sends the current (measured) temperature
|
|
$measuredTemperature = "" if($mode == 2 || $measuredTemperature == 0);
|
|
$untilStr = "" if($mode != 2);
|
|
|
|
$desiredTemperature = $desiredTemperature/2.0; #convert to degree celcius
|
|
Log 5, "battery $batterylow, rferror $rferror, panel $panel, langateway $langateway, dstsetting $dstsetting, mode $mode, valveposition $valveposition %, desiredTemperature $desiredTemperature, until $untilStr, curTemp $measuredTemperature";
|
|
|
|
#Very seldomly, the HeatingThermostat sends us temperatures like 0.2 or 0.3 degree Celcius - ignore them
|
|
$measuredTemperature = "" if($measuredTemperature ne "" and $measuredTemperature < 1);
|
|
|
|
#The HeatingThermostat uses the measurementOffset during control
|
|
#but does not apply it to measuredTemperature before sending it to us (guessed)
|
|
my $measOffset = MAX_ReadingsVal($shash,"measurementOffset");
|
|
$measuredTemperature -= $measOffset if($measuredTemperature ne "" and $measOffset ne "");
|
|
|
|
$shash->{mode} = $mode;
|
|
$shash->{rferror} = $rferror;
|
|
$shash->{dstsetting} = $dstsetting;
|
|
if($mode eq "temporary"){
|
|
$shash->{until} = "$untilStr";
|
|
}else{
|
|
delete($shash->{until});
|
|
}
|
|
|
|
readingsBulkUpdate($shash, "mode", $ctrl_modes[$mode] );
|
|
readingsBulkUpdate($shash, "battery", $batterylow ? "low" : "ok");
|
|
#This formatting must match with in MAX_Set:$templist
|
|
readingsBulkUpdate($shash, "desiredTemperature", sprintf("%2.1f",$desiredTemperature));
|
|
readingsBulkUpdate($shash, "valveposition", $valveposition);
|
|
if($measuredTemperature ne "") {
|
|
readingsBulkUpdate($shash, "temperature", $measuredTemperature);
|
|
}
|
|
|
|
}elsif($msgtype eq "WallThermostatState"){
|
|
my ($bits2,$displayActualTemperature,$desiredTemperature,$null1,$heaterTemperature,$null2,$temperature);
|
|
if( length($args[0]) == 4 ) {
|
|
#This is the message that WallMountedThermostats send to paired HeatingThermostats
|
|
($desiredTemperature,$temperature) = unpack("CC",pack("H*",$args[0]));
|
|
} elsif( length($args[0]) == 14 or length($args[0]) == 12) {
|
|
#len=14: This is the message we get from the Cube over MAXLAN and which is probably send by WallMountedThermostats to the Cube
|
|
#len=12: Payload of the Ack message, last field "temperature" is missing
|
|
($bits2,$displayActualTemperature,$desiredTemperature,$null1,$heaterTemperature,$null2,$temperature) = unpack("aCCCCCC",pack("H*",$args[0]));
|
|
#$heaterTemperature/10 is the temperature measured by a paired HeatingThermostat
|
|
#we don't do anything with it here, because this value also appears as temperature in the HeatingThermostat's ThermostatState message
|
|
my $mode = vec($bits2, 0, 2); #
|
|
my $dstsetting = vec($bits2, 3, 1); #is automatically switching to DST activated
|
|
my $langateway = vec($bits2, 4, 1); #??
|
|
my $panel = vec($bits2, 5, 1); #1 if the heating thermostat is locked for manually setting the temperature at the device
|
|
my $rferror = vec($bits2, 6, 1); #communication with link partner (what does that mean?)
|
|
my $batterylow = vec($bits2, 7, 1); #1 if battery is low
|
|
Log 2, "Warning: WallThermostatState null1: $null1 null2: $null2 should be both zero" if($null1 != 0 || $null2 != 0);
|
|
|
|
Log 5, "battery $batterylow, rferror $rferror, panel $panel, langateway $langateway, dstsetting $dstsetting, mode $mode, displayActualTemperature $displayActualTemperature, heaterTemperature $heaterTemperature";
|
|
$shash->{rferror} = $rferror;
|
|
readingsBulkUpdate($shash, "mode", $ctrl_modes[$mode] );
|
|
readingsBulkUpdate($shash, "battery", $batterylow ? "low" : "ok");
|
|
readingsBulkUpdate($shash, "displayActualTemperature", ($displayActualTemperature) ? 1 : 0);
|
|
} else {
|
|
Log 2, "Invalid WallThermostatState packet"
|
|
}
|
|
|
|
$desiredTemperature /= 2.0; #convert to degree celcius
|
|
if(defined($temperature)) {
|
|
$temperature /= 10.0; #convert to degree celcius
|
|
Log 5, "desiredTemperature $desiredTemperature, temperature $temperature";
|
|
readingsBulkUpdate($shash, "temperature", $temperature);
|
|
} else {
|
|
Log 5, "desiredTemperature $desiredTemperature"
|
|
}
|
|
|
|
#This formatting must match with in MAX_Set:$templist
|
|
readingsBulkUpdate($shash, "desiredTemperature", sprintf("%2.1f",$desiredTemperature));
|
|
|
|
}elsif($msgtype eq "ShutterContactState"){
|
|
my $bits = pack("H2",$args[0]);
|
|
my $isopen = vec($bits,0,2) == 0 ? 0 : 1;
|
|
my $unkbits = vec($bits,2,4);
|
|
my $rferror = vec($bits,6,1);
|
|
my $batterylow = vec($bits,7,1);
|
|
Log 5, "ShutterContact isopen $isopen, rferror $rferror, battery $batterylow, unkbits $unkbits";
|
|
|
|
$shash->{rferror} = $rferror;
|
|
|
|
readingsBulkUpdate($shash, "battery", $batterylow ? "low" : "ok");
|
|
readingsBulkUpdate($shash,"onoff",$isopen);
|
|
|
|
}elsif($msgtype eq "PushButtonState") {
|
|
my ($bits2, $onoff) = unpack("CC",pack("H*",$args[0]));
|
|
#The meaning of $bits2 is completly guessed based on similarity to other devices, TODO: confirm
|
|
my $rferror = vec($bits2, 6, 1); #communication with link partner (what does that mean?)
|
|
my $batterylow = vec($bits2, 7, 1); #1 if battery is low
|
|
|
|
readingsBulkUpdate($shash, "battery", $batterylow ? "low" : "ok");
|
|
readingsBulkUpdate($shash,"onoff",$onoff);
|
|
|
|
}elsif($msgtype eq "CubeClockState"){
|
|
my $clockset = $args[0];
|
|
$shash->{clocknotset} = !$clockset;
|
|
|
|
}elsif($msgtype eq "CubeConnectionState"){
|
|
my $connected = $args[0];
|
|
|
|
readingsBulkUpdate($shash, "connection", $connected);
|
|
|
|
} elsif($msgtype ~~ ["HeatingThermostatConfig", "WallThermostatConfig"]) {
|
|
readingsBulkUpdate($shash, "ecoTemperature", $args[0]);
|
|
readingsBulkUpdate($shash, "comfortTemperature", $args[1]);
|
|
readingsBulkUpdate($shash, "maximumTemperature", $args[2]);
|
|
readingsBulkUpdate($shash, "minimumTemperature", $args[3]);
|
|
if($shash->{type} eq "HeatingThermostat") {
|
|
readingsBulkUpdate($shash, "boostValveposition", $args[4]);
|
|
readingsBulkUpdate($shash, "boostDuration", $boost_durations{$args[5]});
|
|
readingsBulkUpdate($shash, "measurementOffset", $args[6]);
|
|
readingsBulkUpdate($shash, "windowOpenTemperature", $args[7]);
|
|
readingsBulkUpdate($shash, "windowOpenDuration", $args[8]);
|
|
readingsBulkUpdate($shash, "maxValveSetting", $args[9]);
|
|
readingsBulkUpdate($shash, "valveOffset", $args[10]);
|
|
readingsBulkUpdate($shash, "decalcification", "$decalcDays{$args[11]} $args[12]:00");
|
|
$shash->{internal}{weekProfile} = $args[13];
|
|
} else {
|
|
$shash->{internal}{weekProfile} = $args[4];
|
|
}
|
|
|
|
#parse weekprofiles for each day
|
|
for (my $i=0;$i<7;$i++) {
|
|
my (@time_prof, @temp_prof);
|
|
for(my $j=0;$j<13;$j++) {
|
|
$time_prof[$j] = (hex(substr($shash->{internal}{weekProfile},($i*52)+ 4*$j,4))& 0x1FF) * 5;
|
|
$temp_prof[$j] = (hex(substr($shash->{internal}{weekProfile},($i*52)+ 4*$j,4))>> 9 & 0x3F ) / 2;
|
|
}
|
|
|
|
my @hours;
|
|
my @minutes;
|
|
my $j;
|
|
for($j=0;$j<13;$j++) {
|
|
$hours[$j] = ($time_prof[$j] / 60 % 24);
|
|
$minutes[$j] = ($time_prof[$j]%60);
|
|
#if 00:00 reached, last point in profile was found
|
|
last if(int($hours[$j])==0 && int($minutes[$j])==0 );
|
|
}
|
|
|
|
my $time_prof_str = "00:00";
|
|
my $temp_prof_str;
|
|
for (my $k=0;$k<=$j;$k++) {
|
|
$time_prof_str .= sprintf("-%02d:%02d", $hours[$k], $minutes[$k]);
|
|
$temp_prof_str .= $temp_prof[$k];
|
|
if ($k < $j) {
|
|
$time_prof_str .= " / " . sprintf("%02d:%02d", $hours[$k], $minutes[$k]);
|
|
$temp_prof_str .= " / ";
|
|
}
|
|
}
|
|
|
|
readingsBulkUpdate($shash, "weekprofile-$i-$decalcDays{$i}-time", $time_prof_str );
|
|
readingsBulkUpdate($shash, "weekprofile-$i-$decalcDays{$i}-temp", $temp_prof_str );
|
|
|
|
} # Endparse weekprofiles for each day
|
|
|
|
} elsif($msgtype eq "Error") {
|
|
if(@args == 0) {
|
|
delete $shash->{ERROR} if(exists($shash->{ERROR}));
|
|
} else {
|
|
$shash->{ERROR} = join(",",$args[0]);
|
|
}
|
|
|
|
} elsif($msgtype eq "Ack") {
|
|
#The payload of an Ack is a 2-digit hex number (being "01" for okey and "81" for "invalid command/argument"
|
|
if($isToMe and (unpack("C",pack("H*",$args[0])) & 0x80)) {
|
|
my $device = $addr;
|
|
$device = $modules{MAX}{defptr}{$device}{NAME} if(exists($modules{MAX}{defptr}{$device}));
|
|
Log 1, "Device $device answered with: Invalid command/argument";
|
|
}
|
|
#with unknown meaning plus the data of a State broadcast from the same device
|
|
#For HeatingThermostats, it does not contain the last three "until" bytes (or measured temperature)
|
|
if($shash->{type} ~~ "HeatingThermostat" ) {
|
|
return MAX_Parse($hash, "MAX,$isToMe,ThermostatState,$addr,". substr($args[0],2));
|
|
} elsif($shash->{type} eq "WallMountedThermostat") {
|
|
return MAX_Parse($hash, "MAX,$isToMe,WallThermostatState,$addr,". substr($args[0],2));
|
|
} elsif($shash->{type} eq "ShutterContact") {
|
|
return MAX_Parse($hash, "MAX,$isToMe,ShutterContactState,$addr,". substr($args[0],2));
|
|
} elsif($shash->{type} eq "PushButton") {
|
|
return MAX_Parse($hash, "MAX,$isToMe,PushButtonState,$addr,". substr($args[0],2));
|
|
} elsif($shash->{type} eq "Cube") {
|
|
; #Payload is always "00"
|
|
} else {
|
|
Log 2, "MAX_Parse: Don't know how to interpret Ack payload for $shash->{type}";
|
|
}
|
|
|
|
} else {
|
|
Log 1, "MAX_Parse: Unknown message $msgtype";
|
|
}
|
|
|
|
#Build state READING
|
|
my $state = "waiting for data";
|
|
if(exists($shash->{READINGS})) {
|
|
$state = $shash->{READINGS}{connection}{VAL} ? "connected" : "not connected" if(exists($shash->{READINGS}{connection}));
|
|
$state = "$shash->{READINGS}{desiredTemperature}{VAL} °C" if(exists($shash->{READINGS}{desiredTemperature}));
|
|
$state = $shash->{READINGS}{onoff}{VAL} ? "opened" : "closed" if(exists($shash->{READINGS}{onoff}));
|
|
}
|
|
|
|
$state .= " (clock not set)" if($shash->{clocknotset});
|
|
$state .= " (auto)" if(exists($shash->{mode}) and $shash->{mode} eq "auto");
|
|
#Don't print this: it's the standard mode
|
|
#$state .= " (manual)" if(exists($shash->{mode}) and $shash->{mode} eq "manual");
|
|
$state .= " (until ".$shash->{until}.")" if(exists($shash->{mode}) and $shash->{mode} eq "temporary" );
|
|
$state .= " (battery low)" if($shash->{batterylow});
|
|
$state .= " (rf error)" if($shash->{rferror});
|
|
|
|
readingsBulkUpdate($shash, "state", $state);
|
|
readingsEndUpdate($shash, 1);
|
|
return $shash->{NAME}
|
|
}
|
|
|
|
1;
|
|
|
|
=pod
|
|
=begin html
|
|
|
|
<a name="MAX"></a>
|
|
<h3>MAX</h3>
|
|
<ul>
|
|
Devices from the eQ-3 MAX! group.<br>
|
|
When heating thermostats show a temperature of zero degrees, they didn't yet send any data to the cube. You can
|
|
force the device to send data to the cube by physically setting a temperature directly at the device (not through fhem).
|
|
<br><br>
|
|
<a name="MAXdefine"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<code>define <name> MAX <type> <addr></code>
|
|
<br><br>
|
|
|
|
Define an MAX device of type <type> and rf address <addr>.
|
|
The <type> is one of Cube, HeatingThermostat, HeatingThermostatPlus, WallMountedThermostat, ShutterContact, PushButton.
|
|
The <addr> is a 6 digit hex number.
|
|
You should never need to specify this by yourself, the <a href="#autocreate">autocreate</a> module will do it for you.<br>
|
|
It's advisable to set event-on-change-reading, like
|
|
<code>attr MAX_123456 event-on-change-reading .*</code>
|
|
because the polling mechanism will otherwise create events every 10 seconds.<br>
|
|
|
|
Example:
|
|
<ul>
|
|
<code>define switch1 MAX PushButton ffc545</code><br>
|
|
</ul>
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="MAXset"></a>
|
|
<b>Set</b>
|
|
<ul>
|
|
<li>desiredTemperature <value> [until <date>]<br>
|
|
For devices of type HeatingThermostat only. <value> maybe one of
|
|
<ul>
|
|
<li>degree celcius between 3.5 and 30.5 in 0.5 degree steps</li>
|
|
<li>"on" or "off" correspondig to 30.5 and 4.5 degree celcius</li>
|
|
<li>"eco" or "comfort" using the eco/comfort temperature set on the device (just as the right-most physical button on the device itself does)</li>
|
|
<li>"auto <temperature>". The weekly program saved on the thermostat is processed. If the optional <temperature> is given, it is set as desiredTemperature until the next switch point of the weekly program.</li>
|
|
<li>"boost", activates the boost mode, where for boostDuration minutes the valve is opened up boostValveposition percent.</li>
|
|
</ul>
|
|
All values but "auto" maybe accompanied by the "until" clause, with <data> in format "dd.mm.yyyy HH:MM" (minutes may only be "30" or "00"!)
|
|
to set a temporary temperature until that date/time. Make sure that the cube has valid system time!</li>
|
|
<li>groupid <id><br>
|
|
For devices of type HeatingThermostat only.
|
|
Writes the given group id the device's memory. It is usually not necessary to change this.</li>
|
|
<li>ecoTemperature <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given eco temperature to the device's memory. It can be activated by pressing the rightmost physical button on the device.</li>
|
|
<li>comfortTemperature <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given comfort temperature to the device's memory. It can be activated by pressing the rightmost physical button on the device.</li>
|
|
<li>measurementOffset <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given temperature offset to the device's memory. The thermostat tries to match desiredTemperature to (measured temperature at sensor - measurementOffset). Usually, the measured temperature is a bit higher than the overall room temperature (due to closeness to the heater), so one uses a small positive offset. Must be between -3.5 and 3.5 degree.</li>
|
|
<li>minimumTemperature <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given minimum temperature to the device's memory. It confines the temperature that can be manually set on the device.</li>
|
|
<li>maximumTemperature <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given maximum temperature to the device's memory. It confines the temperature that can be manually set on the device.</li>
|
|
<li>windowOpenTemperature <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given window open temperature to the device's memory. That is the temperature the heater will temporarily set if an open window is detected. Setting it to 4.5 degree or "off" will turn off reacting on open windows.</li>
|
|
<li>windowOpenDuration <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given window open duration to the device's memory. That is the duration the heater will temporarily set the window open temperature if an open window is detected by a rapid temperature decrease. (Not used if open window is detected by ShutterControl. Must be between 0 and 60 minutes in multiples of 5.</li>
|
|
<li>decalcification <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given decalcification time to the device's memory. Value must be of format "Sat 12:00" with minutes being "00". Once per week during that time, the HeatingThermostat will open the valves shortly for decalcification.</li>
|
|
<li>boostDuration <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given boost duration to the device's memory. Value must be one of 5, 10, 15, 20, 25, 30, 60. It is the duration of the boost function in minutes.</li>
|
|
<li>boostValveposition <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given boost valveposition to the device's memory. It is the valve position in percent during the boost function.</li>
|
|
<li>maxValveSetting <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given maximum valveposition to the device's memory. The heating thermostat will not open the valve more than this value (in percent).</li>
|
|
<li>valveOffset <value><br>
|
|
For devices of type HeatingThermostat only. Writes the given valve offset to the device's memory. The heating thermostat will add this to all computed valvepositions during control.</li>
|
|
<li>factoryReset<br>
|
|
Resets the device to factory values. It has to be paired again afterwards.<br>
|
|
ATTENTION: When using this on a ShutterContact using the MAXLAN backend, the ShutterContact has to be triggered once manually to complete
|
|
the factoryReset.</li>
|
|
<li>associate <value><br>
|
|
Associated one device to another. <value> can be the name of MAX device or its 6-digit hex address.<br>
|
|
Associating a ShutterContact to a {Heating,WallMounted}Thermostat makes it send message to that device to automatically lower temperature to windowOpenTemperature while the shutter is opened. The thermostat must be associated to the ShutterContact, too, to accept those messages.
|
|
Associating HeatingThermostat and WallMountedThermostat makes them sync their desiredTemperature and uses the measured temperature of the
|
|
WallMountedThermostat for control.</li>
|
|
<li>deassociate <value><br>
|
|
Removes the association set by associate.</li>
|
|
<li>fake <device> <parameters...><br>
|
|
Sends a fake state message of this device over the air to <device>. Works only with CUL_MAX as IODev. For ShutterContacts, sends
|
|
a ShutterContactState message; <parameters...> must be 0 or 1 for "window closed" or "window opened". For WallMountedThermostats.
|
|
sends a WallThermostatState message; <parameters...> must be "$desiredTemperature $measuredTemperature" (both may have one digit after the decimal point, for desiredTemperature it may only by 0 or 5). Make sure you associate the target device with the source device beforehand.</li>
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="MAXget"></a>
|
|
<b>Get</b> <ul>N/A</ul><br>
|
|
|
|
<a name="MAXattr"></a>
|
|
<b>Attributes</b>
|
|
<ul>
|
|
<li><a href="#eventMap">eventMap</a></li>
|
|
<li><a href="#IODev">IODev</a></li>
|
|
<li><a href="#loglevel">loglevel</a></li>
|
|
<li><a href="#do_not_notify">do_not_notify</a></li>
|
|
<li><a href="#ignore">ignore</a></li>
|
|
<li><a href="#readingFnAttributes">readingFnAttributes</a></li>
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="MAXevents"></a>
|
|
<b>Generated events:</b>
|
|
<ul>
|
|
<li>desiredTemperature<br>Only for HeatingThermostat and WallMountedThermostat</li>
|
|
<li>valveposition<br>Only for HeatingThermostat</li>
|
|
<li>battery</li>
|
|
<li>temperature<br>The measured(!) temperature, only for HeatingThermostat and WallMountedThermostat</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
=end html
|
|
=cut
|