#############################################
# $Id$
#
# This file is part of fhem.
#
# Fhem is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
# Fhem is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with fhem. If not, see .
#
##############################################
package main;
use strict;
use warnings;
use Blocking;
use Color;
use vars qw($FW_CSRF);
my $hs;
sub DOIF_cmd ($$$$);
sub DOIF_Notify ($$);
sub DOIF_delTimer($)
{
my ($hash) = @_;
RemoveInternalTimer($hash);
foreach my $key (keys %{$hash->{triggertime}}) {
RemoveInternalTimer (\$hash->{triggertime}{$key});
}
foreach my $key (keys %{$hash->{ptimer}}) {
RemoveInternalTimer (\$hash->{ptimer}{$key});
}
}
sub DOIF_killBlocking($)
{
my ($hash) = @_;
foreach my $key (keys %{$hash->{var}{blockingcalls}}) {
BlockingKill($hash->{var}{blockingcalls}{$key}) if(defined($hash->{var}{blockingcalls}{$key}));
}
}
sub DOIF_delAll($)
{
my ($hash) = @_;
DOIF_killBlocking($hash);
delete ($hash->{helper});
delete ($hash->{condition});
delete ($hash->{do});
#delete ($hash->{devices});
delete ($hash->{time});
delete ($hash->{timer});
delete ($hash->{timers});
delete ($hash->{itimer});
delete ($hash->{timeCond});
delete ($hash->{realtime});
delete ($hash->{localtime});
delete ($hash->{days});
delete ($hash->{readings});
delete ($hash->{internals});
delete ($hash->{trigger});
delete ($hash->{triggertime});
delete ($hash->{ptimer});
delete ($hash->{interval});
delete ($hash->{intervaltimer});
delete ($hash->{intervalfunc});
delete ($hash->{perlblock});
delete ($hash->{var});
delete ($hash->{accu});
delete ($hash->{Regex});
#foreach my $key (keys %{$hash->{Regex}}) {
# delete $hash->{Regex}{$key} if ($key !~ "STATE|DOIF_Readings|uiTable");
#}
my $readings = ($hash->{MODEL} eq "Perl") ? "^(Device|error|warning|cmd|e_|timer_|wait_|matched_|last_cmd|mode|block_)":"^(Device|state|error|warning|cmd|e_|timer_|wait_|matched_|last_cmd|mode|block_)";
foreach my $key (keys %{$defs{$hash->{NAME}}{READINGS}}) {
delete $defs{$hash->{NAME}}{READINGS}{$key} if ($key =~ $readings);
}
}
sub DOIF_Initialize($)
{
my ($hash) = @_;
$hash->{DefFn} = "DOIF_Define";
$hash->{SetFn} = "DOIF_Set";
$hash->{GetFn} = "DOIF_Get";
$hash->{UndefFn} = "DOIF_Undef";
$hash->{ShutdownFn} = "DOIF_Shutdown";
$hash->{AttrFn} = "DOIF_Attr";
$hash->{NotifyFn} = "DOIF_Notify";
$hash->{FW_deviceOverview} = 1;
$hash->{FW_addDetailToSummary} = 1;
$hash->{FW_detailFn} = "DOIF_detailFn";
$hash->{FW_summaryFn} = "DOIF_summaryFn";
#$hash->{FW_atPageEnd} = 1;
$data{FWEXT}{DOIF}{SCRIPT} = "doif.js";
$hash->{AttrList} = "disable:0,1 loglevel:0,1,2,3,4,5,6 wait:textField-long do:always,resetwait cmdState startup:textField-long state:textField-long initialize repeatsame repeatcmd waitsame waitdel cmdpause timerWithWait:1,0 notexist selftrigger:wait,all timerevent:1,0 checkReadingEvent:0,1 addStateEvent:1,0 checkall:event,timer,all weekdays setList:textField-long readingList DOIF_Readings:textField-long event_Readings:textField-long uiTable:textField-long ".$readingFnAttributes;
}
# uiTable
sub DOIF_reloadFW {
map { FW_directNotify("#FHEMWEB:$_", "location.reload()", "") } devspec2array("TYPE=FHEMWEB");
}
sub DOIF_hsv
{
my ($cur,$min,$max,$min_s,$max_s,$s,$v)=@_;
$s=100 if (!defined ($s));
$v=100 if (!defined ($v));
my $m=($max_s-$min_s)/($max-$min);
my $n=$min_s-$min*$m;
if ($cur>$max) {
$cur=$max;
} elsif ($cur<$min) {
$cur=$min;
}
my $h=$cur*$m+$n;
$h /=360;
$s /=100;
$v /=100;
my($r,$g,$b)=Color::hsv2rgb ($h,$s,$v);
$r *= 255;
$g *= 255;
$b *= 255;
return sprintf("#%02X%02X%02X", $r+0.5, $g+0.5, $b+0.5);
}
sub DOIF_rgb {
my ($sc,$ec,$pct,$max,$cur) = @_;
$cur = ($cur =~ /(-?\d+(\.\d+)?)/ ? $1 : 0);
$pct = ($cur-$pct)/($max-$pct) if (@_ == 5);
my $prefix = "";
$prefix = "#" if ("$sc $ec"=~"#");
$sc =~ s/^#//;
$ec =~ s/^#//;
$pct = $pct > 1 ? 1 : $pct;
$pct = $pct < 0 ? 0 : $pct;
$sc =~/([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})/;
my @sc = (hex($1),hex($2),hex($3));
$ec =~/([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})/;
my @ec = (hex($1),hex($2),hex($3));
my @rgb;
for (0..2) {
$rgb[$_] = sprintf("%02X", int(($ec[$_] - $sc[$_])*$pct + $sc[$_] + .5));
}
return $prefix.join("",@rgb);
}
#sub DOIF_Icon {
# my ($dev, $reading, $icon, $cmd, $type) = @_;
# my $val = ReadingsVal($dev,$reading,"???");
# $type= $reading eq 'state' ? 'set' : 'setreading' if (!defined $type);
# my $ret = FW_makeImage($icon,$cmd,"icon");
# $ret = FW_pH "cmd.$dev=$type $dev $reading $cmd", $ret, 0, "webCmd", 1;
# return "$ret";
#}
sub DOIF_UpdateCell
{
my ($hash,$doifId,$dev,$reading) =@_;
my $pn = $hash->{NAME};
my $retVal="";
my $retStyle="";
my $reg="";
my $VALUE="";
if ($doifId =~ /.*_(.*)_c_(.*)_(.*)_(.*)_(.*)$/) {
my $command=$hash->{$1}{table}{$2}{$3}{$4}{$5};
eval ($command);
if ($@) {
my $err="$pn: eval: $command error: $@" ;
Log3 $pn,3,$err;
}
}
}
sub DOIF_Widget
{
my ($hash,$reg,$doifId,$value,$style,$widget,$command,$dev,$reading)=@_;
if ($reg) {
return DOIF_Widget_Register($doifId,$value,$style,$widget,$dev,$reading,$command);
} else {
DOIF_Widget_Update($hash->{NAME},$doifId,$value,$style,$widget,$command,$dev,$reading);
}
}
sub DOIF_Widget_Update
{
my ($pn,$doifId,$value,$style,$widget,$command,$dev,$reading)=@_;
if (defined $widget and $widget ne "") {
map {
FW_directNotify("#FHEMWEB:$_", "doifUpdateCell('$pn','informid','$dev-$reading','$value')","");
} devspec2array("TYPE=FHEMWEB");
} else {
map {
FW_directNotify("#FHEMWEB:$_", "doifUpdateCell('$pn','doifId','$doifId','$value','display:inline;$style')","");
} devspec2array("TYPE=FHEMWEB") if ($value ne "");
}
}
sub DOIF_Widget_Register
{
my ($doifId,$value,$style,$widget,$dev,$reading,$command)=@_;
my $type;
my $cmd='';
if (defined $widget and $widget ne "") {
if (defined $command and $command ne "") {
if ($command =~ /^([^ ]*) *(.*)/) {
$type = !defined $1 ? '': $1;
$cmd = !defined $2 ? '': $2;
} else {
$type=$command;
}
} else {
$type= $reading eq 'state' ? 'set' : 'setreading';
}
$cmd = $cmd eq '' ? $reading : $cmd;
return "
";
} else {
return "$value
";
}
}
sub DOIF_RegisterCell
{
my ($hash,$table,$func,$r,$c,$cc,$cr) =@_;
my $event;
my $err;
my $dev="";
my $reading="";
my $value="";
my $expr;
my $style;
my $widget;
my $command;
my $cell;
my $widsty=0;
my $trigger=0;
if ($func=~ /^\s*(STY[ \t]*\(|WID[ \t]*\()/) {
my ($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($func,'[\(\)]');
if ($err) {
return $err;
} elsif ($currentBlock ne "") {
$cell=$currentBlock;
}
} else {
$cell=$func;
}
my $doifId="$hash->{NAME}_".$table."_c_".$r."_".$c."_".$cc."_".$cr;
if ($func=~ /^\s*STY[ \t]*\(/) {
$widsty=1;
($expr,$style) = SplitDoIf(',',$cell);
} elsif ($func=~ /^\s*WID[ \t]*\(/) {
$widsty=2;
($expr,$widget,$command) = SplitDoIf(',',$cell);
} else {
$expr=$cell;
}
($expr,$err,$event)=ReplaceAllReadingsDoIf($hash,$expr,($table eq "uiTable" ? -5:-6),0,$doifId);
if ($err) {
$err="'error $err: in expression: $expr'";
return $err;
} else {
my ($exp,$sty,$wid,$com)=eval ($hash->{$table}{package}.$expr);
if ($@) {
return "'error $@ in expression: $expr'";
}
if (defined $sty and $sty eq "" and defined $wid and $wid ne "") {
if ($event) {
$dev=$hash->{$table}{dev} if (defined $hash->{$table}{dev});
$reading=$hash->{$table}{reading} if (defined $hash->{$table}{reading});
} else {
return "'no trigger reading in widget: $expr'";
}
$reading="state" if ($reading eq '&STATE');
return "$hash->{$table}{package}::DOIF_Widget(".'$hash,$reg,'."'$doifId',$expr,".(defined $com ? "":"'',")."'$dev','$reading')";
} elsif (defined $sty) {
$widsty=3;
}
}
$trigger=$event;
if (defined $widget and $widget ne "") {
if ($event) {
$dev=$hash->{$table}{dev} if (defined $hash->{$table}{dev});
$reading=$hash->{$table}{reading} if (defined $hash->{$table}{reading});
} else {
return "'no trigger reading in widget: $expr'";
}
($widget,$err,$event)=ReplaceAllReadingsDoIf($hash,$widget,($table eq "uiTable" ? -5:-6),0,$doifId);
$trigger=$event if ($event);
if ($err) {
$err="'error $err: in widget: $widget'";
return $err;
} else {
eval ($widget);
if ($@) {
return "'error $@ in widget: $widget'";
}
}
} else {
$widget="";
}
if ($style) {
($style,$err,$event)=ReplaceAllReadingsDoIf($hash,$style,($table eq "uiTable" ? -5:-6),0,$doifId);
$trigger=$event if ($event);
if ($err) {
$err="'error $err: in style: $style'";
return $err;
} else {
eval $style;
if ($@) {
return "'error $@ in style: $style'";
}
}
} else {
$style='""';
}
if ($widsty==2) {
$reading="state" if ($reading eq '&STATE');
return "$hash->{$table}{package}::DOIF_Widget(".'$hash,$reg,'."'$doifId',$expr,$style,$widget,".(defined $command ? "$command":"''").",'$dev','$reading')";
} elsif ($widsty==3) {
return "$hash->{$table}{package}::DOIF_Widget(".'$hash,$reg,'."'$doifId',$expr)";
} elsif (($widsty==1) or $trigger) {
return "$hash->{$table}{package}::DOIF_Widget(".'$hash,$reg,'."'$doifId',$expr,$style)";
} else {
return ("$hash->{$table}{package}".$expr);
}
return ""
}
sub parse_tpl
{
my ($hash,$wcmd,$table) = @_;
my $d=$hash->{NAME};
my $err="";
## while ($wcmd =~ /(?:^|\n)\s*IMPORT\s*(.*)(\n|$)/g) {
while ($wcmd =~ /\s*IMPORT\s*(.*)(\n|$)/g) {
$err=import_tpl($hash,$1,$table);
return ($err,"") if ($err);
}
#$wcmd =~ s/(^|\n)\s*\#.*(\n|$)/\n/g;
#$wcmd =~ s/(#.*\n)|(#.*$)|\n/ /g;
$wcmd =~ s/(##.*\n)|(##.*$)/\n/g;
##$wcmd =~ s/(^|\n)\s*IMPORT.*(\n|$)//g;
$wcmd =~ s/\s*IMPORT.*(\n|$)//g;
$wcmd =~ s/\$TPL\{/\$hash->\{$table\}\{template\}\{/g;
#$wcmd =~ s/\$TD{/\$hash->{$table}{td}{/g;
#$wcmd =~ s/\$TC{/\$hash->{$table}{tc}{/g;
$wcmd =~ s/\$ATTRIBUTESFIRST/\$hash->{$table}{attributesfirst}/;
$wcmd =~ s/\$TC\{/\$hash->{$table}{tc}\{/g;
$wcmd =~ s/\$hash->\{$table\}\{tc\}\{([\d,.]*)?\}.*(\".*\")/for my \$i ($1) \{\$hash->\{$table\}\{tc\}\{\$i\} = $2\}/g;
$wcmd =~ s/\$TR\{/\$hash->{$table}{tr}\{/g;
$wcmd =~ s/\$hash->\{$table\}\{tr\}\{([\d,.]*)?\}.*(\".*\")/for my \$i ($1) \{\$hash->\{$table\}\{tr\}\{\$i\} = $2\}/g;
$wcmd =~ s/\$TD\{(.*)?\}\{(.*)?\}.*(\".*\")/for my \$rowi ($1) \{for my \$coli ($2) \{\$hash->\{$table\}\{td\}\{\$rowi\}\{\$coli\} = $3\}\}/g;
$wcmd =~ s/\$TABLE/\$hash->{$table}{tablestyle}/;
$wcmd =~ s/\$VAR/\$hash->{var}/g;
$wcmd =~ s/\$_(\w+)/\$hash->\{var\}\{$1\}/g;
$wcmd =~ s/\$SELF/$d/g;
$wcmd =~ s/FUNC_/::DOIF_FUNC_$d\_/g;
$wcmd =~ s/PUP[ \t]*\(/::DOIF_tablePopUp(\"$d\",/g;
$wcmd =~ s/\$SHOWNOSTATE/\$hash->{$table}{shownostate}/;
$wcmd =~ s/\$SHOWNODEVICELINK/\$hash->{$table}{shownodevicelink}/;
$wcmd =~ s/\$SHOWNODEVICELINE/\$hash->{$table}{shownodeviceline}/;
$hash->{$table}{package} = "" if (!defined ($hash->{$table}{package}));
if ($wcmd=~ /^\s*\{/) { # perl block
my ($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($wcmd,'[\{\}]');
if ($err) {
return ("error in $table: $err","");
} elsif ($currentBlock ne "") {
$currentBlock ="no warnings 'redefine';".$currentBlock;
if ($currentBlock =~ /\s*package\s*(\w*)/) {
$hash->{$table}{package}="package $1;";
}
eval ($currentBlock);
if ($@) {
$err="$d: error: $@ in $table: $currentBlock";
return ($err,"");
}
$wcmd=$tailBlock;
}
}
($err,$wcmd)=DOIF_uiTable_FOR($hash,$wcmd,$table);
if ($err) {
return($err,"");
}
$wcmd =~ s/^\s*//;
$wcmd =~ s/[ \t]*\n/\n/g;
$wcmd =~ s/,[ \t]*[\n]+/,/g;
$wcmd =~ s/\.[ \t]*[\n]+/\./g;
$wcmd =~ s/\|[ \t]*[\n]+/\|/g;
$wcmd =~ s/>[ \t]*[\n]+/>/g;
my $tail=$wcmd;
my $beginning;
my $currentBlock;
while($tail =~ /(?:^|\n)\s*DEF\s*(TPL_[^ ^\t^\(]*)[^\(]*\(/g) {
($beginning,$currentBlock,$err,$tail)=GetBlockDoIf($tail,'[\(\)]');
if ($err) {
return ("error in $table: $err","");
} elsif ($currentBlock ne "") {
$hash->{$table}{tpl}{$1}=$currentBlock;
}
}
return ("",$tail);
}
sub import_tpl
{
my ($hash,$file,$table) = @_;
my $fh;
my $err;
if(!open($fh, $file)) {
return "Can't open $file: $!";
}
my @tpl=<$fh>;
close $fh;
my $wcmd=join("",@tpl);
($err,$wcmd)=parse_tpl($hash,$wcmd,$table);
return $err if ($err);
return "";
}
sub DOIF_uiTable_FOR
{
my ($hash,$wcmd,$table)=@_;
my $err="";
my $tail=$wcmd;
my $beginning;
my $currentBlock;
my $output="";
while ($tail ne "") {
if ($tail =~ /FOR/g) {
my $prefix=substr($tail,0,pos($tail));
my $begin=substr($tail,0,pos($tail)-3);
$tail=substr($tail,pos($tail)-3);
if ($tail =~ /^FOR\s*\(/) {
($beginning,$currentBlock,$err,$tail)=GetBlockDoIf($tail,'[\(\)]');
if ($err) {
return ("error in $table: $err $currentBlock","");
} elsif ($currentBlock ne "") {
my ($array,$command) = SplitDoIf(',',$currentBlock);
my $commandoutput="";
for (eval($array)) {
my $temp=$command;
$temp =~ s/\$_/$_/g;
$commandoutput.=$temp."\n";
}
$output.=($begin.$commandoutput);
}
} else {
$tail=substr($tail,3);
$output.=$prefix;
}
} else {
$output.=$tail;
$tail="";
}
}
return ("",$output);
}
sub DOIF_uiTable_def
{
my ($hash,$wcmd,$table) = @_;
return undef if (!$wcmd);
my $err="";
delete ($hash->{Regex}{$table});
delete ($hash->{$table});
($err,$wcmd)=parse_tpl($hash,$wcmd,$table);
return $err if ($err);
my $beginning;
my $currentBlock;
my $output="";
#$wcmd=DOIF_uiTable_FOR($wcmd,$table);
my $tail=$wcmd;
while ($tail ne "") {
if ($tail =~ /TPL_/g) {
my $prefix=substr($tail,0,pos($tail));
my $begin=substr($tail,0,pos($tail)-4);
$tail=substr($tail,pos($tail)-4);
if ($tail =~ /^(TPL_\w*)\s*\(/) {
my $template=$1;
if (defined $hash->{$table}{tpl}{$template}) {
my $templ=$hash->{$table}{tpl}{$template};
($beginning,$currentBlock,$err,$tail)=GetBlockDoIf($tail,'[\(\)]');
if ($err) {
return "error in $table: $err";
} elsif ($currentBlock ne "") {
my @param = SplitDoIf(',',$currentBlock);
for (my $j=0;$j<@param;$j++) {
my $p=$j+1;
$templ =~ s/\$$p/$param[$j]/g;
}
}
$output.=($begin.$templ);
} else {
return ("no Template $template defined");
}
} else {
$tail=substr($tail,4);
$output.=$prefix;
}
} else {
$output.=$tail;
$tail="";
}
}
$wcmd=$output;
my @rcmd = split(/\n/,$wcmd);
my $ii=0;
for (my $i=0; $i<@rcmd; $i++) {
next if ($rcmd[$i] =~ /^\s*$/);
my @ccmd = SplitDoIf('|',$rcmd[$i]);
for (my $k=0;$k<@ccmd;$k++) {
my @cccmd = SplitDoIf(',',$ccmd[$k]);
for (my $l=0;$l<@cccmd;$l++) {
my @crcmd = SplitDoIf('.',$cccmd[$l]);
for (my $m=0;$m<@crcmd;$m++) {
$hash->{$table}{table}{$ii}{$k}{$l}{$m}= DOIF_RegisterCell($hash,$table,$crcmd[$m],$ii,$k,$l,$m);
}
}
}
$ii++;
}
return undef;
##$hash->{$table}{tabledef}=DOIF_RegisterEvalAll($hash);
}
sub DOIF_RegisterEvalAll
{
my ($hash,$d,$table) = @_;
my $ret = "";
my $reg=1;
return undef if (!defined $hash->{$table}{table});
#$ret =~ s/class\=\'block\'/$hash->{$table}{table}/ if($hash->{$table}{table});
if ($table eq "uiTable") {
$ret .= "\n";
#$ret .= "\n";
} else {
$ret .= "\n";
}
my $lasttr =scalar keys %{$hash->{$table}{table}};
for (my $i=0;$i < $lasttr;$i++){
my $class = ($i&1)?"class='odd'":"class='even'";
$ret .="{$table}{tr}{$i}) ? $hash->{$table}{tr}{$i}:"");
$ret .=" ".(($i&1) ? $hash->{$table}{tr}{odd}:"") if (defined $hash->{$table}{tr}{odd});
$ret .=" ".((!($i&1)) ? $hash->{$table}{tr}{even}:"") if (defined $hash->{$table}{tr}{even});
$ret .=" ".(($i==$lasttr-1) ? $hash->{$table}{tr}{last}:"") if (defined $hash->{$table}{tr}{last});
$ret .=" $class >";
my $lastc =scalar keys %{$hash->{$table}{table}{$i}};
for (my $k=0;$k < $lastc;$k++){
$ret .="{$table}{td}{$i}{$k}) ? $hash->{$table}{td}{$i}{$k}:"");
$ret .=" ".((defined $hash->{$table}{tc}{$k} )? $hash->{$table}{tc}{$k}:"");
$ret .=" ".(($k&1)?$hash->{$table}{tc}{odd}:"") if (defined $hash->{$table}{tc}{odd});
$ret .=" ".((!($k&1))?$hash->{$table}{tc}{even}:"") if (defined $hash->{$table}{tc}{even});
$ret .=" ".(($k==$lastc-1)?$hash->{$table}{tc}{last}:"") if (defined $hash->{$table}{tc}{last});
$ret .=">";
my $lastcc =scalar keys %{$hash->{$table}{table}{$i}{$k}};
for (my $l=0;$l < $lastcc;$l++){
for (my $m=0;$m < scalar keys %{$hash->{$table}{table}{$i}{$k}{$l}};$m++) {
if (defined $hash->{$table}{table}{$i}{$k}{$l}{$m}){
my $value= eval ($hash->{$table}{table}{$i}{$k}{$l}{$m});
if (defined ($value)) {
if (defined $defs{$value} and (!defined $hash->{$table}{shownodevicelink} or !$hash->{$table}{shownodevicelink})) {
$ret.="$value";
} else {
$ret.=$value;
}
}
}
}
$ret.=" " if ($l+1 != $lastcc);
}
$ret.=" | ";
}
$ret .= "
";
}
$ret .= "
\n"; # if ($table eq "uiTable");
#$hash->{$table}{deftable}=$ret;
return $ret;
}
sub DOIF_tablePopUp {
my ($pn,$d,$icon,$table) = @_;
$table = $table ? $table : "uiTable";
if ($defs{$d} && AttrVal($d,$table,"")) {
my $ret = "".FW_makeImage($icon)."";
} else {
return "no device $d or attribut $table";
}
}
sub DOIF_summaryFn ($$$$) {
my ($FW_wname, $d, $room, $pageHash) = @_; # pageHash is set for summaryFn.
my $hash = $defs{$d};
my $ret = "";
# if ($hash->{uiTable}{shownostate}) {
# return "";
# }
#Log3 $d,1,"vor DOIF_RegisterEvalAll uiState d: $d";
$ret=DOIF_RegisterEvalAll($hash,$d,"uiState");
#Log3 $d,1,"nach DOIF_RegisterEvalAll";
return $ret;
}
sub DOIF_detailFn ($$$$) {
my ($FW_wname, $d, $room, $pageHash) = @_; # pageHash is set for summaryFn.
my $hash = $defs{$d};
my $ret = "";
#Log3 $d,1,"vor DOIF_RegisterEvalAll uiTable";
$ret=DOIF_RegisterEvalAll($hash,$d,"uiTable");
#Log3 $d,1,"nach DOIF_RegisterEvalAll";
return $ret;
}
sub GetBlockDoIf ($$)
{
my ($cmd,$match) = @_;
my $count=0;
my $first_pos=0;
my $last_pos=0;
my $err="";
while($cmd =~ /$match/g) {
if (substr($cmd,pos($cmd)-1,1) eq substr($match,2,1)) {
$count++;
$first_pos=pos($cmd) if ($count == 1);
} elsif (substr($cmd,pos($cmd)-1,1) eq substr($match,4,1)) {
$count--;
}
if ($count < 0)
{
$err="right bracket without left bracket";
return ("",substr($cmd,pos($cmd)-1),$err,"");
}
if ($count == 0) {
$last_pos=pos($cmd);
last;
}
}
if ($count > 0) {
$err="no right bracket";
return ("",substr($cmd,$first_pos-1),$err);
}
if ($first_pos) {
return (substr($cmd,0,$first_pos-1),substr($cmd,$first_pos,$last_pos-$first_pos-1),"",substr($cmd,$last_pos));
} else {
return ($cmd,"","","");
}
}
sub GetCommandDoIf ($$)
{
my ($separator,$tailBlock) = @_;
my $char;
my $beginning;
my $currentBlock;
my $err;
my $cmd="";
while ($tailBlock=~ /^([^$separator^"^\[^\{^\(]*)/g) {
$char=substr($tailBlock,pos($tailBlock),1);
if ($char eq $separator) {
$cmd=$cmd.substr($tailBlock,0,pos($tailBlock));
$tailBlock=substr($tailBlock,pos($tailBlock)+1);
return($cmd,$tailBlock,"");
} elsif ($char eq '{') {
($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\{\}]');
return ($currentBlock,$tailBlock,$err) if ($err);
$cmd=$cmd.$beginning."{$currentBlock}";
} elsif ($char eq '(') {
($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\(\)]');
return ($currentBlock,$tailBlock,$err) if ($err);
$cmd=$cmd.$beginning."($currentBlock)";
} elsif ($char eq '[') {
($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\[\]]');
return ($currentBlock,$tailBlock,$err) if ($err);
$cmd=$cmd.$beginning."[$currentBlock]";
} elsif ($char eq '"') {
if ($tailBlock =~ /(^[^"]*"[^"]*")(.*)/) {
$cmd=$cmd.$1;
$tailBlock=$2;
}
}
}
if ($cmd eq "") {
$cmd=$tailBlock;
} else {
$cmd=$cmd.$tailBlock
}
return ($cmd,"","");
}
sub EvalValueDoIf($$$)
{
my ($hash,$attr,$value)=@_;
return "" if (!defined($value) or $value eq "");
my $err="";
my $pn=$hash->{NAME};
$value =~ s/\$SELF/$pn/g;
($value,$err)=ReplaceAllReadingsDoIf($hash,$value,-1,1);
if ($err) {
my $error="$pn: error in $attr: $err";
Log3 $pn,4 , $error;
readingsSingleUpdate ($hash, "error", $error,1);
$value=0;
} else {
my $ret = eval $value;
if ($@) {
my $error="$pn: error in $attr: $value";
Log3 $pn,4 , $error;
readingsSingleUpdate ($hash, "error", $error,1);
$value=0;
} else {
$value=$ret;
}
}
return ($value);
}
sub EvalCmdStateDoIf($$)
{
my ($hash,$state)=@_;
my $err;
my $pn=$hash->{NAME};
($state,$err)=ReplaceAllReadingsDoIf($hash,$state,-1,1);
if ($err) {
Log3 $pn,4 , "$pn: error in state: $err" if ($err);
$state=$err;
} else {
($state,$err)=EvalAllDoIf($hash, $state);
if ($err) {
Log3 $pn,4 , "$pn: error in state: $err" if ($err);
$state=$err;
}
}
return($state)
}
sub SplitDoIf($$)
{
my ($separator,$tailBlock)=@_;
my @commands;
my $cmd;
my $err;
if (defined $tailBlock) {
while ($tailBlock ne "") {
($cmd,$tailBlock,$err)=GetCommandDoIf($separator,$tailBlock);
push(@commands,$cmd) if (defined $cmd);
}
}
return(@commands);
}
sub EventCheckDoif($$$$)
{
my ($n,$dev,$eventa,$NotifyExp)=@_;
my $found=0;
my $s;
return 0 if ($dev ne $n);
return 0 if(!$eventa);
my $max = int(@{$eventa});
my $ret = 0;
if ($NotifyExp eq "") {
return 1 ;
}
for (my $i = 0; $i < $max; $i++) {
$s = $eventa->[$i];
$s = "" if(!defined($s));
$found = ($s =~ m/$NotifyExp/);
if ($found) {
return 1;
}
}
return 0;
}
sub AggrIntDoIf
{
my ($hash,$modeType,$device,$reading,$cond,$default)=@_;
my $num=0;
my $value="";
my $sum=0;
my $average;
my $extrem;
my $name;
my $devname;
my $err;
my $ret;
my $result;
my @devices;
my $group;
my $room;
my $STATE;
my $TYPE;
my $warning=0;
my $mode=substr($modeType,0,1);
my $type;
my $format;
my $place;
my $number;
my $readingRegex;
if ($modeType =~ /.(sum|average|max|min)?[:]?(?:(a|d)?(\d)?)?/) {
$type = (defined $1)? $1 : "";
$format= (defined $2)? $2 : "";
$place= $3;
}
if (defined $default) {
if ($default =~ /^"(.*)"$/) {
$default = $1;
} else {
$default=EvalValueDoIf($hash,"default",$default);
}
}
if (defined $reading) {
if ($reading =~ /^"(.*)"$/) {
$readingRegex = $1;
}
}
foreach my $name (($device eq "") ? keys %defs:grep {/$device/} keys %defs) {
next if($attr{$name} && $attr{$name}{ignore});
foreach my $reading ((defined $readingRegex) ? grep {/$readingRegex/} keys %{$defs{$name}{READINGS}} : $reading) {
$value="";
$number="";
if ($reading) {
if (defined $defs{$name}{READINGS}{$reading}) {
$value=$defs{$name}{READINGS}{$reading}{VAL};
$number = ($value =~ /(-?\d+(\.\d+)?)/ ? $1 : 0);
} else {
next;
}
}
if ($cond) {
if ($cond =~ /^"(.*)"$/) {
if (defined $defs{$name}{READINGS}{$reading}) {
$ret=($value =~ /$1/);
}
} else {
$_=$value;
$STATE=Value($name);
$TYPE=$defs{$name}{TYPE};
$group=AttrVal($name,"group","");
$room=AttrVal($name,"room","");
$lastWarningMsg="";
$ret = eval $cond;
if ($@) {
$@ =~ s/^(.*) at \(eval.*\)(.*)$/$1,$2/;
if (defined $hash) {
Log3 ($hash->{NAME},3 , "$hash->{NAME}: aggregate function: error in condition: $cond, $@");
}
return("error in aggregate function: ".$@);
}
if ($lastWarningMsg) {
$warning=1;
$lastWarningMsg =~ s/^(.*) at \(eval.*$/$1/;
Log3 ($hash->{NAME},3 , "$hash->{NAME}: aggregate function: warning in condition: $cond, Device: $name");
readingsSingleUpdate ($hash, "warning_aggr", "condition: $cond , device: $name, $lastWarningMsg",1);
}
$lastWarningMsg="";
}
} else {
$ret=1;
}
if ($format eq "a") {
$devname=AttrVal($name,"alias",$name);
} else {
$devname=$name;
}
if ($ret) {
if ($type eq ""){
$num++;
push (@devices,$devname);
} elsif (defined $value) {
if ($type eq "sum" or $type eq "average") {
$num++;
push (@devices,$devname);
$sum+=$number;
} elsif ($type eq "max") {
if (!defined $extrem or $number>$extrem) {
$extrem=$number;
@devices=($devname);
}
} elsif ($type eq "min") {
if (!defined $extrem or $number<$extrem) {
$extrem=$number;
@devices=($devname);
}
}
}
}
}
}
delete ($defs{$hash->{NAME}}{READINGS}{warning_aggr}) if (defined $hash and $warning==0);
if ($type eq "max" or $type eq "min") {
$extrem=0 if (!defined $extrem);
$result=$extrem;
} elsif ($type eq "sum") {
$result= $sum;
} elsif ($type eq "average") {
if ($num>0) {
$result=($sum/$num)
}
} else {
$result=$num;
}
if ($mode eq "#") {
if ($format eq "d") {
$result = ($result =~ /(-?\d+(\.\d+)?)/ ? $1 : 0);
$result = round ($result,$place) if (defined $place);
}
if ($num==0 and defined $default) {
return ($default);
} else {
return ($result);
}
} elsif ($mode eq "@") {
if ($num==0 and defined $default) {
@devices =($default);
}
return (sort @devices);
}
return 0;
}
sub AggrDoIf
{
my ($modeType,$device,$reading,$cond,$default)=@_;
return (AggrIntDoIf(undef,$modeType,$device,$reading,$cond,$default));
}
sub AggregateDoIf
{
my ($hash,$modeType,$device,$reading,$cond,$default)=@_;
my $mode=substr($modeType,0,1);
my $type=substr($modeType,1);
my $splittoken=",";
if ($modeType =~ /.(?:sum|average|max|min)?[:]?[^s]*(?:s\((.*)\))?/) {
$splittoken=$1 if (defined $1);
}
if ($mode eq "#") {
return (AggrIntDoIf($hash,$modeType,$device,$reading,$cond,$default));
} elsif ($mode eq "@") {
return (join ($splittoken,AggrIntDoIf($hash,$modeType,$device,$reading,$cond,$default)));
}
return ("");
}
sub EventDoIf
{
my ($n,$hash,$NotifyExp,$check,$filter,$output,$default)=@_;
my $dev=$hash->{helper}{triggerDev};
my $eventa=$hash->{helper}{triggerEvents};
if ($check) {
if ($dev eq "" or $dev ne $n) {
if (defined $filter) {
return ($default)
} else {
return 0;
}
}
} else {
if ($dev eq "" or $n and $dev !~ /$n/) {
if (defined $filter) {
return ($default)
} else {
return 0;
}
}
}
return 0 if(!$eventa);
my $max = int(@{$eventa});
my $ret = 0;
if ($NotifyExp eq "") {
return 1 if (!defined $filter);
}
my $s;
my $found;
my $element;
for (my $i = 0; $i < $max; $i++) {
$s = $eventa->[$i];
$s = "" if(!defined($s));
$found = ($s =~ m/$NotifyExp/);
if ($found or $NotifyExp eq "") {
$hash->{helper}{event}=$s;
if (defined $filter) {
$element = ($s =~ /$filter/) ? $1 : "";
if ($element) {
if ($output ne "") {
$element= eval $output;
if ($@) {
Log3 ($hash->{NAME},4 , "$hash->{NAME}: $@");
readingsSingleUpdate ($hash, "error", $@,1);
return(undef);
}
}
return ($element);
}
} else {
return 1;
}
}
#if(!$found && AttrVal($n, "eventMap", undef)) {
# my @res = ReplaceEventMap($n, [$n,$s], 0);
# shift @res;
# $s = join(" ", @res);
# $found = ("$n:$s" =~ m/^$re$/);
}
if (defined $filter) {
return ($default);
} else {
return 0;
}
}
sub InternalDoIf
{
my ($hash,$name,$internal,$default,$regExp,$output)=@_;
$default=AttrVal($hash->{NAME},'notexist','') if (!defined $default);
$regExp='' if (!defined $regExp);
$output='' if (!defined $output);
if ($default =~ /^"(.*)"$/) {
$default = $1;
} else {
$default=EvalValueDoIf($hash,"default",$default);
}
my $r="";
my $element;
return ($default) if (!defined $defs{$name});
return ($default) if (!defined $defs{$name}{$internal});
$r=$defs{$name}{$internal};
if ($regExp) {
$element = ($r =~ /$regExp/) ? $1 : "";
if ($output) {
$element= eval $output;
if ($@) {
Log3 ($hash->{NAME},4 , "$hash->{NAME}: $@");
readingsSingleUpdate ($hash, "error", $@,1);
return(undef);
}
}
} else {
$element=$r;
}
return($element);
}
sub ReadingSecDoIf($$)
{
my ($name,$reading)=@_;
my ($seconds, $microseconds) = gettimeofday();
return ($seconds - time_str2num(ReadingsTimestamp($name, $reading, "1970-01-01 01:00:00")));
}
sub ReadingValDoIf
{
my ($hash,$name,$reading,$default,$regExp,$output)=@_;
$default=AttrVal($hash->{NAME},'notexist','') if (!defined $default);
$output='' if (!defined $output);
$regExp='' if (!defined $regExp);
if ($default =~ /^"(.*)"$/) {
$default = $1;
} else {
$default=EvalValueDoIf($hash,"default",$default);
}
my $r;
my $element;
return ($default) if (!defined $defs{$name});
return ($default) if (!defined $defs{$name}{READINGS});
return ($default) if (!defined $defs{$name}{READINGS}{$reading});
$r=$defs{$name}{READINGS}{$reading}{VAL};
$r="" if (!defined($r));
if ($regExp) {
if ($regExp =~ /^(avg|med|diff|inc)(\d*)/) {
my @a=@{$hash->{accu}{"$name $reading"}{value}};
my $func=$1;
my $dim=$2;
$dim=2 if (!defined $dim or !$dim);
my $num=@a < $dim ? @a : $dim;
@a=splice (@a, -$num,$num);
if ($func eq "avg" or $func eq "med") {
return ($r) if (!@a);
} elsif ($func eq "diff" or $func eq "inc") {
return (0) if (@a <= 1);
}
if ($func eq "avg") {
my $sum=0;
foreach (@a) {
$sum += $_;
}
return ($sum/$num);
} elsif ($func eq "med") {
my @vals = sort{$a <=> $b} @a;
if ($num % 2) {
return $vals[int($num/2)] if ($num % 2)
} else {
return ($vals[int($num/2) - 1] + $vals[int($num/2)])/2;
}
} elsif ($func eq "diff") {
return (($a[-1]-$a[0]));
} elsif ($func eq "inc") {
if ($a[0] == 0) {
return(0);
} else {
return (($a[-1]-$a[0])/$a[0]);
}
}
} elsif ($regExp =~ /^d(\d)?/) {
my $round=$1;
$r = ($r =~ /(-?\d+(\.\d+)?)/ ? $1 : 0);
$r = round ($r,$round) if (defined $round);
$regExp="(.*)";
}
"" =~ /()()()()()()()()()/; #reset $1, $2...
$element = ($r =~ /$regExp/) ? $1 : "";
if ($output) {
$element= eval $output;
if ($@) {
Log3 ($hash->{NAME},4 , "$hash->{NAME}: $@");
readingsSingleUpdate ($hash, "error", $@,1);
return(undef);
}
}
} else {
$element=$r;
}
return($element);
}
sub accu_setValue
{
my ($hash,$name,$reading)=@_;
if (defined $hash->{accu}{"$name $reading"}) {
my @a=@{$hash->{accu}{"$name $reading"}{value}};
my $dim=$hash->{accu}{"$name $reading"}{dim};
shift (@a) if (@a >= $dim);
my $r=ReadingsVal($name,$reading,0);
$r = ($r =~ /(-?\d+(\.\d+)?)/ ? $1 : 0);
push (@a,$r);
@{$hash->{accu}{"$name $reading"}{value}}=@a;
}
}
sub EvalAllDoIf($$)
{
my ($hash,$tailBlock)= @_;
my $eval="";
my $beginning;
my $err;
my $cmd="";
my $ret="";
my $eventa=$hash->{helper}{triggerEvents};
my $device=$hash->{helper}{triggerDev};
my $event=$hash->{helper}{event};
my $events="";
if ($eventa) {
$events=join(",",@{$eventa});
}
while ($tailBlock ne "") {
($beginning,$eval,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\{\}]');
return ($eval,$err) if ($err);
if ($eval) {
if (substr($eval,0,1) eq "(") {
$eval=$1 if ($eval =~/^\((.*)\)$/);
my $ret = eval $eval;
return($eval." ",$@) if ($@);
$eval=$ret;
} else {
$eval="{".$eval."}";
}
}
$cmd.=$beginning.$eval;
}
return ($cmd,"");
}
sub ReplaceAggregateDoIf($$$)
{
my ($hash,$block,$eval) = @_;
my $exp;
my $nameExp;
my $notifyExp;
my $match;
my $reading;
my $aggrType;
my $default;
($block,$default)=SplitDoIf(",",$block);
if ($block =~ /^([^"]*)(.*)/) {
$aggrType=$1;
$block=$2;
}
($exp,$reading,$match)=SplitDoIf(":",$block);
if ($exp =~ /^"(.*)"/){
$exp=$1;
if ($exp =~ /([^\:]*):(.*)/) {
$nameExp=$1;
$notifyExp=$2;
} else {
$nameExp=$exp;
}
}
$nameExp="" if (!defined $nameExp);
$notifyExp="" if (!defined $notifyExp);
if (defined $default) {
$match="" if (!defined $match);
$block="::AggregateDoIf(".'$hash'.",'$aggrType','$nameExp','$reading','$match','$default')";
} elsif (defined $match) {
$block="::AggregateDoIf(".'$hash'.",'$aggrType','$nameExp','$reading','$match')";
} elsif (defined $reading) {
$block="::AggregateDoIf(".'$hash'.",'$aggrType','$nameExp','$reading')";
} else {
$block="::AggregateDoIf(".'$hash'.",'$aggrType','$nameExp')";
}
if ($eval) {
my $ret = eval $block;
return($block." ",$@) if ($@);
$block=$ret;
}
return ($block,undef);
}
sub ReplaceEventDoIf($)
{
my ($block) = @_;
my $exp;
my $exp2;
my $nameExp;
my $notifyExp;
my $default;
my $filter;
my $output;
($exp,$default)=SplitDoIf(",",$block);
($exp2,$filter,$output)=SplitDoIf(":",$exp);
if ($exp2 =~ /^"(.*)"/){
$exp2=$1;
if ($exp2 =~ /([^\:]*):(.*)/) {
$nameExp=$1;
$notifyExp=$2;
} else {
$nameExp=$exp2;
}
}
$nameExp="" if (!defined $nameExp);
$notifyExp="" if (!defined $notifyExp);
$output="" if (!defined $output);
if (defined $default) {
if ($default =~ /"(.*)"/) {
$default = $1;
}
if (defined $filter) {
if ($filter =~ /"(.*)"/) {
$filter=$1;
} else {
return ($filter,"wrong filter Regex")
}
} else {
$filter='[^\:]*: (.*)';
}
} else {
if (defined $filter) {
return ($block,"default value must be defined")
} else {
$block="::EventDoIf('$nameExp',".'$hash,'."'$notifyExp',0)";
return ($block,undef);
}
}
$block="::EventDoIf('$nameExp',".'$hash,'."'$notifyExp',0,'$filter','$output','$default')";
return ($block,undef);
}
sub ReplaceReadingDoIf($)
{
my ($element) = @_;
my $beginning;
my $tailBlock;
my $err;
my $regExp="";
my $name;
my $reading;
my $format;
my $output="";
my $exp;
my $default;
my $param="";
($exp,$default)=SplitDoIf(",",$element);
$default="" if (!defined($default));
my $internal="";
my $notifyExp="";
if ($exp =~ /^([^:]*):(".*")/) {
$name=$1;
$reading=$2;
} elsif ($exp =~ /^([^:]*)(?::([^:]*)(?::(.*))?)?/) {
$name=$1;
$reading=$2;
$format=$3;
}
if ($name) {
if ($reading) {
if (substr($reading,0,1) eq "\?") {
$notifyExp=substr($reading,1);
return("::EventDoIf('$name',".'$hash,'."'$notifyExp',1)","",$name,undef,undef);
} elsif ($reading =~ /^"(.*)"$/g) {
$notifyExp=$1;
return("::EventDoIf('$name',".'$hash,'."'$notifyExp',1)","",$name,undef,undef);
}
$internal = substr($reading,1) if (substr($reading,0,1) eq "\&");
if ($format) {
if ($format eq "sec") {
return("::ReadingSecDoIf('$name','$reading')","",$name,$reading,undef);
} elsif (substr($format,0,1) eq '[') { #old Syntax
($beginning,$regExp,$err,$tailBlock)=GetBlockDoIf($format,'[\[\]]');
return ($regExp,$err) if ($err);
return ($regExp,"no round brackets in regular expression") if ($regExp !~ /.*\(.*\)/);
} elsif ($format =~ /^"([^"]*)"(?::(.*))?/){
$regExp=$1;
$output=$2;
return ($regExp,"no round brackets in regular expression") if ($regExp !~ /.*\(.*\)/);
} elsif ($format =~ /^((avg|med|diff|inc)(\d*))/) {
AddRegexpTriggerDoIf($hs,"accu","","accu",$name,$reading);
$regExp =$1;
my $dim=$3;
$dim=2 if (!defined $dim or !$dim);
if (defined $hs->{accu}{"$name $reading"}{dim}) {
$hs->{accu}{"$name $reading"}{dim}=$hs->{accu}{"$name $reading"}{dim} < $dim ? $dim : $hs->{accu}{"$name $reading"}{dim};
} else {
$hs->{accu}{"$name $reading"}{dim}=$dim;
@{$hs->{accu}{"$name $reading"}{value}}=();
}
} elsif ($format =~ /^(d[^:]*)(?::(.*))?/) {
$regExp =$1;
$output=$2;
}else {
return($format,"unknown expression format");
}
}
$output="" if (!defined($output));
if ($output) {
$param=",'$default','$regExp','$output'";
} elsif ($regExp) {
$param=",'$default','$regExp'";
} elsif ($default) {
$param=",'$default'";
}
if ($internal) {
return("::InternalDoIf(".'$hash'.",'$name','$internal'".$param.")","",$name,undef,$internal);
} else {
return("::ReadingValDoIf(".'$hash'.",'$name','$reading'".$param.")","",$name,$reading,undef);
}
} else {
if ($default) {
$param=",'$default'";
}
return("::InternalDoIf(".'$hash'.",'$name','STATE'".$param.")","",$name,undef,'STATE');
}
}
}
sub ReplaceReadingEvalDoIf($$$)
{
my ($hash,$element,$eval) = @_;
my ($block,$err,$device,$reading,$internal)=ReplaceReadingDoIf($element);
return ($block,$err) if ($err);
if ($eval) {
# return ("[".$element."]","") if(!$defs{$device});
# return ("[".$element."]","") if (defined ($reading) and !defined($defs{$device}{READINGS}{$reading}));
# return ("[".$element."]","") if (defined ($internal) and !defined($defs{$device}{$internal}));
my $ret = eval $block;
return($block." ",$@) if ($@);
$block=$ret;
}
return ($block,"",$device,$reading,$internal);
}
sub AddItemDoIf($$)
{
my ($items,$item)=@_;
if (!$items) {
$items=" $item ";
} elsif ($items !~ / $item /) {
$items.="$item ";
}
return $items;
}
sub AddRegexpTriggerDoIf
{
my ($hash,$type,$regexp,$element,$dev,$reading)= @_;
$dev="" if (!defined($dev));
$reading="" if (!defined($reading));
my $regexpid='"'.$regexp.'"';
if ($dev) {
if ($reading){
$hash->{Regex}{$type}{$dev}{$element}{$reading}=(($reading =~ "^\&") ? "\^$dev\$":"\^$dev\$:\^$reading: ");
} elsif ($regexp) {
$hash->{Regex}{$type}{$dev}{$element}{$regexpid}="\^$dev\$:$regexp";
}
return;
}
$hash->{Regex}{$type}{$dev}{$element}{$regexpid}=$regexp;
}
sub addDOIF_Readings
{
my ($hash,$DOIF_Readings,$ReadingType) = @_;
delete $hash->{$ReadingType};
delete $hash->{Regex}{$ReadingType};
$DOIF_Readings =~ s/\n/ /g;
my @list=SplitDoIf(',',$DOIF_Readings);
my $reading;
my $readingdef;
for (my $i=0;$i<@list;$i++)
{
($reading,$readingdef)=SplitDoIf(":",$list[$i]);
if (!$readingdef) {
return ($DOIF_Readings,"no reading definiton: $list[$i]");
}
if ($reading =~ /^\s*([a-z0-9._-]*[a-z._-]+[a-z0-9._-]*)\s*$/i) {
my ($def,$err)=ReplaceAllReadingsDoIf($hash,$readingdef,($ReadingType eq "event_Readings" ? -7 : -4),0,$1);
return ($def,$err) if ($err);
$hash->{$ReadingType}{$1}=$def;
} else {
return ($list [$i],"wrong reading specification for: $reading");
}
}
return ("","");
}
sub setDOIF_Reading
{
my ($hash,$DOIF_Reading,$reading,$ReadingType,$eventa,$eventas,$dev) = @_;
$lastWarningMsg="";
$hash->{helper}{triggerEvents}=$eventa;
$hash->{helper}{triggerEventsState}=$eventas;
$hash->{helper}{triggerDev}=$dev;
$hash->{helper}{event}=join(",",@{$eventa}) if ($eventa);
my $ret = eval $hash->{$ReadingType}{$DOIF_Reading};
if ($@) {
$@ =~ s/^(.*) at \(eval.*\)(.*)$/$1,$2/;
$ret="error in $ReadingType: ".$@;
}
if ($lastWarningMsg) {
$lastWarningMsg =~ s/^(.*) at \(eval.*$/$1/;
Log3 ($hash->{NAME},3 , "$hash->{NAME}: warning in $ReadingType: $DOIF_Reading");
}
$lastWarningMsg="";
if ($ReadingType eq "event_Readings") {
readingsSingleUpdate ($hash,$DOIF_Reading,$ret,1);
} elsif ($ret ne ReadingsVal($hash->{NAME},$DOIF_Reading,"") or !defined $defs{$hash->{NAME}}{READINGS}{$DOIF_Reading}) {
push (@{$hash->{helper}{DOIF_Readings_events}},"$DOIF_Reading: $ret");
push (@{$hash->{helper}{DOIF_Readings_eventsState}},"$DOIF_Reading: $ret");
readingsSingleUpdate ($hash,$DOIF_Reading,$ret,0);
}
}
sub ReplaceAllReadingsDoIf
{
my ($hash,$tailBlock,$condition,$eval,$id)= @_;
my $block="";
my $beginning;
my $err;
my $cmd="";
my $ret="";
my $device="";
my $nr;
my $timer="";
my $event=0;
my $definition=$tailBlock;
my $reading;
my $internal;
my $trigger=1;
if (!defined $tailBlock) {
return ("","");
}
$tailBlock =~ s/\$SELF/$hash->{NAME}/g;
while ($tailBlock ne "") {
($beginning,$block,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\[\]]');
return ($block,$err) if ($err);
if ($block ne "") {
if (substr($block,0,1) eq "?") {
$block=substr($block,1);
$trigger=0;
} else {
$trigger=1;
}
if ($block =~ /^(?:(?:#|@)[^"]*)"([^"]*)"/) {
($block,$err)=ReplaceAggregateDoIf($hash,$block,$eval);
return ($block,$err) if ($err);
if ($trigger) {
$event=1;
if ($condition >= 0) {
AddRegexpTriggerDoIf($hash,"cond",$1,$condition);
} elsif ($condition == -2) {
AddRegexpTriggerDoIf($hash,"STATE",$1,"STATE");
} elsif ($condition == -4) {
AddRegexpTriggerDoIf($hash,"DOIF_Readings",$1,$id);
} elsif ($condition == -5) {
AddRegexpTriggerDoIf($hash,"uiTable",$1,$id);
} elsif ($condition == -6) {
AddRegexpTriggerDoIf($hash,"uiState",$1,$id);
} elsif ($condition == -7) {
AddRegexpTriggerDoIf($hash,"event_Readings",$1,$id);
}
}
} elsif ($block =~ /^"([^"]*)"/) {
($block,$err)=ReplaceEventDoIf($block);
return ($block,$err) if ($err);
if ($trigger) {
if ($condition>=0) {
AddRegexpTriggerDoIf($hash,"cond",$1,$condition);
$event=1;
} elsif ($condition == -4) {
AddRegexpTriggerDoIf($hash,"DOIF_Readings",$1,$id);
} elsif ($condition == -7) {
AddRegexpTriggerDoIf($hash,"event_Readings",$1,$id);
} else {
$block="[".$block."]";
}
} else {
$block="[".$block."]";
}
} else {
$trigger=0 if (substr($block,0,1) eq "\$");
if ($block =~ /^\$?[a-z0-9._]*[a-z._]+[a-z0-9._]*($|:.+$|,.+$)/i) {
($block,$err,$device,$reading,$internal)=ReplaceReadingEvalDoIf($hash,$block,$eval);
return ($block,$err) if ($err);
if ($condition >= 0) {
if ($trigger) {
#$hash->{devices}{$condition} = AddItemDoIf($hash->{devices}{$condition},$device);
#$hash->{devices}{all} = AddItemDoIf($hash->{devices}{all},$device);
AddRegexpTriggerDoIf($hash,"cond","",$condition,$device,((defined $reading) ? $reading :((defined $internal) ? ("&".$internal):"&STATE")));
$event=1;
}
#$hash->{readings}{$condition} = AddItemDoIf($hash->{readings}{$condition},"$device:$reading") if (defined ($reading) and $trigger);
#$hash->{internals}{$condition} = AddItemDoIf($hash->{internals}{$condition},"$device:$internal") if (defined ($internal));
$hash->{readings}{all} = AddItemDoIf($hash->{readings}{all},"$device:$reading") if (defined ($reading) and $trigger);
$hash->{internals}{all} = AddItemDoIf($hash->{internals}{all},"$device:$internal") if (defined ($internal));
$hash->{trigger}{all} = AddItemDoIf($hash->{trigger}{all},"$device") if (!defined ($internal) and !defined($reading));
} elsif ($condition == -2) {
if ($trigger) {
AddRegexpTriggerDoIf($hash,"STATE","","STATE",$device,((defined $reading) ? $reading :((defined $internal) ? ("&".$internal):"&STATE")));
$event=1;
}
} elsif ($condition == -3) {
AddRegexpTriggerDoIf($hash,"itimer","","itimer",$device,((defined $reading) ? $reading :((defined $internal) ? ("&".$internal):"&STATE")));
#$hash->{itimer}{all} = AddItemDoIf($hash->{itimer}{all},$device);
} elsif ($condition == -4) {
if ($trigger) {
AddRegexpTriggerDoIf($hash,"DOIF_Readings","",$id,$device,((defined $reading) ? $reading :((defined $internal) ? ("&".$internal):"&STATE")));
$event=1;
}
} elsif ($condition == -5) {
if ($trigger) {
AddRegexpTriggerDoIf($hash,"uiTable","",$id,$device,((defined $reading) ? $reading :((defined $internal) ? ("&".$internal):"&STATE")));
$hash->{uiTable}{dev}=$device;
$hash->{uiTable}{reading}=((defined $reading) ? $reading :((defined $internal) ? ("&".$internal):"&STATE"));
$event=1;
}
} elsif ($condition == -6) {
if ($trigger) {
AddRegexpTriggerDoIf($hash,"uiState","",$id,$device,((defined $reading) ? $reading :((defined $internal) ? ("&".$internal):"&STATE")));
$hash->{uiState}{dev}=$device;
$hash->{uiState}{reading}=((defined $reading) ? $reading :((defined $internal) ? ("&".$internal):"&STATE"));
$event=1;
}
} elsif ($condition == -7) {
if ($trigger) {
AddRegexpTriggerDoIf($hash,"event_Readings","",$id,$device,((defined $reading) ? $reading :((defined $internal) ? ("&".$internal):"&STATE")));
$event=1;
}
}
} elsif ($condition >= 0) {
($timer,$err)=DOIF_CheckTimers($hash,$block,$condition,$trigger);
if ($err eq "no timer") {
$block="[".$block."]";
} else {
return($timer,$err) if ($err);
if ($timer) {
$block=$timer;
$event=1 if ($trigger);
}
}
} else {
$block="[".$block."]";
}
}
}
$cmd.=$beginning.$block;
}
#return ($definition,"no trigger in condition") if ($condition >=0 and $event == 0);
return ($cmd,"",$event);
}
sub
ParseCommandsDoIf($$$)
{
my($hash,$tailBlock,$eval) = @_;
my $pn=$hash->{NAME};
my $currentBlock="";
my $beginning="";
my $err="";
my $pos=0;
my $last_error="";
my $ifcmd;
my $ret;
my $eventa=$hash->{helper}{triggerEvents};
my $device=$hash->{helper}{triggerDev};
my $event=$hash->{helper}{event};
my $events="";
if ($eventa) {
$events=join(",",@{$eventa});
}
while ($tailBlock ne "") {
if ($tailBlock=~ /^\s*\{/) { # perl block
($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\{\}]');
return ($currentBlock,$err) if ($err);
if ($currentBlock ne "") {
($currentBlock,$err)=ReplaceAllReadingsDoIf($hash,$currentBlock,-1,$eval);
return ($currentBlock,$err) if ($err);
if ($eval) {
($currentBlock,$err)=EvalAllDoIf($hash,$currentBlock);
return ($currentBlock,$err) if ($err);
}
}
$currentBlock="{".$currentBlock."}";
} elsif ($tailBlock =~ /^\s*IF/) {
my $ifcmd="";
($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\(\)]'); #condition
return ($currentBlock,$err) if ($err);
$ifcmd.=$beginning."(".$currentBlock.")";
($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\(\)]'); #if case
return ($currentBlock,$err) if ($err);
$ifcmd.=$beginning."(".$currentBlock.")";
if ($tailBlock =~ /^\s*ELSE/) {
($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\(\)]'); #else case
return ($currentBlock,$err) if ($err);
$ifcmd.=$beginning."(".$currentBlock.")";
}
$currentBlock=$ifcmd;
} else {
if ($tailBlock =~ /^\s*\(/) { # remove bracket
($beginning,$currentBlock,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\(\)]');
return ($currentBlock,$err) if ($err);
#$tailBlock=substr($tailBlock,pos($tailBlock)) if ($tailBlock =~ /^\s*,/g);
} else {
($currentBlock,$tailBlock)=GetCommandDoIf(',',$tailBlock);
}
if ($currentBlock ne "") {
($currentBlock,$err)=ReplaceAllReadingsDoIf($hash,$currentBlock,-1,$eval);
return ($currentBlock,$err) if ($err);
if ($eval) {
($currentBlock,$err)=EvalAllDoIf($hash, $currentBlock);
return ($currentBlock,$err) if ($err);
}
}
}
if ($eval) {
if ($currentBlock =~ /^{.*}$/) {
$ret = AnalyzePerlCommand(undef,$currentBlock);
} else {
$ret = AnalyzeCommandChain(undef,$currentBlock);
}
if ($ret) {
Log3 $pn,2 , "$pn: $currentBlock: $ret";
$last_error.="$currentBlock: $ret ";
}
}
$tailBlock=substr($tailBlock,pos($tailBlock)) if ($tailBlock =~ /^\s*,/g);
}
return("",$last_error);
}
sub DOIF_weekdays($$)
{
my ($hash,$weekdays)=@_;
my @days=split(',',AttrVal($hash->{NAME},"weekdays","So|Su,Mo,Di|Tu,Mi|We,Do|Th,Fr,Sa,WE,AT|WD,MWE|TWE"));
for (my $i=@days-1;$i>=0;$i--)
{
$weekdays =~ s/$days[$i]/$i/;
}
return($weekdays);
}
sub
DOIF_CheckTimers($$$$)
{
my ($hash,$timer,$condition,$trigger)=@_;
my $i=0;
my $days;
my $err;
my $time;
my $block;
my $result;
my $end;
my $intervaltimer;
$timer =~ s/\s//g;
($timer,$days)=SplitDoIf('|',$timer);
$days="" if (!defined $days);
($timer,$intervaltimer)=SplitDoIf(',',$timer);
($time,$end)=SplitDoIf('-',$timer);
if (defined $intervaltimer) {
if (!defined $end) {
return($timer,"intervaltimer without time interval");
}
}
$i=$hash->{helper}{last_timer}++;
if (defined $time) {
if ($time !~ /^\s*(\[.*\]|\{.*\}|\(.*\)|\+.*|[0-9][0-9]:.*|:[0-5][0-9])$/ and $hash->{MODEL} eq "Perl") {
return ($timer,"no timer");
}
($result,$err) = DOIF_getTime($hash,$condition,$time,$trigger,$i,$days);
return ($result,$err) if ($err);
} else {
return($timer,"no timer defined");
}
if (defined $end) {
if ($end !~ /^\s*(\[.*\]|\{.*\}|\(.*\)|\+.*|[0-9][0-9]:.*|:[0-5][0-9])$/ and $hash->{MODEL} eq "Perl") {
return ($timer,"no timer");
}
($result,$err) = DOIF_getTime($hash,$condition,$end,$trigger,$hash->{helper}{last_timer}++,$days);
return ($result,$err) if ($err);
}
if (defined $intervaltimer) {
($result,$err) = DOIF_getTime($hash,$condition,$intervaltimer,$trigger,$hash->{helper}{last_timer}++,$days);
return ($result,$err) if ($err);
}
if (defined $end) {
if ($days eq "") {
$block='::DOIF_time($hash,'.$i.','.($i+1).',$wday,$hms)';
} else {
$block='::DOIF_time($hash,'.$i.','.($i+1).',$wday,$hms,"'.$days.'")';
}
$hash->{interval}{$i}=-1;
$hash->{interval}{($i+1)}=$i;
if (defined ($intervaltimer)) {
$hash->{intervaltimer}{$i}=($i+2);
$hash->{intervaltimer}{($i+1)}=($i+2);
$hash->{intervalfunc}{($i+2)}=$block;
}
} else {
if ($days eq "") {
$block='::DOIF_time_once($hash,'.$i.',$wday)';
} else {
$block='::DOIF_time_once($hash,'.$i.',$wday,"'.$days.'")';
}
}
if ($init_done) {
DOIF_SetTimer ($hash,"DOIF_TimerTrigger",$i);
DOIF_SetTimer ($hash,"DOIF_TimerTrigger",($i+1)) if (defined $end);
DOIF_SetTimer ($hash,"DOIF_TimerTrigger",($i+2)) if (defined $intervaltimer);
}
return ($block,"");
}
sub DOIF_getTime {
my ($hash,$condition,$time,$trigger,$nr,$days)=@_;
my ($result,$err)=ReplaceAllReadingsDoIf($hash,$time,-3,0);
return ($time,$err) if ($err);
$time .=":00" if ($time =~ m/^[0-9][0-9]:[0-5][0-9]$/);
$hash->{timer}{$nr}=0;
$hash->{time}{$nr}=$time;
$hash->{timeCond}{$nr}=$condition;
$hash->{days}{$nr}=$days if ($days);
$hash->{timers}{$condition}.=" $nr " if ($trigger);
}
sub DOIF_time {
my $ret=0;
my ($hash,$b,$e,$wday,$hms,$days)=@_;
$days="" if (!defined ($days));
return 0 if (!defined $hash->{realtime}{$b});
return 0 if (!defined $hash->{realtime}{$e});
my $begin=$hash->{realtime}{$b};
my $end=$hash->{realtime}{$e};
my $err;
return 0 if ($begin eq $end);
($days,$err)=ReplaceAllReadingsDoIf($hash,$days,-1,1);
if ($err) {
my $errmsg="error in days: $err";
Log3 ($hash->{NAME},4 , "$hash->{NAME}: $errmsg");
readingsSingleUpdate ($hash, "error", $errmsg,1);
return 0;
}
$days=DOIF_weekdays($hash,$days);
my $we=DOIF_we($wday);
my $twe=DOIF_tomorrow_we($wday);
if ($end gt $begin) {
if ($hms ge $begin and $hms lt $end) {
$ret=1;
}
} else {
if ($hms ge $begin) {
$ret=1;
} elsif ($hms lt $end) {
$wday=6 if ($wday-- == 0);
$we=DOIF_we($wday);
$ret=1;
}
}
if ($ret == 1) {
return 1 if ($days eq "" or $days =~ /$wday/ or ($days =~ /7/ and $we) or ($days =~ /8/ and !$we) or ($days =~ /9/ and $twe));
}
return 0;
}
sub DOIF_time_once {
my ($hash,$nr,$wday,$days)=@_;
$days="" if (!defined ($days));
my $flag=$hash->{timer}{$nr};
my $err;
($days,$err)=ReplaceAllReadingsDoIf($hash,$days,-1,1);
if ($err) {
my $errmsg="error in days: $err";
Log3 ($hash->{NAME},4 , "$hash->{NAME}: $errmsg");
readingsSingleUpdate ($hash, "error", $errmsg,1);
return 0;
}
$days=DOIF_weekdays($hash,$days);
my $we=DOIF_we($wday);
my $twe=DOIF_tomorrow_we($wday);
if ($flag) {
return 1 if ($days eq "" or $days =~ /$wday/ or ($days =~ /7/ and $we) or ($days =~ /8/ and !$we) or ($days =~ /9/ and $twe));
}
return 0;
}
sub DOIF_SetState($$$$$) {
my ($hash,$nr,$subnr,$event,$last_error)=@_;
my $pn=$hash->{NAME};
my $cmdNr="";
my $cmd="";
my $err="";
my $state=AttrVal($hash->{NAME},"state","");
$state =~ s/\$SELF/$pn/g;
$nr=ReadingsVal($pn,"cmd_nr",0)-1 if (!$event);
if ($nr!=-1) {
$cmdNr=$nr+1;
my @cmdState;
@cmdState=@{$hash->{attr}{cmdState}{$nr}} if (defined $hash->{attr}{cmdState}{$nr});
if (defined $cmdState[$subnr]) {
$cmd=EvalCmdStateDoIf($hash,$cmdState[$subnr]);
} else {
if (defined $hash->{do}{$nr}{$subnr+1}) {
$cmd="cmd_".$cmdNr."_".($subnr+1);
} else {
if (defined ($cmdState[0])) {
$cmd=EvalCmdStateDoIf($hash,$cmdState[0]);
} else {
$cmd="cmd_$cmdNr";
}
}
}
}
if ($cmd =~ /^"(.*)"$/) {
$cmd=$1;
}
delete $hash->{helper}{DOIF_eventa};
delete $hash->{helper}{DOIF_eventas};
readingsBeginUpdate($hash);
if ($event) {
push (@{$hash->{helper}{DOIF_eventas}},"cmd_nr: $cmdNr");
readingsBulkUpdate($hash,"cmd_nr",$cmdNr);
if (defined $hash->{do}{$nr}{1}) {
readingsBulkUpdate($hash,"cmd_seqnr",$subnr+1);
push (@{$hash->{helper}{DOIF_eventas}},("cmd_seqnr: ".($subnr+1)));
readingsBulkUpdate($hash,"cmd",$cmdNr.".".($subnr+1));
} else {
delete ($defs{$hash->{NAME}}{READINGS}{cmd_seqnr});
push (@{$hash->{helper}{DOIF_eventas}},"cmd: $cmdNr");
readingsBulkUpdate($hash,"cmd",$cmdNr);
}
push (@{$hash->{helper}{DOIF_eventas}},"cmd_event: $event");
readingsBulkUpdate($hash,"cmd_event",$event);
if ($last_error) {
push (@{$hash->{helper}{DOIF_eventas}},"error: $last_error");
readingsBulkUpdate($hash,"error",$last_error);
} else {
delete ($defs{$hash->{NAME}}{READINGS}{error});
}
}
if ($state) {
my $stateblock='\['.$pn.'\]';
$state =~ s/$stateblock/$cmd/g;
$state=EvalCmdStateDoIf($hash,$state);
} else {
$state=$cmd;
}
if (defined($hash->{helper}{DOIF_eventas})) {
@{$hash->{helper}{DOIF_eventa}}=@{$hash->{helper}{DOIF_eventas}};
}
push (@{$hash->{helper}{DOIF_eventas}},"state: $state");
push (@{$hash->{helper}{DOIF_eventa}},"$state");
readingsBulkUpdate($hash, "state", $state);
if (defined $hash->{uiState}{table}) {
readingsEndUpdate ($hash, 0);
} else {
readingsEndUpdate ($hash, 1);
}
}
sub DOIF_we($) {
my ($wday)=@_;
my $we=IsWe("",$wday);
#my $we = (($wday==0 || $wday==6) ? 1 : 0);
#if(!$we) {
# foreach my $h2we (split(",", AttrVal("global", "holiday2we", ""))) {
# if($h2we && Value($h2we)) {
# my ($a, $b) = ReplaceEventMap($h2we, [$h2we, Value($h2we)], 0);
# $we = 1 if($b ne "none");
# }
# }
#}
return $we;
}
sub DOIF_tomorrow_we($) {
my ($wday)=@_;
my $we=IsWe("tomorrow",$wday);
#my $we = (($wday==5 || $wday==6) ? 1 : 0);
#if(!$we) {
# foreach my $h2we (split(",", AttrVal("global", "holiday2we", ""))) {
# if($h2we && ReadingsVal($h2we,"tomorrow",0)) {
# my ($a, $b) = ReplaceEventMap($h2we, [$h2we, ReadingsVal($h2we,"tomorrow",0)], 0);
# $we = 1 if($b ne "none");
# }
# }
#}
return $we;
}
sub DOIF_CheckCond($$) {
my ($hash,$condition) = @_;
my $err="";
my ($seconds, $microseconds) = gettimeofday();
my ($sec,$min,$hour,$mday,$month,$year,$wday,$yday,$isdst) = localtime($seconds);
$month++;
$year+=1900;
my $week=strftime ('%W', localtime($seconds));
my $hms = sprintf("%02d:%02d:%02d", $hour, $min, $sec);
my $hm = sprintf("%02d:%02d", $hour, $min);
my $ymd = sprintf("%02d-%02d-%02d", $year, $month,$mday);
my $md = sprintf("%02d-%02d",$month,$mday);
my $dev;
my $reading;
my $internal;
my $we=DOIF_we($wday);
my $twe=DOIF_tomorrow_we($wday);
my $eventa=$hash->{helper}{triggerEvents};
my $device=$hash->{helper}{triggerDev};
my $event=$hash->{helper}{event};
my $events="";
my $cmd=ReadingsVal($hash->{NAME},"cmd",0);
if ($eventa) {
$events=join(",",@{$eventa});
}
#if (defined ($hash->{readings}{$condition})) {
# foreach my $devReading (split(/ /,$hash->{readings}{$condition})) {
# $devReading=~ s/\$DEVICE/$hash->{helper}{triggerDev}/g if ($devReading);
# }
#}
#if (defined ($hash->{internals}{$condition})) {
# foreach my $devInternal (split(/ /,$hash->{internals}{$condition})) {
# $devInternal=~ s/\$DEVICE/$hash->{helper}{triggerDev}/g if ($devInternal);
# }
#}
my $command=$hash->{condition}{$condition};
if ($command) {
my $eventa=$hash->{helper}{triggerEvents};
my $events="";
if ($eventa) {
$events=join(",",@{$eventa});
}
$command =~ s/\$DEVICE/$hash->{helper}{triggerDev}/g;
$command =~ s/\$EVENTS/$events/g;
$command =~ s/\$EVENT/$hash->{helper}{event}/g;
#my $idx = 0;
#my $evt;
#foreach my $part (split(" ", $hash->{helper}{event})) {
# $evt='\$EVTPART'.$idx;
# $command =~ s/$evt/$part/g;
# $idx++;
#}
}
$cmdFromAnalyze="$hash->{NAME}: ".sprintf("warning in condition c%02d",($condition+1));
$lastWarningMsg="";
$hs=$hash;
my $ret=$hash->{MODEL} eq "Perl" ? eval("package DOIF; $command"):eval ($command);
#my $ret = eval ($command);
if($@){
$@ =~ s/^(.*) at \(eval.*\)(.*)$/$1,$2/;
$err = sprintf("condition c%02d",($condition+1)).": $@";
$ret = 0;
}
if ($lastWarningMsg) {
$lastWarningMsg =~ s/^(.*) at \(eval.*$/$1/;
readingsSingleUpdate ($hash, "warning", sprintf("condition c%02d",($condition+1)).": $lastWarningMsg",1);
} else {
delete ($defs{$hash->{NAME}}{READINGS}{warning});
}
$lastWarningMsg="";
$cmdFromAnalyze = undef;
return ($ret,$err);
}
sub DOIF_cmd ($$$$) {
my ($hash,$nr,$subnr,$event)=@_;
my $pn = $hash->{NAME};
my $ret;
my $cmd;
my $err="";
my $repeatnr;
my $last_cmd=ReadingsVal($pn,"cmd_nr",0)-1;
my ($seconds, $microseconds) = gettimeofday();
if (defined $hash->{attr}{cmdpause}) {
my @cmdpause=@{$hash->{attr}{cmdpause}};
my $cmdpauseValue=EvalValueDoIf($hash,"cmdpause",$cmdpause[$nr]);
if ($cmdpauseValue and $subnr==0) {
return undef if ($seconds - time_str2num(ReadingsTimestamp($pn, "state", "1970-01-01 01:00:00")) < $cmdpauseValue);
}
}
my @sleeptimer;
if (defined $hash->{attr}{repeatcmd}) {
@sleeptimer=@{$hash->{attr}{repeatcmd}};
}
if (defined $hash->{attr}{repeatsame}) {
my @repeatsame=@{$hash->{attr}{repeatsame}};
my $repeatsameValue=EvalValueDoIf($hash,"repeatsame",$repeatsame[$nr]);
if ($subnr == 0) {
if ($repeatsameValue) {
$repeatnr=ReadingsVal($pn,"cmd_count",0);
if ($last_cmd == $nr) {
if ($repeatnr < $repeatsameValue) {
$repeatnr++;
} else {
delete ($defs{$hash->{NAME}}{READINGS}{cmd_count}) if (defined ($sleeptimer[$nr]) and (AttrVal($pn,"do","") eq "always" or AttrVal($pn,"do","") eq "resetwait"));
return undef;
}
} else {
$repeatnr=1;
}
readingsSingleUpdate ($hash, "cmd_count", $repeatnr,1);
} else {
return undef if ($last_cmd == $nr and $subnr==0 and (AttrVal($pn,"do","") ne "always" and AttrVal($pn,"do","") ne "resetwait"));
delete ($defs{$hash->{NAME}}{READINGS}{cmd_count});
}
}
}
if (defined $hash->{attr}{waitsame}) {
my @waitsame=@{$hash->{attr}{waitsame}};
my $waitsameValue=EvalValueDoIf($hash,"waitsame",$waitsame[$nr]);
if ($subnr == 0) {
if ($waitsameValue) {
my $cmd_nr="cmd_".($nr+1);
if (ReadingsVal($pn,"waitsame","") eq $cmd_nr) {
if ($seconds - time_str2num(ReadingsTimestamp($pn, "waitsame", "1970-01-01 01:00:00")) > $waitsameValue) {
readingsSingleUpdate ($hash, "waitsame", $cmd_nr,1);
return undef;
}
} else {
readingsSingleUpdate ($hash, "waitsame", $cmd_nr,1);
return undef;
}
}
delete ($defs{$hash->{NAME}}{READINGS}{waitsame});
}
}
if ($hash->{do}{$nr}{$subnr}) {
$cmd=$hash->{do}{$nr}{$subnr};
my $eventa=$hash->{helper}{triggerEvents};
my $events="";
if ($eventa) {
$events=join(",",@{$eventa});
}
$cmd =~ s/\$DEVICE/$hash->{helper}{triggerDev}/g;
$cmd =~ s/\$EVENTS/$events/g;
$cmd =~ s/\$EVENT/$hash->{helper}{event}/g;
#my $idx = 0;
#my $evt;
#foreach my $part (split(" ", $hash->{helper}{event})) {
# $evt='\$EVTPART'.$idx;
# $cmd =~ s/$evt/$part/g;
# $idx++;
#}
#readingsSingleUpdate ($hash, "Event",$hash->{helper}{event},0);
($cmd,$err)=ParseCommandsDoIf($hash,$cmd,1);
}
DOIF_SetState ($hash,$nr,$subnr,$event,$err);
if (defined $hash->{do}{$nr}{++$subnr}) {
my $last_cond=ReadingsVal($pn,"cmd_nr",0)-1;
if (DOIF_SetSleepTimer($hash,$last_cond,$nr,$subnr,$event,-1,undef)) {
DOIF_cmd ($hash,$nr,$subnr,$event);
}
} else {
if (($sleeptimer[$nr])) {
my $last_cond=ReadingsVal($pn,"cmd_nr",0)-1;
if (DOIF_SetSleepTimer($hash,$last_cond,$nr,0,$event,-1,$sleeptimer[$nr])) {
DOIF_cmd ($hash,$nr,$subnr,$event);
}
}
}
#delete $hash->{helper}{cur_cmd_nr};
return undef;
}
sub CheckiTimerDoIf($$$) {
my ($device,$itimer,$eventa)=@_;
my $max = int(@{$eventa});
my $found;
return 1 if ($itimer =~ /\[$device(\]|,.+\])/);
for (my $j = 0; $j < $max; $j++) {
if ($eventa->[$j] =~ "^([^:]+): ") {
$found = ($itimer =~ /\[$device:$1(\]|:.+\]|,.+\])/);
if ($found) {
return 1;
}
}
}
return 0;
}
sub CheckReadingDoIf($$$)
{
my ($mydevice,$readings,$eventa)=@_;
my $max = int(@{$eventa});
my $s;
my $found=0;
my $device;
my $reading;
if (!defined $readings) {
return 1;
}
if ($readings !~ / $mydevice:.+ /) {
return 1;
}
foreach my $item (split(/ /,$readings)) {
($device,$reading)=(split(":",$item));
if (defined $reading and $mydevice eq $device) {
for (my $j = 0; $j < $max; $j++) {
$s = $eventa->[$j];
$s = "" if(!defined($s));
$found = ($s =~ m/^$reading: /);
if ($found) {
return 1;
}
}
}
}
return 0;
}
sub CheckRegexpDoIf
{
my ($hash,$type,$device,$id,$eventa,$eventas,$readingupdate)=@_;
my $nameExp;
my $notifyExp;
my $event;
my @idlist;
my @devlist;
return undef if (!defined $hash->{Regex}{$type});
if (!AttrVal($hash->{NAME}, "checkReadingEvent", 1)) {
if (defined $hash->{Regex}{$type}{$device}) {
return 1;
}
@devlist=("");
} else {
@devlist=("$device","");
}
foreach my $dev (@devlist){
if (defined $hash->{Regex}{$type}{$dev}) {
@idlist=($id eq "") ? (keys %{$hash->{Regex}{$type}{$dev}}):($id);
foreach my $id (@idlist) {
foreach my $i (keys %{$hash->{Regex}{$type}{$dev}{$id}}) {
$nameExp="";
$notifyExp="";
if ($hash->{Regex}{$type}{$dev}{$id}{$i} =~ /([^\:]*):(.*)/) {
$nameExp=$1;
$notifyExp=$2;
} else {
$nameExp=$hash->{Regex}{$type}{$dev}{$id}{$i};
}
if ($nameExp eq "" or $device =~ /$nameExp/) {
if ($notifyExp eq "") {
return $i;
}
if (defined $eventa and defined $eventas) {
my @events_temp;
if (substr($i,0,1) eq '"') {
@events_temp=@{$eventa};
}
else {
@events_temp=@{$eventas};
}
#my $max=defined @events_temp ? int(@events_temp):0;
my $s;
my $found;
for (my $j = 0; $j < @events_temp; $j++) {
$s = $events_temp[$j];
$s = "" if(!defined($s));
$found = ($s =~ m/$notifyExp/);
if ($found) {
if ($readingupdate==1) {
#readingsSingleUpdate ($hash, "matched_regex_$id",$s,0);
} elsif ($readingupdate==2) {
#readingsBulkUpdate ($hash, "matched_event_$event"."_".($i+1),$s);
}
return $i;
}
}
}
}
}
}
}
}
return undef;
}
sub DOIF_Perl_Trigger
{
my ($hash,$device)= @_;
my $timerNr=-1;
my $ret;
my $err;
my $event="$device";
my $pn=$hash->{NAME};
my $max_cond=keys %{$hash->{condition}};
my $j;
my @triggerEvents;
for (my $i=0; $i<$max_cond;$i++) {
if ($device eq "") {# timer
my $found=0;
if (defined ($hash->{timers}{$i})) {
foreach $j (split(" ",$hash->{timers}{$i})){
if ($hash->{timer}{$j} == 1) {
$found=1;
$timerNr=$j;
last;
}
}
}
next if (!$found);
$event="timer_".($timerNr+1);
@triggerEvents=($event);
$hash->{helper}{triggerEvents}=\@triggerEvents;
$hash->{helper}{triggerEventsState}=\@triggerEvents;
$hash->{helper}{triggerDev}="";
$hash->{helper}{event}=$event;
} else { #event
next if (!defined (CheckRegexpDoIf($hash,"cond", $device,$i,$hash->{helper}{triggerEvents},$hash->{helper}{triggerEventsState},1)));
$event="$device";
}
if (($ret,$err)=DOIF_CheckCond($hash,$i)) {
if ($err) {
Log3 $hash->{NAME},4,"$hash->{NAME}: $err in perl block ".($i+1) if ($ret != -1);
if ($hash->{perlblock}{$i}) {
readingsSingleUpdate ($hash, "block_$hash->{perlblock}{$i}", $err,1);
} else {
readingsSingleUpdate ($hash, sprintf("block_%02d",($i+1)), $err,1);
}
} else {
if ($hash->{perlblock}{$i}) {
readingsSingleUpdate ($hash, "block_$hash->{perlblock}{$i}", "executed",0);
} else {
readingsSingleUpdate ($hash, sprintf("block_%02d",($i+1)), "executed",0);
}
}
}
}
return undef;
}
sub DOIF_Trigger
{
my ($hash,$device,$checkall)= @_;
my $timerNr=-1;
my $ret;
my $err;
my $doelse=0;
my $event="$device";
my $pn=$hash->{NAME};
my $max_cond=keys %{$hash->{condition}};
my $last_cond=ReadingsVal($pn,"cmd_nr",0)-1;
my $j;
my @triggerEvents;
if (AttrVal($pn, "checkall", 0) =~ "1|all|timer" and $device eq "") {
for ($j=0; $j<$hash->{helper}{last_timer};$j++) {
if ($hash->{timer}{$j}==1) {
$timerNr=$j; #first timer
last;
}
}
}
for (my $i=0; $i<$max_cond;$i++) {
if ($device eq "") {# timer
my $found=0;
if (defined ($hash->{timers}{$i})) {
foreach $j (split(" ",$hash->{timers}{$i})) {
if ($hash->{timer}{$j} == 1) {
$found=1;
$timerNr=$j;
last;
}
}
}
next if (!$found and AttrVal($pn, "checkall", 0) !~ "1|all|timer");
$event="timer_".($timerNr+1);
@triggerEvents=($event);
$hash->{helper}{triggerEvents}=\@triggerEvents;
$hash->{helper}{triggerEventsState}=\@triggerEvents;
$hash->{helper}{triggerDev}="";
$hash->{helper}{event}=$event;
} else { #event
if (!defined (CheckRegexpDoIf($hash,"cond", $device,$i,$hash->{helper}{triggerEvents},$hash->{helper}{triggerEventsState},1))) {
if (!defined ($checkall) and AttrVal($pn, "checkall", 0) !~ "1|all|event") {
next;
}
}
$event="$device";
}
if (($ret,$err)=DOIF_CheckCond($hash,$i)) {
if ($err) {
Log3 $hash->{NAME},4,"$hash->{NAME}: $err" if ($ret != -1);
readingsSingleUpdate ($hash, "error", $err,1);
return undef;
}
if ($ret) {
$hash->{helper}{timerevents}=$hash->{helper}{triggerEvents};
$hash->{helper}{timereventsState}=$hash->{helper}{triggerEventsState};
$hash->{helper}{timerevent}=$hash->{helper}{event};
$hash->{helper}{timerdev}=$hash->{helper}{triggerDev};
if (DOIF_SetSleepTimer($hash,$last_cond,$i,0,$device,$timerNr,undef)) {
DOIF_cmd ($hash,$i,0,$event);
return 1;
} else {
return undef;
}
} else {
$doelse = 1;
}
}
}
if ($doelse) { #DOELSE
if (defined ($hash->{do}{$max_cond}{0}) or ($max_cond == 1 and !(AttrVal($pn,"do","") or AttrVal($pn,"repeatsame","")))) { #DOELSE
$hash->{helper}{timerevents}=$hash->{helper}{triggerEvents};
$hash->{helper}{timereventsState}=$hash->{helper}{triggerEventsState};
$hash->{helper}{timerevent}=$hash->{helper}{event};
$hash->{helper}{timerdev}=$hash->{helper}{triggerDev};
if (DOIF_SetSleepTimer($hash,$last_cond,$max_cond,0,$device,$timerNr,undef)) {
DOIF_cmd ($hash,$max_cond,0,$event) ;
return 1;
}
}
}
return undef;
}
sub DOIF_Set_Filter
{
my ($hash) = @_;
$hash->{helper}{NOTIFYDEV}="global";
$hash->{helper}{DEVFILTER}="\^global\$";
foreach my $type (keys %{$hash->{Regex}}) {
foreach my $device (keys %{$hash->{Regex}{$type}}) {
foreach my $id (keys %{$hash->{Regex}{$type}{$device}}) {
foreach my $reading (keys %{$hash->{Regex}{$type}{$device}{$id}}) {
my $devreg=$hash->{Regex}{$type}{$device}{$id}{$reading};
my($regdev)=split(/:/,$devreg);
my $devfilter=$regdev;
if ($regdev eq "") {
$regdev='.*';
} else {
if ($regdev=~/^\^/) {
$regdev=~s/^\^//;
} else {
$regdev="\.\*".$regdev;
}
if ($regdev=~/\$$/) {
$regdev=~s/\$$//;
} else {
$regdev.='.*';
}
}
my $found=0;
foreach my $item (split(/\|/,$hash->{helper}{NOTIFYDEV})) {
if ($regdev eq $item) {
$found=1;
last;
}
}
if (!$found) {
$hash->{helper}{NOTIFYDEV}.="\|$regdev" ;
$hash->{helper}{DEVFILTER}.="\|$devfilter" ;
}
#$hash->{helper}{NOTIFYDEV}.="\|$regdev" if ($hash->{helper}{NOTIFYDEV}!~/\|$regdev(\||$)/);
#$hash->{helper}{DEVFILTER}.="\|$devfilterori" if ($hash->{helper}{DEVFILTER}!~/\|$devfilter(\||$)/);
}
}
}
}
notifyRegexpChanged($hash,$hash->{helper}{NOTIFYDEV});
if (defined ($hash->{NOTIFYDEV})) {
delete ($hash->{DOIFDEV});
} else {
$hash->{DOIFDEV}=$hash->{helper}{DEVFILTER};
}
}
sub
DOIF_Notify($$)
{
my ($hash, $dev) = @_;
my $pn = $hash->{NAME};
return "" if($attr{$pn} && $attr{$pn}{disable});
return "" if (!$dev->{NAME});
my $device;
my $reading;
my $internal;
my $ret;
my $err;
my $eventa;
my $eventas;
if (!defined($hash->{helper}{DEVFILTER})) {
return "";
} elsif ($dev->{NAME} !~ /$hash->{helper}{DEVFILTER}/) {
return "";
}
$eventa = deviceEvents($dev, AttrVal($pn, "addStateEvent", 0));
$eventas = deviceEvents($dev, 1);
delete ($hash->{helper}{DOIF_eventas});
delete ($hash->{helper}{DOIF_eventa});
if ($dev->{NAME} eq "global" and (EventCheckDoif($dev->{NAME},"global",$eventa,'^INITIALIZED$') or EventCheckDoif($dev->{NAME},"global",$eventa,'^REREADCFG$')))
{
$hash->{helper}{globalinit}=1;
# delete old timer-readings
foreach my $key (keys %{$defs{$hash->{NAME}}{READINGS}}) {
delete $defs{$hash->{NAME}}{READINGS}{$key} if ($key =~ "^timer_");
}
delete ($defs{$hash->{NAME}}{READINGS}{wait_timer});
if ($hash->{helper}{last_timer} > 0){
for (my $j=0; $j<$hash->{helper}{last_timer};$j++) {
DOIF_SetTimer ($hash,"DOIF_TimerTrigger",$j);
}
}
if (AttrVal($pn,"initialize",0) and !AttrVal($pn,"disable",0)) {
readingsBeginUpdate($hash);
readingsBulkUpdate ($hash,"state",AttrVal($pn,"initialize",0));
readingsBulkUpdate ($hash,"cmd_nr","0");
readingsBulkUpdate ($hash,"cmd",0);
readingsEndUpdate($hash, 0);
}
if (defined $hash->{perlblock}{init}) {
if (($ret,$err)=DOIF_CheckCond($hash,$hash->{perlblock}{init})) {
if ($err) {
Log3 $hash->{NAME},4,"$hash->{NAME}: $err in perl block init" if ($ret != -1);
readingsSingleUpdate ($hash, "block_init", $err,0);
} else {
readingsSingleUpdate ($hash, "block_init", "executed",0);
}
}
}
my $startup=AttrVal($pn, "startup", 0);
if ($startup and !AttrVal($pn,"disable",0)) {
$startup =~ s/\$SELF/$pn/g;
my ($cmd,$err)=ParseCommandsDoIf($hash,$startup,1);
Log3 ($pn,3,"$pn: error in startup: $err") if ($err);
}
my $uiTable=AttrVal($pn, "uiTable", 0);
if ($uiTable){
my $err=DOIF_uiTable_def($hash,$uiTable,"uiTable");
Log3 ($pn,3,"$pn: error in uiTable: $err") if ($err);
}
my $uiState=AttrVal($pn, "uiState", 0);
if ($uiState){
my $err=DOIF_uiTable_def($hash,$uiState,"uiState");
Log3 ($pn,3,"$pn: error in uiState: $err") if ($err);
}
DOIF_Set_Filter ($hash);
}
return "" if (!$hash->{helper}{globalinit});
#return "" if (!$hash->{itimer}{all} and !$hash->{devices}{all} and !keys %{$hash->{Regex}});
#if (($hash->{itimer}{all}) and $hash->{itimer}{all} =~ / $dev->{NAME} /) {
if (defined CheckRegexpDoIf($hash,"itimer",$dev->{NAME},"itimer",$eventa,$eventas,1)) {
for (my $j=0; $j<$hash->{helper}{last_timer};$j++) {
if (CheckiTimerDoIf ($dev->{NAME},$hash->{time}{$j},$eventas)) {
DOIF_SetTimer ($hash,"DOIF_TimerTrigger",$j);
if (defined $hash->{intervaltimer}{$j}) {
DOIF_SetTimer($hash,"DOIF_TimerTrigger",$hash->{intervaltimer}{$j});
}
}
}
}
return "" if (defined $hash->{helper}{cur_cmd_nr} and $hash->{MODEL} ne "Perl");
return "" if (ReadingsVal($pn,"mode","") eq "disabled");
$ret=0;
if (defined $hash->{Regex}{"accu"}{"$dev->{NAME}"}) {
my $device=$dev->{NAME};
my $reading=CheckRegexpDoIf($hash,"accu",$dev->{NAME},"accu",$eventa,$eventas,0);
if (defined $reading) {
accu_setValue($hash,$device,$reading);
}
}
if (defined CheckRegexpDoIf($hash,"cond",$dev->{NAME},"",$eventa,$eventas,0)) {
$hash->{helper}{cur_cmd_nr}="Trigger $dev->{NAME}" if (AttrVal($hash->{NAME},"selftrigger","") ne "all");
$hash->{helper}{triggerEvents}=$eventa;
$hash->{helper}{triggerEventsState}=$eventas;
$hash->{helper}{triggerDev}=$dev->{NAME};
$hash->{helper}{event}=join(",",@{$eventa});
if ($hash->{readings}{all}) {
foreach my $item (split(/ /,$hash->{readings}{all})) {
($device,$reading)=(split(":",$item));
if ($item and $device eq $dev->{NAME} and defined ($defs{$device}{READINGS}{$reading})) {
if (!AttrVal($pn, "checkReadingEvent", 1) or CheckReadingDoIf ($dev->{NAME}," $item ",$eventas)) {
readingsSingleUpdate ($hash, "e_".$dev->{NAME}."_".$reading,$defs{$device}{READINGS}{$reading}{VAL},0);
}
}
}
}
if ($hash->{internals}{all}) {
foreach my $item (split(/ /,$hash->{internals}{all})) {
($device,$internal)=(split(":",$item));
readingsSingleUpdate ($hash, "e_".$dev->{NAME}."_".$internal,$defs{$device}{$internal},0) if ($item and $device eq $dev->{NAME} and defined ($defs{$device}{$internal}));
}
}
if ($hash->{trigger}{all}) {
if ($hash->{trigger}{all} =~ / $dev->{NAME} /) {
readingsSingleUpdate ($hash, "e_".$dev->{NAME}."_events",join(",",@{$eventa}),0);
}
}
readingsSingleUpdate ($hash, "Device",$dev->{NAME},0) if ($dev->{NAME} ne $hash->{NAME});
$ret=$hash->{MODEL} eq "Perl" ? DOIF_Perl_Trigger($hash,$dev->{NAME}) : DOIF_Trigger($hash,$dev->{NAME});
}
if ((defined CheckRegexpDoIf($hash,"STATE",$dev->{NAME},"STATE",$eventa,$eventas,1)) and !$ret) {
$hash->{helper}{triggerEvents}=$eventa;
$hash->{helper}{triggerEventsState}=$eventas;
$hash->{helper}{triggerDev}=$dev->{NAME};
$hash->{helper}{event}=join(",",@{$eventa});
DOIF_SetState($hash,"",0,"","");
}
delete $hash->{helper}{cur_cmd_nr};
if (defined $hash->{Regex}{"DOIF_Readings"}) {
foreach $device ("$dev->{NAME}","") {
if (defined $hash->{Regex}{"DOIF_Readings"}{$device}) {
#readingsBeginUpdate($hash);
foreach my $reading (keys %{$hash->{Regex}{"DOIF_Readings"}{$device}}) {
my $readingregex=CheckRegexpDoIf($hash,"DOIF_Readings",$dev->{NAME},$reading,$eventa,$eventas,0);
setDOIF_Reading($hash,$reading,$readingregex,"DOIF_Readings",$eventa, $eventas,$dev->{NAME}) if (defined($readingregex));
}
#readingsEndUpdate($hash, 1);
}
}
if (defined ($hash->{helper}{DOIF_eventas})) { #$SELF events
foreach my $reading (keys %{$hash->{Regex}{"DOIF_Readings"}{$hash->{NAME}}}) {
my $readingregex=CheckRegexpDoIf($hash,"DOIF_Readings",$hash->{NAME},$reading,$hash->{helper}{DOIF_eventa},$hash->{helper}{DOIF_eventas},0);
setDOIF_Reading($hash,$reading,$readingregex,"DOIF_Readings",$eventa, $eventas,$dev->{NAME}) if (defined($readingregex));
}
}
}
foreach my $table ("uiTable","uiState") {
if (defined $hash->{Regex}{$table}) {
foreach $device ("$dev->{NAME}","") {
if (defined $hash->{Regex}{$table}{$device}) {
foreach my $doifId (keys %{$hash->{Regex}{$table}{$device}}) {
my $readingregex=CheckRegexpDoIf($hash,$table,$dev->{NAME},$doifId,$eventa,$eventas,0);
DOIF_UpdateCell($hash,$doifId,$hash->{NAME},$readingregex) if (defined($readingregex));
}
}
}
if (defined ($hash->{helper}{DOIF_eventas})) { #$SELF events
foreach my $doifId (keys %{$hash->{Regex}{$table}{$hash->{NAME}}}) {
my $readingregex=CheckRegexpDoIf($hash,$table,$hash->{NAME},$doifId,$hash->{helper}{DOIF_eventa},$hash->{helper}{DOIF_eventas},0);
DOIF_UpdateCell($hash,$doifId,$hash->{NAME},$readingregex) if (defined($readingregex));
}
}
}
}
if (defined $hash->{Regex}{"event_Readings"}) {
foreach $device ("$dev->{NAME}","") {
if (defined $hash->{Regex}{"event_Readings"}{$device}) {
#readingsBeginUpdate($hash);
foreach my $reading (keys %{$hash->{Regex}{"event_Readings"}{$device}}) {
my $readingregex=CheckRegexpDoIf($hash,"event_Readings",$dev->{NAME},$reading,$eventa,$eventas,0);
setDOIF_Reading($hash,$reading,$readingregex,"event_Readings",$eventa, $eventas,$dev->{NAME}) if (defined($readingregex));
}
#readingsEndUpdate($hash,1);
}
}
if (defined ($hash->{helper}{DOIF_eventas})) { #$SELF events
foreach my $reading (keys %{$hash->{Regex}{"event_Readings"}{$hash->{NAME}}}) {
my $readingregex=CheckRegexpDoIf($hash,"event_Readings",$hash->{NAME},$reading,$hash->{helper}{DOIF_eventa},$hash->{helper}{DOIF_eventas},0);
setDOIF_Reading($hash,$reading,$readingregex,"event_Readings",$eventa, $eventas,$dev->{NAME}) if (defined($readingregex));
}
}
}
if (defined $hash->{helper}{DOIF_Readings_events}) {
if ($dev->{NAME} ne $hash->{NAME}) {
@{$hash->{CHANGED}}=@{$hash->{helper}{DOIF_Readings_events}};
@{$hash->{CHANGEDWITHSTATE}}=@{$hash->{helper}{DOIF_Readings_eventsState}};
delete $hash->{helper}{DOIF_Readings_events};
delete $hash->{helper}{DOIF_Readings_eventsState};
DOIF_Notify($hash,$hash);
}
}
return undef;
}
sub DOIF_TimerTrigger ($) {
my ($timer)=@_;
my $hash=${$timer}->{hash};
my $pn = $hash->{NAME};
my $localtime=${$timer}->{localtime};
delete $hash->{triggertime}{$localtime};
my $ret;
my ($now, $microseconds) = gettimeofday();
my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($now);
$hash->{helper}{cur_cmd_nr}="timer $localtime" if (AttrVal($hash->{NAME},"selftrigger","") ne "all");
#$hash->{helper}{cur_cmd_nr}="timer $localtime";
for (my $j=0; $j<$hash->{helper}{last_timer};$j++) {
if (defined $hash->{localtime}{$j} and $hash->{localtime}{$j} == $localtime) {
if (defined ($hash->{interval}{$j})) {
if ($hash->{interval}{$j} != -1) {
if (defined $hash->{realtime}{$j} eq $hash->{realtime}{$hash->{interval}{$j}}) {
$hash->{timer}{$hash->{interval}{$j}}=0;
next;
}
}
}
$hash->{timer}{$j}=1;
if (!DOIF_time_once($hash,$j,$wday,$hash->{days}{$j})) {#check days
$hash->{timer}{$j}=0;
}
}
}
$ret=($hash->{MODEL} eq "Perl" ? DOIF_Perl_Trigger($hash,"") : DOIF_Trigger($hash,"")) if (ReadingsVal($pn,"mode","") ne "disabled");
for (my $j=0; $j<$hash->{helper}{last_timer};$j++) {
$hash->{timer}{$j}=0;
if (defined $hash->{localtime}{$j} and $hash->{localtime}{$j} == $localtime) {
if (!AttrVal($hash->{NAME},"disable","")) {
if (defined ($hash->{interval}{$j})) {
if ($hash->{interval}{$j} != -1) {
DOIF_SetTimer($hash,"DOIF_TimerTrigger",$hash->{interval}{$j});
DOIF_SetTimer($hash,"DOIF_TimerTrigger",$j,1);
#if (defined $hash->{intervaltimer}{$j}) {
# DOIF_DelInternalTimer($hash, $hash->{intervaltimer}{$j});
#}
} else {
if (defined $hash->{intervaltimer}{$j}) {
DOIF_SetTimer($hash,"DOIF_TimerTrigger",$hash->{intervaltimer}{$j});
}
}
} else {
DOIF_SetTimer($hash,"DOIF_TimerTrigger",$j,1);
}
}
}
}
delete ($hash->{helper}{cur_cmd_nr});
return undef;
#return($ret);
}
sub DOIF_DelInternalTimer {
my ($hash, $nr) = @_;
RemoveInternalTimer(\$hash->{triggertime}{$hash->{localtime}{$nr}});
delete ($hash->{triggertime}{$hash->{localtime}{$nr}});
my $cond=$hash->{timeCond}{$nr};
my $timernr=sprintf("timer_%02d_c%02d",($nr+1),($cond+1));
delete ($defs{$hash->{NAME}}{READINGS}{$timernr});
}
sub
DOIF_DetTime($$)
{
my ($hash, $timeStr) = @_;
my $rel=0;
my $align;
my $hr=0;
my $err;
my $h=0;
my $m=0;
my $s=0;
my $fn;
if (substr($timeStr,0,1) eq "+") {
$timeStr=substr($timeStr,1);
$rel=1;
}
my ($now, $microseconds) = gettimeofday();
my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($now);
if($timeStr =~ m/^\[([0-9]+)\]:([0-5][0-9])$/) {
$hr=$1;
$rel=0;
$align=$2;
} elsif ($timeStr =~ m/^:([0-5][0-9])$/) {
$align=$1;
} elsif ($timeStr =~ m/^(\-?([0-9]+))$/) {
$s=$1;
} else {
($timeStr,$err)=ReplaceAllReadingsDoIf($hash,$timeStr,-3,1);
return ($err) if ($err);
($err, $h, $m, $s, $fn) = GetTimeSpec($timeStr);
return $err if ($err);
}
if (defined ($align)) {
if ($rel) {
if ($align > 0) {
$m = (int($min/$align)+1)*$align;
if ($m>=60) {
$h = $hour+1;
$m = 0;
} else {
$h = $hour;
}
}
$rel=0;
} else {
$m=$align;
if ($hr > 1) {
$h = (int($hour/$hr)+1)*$hr;
$h = 0 if ($h >=24);
} else {
if ($m <= $min) {
$h = $hour+1;
} else {
$h = $hour;
}
}
}
}
my $second = $h*3600+$m*60+$s;
if ($second == 0 and $rel) {
$err = "null is not allowed on a relative time";
}
return ($err, ($rel and !defined ($align)), $second,defined ($align));
}
sub
DOIF_CalcTime($$)
{
my ($hash,$block)= @_;
my $tailBlock;
my $beginning;
my $err;
my $cmd="";
my $rel="";
my $relGlobal=0;
my $reading;
my $internal;
my $device;
my $pos;
my $ret;
my $align;
my $alignInCalc;
if ($block=~ m/^\+\[([0-9]+)\]:([0-5][0-9])$/) {
($err,$rel,$block,$align)=DOIF_DetTime($hash,$block);
return ($block,$err,$rel,$align);
} elsif ($block =~ /^\+\(/ or $block =~ /^\+\[/) {
$relGlobal=1;
#$pos=pos($block);
$block=substr($block,1);
}
if ($block =~ /^\(/) {
($beginning,$tailBlock,$err,$tailBlock)=GetBlockDoIf($block,'[\(\)]');
return ($tailBlock,$err) if ($err);
} else {
if ($block =~ /^\[/) {
($beginning,$block,$err,$tailBlock)=GetBlockDoIf($block,'[\[\]]');
return ($block,$err) if ($err);
($block,$err,$device,$reading,$internal)=ReplaceReadingEvalDoIf($hash,$block,1);
return ($block,$err) if ($err);
}
($err,$rel,$block,$align)=DOIF_DetTime($hash, $block);
$rel=1 if ($relGlobal);
return ($block,$err,$rel,$align);
}
$tailBlock=$block;
while ($tailBlock ne "") {
($beginning,$block,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\{\}]');
return ($block,$err) if ($err);
if ($block ne "") {
($err,$rel,$block)=DOIF_DetTime($hash,"{".$block."}");
return ($block,$err) if ($err);
}
$cmd.=$beginning.$block;
}
$tailBlock=$cmd;
$cmd="";
while ($tailBlock ne "") {
($beginning,$block,$err,$tailBlock)=GetBlockDoIf($tailBlock,'[\[\]]');
return ($block,$err) if ($err);
if ($block ne "") {
if ($block =~ /^\??[a-z0-9._]*[a-z._]+[a-z0-9._]*($|:.+$)/i) {
($block,$err,$device,$reading,$internal)=ReplaceReadingEvalDoIf($hash,$block,1);
return ($block,$err) if ($err);
}
($err,$rel,$block,$alignInCalc)=DOIF_DetTime($hash,$block);
$align=$alignInCalc if ($alignInCalc);
return ($block,$err) if ($err);
}
$cmd.=$beginning.$block;
}
$ret = eval $cmd;
return($cmd." ",$@) if ($@);
return ($ret,"null is not allowed on a relative time",$relGlobal) if ($ret == 0 and $relGlobal);
return ($ret,"",$relGlobal,$align);
}
sub DOIF_SetTimer {
my ($hash, $func, $nr,$next_day) = @_;
my $timeStr=$hash->{time}{$nr};
my $cond=$hash->{timeCond}{$nr};
my $next_time;
if (defined ($hash->{localtime}{$nr})) {
my $old_lt=$hash->{localtime}{$nr};
my $found=0;
delete ($hash->{localtime}{$nr});
delete ($hash->{realtime}{$nr});
foreach my $lt (keys %{$hash->{localtime}}) {
if ($hash->{localtime}{$lt} == $old_lt) {
$found=1;
last;
}
}
if (!$found) {
RemoveInternalTimer(\$hash->{triggertime}{$old_lt});
delete ($hash->{triggertime}{$old_lt});
}
}
my ($second,$err, $rel,$align)=DOIF_CalcTime($hash,$timeStr);
my $timernr=sprintf("timer_%02d_c%02d",($nr+1),($cond+1));
if ($err)
{
readingsSingleUpdate ($hash,$timernr,"error: ".$err,AttrVal($hash->{NAME},"timerevent","")?1:0);
Log3 $hash->{NAME},4 , "$hash->{NAME} ".$timernr." error: ".$err;
#RemoveInternalTimer($timer);
#$hash->{realtime}{$nr} = "00:00:00" if (!defined $hash->{realtime}{$nr});
return $err;
}
if ($second < 0) {
if ($rel) {
readingsSingleUpdate ($hash,$timernr,"time offset: $second, negativ offset is not allowed",AttrVal($hash->{NAME},"timerevent","")?1:0);
return($timernr,"time offset: $second, negativ offset is not allowed");
} else {
readingsSingleUpdate ($hash,$timernr,"time in seconds: $second, negative times are not allowed",AttrVal($hash->{NAME},"timerevent","")?1:0);
return($timernr,"time in seconds: $second, negative times are not allowed");
}
}
my ($now, $microseconds) = gettimeofday();
my ($sec,$min,$hour,$mday,$month,$year,$wday,$yday,$isdst) = localtime($now);
my $hms_now = sprintf("%02d:%02d:%02d", $hour, $min, $sec);
my $wday_now = $wday;
my $isdst_now=$isdst;
my $sec_today = $hour*3600+$min*60+$sec;
my $midnight = $now-$sec_today;
if ($rel) {
$next_time =$now+$second;
} else {
$next_time = $midnight+$second;
}
if ($second <= $sec_today and !$rel or defined ($next_day) and !$rel and $second < 86400 and !$align) {
$next_time+=86400;
}
($sec,$min,$hour,$mday,$month,$year,$wday,$yday,$isdst) = localtime($next_time);
if ($isdst_now != $isdst) {
if ($isdst_now == 1) {
$next_time+=3600 if ($isdst == 0);
} else {
$next_time-=3600 if ($second>=3*3600 or $second <= $sec_today and $second<2*3600);
}
}
if (defined ($hash->{intervalfunc}{$nr})) {
my $hms = $hms_now;
$wday = $wday_now;
my $cond=$hash->{timeCond}{$nr};
my $timernr=sprintf("timer_%02d_c%02d",($nr+1),($cond+1));
if (!eval ($hash->{intervalfunc}{$nr})) {
delete ($defs{$hash->{NAME}}{READINGS}{$timernr});
return undef;
}
($sec,$min,$hour,$mday,$month,$year,$wday,$yday,$isdst) = localtime($next_time);
$hms = sprintf("%02d:%02d:%02d", $hour, $min, $sec);
if (!eval ($hash->{intervalfunc}{$nr})) {
delete ($defs{$hash->{NAME}}{READINGS}{$timernr});
return undef;
}
}
my $next_time_str=strftime("%d.%m.%Y %H:%M:%S",localtime($next_time));
$next_time_str.="\|".$hash->{days}{$nr} if (defined ($hash->{days}{$nr}));
readingsSingleUpdate ($hash,$timernr,$next_time_str,AttrVal($hash->{NAME},"timerevent","")?1:0);
$hash->{realtime}{$nr}=strftime("%H:%M:%S",localtime($next_time));
$hash->{localtime}{$nr}=$next_time;
if (!defined ($hash->{triggertime}{$next_time})) {
$hash->{triggertime}{$next_time}{hash}=$hash;
$hash->{triggertime}{$next_time}{localtime}=$next_time;
InternalTimer($next_time, $func, \$hash->{triggertime}{$next_time}, 0);
}
return undef;
}
sub
DOIF_SetSleepTimer($$$$$$$)
{
my ($hash,$last_cond,$nr,$subnr,$device,$timerNr,$repeatcmd)=@_;
my $pn = $hash->{NAME};
my $sleeptimer=$hash->{helper}{sleeptimer};
my @waitdel;
@waitdel=@{$hash->{attr}{waitdel}{$nr}} if (defined $hash->{attr}{waitdel}{$nr});
my $err;
if ($sleeptimer != -1 and (($sleeptimer != $nr or AttrVal($pn,"do","") eq "resetwait") or ($sleeptimer == $nr and $waitdel[$subnr]))) {
RemoveInternalTimer($hash);
#delete ($defs{$hash->{NAME}}{READINGS}{wait_timer});
readingsSingleUpdate ($hash, "wait_timer", "no timer",1);
$hash->{helper}{sleeptimer}=-1;
$subnr=$hash->{helper}{sleepsubtimer} if ($hash->{helper}{sleepsubtimer}!=-1 and $sleeptimer == $nr);
return 0 if ($sleeptimer == $nr and $waitdel[$subnr]);
}
if ($timerNr >= 0 and !AttrVal($pn,"timerWithWait","")) {#Timer
if ($last_cond != $nr or AttrVal($pn,"do","") eq "always" or AttrVal($pn,"do","") eq "resetwait" or AttrVal($pn,"repeatsame","")) {
return 1;
} else {
return 0;
}
}
if ($hash->{helper}{sleeptimer} == -1 and ($last_cond != $nr or $subnr > 0
or AttrVal($pn,"do","") eq "always"
or AttrVal($pn,"do","") eq "resetwait"
or AttrVal($pn,"repeatsame","")
or $repeatcmd)) {
my $sleeptime=0;
if ($repeatcmd) {
$sleeptime=$repeatcmd;
} else {
my @sleeptimer;
@sleeptimer=@{$hash->{attr}{wait}{$nr}} if (defined $hash->{attr}{wait}{$nr});
if ($waitdel[$subnr]) {
$sleeptime = $waitdel[$subnr];
} else {
if ($sleeptimer[$subnr]) {
$sleeptime=$sleeptimer[$subnr];
}
}
}
$sleeptime=EvalValueDoIf($hash,"wait",$sleeptime);
if ($sleeptime) {
my $seconds = gettimeofday();
my $next_time = $seconds+$sleeptime;
$hash->{helper}{sleeptimer}=$nr;
$hash->{helper}{sleepsubtimer}=$subnr;
$device="timer_".($timerNr+1) if ($timerNr >= 0);
$hash->{helper}{sleepdevice}=$device;
my $cmd_nr=$nr+1;
if (defined $hash->{do}{$nr}{1}) {
my $cmd_subnr=$subnr+1;
readingsSingleUpdate ($hash,"wait_timer",strftime("%d.%m.%Y %H:%M:%S cmd_$cmd_nr"."_$cmd_subnr $device",localtime($next_time)),1);
} else {
readingsSingleUpdate ($hash,"wait_timer",strftime("%d.%m.%Y %H:%M:%S cmd_$cmd_nr $device",localtime($next_time)),1);
}
InternalTimer($next_time, "DOIF_SleepTrigger",$hash, 0);
return 0;
} elsif ($repeatcmd){
return 0;
} else {
return 1;
}
} else {
return 0;
}
}
sub
DOIF_SleepTrigger ($)
{
my ($hash)=@_;
my $sleeptimer=$hash->{helper}{sleeptimer};
my $sleepsubtimer=$hash->{helper}{sleepsubtimer};
my $pn = $hash->{NAME};
$hash->{helper}{cur_cmd_nr}="wait_timer" if (!AttrVal($hash->{NAME},"selftrigger",""));
$hash->{helper}{triggerEvents}=$hash->{helper}{timerevents};
$hash->{helper}{triggerEventsState}=$hash->{helper}{timereventsState};
$hash->{helper}{event}=$hash->{helper}{timerevent};
$hash->{helper}{triggerDev}=$hash->{helper}{timerdev};
readingsSingleUpdate ($hash, "wait_timer", "no timer",1);
$hash->{helper}{sleeptimer}=-1;
$hash->{helper}{sleepsubtimer}=-1;
if (ReadingsVal($pn,"mode","") ne "disabled") {
DOIF_cmd ($hash,$sleeptimer,$sleepsubtimer,$hash->{helper}{sleepdevice});
}
delete $hash->{helper}{cur_cmd_nr};
return undef;
}
sub
CmdDoIfPerl($$)
{
my ($hash, $tail) = @_;
my $perlblock="";
my $beginning;
my $ret;
my $err="";
my $i=0;
$hs=$hash;
#def modify
if ($init_done)
{
DOIF_delTimer($hash);
DOIF_delAll ($hash);
readingsBeginUpdate($hash);
#readingsBulkUpdate($hash,"state","initialized");
readingsBulkUpdate ($hash,"mode","enabled");
readingsEndUpdate($hash, 1);
$hash->{helper}{globalinit}=1;
#foreach my $key (keys %{$attr{$hash->{NAME}}}) {
# if ($key ne "disable" and AttrVal($hash->{NAME},$key,"")) {
# DOIF_Attr ("set",$hash->{NAME},$key,AttrVal($hash->{NAME},$key,""));
# }
#}
}
$hash->{helper}{last_timer}=0;
$hash->{helper}{sleeptimer}=-1;
return("","") if ($tail =~ /^ *$/);
$tail =~ s/\$_(\w+)/\$hash->\{var\}\{$1\}/g;
while ($tail ne "") {
($beginning,$perlblock,$err,$tail)=GetBlockDoIf($tail,'[\{\}]');
return ($perlblock,$err) if ($err);
if ($beginning =~ /(\w*)[\s]*$/) {
my $blockname=$1;
if ($blockname eq "subs") {
$perlblock =~ s/\$SELF/$hash->{NAME}/g;
$perlblock ="no warnings 'redefine';package DOIF;".$perlblock;
eval ($perlblock);
if ($@) {
return ("error in defs block",$@);
}
next;
}
($perlblock,$err)=ReplaceAllReadingsDoIf($hash,$perlblock,$i,0);
return ($perlblock,$err) if ($err);
$hash->{condition}{$i}=$perlblock;
$hash->{perlblock}{$i}=$blockname;
if ($blockname eq "init") {
$hash->{perlblock}{init}=$i;
}
}
$i++;
}
if (defined $hash->{perlblock}{init}) {
if ($init_done) {
if (($ret,$err)=DOIF_CheckCond($hash,$hash->{perlblock}{init})) {
if ($err) {
Log3 $hash->{NAME},4,"$hash->{NAME}: $err in perl block init" if ($ret != -1);
readingsSingleUpdate ($hash, "block_init", $err,0);
} else {
readingsSingleUpdate ($hash, "block_init", "executed",0);
}
}
}
}
if ($init_done) {
foreach my $key (keys %{$attr{$hash->{NAME}}}) {
if ($key ne "disable" and AttrVal($hash->{NAME},$key,"")) {
DOIF_Attr ("set",$hash->{NAME},$key,AttrVal($hash->{NAME},$key,""));
}
}
}
return("","")
}
#############################
sub
CmdDoIf($$)
{
my ($hash, $tail) = @_;
my $cond="";
my $err="";
my $if_cmd="";
my $if_cmd_ori="";
my $else_cmd="";
my $else_cmd_ori="";
my $tailBlock;
my $eval="";
my $beginning;
my $i=0;
my $j=0;
my $last_do;
#def modify
if ($init_done)
{
DOIF_delTimer($hash);
DOIF_delAll ($hash);
readingsBeginUpdate($hash);
readingsBulkUpdate($hash,"cmd",0);
readingsBulkUpdate($hash,"state","initialized");
readingsBulkUpdate ($hash,"mode","enabled");
readingsEndUpdate($hash, 1);
$hash->{helper}{globalinit}=1;
#foreach my $key (keys %{$attr{$hash->{NAME}}}) {
# if ($key ne "disable" and AttrVal($hash->{NAME},$key,"")) {
# DOIF_Attr ("set",$hash->{NAME},$key,AttrVal($hash->{NAME},$key,""));
# }
#}
}
$hash->{helper}{last_timer}=0;
$hash->{helper}{sleeptimer}=-1;
return("","") if ($tail =~ /^ *$/);
$tail =~ s/\n/ /g;
while ($tail ne "") {
return($tail, "no left bracket of condition") if ($tail !~ /^ *\(/);
#condition
($beginning,$cond,$err,$tail)=GetBlockDoIf($tail,'[\(\)]');
return ($cond,$err) if ($err);
($cond,$err)=ReplaceAllReadingsDoIf($hash,$cond,$i,0);
return ($cond,$err) if ($err);
return ($tail,"no condition") if ($cond eq "");
$hash->{condition}{$i}=$cond;
#DOIF
$if_cmd_ori="";
$j=0;
while ($tail =~ /^\s*(\(|\{)/) {
if ($tail =~ /^\s*\(/) {
($beginning,$if_cmd_ori,$err,$tail)=GetBlockDoIf($tail,'[\(\)]');
return ($if_cmd_ori,$err) if ($err);
} elsif ($tail =~ /^\s*\{/) {
($beginning,$if_cmd_ori,$err,$tail)=GetBlockDoIf($tail,'[\{\}]');
return ($if_cmd_ori,$err) if ($err);
$if_cmd_ori="{".$if_cmd_ori."}";
}
($if_cmd,$err)=ParseCommandsDoIf($hash,$if_cmd_ori,0);
return ($if_cmd,$err) if ($err);
#return ($tail,"no commands") if ($if_cmd eq "");
$hash->{do}{$i}{$j++}=$if_cmd_ori;
}
$hash->{do}{$i}{0}=$if_cmd_ori if ($j==0); #do without brackets
$last_do=$i;
$tail =~ s/^\s*$//g;
if (length($tail)) {
$tail =~ /^\s*DOELSEIF/g;
if (pos($tail)) {
$tail=substr($tail,pos($tail));
if (!length($tail)) {
return ($tail,"no DOELSEIF block");
}
} else {
last if ($tail =~ /^\s*DOELSE/);
return ($tail,"expected DOELSEIF or DOELSE");
}
}
$i++;
}
#DOELSE
if (length($tail)) {
$tail =~ /^\s*DOELSE/g;
if (pos($tail)) {
$tail=substr($tail,pos($tail));
} else {
return ($tail,"expected DOELSE");
}
$j=0;
while ($tail =~ /^\s*(\(|\{)/) {
if ($tail =~ /^\s*\(/) {
($beginning,$else_cmd_ori,$err,$tail)=GetBlockDoIf($tail,'[\(\)]');
return ($else_cmd_ori,$err) if ($err);
} elsif ($tail =~ /^\s*\{/) {
($beginning,$else_cmd_ori,$err,$tail)=GetBlockDoIf($tail,'[\{\}]');
return ($else_cmd_ori,$err) if ($err);
$else_cmd_ori="{".$else_cmd_ori."}";
}
($else_cmd,$err)=ParseCommandsDoIf($hash,$else_cmd_ori,0);
return ($else_cmd,$err) if ($err);
$hash->{do}{$last_do+1}{$j++}=$else_cmd_ori;
}
$hash->{do}{$last_do+1}{0}=$else_cmd_ori if ($j==0); #doelse without brackets
}
if ($init_done) {
foreach my $key (keys %{$attr{$hash->{NAME}}}) {
if ($key ne "disable" and AttrVal($hash->{NAME},$key,"")) {
DOIF_Attr ("set",$hash->{NAME},$key,AttrVal($hash->{NAME},$key,""));
}
}
}
return("","")
}
sub
DOIF_Define($$$)
{
my ($hash, $def) = @_;
my ($name, $type, $cmd) = split(/[\s]+/, $def, 3);
return undef if (AttrVal($hash->{NAME},"disable",""));
my $err;
my $msg;
$hs=$hash;
if (AnalyzeCommandChain(undef,"version 98_DOIF.pm noheader") =~ "^98_DOIF.pm (.*)Z") {
$hash->{VERSION}=$1;
}
if (!$cmd) {
$cmd="";
$defs{$hash->{NAME}}{DEF}="##";
} else {
$cmd =~ s/(##.*\n)|(##.*$)/ /g;
$cmd =~ s/\$SELF/$hash->{NAME}/g;
}
if ($cmd =~ /^\s*(\(|$)/) {
$hash->{MODEL}="FHEM";
($msg,$err)=CmdDoIf($hash,$cmd);
#delete $defs{$hash->{NAME}}{".AttrList"};
setDevAttrList($hash->{NAME});
} else {
$hash->{MODEL}="Perl";
#$defs{$hash->{NAME}}{".AttrList"} = "disable:0,1 loglevel:0,1,2,3,4,5,6 startup state initialize notexist checkReadingEvent:1,0 addStateEvent:1,0 weekdays setList:textField-long readingList DOIF_Readings:textField-long uiTable:textField-long ".$readingFnAttributes;
setDevAttrList($hash->{NAME},"disable:0,1 loglevel:0,1,2,3,4,5,6 notexist checkReadingEvent:0,1 addStateEvent:1,0 weekdays setList:textField-long readingList DOIF_Readings:textField-long event_Readings:textField-long uiTable:textField-long ".$readingFnAttributes);
($msg,$err)=CmdDoIfPerl($hash,$cmd);
}
if ($err ne "") {
$msg=$cmd if (!$msg);
my $errmsg="$name $type: $err: $msg";
return $errmsg;
} else {
DOIF_Set_Filter ($hash);
return undef;
}
}
#################################
sub
DOIF_Attr(@)
{
my @a = @_;
my $hash = $defs{$a[1]};
my $pn=$hash->{NAME};
my $ret="";
$hs=$hash;
if (($a[0] eq "set" and $a[2] eq "disable" and ($a[3] eq "0")) or (($a[0] eq "del" and $a[2] eq "disable")))
{
my $cmd = $defs{$hash->{NAME}}{DEF};
my $msg;
my $err;
if (!$cmd) {
$cmd="";
$defs{$hash->{NAME}}{DEF}="##";
} else {
$cmd =~ s/(##.*\n)|(##.*$)/ /g;
$cmd =~ s/\$SELF/$hash->{NAME}/g;
}
if ($cmd =~ /^\s*(\(|$)/) {
$hash->{MODEL}="FHEM";
($msg,$err)=CmdDoIf($hash,$cmd);
} else {
$hash->{MODEL}="Perl";
($msg,$err)=CmdDoIfPerl($hash,$cmd);
}
if ($err ne "") {
$msg=$cmd if (!$msg);
return ("$err: $msg");
}
} elsif($a[0] eq "set" and $a[2] eq "disable" and $a[3] eq "1") {
DOIF_delTimer($hash);
DOIF_delAll ($hash);
readingsBeginUpdate($hash);
if ($hash->{MODEL} ne "Perl") {
readingsBulkUpdate ($hash, "state", "deactivated");
}
readingsBulkUpdate ($hash, "mode", "deactivated");
readingsEndUpdate ($hash, 1);
} elsif($a[0] eq "set" && $a[2] eq "state") {
delete $hash->{Regex}{"STATE"};
my ($block,$err)=ReplaceAllReadingsDoIf($hash,$a[3],-2,0);
return $err if ($err);
} elsif($a[0] eq "del" && $a[2] eq "state") {
delete $hash->{Regex}{"STATE"};
} elsif($a[0] =~ "set|del" && $a[2] eq "wait") {
if ($a[0] eq "del") {
RemoveInternalTimer($hash);
readingsSingleUpdate ($hash, "wait_timer", "no timer",1);
$hash->{helper}{sleeptimer}=-1;
}
delete $hash->{attr}{wait};
my @wait=SplitDoIf(':',$a[3]);
for (my $i=0;$i<@wait;$i++){
@{$hash->{attr}{wait}{$i}}=SplitDoIf(',',$wait[$i]);
}
} elsif($a[0] =~ "set|del" && $a[2] eq "waitdel") {
if ($a[0] eq "del") {
RemoveInternalTimer($hash);
readingsSingleUpdate ($hash, "wait_timer", "no timer",1);
$hash->{helper}{sleeptimer}=-1;
}
delete $hash->{attr}{waitdel};
my @waitdel=SplitDoIf(':',$a[3]);
for (my $i=0;$i<@waitdel;$i++){
@{$hash->{attr}{waitdel}{$i}}=SplitDoIf(',',$waitdel[$i]);
}
} elsif($a[0] =~ "set|del" && $a[2] eq "repeatsame") {
delete ($defs{$hash->{NAME}}{READINGS}{cmd_count});
@{$hash->{attr}{repeatsame}}=SplitDoIf(':',$a[3]);
} elsif($a[0] =~ "set|del" && $a[2] eq "repeatcmd") {
@{$hash->{attr}{repeatcmd}}=SplitDoIf(':',$a[3]);
} elsif($a[0] =~ "set|del" && $a[2] eq "cmdpause") {
@{$hash->{attr}{cmdpause}}=SplitDoIf(':',$a[3]);
} elsif($a[0] =~ "set|del" && $a[2] eq "cmdState") {
delete $hash->{attr}{cmdState};
my @cmdState=SplitDoIf('|',$a[3]);
for (my $i=0;$i<@cmdState;$i++){
@{$hash->{attr}{cmdState}{$i}}=SplitDoIf(',',$cmdState[$i]);
}
} elsif($a[0] =~ "set|del" && $a[2] eq "waitsame") {
delete ($defs{$hash->{NAME}}{READINGS}{waitsame});
@{$hash->{attr}{waitsame}}=SplitDoIf(':',$a[3]);
} elsif($a[0] eq "set" && ($a[2] eq "DOIF_Readings" or $a[2] eq "event_Readings")) {
my ($def,$err)=addDOIF_Readings($hash,$a[3],$a[2]);
if ($err) {
return ("error in $a[2] $def, $err");
} else {
if ($init_done) {
foreach my $reading (keys %{$hash->{$a[2]}}) {
setDOIF_Reading ($hash,$reading,"",$a[2],"","","");
}
}
}
} elsif($a[0] eq "del" && ($a[2] eq "DOIF_Readings" or $a[2] eq "event_Readings")) {
delete ($hash->{$a[2]});
delete $hash->{Regex}{$a[2]};
} elsif($a[0] eq "set" && ($a[2] eq "uiTable" || $a[2] eq "uiState")) {
if ($init_done) {
my $err=DOIF_uiTable_def($hash,$a[3],$a[2]);
return $err if ($err);
DOIF_reloadFW;
}
} elsif($a[0] eq "del" && ($a[2] eq "uiTable" || $a[2] eq "uiState")) {
delete ($hash->{Regex}{$a[2]});
delete ($hash->{$a[2]});
} elsif($a[0] eq "set" && $a[2] eq "startup") {
my ($cmd,$err)=ParseCommandsDoIf($hash,$a[3],0);
if ($err) {
return ("error in startup $a[3], $err");
}
}
DOIF_Set_Filter($hash);
return undef;
}
sub
DOIF_Undef
{
my ($hash, $name) = @_;
$hash->{DELETED} = 1;
DOIF_delTimer($hash);
DOIF_killBlocking($hash);
return undef;
}
sub
DOIF_Shutdown
{
my ($hash) = @_;
DOIF_killBlocking($hash);
return undef;
}
sub
DOIF_Set($@)
{
my ($hash, @a) = @_;
my $pn = $hash->{NAME};
my $arg = $a[1];
my $value = (defined $a[2]) ? $a[2] : "";
my $ret="";
$hs=$hash;
if ($arg eq "disable" or $arg eq "initialize" or $arg eq "enable") {
if (AttrVal($hash->{NAME},"disable","")) {
return ("modul ist deactivated by disable attribut, delete disable attribut first");
}
}
if ($arg eq "disable") {
readingsBeginUpdate ($hash);
if ($hash->{MODEL} ne "Perl") {
readingsBulkUpdate($hash,"last_cmd",ReadingsVal($pn,"state",""));
readingsBulkUpdate($hash, "state", "disabled");
}
readingsBulkUpdate($hash, "mode", "disabled");
readingsEndUpdate ($hash, 1);
} elsif ($arg eq "initialize" ) {
readingsSingleUpdate ($hash,"mode","enabled",1);
if ($hash->{MODEL} ne "Perl") {
delete ($defs{$hash->{NAME}}{READINGS}{cmd_nr});
delete ($defs{$hash->{NAME}}{READINGS}{cmd});
delete ($defs{$hash->{NAME}}{READINGS}{cmd_seqnr});
delete ($defs{$hash->{NAME}}{READINGS}{cmd_event});
readingsSingleUpdate($hash, "state","initialize",1);
}
} elsif ($arg eq "enable" ) {
#delete ($defs{$hash->{NAME}}{READINGS}{mode});
if ($hash->{MODEL} ne "Perl") {
readingsSingleUpdate ($hash,"state",ReadingsVal($pn,"last_cmd",""),0) if (ReadingsVal($pn,"last_cmd","") ne "");
delete ($defs{$hash->{NAME}}{READINGS}{last_cmd});
}
readingsSingleUpdate ($hash,"mode","enabled",1)
} elsif ($arg eq "checkall" ) {
$hash->{helper}{triggerDev}="";
delete $hash->{helper}{triggerEvents};
delete $hash->{helper}{triggerEventsState};
DOIF_Trigger ($hash,$pn,1);
} elsif ($arg =~ /^cmd_(.*)/ ) {
if (ReadingsVal($pn,"mode","") ne "disabled") {
if ($hash->{helper}{sleeptimer} != -1) {
RemoveInternalTimer($hash);
readingsSingleUpdate ($hash, "wait_timer", "no timer",1);
$hash->{helper}{sleeptimer}=-1;
}
DOIF_cmd ($hash,$1-1,0,"set_cmd_".$1);
}
} elsif ($arg eq "?") {
my $setList = AttrVal($pn, "setList", " ");
$setList =~ s/\n/ /g;
my $cmdList="";
my $checkall="";
my $initialize="";
if ($hash->{MODEL} ne "Perl") {
$checkall="checkall:noArg";
$initialize="initialize:noArg";
my $max_cond=keys %{$hash->{condition}};
$max_cond++ if (defined ($hash->{do}{$max_cond}{0}) or ($max_cond == 1 and !(AttrVal($pn,"do","") or AttrVal($pn,"repeatsame",""))));
for (my $i=0; $i <$max_cond;$i++) {
$cmdList.="cmd_".($i+1).":noArg ";
}
}
return "unknown argument ? for $pn, choose one of disable:noArg enable:noArg $initialize $checkall $cmdList $setList";
} else {
my @rl = split(" ", AttrVal($pn, "readingList", ""));
my $doRet;
eval {
if(@rl && grep /\b$arg\b/, @rl) {
my $v = shift @a;
$v = shift @a;
readingsSingleUpdate($hash, $v, join(" ",@a), 1);
$doRet = 1;
}
};
return if($doRet);
if (ReadingsVal($pn,"mode","") ne "disabled") {
foreach my $i (keys %{$hash->{attr}{cmdState}}) {
if ($arg eq EvalCmdStateDoIf($hash,$hash->{attr}{cmdState}{$i}[0])) {
if ($hash->{helper}{sleeptimer} != -1) {
RemoveInternalTimer($hash);
readingsSingleUpdate ($hash, "wait_timer", "no timer",1);
$hash->{helper}{sleeptimer}=-1;
}
DOIF_cmd ($hash,$i,0,"set_".$arg."_cmd_".($i+1));
last;
}
}
}
#return "unknown argument $arg for $pn, choose one of disable:noArg initialize:noArg enable:noArg cmd $setList";
}
return $ret;
}
sub
DOIF_Get($@)
{
my ($hash, @a) = @_;
my $pn = $a[0];
return "$pn: get needs at least one parameter" if(@a < 2);
my $arg= $a[1];
if( $arg eq "html" ) {
return DOIF_RegisterEvalAll($hash,$pn,"uiTable");
}
return undef;
}
package DOIF;
#use Date::Parse qw(str2time);
use Time::HiRes qw(gettimeofday);
sub DOIF_ExecTimer
{
my ($timer)=@_;
my $hash=${$timer}->{hash};
my $timername=${$timer}->{name};
my $name=$hash->{NAME};
my $subname=${$timer}->{subname};
my $param=${$timer}->{param} if (defined ${$timer}->{param});
$hs=$hash;
delete ($::defs{$name}{READINGS}{"timer_$timername"});
if (!defined ($param)) {
eval ("package DOIF;$subname");
} else {
#eval ("package DOIF;$subname(\"$param\")");
eval('package DOIF;no strict "refs";&{$subname}($param);use strict "refs"');
}
if ($@) {
::Log3 ($::defs{$name}{NAME},1 , "$name error in $subname: $@");
::readingsSingleUpdate ($hash, "error", "in $subname: $@",1);
}
}
sub set_Exec
{
my ($timername,$seconds,$subname,$param)=@_;
my $current = ::gettimeofday();
my $next_time = $current+$seconds;
$hs->{ptimer}{$timername}{time}=$next_time;
$hs->{ptimer}{$timername}{name}=$timername;
$hs->{ptimer}{$timername}{subname}=$subname;
$hs->{ptimer}{$timername}{param}=$param if (defined $param);
$hs->{ptimer}{$timername}{hash}=$hs;
::RemoveInternalTimer(\$hs->{ptimer}{$timername});
if ($seconds > 0) {
::readingsSingleUpdate ($hs,"timer_$timername",::strftime("%d.%m.%Y %H:%M:%S",localtime($next_time)),0);
}
::InternalTimer($next_time, "DOIF::DOIF_ExecTimer",\$hs->{ptimer}{$timername}, 0);
}
sub get_Exec
{
my ($timername)=@_;
my $current = ::gettimeofday();
if (defined $hs->{ptimer}{$timername}{time}) {
my $sec=$hs->{ptimer}{$timername}{time}-$current;
if ($sec > 0) {
return ($sec);
} else {
delete ($hs->{ptimer}{$timername}{time});
return (0);
}
} else {
return (0);
}
}
sub del_Exec
{
my ($timername)=@_;
::RemoveInternalTimer(\$hs->{ptimer}{$timername});
delete $hs->{ptimer}{$timername};
delete ($::defs{$hs->{NAME}}{READINGS}{"timer_$timername"});
}
sub set_Event
{
my ($event)=@_;
::DoTrigger($hs->{NAME}, $event);
}
sub set_State
{
my ($content,$trigger)=@_;
if (defined $trigger) {
return(::readingsSingleUpdate($hs,"state",$content,$trigger));
} else {
return(::readingsSingleUpdate($hs,"state",$content,1));
}
}
sub set_Reading
{
my ($reading,$content,$trigger)=@_;
if (defined $trigger) {
return(::readingsSingleUpdate($hs,$reading,$content,$trigger));
} else {
return(::readingsSingleUpdate($hs,$reading,$content,0));
}
}
sub set_Reading_Begin
{
return(::readingsBeginUpdate ($hs));
}
sub set_Reading_Update ($$@)
{
my ($reading,$value,$changed)= @_;
return(::readingsBulkUpdate($hs, $reading, $value,$changed));
}
sub set_Reading_End
{
my ($trigger)=@_;
return(::readingsEndUpdate($hs,$trigger));
}
sub get_State
{
my ($default)=@_;
if (defined $default) {
return(::ReadingsVal($hs->{NAME},"state",$default));
} else {
return(::ReadingsVal($hs->{NAME},"state",""));
}
}
sub get_Reading
{
my ($reading,$default)=@_;
if (defined $default) {
return(::ReadingsVal($hs->{NAME},$reading,$default));
} else {
return(::ReadingsVal($hs->{NAME},$reading,""));
}
}
sub fhem_set {
my ($content)=@_;
return(::CommandSet(undef,$content));
}
sub fhem ($@){
my ($param, $silent) = @_;
return(::fhem($param, $silent));
}
sub Log {
my ($loglevel, $text) = @_;
return(::Log3(undef, $loglevel, $text));
}
sub Log3 {
my ($dev, $loglevel, $text) = @_;
return(::Log3($dev, $loglevel, $text));
}
sub InternalVal {
my ($d,$n,$default) = @_;
return(::InternalVal($d,$n,$default));
}
sub InternalNum {
my ($d,$n,$default,$round) = @_;
return(::InternalNum($d,$n,$default,$round));
}
sub OldReadingsVal {
my ($d,$n,$default) = @_;
return(::OldReadingsVal($d,$n,$default));
}
sub OldReadingsNum {
my ($d,$n,$default,$round) = @_;
return(::OldReadingsNum($d,$n,$default,$round));
}
sub OldReadingsTimestamp {
my ($d,$n,$default) = @_;
return(::OldReadingsTimestamp($d,$n,$default));
}
sub ReadingsVal {
my ($device,$reading,$default)=@_;
return(::ReadingsVal($device,$reading,$default));
}
sub ReadingsNum {
my ($d,$n,$default,$round) = @_;
return(::ReadingsNum($d,$n,$default,$round));
}
sub ReadingsTimestamp {
my ($d,$n,$default) = @_;
return(::ReadingsTimestamp($d,$n,$default));
}
sub ReadingsAge {
my ($device,$reading,$default) = @_;
return(::ReadingsAge($device,$reading,$default));
}
sub Value($) {
my ($d) = @_;
return(::Value($d));
}
sub OldValue {
my ($d) = @_;
return(::OldValue($d));
}
sub OldTimestamp {
my ($d) = @_;
return(::OldTimestamp($d));
}
sub AttrVal {
my ($d,$n,$default) = @_;
return(::AttrVal($d,$n,$default));
}
sub AttrNum {
my ($d,$n,$default,$round) = @_;
return (::AttrNum($d,$n,$default,$round));
}
package ui_Table;
sub FW_makeImage {
my ($image) = @_;
return (::FW_makeImage($image));
}
#Styles
sub temp
{
my ($temp,$size,$icon)=@_;
return((defined($icon) ? ::FW_makeImage($icon):"").$temp." °C","font-weight:bold;".(defined ($size) ? "font-size:".$size."pt;":"").ui_Table::temp_style($temp));
}
sub temp_style
{
my ($temp)=@_;
if ($temp >=30) {
return ("color:".::DOIF_hsv ($temp,30,50,20,0,90,95));
} elsif ($temp >= 10) {
return ("color:".::DOIF_hsv ($temp,10,30,73,20,80,95));
} elsif ($temp >= 0) {
return ("color:".::DOIF_hsv ($temp,0,10,211,73,60,95));
} elsif ($temp >= -20) {
return ("color:".::DOIF_hsv ($temp,-20,0,277,211,50,95));
}
}
sub hum
{
my ($hum,$size,$icon)=@_;
return ((defined($icon) ? ::FW_makeImage($icon):"").$hum." %","font-weight:bold;".(defined ($size) ? "font-size:".$size."pt;":"")."color:".::DOIF_hsv ($hum,30,100,30,260,60,90));
}
sub style
{
my ($text,$color,$font_size,$font_weight)=@_;
my $style="";
$style.="color:$color;" if (defined ($color));
$style.="font-size:$font_size"."pt;" if (defined ($font_size));
$style.="font-weight:$font_weight;" if (defined ($font_weight));
return ($text,$style);
}
# Widgets
sub temp_knob {
my ($value,$color,$set)=@_;
$color="DarkOrange" if (!defined $color);
$set="set" if (!defined $set);
return ($value,"","knob,min:17,max:25,width:40,height:35,step:0.5,fgColor:$color,bgcolor:grey,anglearc:270,angleOffset:225,cursor:15,thickness:.3",$set)
}
sub shutter {
my ($value,$color,$type)=@_;
$color="\@darkorange" if (!defined ($color) or $color eq "");
if (!defined ($type) or $type == 3) {
return ($value,"","iconRadio,$color,100,fts_shutter_10,30,fts_shutter_70,0,fts_shutter_100","set");
} elsif ($type == 4) {
return ($value,"","iconRadio,$color,100,fts_shutter_10,50,fts_shutter_50,30,fts_shutter_70,0,fts_shutter_100","set");
} elsif ($type == 5) {
return ($value,"","iconRadio,$color,100,fts_shutter_10,70,fts_shutter_30,50,fts_shutter_50,30,fts_shutter_70,0,fts_shutter_100","set");
} elsif ($type >= 6) {
return ($value,"","iconRadio,$color,100,fts_shutter_10,70,fts_shutter_30,50,fts_shutter_50,30,fts_shutter_70,20,fts_shutter_80,0,fts_shutter_100","set");
} elsif ($type == 2) {
return ($value,"","iconRadio,$color,100,fts_shutter_10,0,fts_shutter_100","set");
}
}
sub dimmer {
my ($value,$color,$type)=@_;
$color="\@darkorange" if (!defined ($color) or $color eq "");
if (!defined ($type) or $type == 3) {
return ($value,"","iconRadio,$color,0,light_light_dim_00,50,light_light_dim_50,100,light_light_dim_100","set");
} elsif ($type == 4) {
return ($value,"","iconRadio,$color,0,light_light_dim_00,50,light_light_dim_50,70,light_light_dim_70,100,light_light_dim_100","set");
} elsif ($type == 5) {
return ($value,"","iconRadio,$color,0,light_light_dim_00,30,light_light_dim_30,50,light_light_dim_50,70,light_light_dim_70,100,light_light_dim_100","set");
} elsif ($type == 6) {
return ($value,"","iconRadio,$color,0,light_light_dim_00,30,light_light_dim_30,50,light_light_dim_50,70,light_light_dim_70,80,light_light_dim_80,100,light_light_dim_100","set");
} elsif ($type >= 7) {
return ($value,"","iconRadio,$color,0,light_light_dim_00,20,light_light_dim_20,30,light_light_dim_30,50,light_light_dim_50,70,light_light_dim_70,80,light_light_dim_80,100,light_light_dim_100","set");
} elsif ($type == 2) {
return ($value,"","iconRadio,$color,0,light_light_dim_00,100,light_light_dim_100","set");
}
}
sub switch {
my ($value,$icon_off,$icon_on,$state_off,$state_on)=@_;
$state_on=(defined ($state_on) and $state_on ne "") ? $state_on : "on";
$state_off=(defined ($state_off) and $state_off ne "") ? $state_off : "off";
my $i_off=(defined ($icon_off) and $icon_off ne "") ? $icon_off : "off";
$icon_on=((defined ($icon_on) and $icon_on ne "") ? $icon_on :(defined ($icon_off) and $icon_off ne "") ? "$icon_off\@DarkOrange" : "on");
return($value,"",("iconSwitch,".$state_on.",".$i_off.",".$state_off.",".$icon_on));
}
sub ICON {
my ($icon)=@_;
::FW_makeImage($icon);
}
sub icon {
my ($value,$icon_off,$icon_on,$state_off,$state_on)=@_;
$state_on=(defined ($state_on) and $state_on ne "") ? $state_on : "on";
$state_off=(defined ($state_off) and $state_off ne "") ? $state_off : "off";
my $i_off=(defined ($icon_off) and $icon_off ne "") ? $icon_off : "off";
$icon_on=((defined ($icon_on) and $icon_on ne "") ? $icon_on :(defined ($icon_off) and $icon_off ne "") ? "$icon_off\@DarkOrange" : "on");
return($value,"",("iconLabel,".$state_on.",".$icon_on.",".$state_off.",".$i_off));
}
sub icon_label
{
my ($icon,$text,$color,$color_bg,$pos_left,$pos_top) = @_;
$color = "" if (!defined ($color));
$color_bg = "" if (!defined ($color_bg));
$pos_left = -3 if (!defined ($pos_left));
$pos_top = -8 if (!defined ($pos_top));
my $pad = (length($text) > 1) ? 2 : 5;
return ''.::FW_makeImage($icon).'
'.$text.'
'
}
sub hsv {
return(::DOIF_hsv(@_));
}
1;
=pod
=item helper
=item summary universal module, it works event- and time-controlled
=item summary_DE universelles Modul, welches ereignis- und zeitgesteuert Anweisungen ausführt
=begin html
DOIF
DOIF is a universal module. It works event- and time-controlled.
It combines the functionality of a notify, at-, watchdog command with logical queries.
Complex problems can be solved with this module, which would otherwise be solved only with several modules at different locations in FHEM. This leads to clear solutions and simplifies their maintenance.
Logical queries are created in conditions using Perl operators.
These are combined with information from states, readings, internals of devices or times in square brackets.
Arbitrary Perl functions can also be specified that are defined in FHEM.
The module is triggered by time or by events information through the Devices specified in the condition.
If a condition is true, the associated FHEM- or Perl commands are executed.
Syntax FHEM-Mode:
define <name> DOIF (<condition>) (<commands>) DOELSEIF (<condition>) (<commands>) DOELSEIF ... DOELSE (<commands>)
Syntax Perl-Mode:
define <name> DOIF <Blockname> {<Perl with DOIF-Syntax>} <Blockname> {<Perl with DOIF-Syntax>} ...
The commands are always processed from left to right. There is only one command executed, namely the first, for which the corresponding condition in the processed sequence is true. In addition, only the conditions are checked, which include a matching device of the trigger (in square brackets).
Features
+ intuitive syntax, as used in branches (if - elseif-....elseif - else) in higher-level languages
+ in the condition of any logical queries can be made as well as perl functions are used (full perl support)
+ it can be any FHEM commands and perl commands are executed
+ syntax checking at the time of definition are identified missing brackets
+ status is specified with [<devicename>]
, readings with [<devicename>:<readingname>]
or internals with [<devicename>:&<internal>]
+ time information on the condition: [HH:MM:SS]
or [HH:MM]
or [<seconds>]
+ indirect time on the condition: [[<devicename>]]
or [[<devicename>:<readingname>]]
or [{<perl-function>}]
+ time calculation on the condition: [(<time calculation in Perl with time syntax specified above>)]
+ time intervals: [<begin>-<end>]
for <begin>
and <end>
, the above time format can be selected.
+ relative times preceded by a plus sign [+<time>]
or [+<begin>-+<end>]
combined with Perl functions
+ weekday control: [<time>|0123456789]
or [<begin>-<end>|0123456789]
(0-6 corresponds to Sunday through Saturday) such as 7 for $we, 8 for !$we, 9 for $we tomorrow ($twe)
+ statuses, readings, internals und time intervals for only queries without trigger with [?...]
+ DOELSEIF cases and DOELSE at the end are optional
+ delay specification with resetting is possible (watchdog function)
+ the execution part can be left out in each case. So that the module can be used for pure status display.
+ definition of the status display with use of any readings or statuses
Many examples with english identifiers - see german section.
=end html
=begin html_DE
DOIF
DOIF (ausgeprochen: du if, übersetzt: tue wenn) ist ein universelles Modul mit Web-Interface, welches ereignis- und zeitgesteuert in Abhängigkeit definierter Bedingungen Anweisungen ausführt.
Mit diesem Modul ist es möglich, einfache wie auch komplexere Automatisierungsvorgänge zu definieren oder in Perl zu programmieren.
Ereignisse, Zeittrigger, Readings oder Status werden durch DOIF-spezifische Angaben in eckigen Klammern angegeben. Sie führen zur Triggerung des Moduls und damit zur Auswertung und Ausführung der definierten Anweisungen.
Das Modul verfügt über zwei Modi: FHEM-Modus und Perl-Modus. Der Modus eines definierten DOIF-Devices wird automatisch aufgrund der Definition vom Modul erkannt
(FHEM-Modus beginnt mit einer runden Klammer auf).
Der Perl-Modus kommt weitgehend ohne Attribute aus, er ist aufgrund seiner Flexibilität,
der Möglichkeit strukturiert zu programmieren und seiner hohen Performance insb. bei umfangreichen Automatisierungsaufgaben dem FHEM-Modus vorzuziehen. Hier geht´s zum Perl-Modus.
Beide Modi sind innerhalb eines DOIF-Devices nicht miteinander kombinierbar.
Syntax FHEM-Modus:
define <name> DOIF (<Bedingung>) (<Befehle>) DOELSEIF (<Bedingung>) (<Befehle>) DOELSEIF ... DOELSE (<Befehle>)
Die Angaben werden immer von links nach rechts abgearbeitet. Logische Abfragen werden in DOIF/DOELSEIF-Bedingungen vornehmlich mit Hilfe von and/or-Operatoren erstellt.
Zu beachten ist, dass nur die Bedingungen überprüft werden,
die zum ausgelösten Event das dazughörige Device bzw. die dazugehörige Triggerzeit beinhalten.
Kommt ein Device in mehreren Bedingungen vor, so wird immer nur ein Kommando ausgeführt, und zwar das erste,
für das die dazugehörige Bedingung in der abgearbeiteten Reihenfolge wahr ist.
Das DOIF-Modul arbeitet mit Zuständen. Jeder Ausführungszweig DOIF/DOELSEIF..DOELSEIF/DOELSE stellt einen eigenen Zustand dar (cmd_1, cmd_2, usw.).
Das Modul merkt sich den zuletzt ausgeführten Ausführungszweig und wiederholt diesen standardmäßig nicht.
Ein Ausführungszweig wird erst dann wieder ausgeführt, wenn zwischenzeitlich ein anderer Ausführungszweig ausgeführt wurde, also ein Statuswechsel des DOIF-Moduls stattgefunden hat.
Dieses Verhalten ist sinnvoll, um zu verhindern, dass zyklisch sendende Sensoren (Temperatur, Feuchtigkeit, Helligkeit, usw.) zu ständiger Wiederholung des selben Befehls oder Befehlsabfolge führen.
Das Verhalten des Moduls im FHEM-Modus kann durch diverse Attribute verändert werden. Im FHEM-Modus wird maximal nur ein Zweig pro Ereignis- oder Zeit-Trigger ausgeführt, es gibt nur einen Wait-Timer.
Einfache Anwendungsbeispiele (vgl. Anwendungsbeispiele im Perl-Modus):
Fernbedienung (Ereignissteuerung)
define di_rc_tv DOIF ([remotecontol:"on"]) (set tv on) DOELSE (set tv off)
Zeitschaltuhr (Zeitsteuerung)
define di_clock_radio DOIF ([06:30|Mo Di Mi] or [08:30|Do Fr Sa So]) (set radio on) DOELSEIF ([08:00|Mo Di Mi] or [09:30|Do Fr Sa So]) (set radio off)
Kombinierte Ereignis- und Zeitsteuerung
define di_lamp DOIF ([06:00-09:00] and [sensor:brightness] < 40) (set lamp on) DOELSE (set lamp off)
Eine ausführliche Erläuterung der obigen Anwendungsbeispiele kann hier nachgelesen werden:
Erste Schritte mit DOIF
Inhaltsübersicht (Beispiele im Perl-Modus sind besonders gekennzeichnet)
Attribute
Set Befehle
Get Befehle
Lesbarkeit der Definitionen back
Da die Definitionen im Laufe der Zeit recht umfangreich werden können, sollten die gleichen Regeln, wie auch beim Programmieren in höheren Programmiersprachen, beachtet werden.
Dazu zählen: das Einrücken von Befehlen, Zeilenumbrüche sowie das Kommentieren seiner Definition, damit man auch später noch die Funktionalität seines Moduls nachvollziehen kann.
Das Modul unterstützt dazu Einrückungen, Zeilenumbrüche an beliebiger Stelle und Kommentierungen beginnend mit ## bis zum Ende der Zeile.
Die Formatierungen lassen sich im DEF-Editor der Web-Oberfläche vornehmen.
So könnte eine Definition aussehen:
define di_Modul DOIF ([Switch1] eq "on" and [Switch2] eq "on") | ## wenn Schalter 1 und Schalter 2 on ist
|
(set lamp on)
| ## wird Lampe eingeschaltet |
DOELSE | ## im sonst-Fall, also wenn einer der Schalter off ist
|
(set lamp off)
| ## wird die Lampe ausgeschaltet |
Perl-Modus:
define di_Modul DOIF
{ if ([Switch1] eq "on" and [Switch2] eq "on") { | ## wenn Schalter 1 und Schalter 2 on ist
|
fhem_set "lamp on"
| ## wird Lampe eingeschaltet |
} else { | ## im sonst-Fall, also wenn einer der Schalter off ist
|
fhem_set "lamp off"
| ## wird die Lampe ausgeschaltet |
}
|
}
|
Im Folgenden wird die Funktionalität des Moduls im Einzelnen an vielen praktischen Beispielen erklärt.
Ereignissteuerung back
Vergleichende Abfragen werden in der Bedingung, mit Perl-Operatoren ==, !=, <, <=, >, >=
bei Zahlen und mit eq, ne, lt, le, gt, ge, =~, !~
bei Zeichenketten angegeben.
Logische Verknüpfungen sollten zwecks Übersichtlichkeit mit and
bzw. or
vorgenommen werden.
Die Reihenfolge der Auswertung wird, wie in höheren Sprachen üblich, durch runde Klammern beeinflusst.
Status werden mit [<devicename>]
, Readings mit [<devicename>:<readingname>]
,
Internals mit [<devicename>:&<internal>]
angegeben.
Anwendungsbeispiel: Einfache Ereignissteuerung, "remotecontrol" ist hier ein Device, es wird in eckigen Klammern angegeben. Ausgewertet wird der Status des Devices - nicht das Event.
define di_garage DOIF ([remotecontrol] eq "on") (set garage on) DOELSEIF ([remotecontrol] eq "off") (set garage off)
Das Modul wird getriggert, sobald das angegebene Device hier "remotecontrol" ein Event erzeugt. Das geschieht, wenn irgendein Reading oder der Status von "remotecontrol" aktualisiert wird.
Ausgewertet wird hier der Zustand des Status von remotecontrol nicht das Event selbst. Im FHEM-Modus arbeitet das Modul mit Zuständen, indem es den eigenen Status auswertet.
Die Ausführung erfolgt standardmäßig nur ein mal, bis ein anderer DOIF-Zweig und damit eine Ändernung des eigenen Status erfolgt.
Das bedeutet, dass ein mehrmaliges Drücken der Fernbedienung auf "on" nur einmal "set garage on" ausführt. Die nächste mögliche Ausführung ist "set garage off", wenn Fernbedienung "off" liefert.
Wünscht man eine Ausführung des gleichen Befehls mehrfach nacheinander bei jedem Trigger, unabhängig davon welchen Status das DOIF-Modul hat,
weil z. B. Garage nicht nur über die Fernbedienung geschaltet wird, dann muss man das per "do always"-Attribut angeben:
attr di_garage do always
Bei der Angabe von zyklisch sendenden Sensoren (Temperatur, Feuchtigkeit, Helligkeit usw.) wie z. B.:
define di_heating DOIF ([sens:temperature] < 20) (set heating on)
ist die Nutzung des Attributes do always
nicht sinnvoll, da das entsprechende Kommando hier: "set heating on" jedes mal ausgeführt wird,
wenn der Temperatursensor in regelmäßigen Abständen eine Temperatur unter 20 Grad sendet.
Ohne do always
wird hier dagegen erst wieder "set heating on" ausgeführt, wenn der Zustand des Moduls auf "cmd_2" gewechselt hat, also die Temperatur zwischendurch größer oder gleich 20 Grad war.
Soll bei Nicht-Erfüllung aller Bedingungen ein Zustandswechsel erfolgen, so muss man ein DOELSE am Ende der Definition anhängen. Ausnahme ist eine einzige Bedingung ohne do always, wie im obigen Beispiel,
hierbei wird intern ein virtuelles DOELSE angenommen, um bei Nicht-Erfüllung der Bedingung einen Zustandswechsel in cmd_2 zu provozieren, da sonst nur ein einziges Mal geschaltet werden könnte, da das Modul aus dem cmd_1-Zustand nicht mehr herauskäme.
Perl-Modus:
Im Perl-Modus arbeitet das DOIF-Modul im Gegensatz zum FHEM-Modus ohne den eigenen Status auszuwerten. Es kommt immer zur Auswertung des definierten Block, wenn er getriggert wird.
Diese Verhalten entspricht dem Verhalten mit dem Attribut do always im FHEM-Modus. Damit bei zyklisch sendenden Sensoren nicht zum ständigen Schalten kommt, muss das Schalten unterbunden werden. Das obige Beispiel lässt sich, wie folgt definieren:
define di_heating DOIF {if ([sens:temperature] < 20) {if (Value("heating") ne "on") {fhem_set"heating on"}}}
Teilausdrücke abfragen back
Abfragen nach Vorkommen eines Wortes innerhalb einer Zeichenkette können mit Hilfe des Perl-Operators =~
vorgenommen werden.
Anwendungsbeispiel: Garage soll beim langen Tastendruck öffnen, hier: wenn das Wort "Long" im Status vorkommt (bei HM-Komponenten stehen im Status noch weitere Informationen).
define di_garage DOIF ([remotecontrol] =~ "Long") (set garage on)
attr di_garage do always
Perl-Modus:
define di_garage DOIF {if ([remotecontrol] =~ "Long") {fhem_set"garage on"}}
Weitere Möglichkeiten bei der Nutzung des Perl-Operators: =~
, insbesondere in Verbindung mit regulären Ausdrücken, können in der Perl-Dokumentation nachgeschlagen werden.
Ereignissteuerung über Auswertung von Events back
Eine Alternative zur Auswertung von Status oder Readings ist das Auswerten von Ereignissen (Events) mit Hilfe von regulären Ausdrücken. Der Suchstring wird als regulärer Ausdruck in Anführungszeichen angegeben.
Die Syntax lautet: [<devicename>:"<regex>"]
Anwendungsbeispiel: wie oben, jedoch wird hier nur das Ereignis (welches im Eventmonitor erscheint) ausgewertet und nicht der Status von "remotecontrol" wie im vorherigen Beispiel
define di_garage DOIF ([remotecontrol:"on"]) (set garage on) DOELSEIF ([remotecontrol:"off"]) (set garage off)
Perl-Modus:
define di_garage DOIF {if ([remotecontrol:"on"]) {fhem_set"garage on"} elsif ([remotecontrol:"off"]) {fhem_set"garage off"}}
In diesem Beispiel wird nach dem Vorkommen von "on" innerhalb des Events gesucht.
Falls "on" gefunden wird, wird der Ausdruck wahr und der if-Fall wird ausgeführt, ansonsten wird der else-if-Fall entsprechend ausgewertet.
Die Auswertung von reinen Ereignissen bietet sich dann an, wenn ein Modul keinen Status oder Readings benutzt, die man abfragen kann, wie z. B. beim Modul "sequence".
Die Angabe von regulären Ausdrücken kann recht komplex werden und würde die Aufzählung aller Möglichkeiten an dieser Stelle den Rahmen sprengen.
Weitere Informationen zu regulären Ausdrücken sollten in der Perl-Dokumentation nachgeschlagen werden.
Die logische Verknüpfung "and" mehrerer Ereignisse ist nicht sinnvoll, da zu einem Zeitpunkt immer nur ein Ereignis zutreffen kann.
Die alte Syntax [<devicename>:?<regex>]
wird aus Kompatibilitätsgründen noch unterstützt, sollte aber nicht mehr benutzt werden.
Sollen Events verschiedener Devices ausgewertet werden, so lässt sich folgende Syntax anwenden: ["<device regex>:<event regex>"]
Im Gegensatz zum notify werden vom DOIF-Modul selbst keine Regex-Sonderzeichen hinzugefügt. Insb. wird kein ^ für Anfang vorangestellt, bzw. kein $ für Ende angehängt.
Beispiele für Regex-Angaben:
["FS"] triggert auf alle Devices, die "FS" im Namen beinhalten
["^FS"] triggert auf alle Devices, die mit "FS" im Namen anfangen
["FS:temp"] triggert auf alle Devices, die "FS" im Namen und "temp" im Event beinhalten
([":^temp"]) triggert auf beliebige Devices, die im Event mit "temp" beginnen
(["^FS$:^temp$"] triggert auf Devices, die genau "FS" heißen und im Event genau "temp" vorkommt
[""] triggert auf alles
In der Bedingung und im Ausführungsteil werden die Schlüsselwörter $SELF durch den eigenen Namen des DOIF-Moduls, $DEVICE durch das aktuelle Device, $EVENT durch die passende Eventzeile, $EVENTS kommagetrennt durch alle Eventzeilen des Triggers ersetzt.
Entsprechend können Perl-Variablen in der DOIF-Bedingung ausgewertet werden, sie werden in Kleinbuchstaben geschrieben. Sie lauten: $device, $event, $events
Anwendungsbeispiele:
"Fenster offen"-Meldung
define di_window_open DOIF (["^window_:open"]) (set Pushover msg 'alarm' 'open windows $DEVICE' '' 2 'persistent' 30 3600)
attr di_window_open do always
Perl-Modus:
define di_window_open DOIF {if (["^window_:open"]) {fhem_set"Pushover msg 'alarm' 'open windows $DEVICE' '' 2 'persistent' 30 3600"}}
Hier werden alle Fenster, die mit dem Device-Namen "window_" beginnen auf "open" im Event überwacht.
Allgemeine Ereignistrigger können ebenfalls so definiert werden, dass sie nicht nur wahr zum Triggerzeitpunkt und sonst nicht wahr sind,
sondern Inhalte des Ereignisses zurückliefern. Initiiert wird dieses Verhalten durch die Angabe eines Default-Wertes.
Syntax:
["regex for trigger",<default value>]
Anwendungsbeispiel:
define di_warning DOIF ([":^temperature",0]< 0) (set pushmsg danger of frost $DEVICE)
attr di_warning do always
Perl-Modus:
define di_warning DOIF {if ([":^temperature",0]< 0) {fhem_set"pushmsg danger of frost $DEVICE}}
Damit wird auf alle Devices getriggert, die mit "temperature" im Event beginnen. Zurückgeliefert wird der Wert, der im Event hinter "temperature: " steht.
Wenn kein Event stattfindet, wird der Defaultwert, hier 0, zurückgeliefert.
Ebenfalls kann ein Ereignisfilter mit Ausgabeformatierung angegeben werden.
Syntax:
["regex for trigger":"<regex filter>":<output>,<default value>]
Regex-Filter- und Output-Parameter sind optional. Der Default-Wert ist verpflichtend.
Die Angaben zum Filter und Output funktionieren, wie die beim Reading-Filter. Siehe: Filtern nach Ausdrücken mit Ausgabeformatierung
Wenn kein Filter, wie obigen Beispiel, angegeben wird, so wird intern folgende Regex vorbelegt: "[^\:]*: (.*)" Damit wird der Wert hinter der Readingangabe genommen.
Durch eigene Regex-Filter-Angaben kann man beliebige Teile des Events herausfiltern, ggf. über Output formatieren und in der Bedingung entsprechend auswerten,
ohne auf Readings zurückgreifen zu müssen.
Filtern nach Ausdrücken mit Ausgabeformatierung back
Syntax: [<device>:<reading>|<internal>:d<number>|"<regex>":<output>]
d - Der Buchstabe "d" ist ein Synonym für das Filtern nach Dezimalzahlen, es entspricht intern dem regulären Ausdruck "(-?\d+(\.\d+)?)". Ebenfalls lässt sich eine Dezimalzahl auf eine bestimmte Anzahl von Nachkommastellen runden. Dazu wird an das "d" eine Ziffer angehängt. Mit der Angabe d0 wird die Zahl auf ganze Zahlen gerundet.
<Regex>- Der reguläre Ausdruck muss in Anführungszeichen angegeben werden. Dabei werden Perl-Mechanismen zu regulären Ausdrücken mit Speicherung der Ergebnisse in Variablen $1, $2 usw. genutzt.
<Output> - ist ein optionaler Parameter, hier können die in den Variablen $1, $2, usw. aus der Regex-Suche gespeicherten Informationen für die Aufbereitung genutzt werden. Sie werden in Anführungszeichen bei Texten oder in Perlfunktionen angegeben. Wird kein Output-Parameter angegeben, so wird automatisch $1 genutzt.
Beispiele:
Es soll aus einem Reading, das z. B. ein Prozentzeichen beinhaltet, nur der Zahlenwert für den Vergleich genutzt werden:
define di_heating DOIF ([adjusting:actuator:d] < 10) (set heating off) DOELSE (set heating on)
Alternativen für die Nutzung der Syntax am Beispiel des Filterns nach Zahlen:
[mydevice:myreading:d]
entspricht:
[mydevice:myreading:"(-?\d+(\.\d+)?)"]
entspricht:
[mydevice:myreading:"(-?\d+(\.\d+)?)":$1]
entspricht:
[mydevice:myreading:"(-?\d+(\.\d+)?)":"$1"]
entspricht:
[mydevice:myreading:"(-?\d+(\.\d+)?)":sprintf("%s":$1)]
Es soll die Zahl aus einem Reading auf 3 Nachkommastellen formatiert werden:
[mydevice:myreading:d3]
Es soll aus einem Text eine Zahl herausgefiltert werden und anschließend gerundet auf zwei Nachkommastellen mit der Einheit °C ausgeben werden:
... (set mydummy [mydevice:myreading:d2:"$1 °C"])
Es sollen aus einem Reading der Form "HH:MM:SS" die Stunden, Minuten und Sekunden separieret werden:
[mydevice:myreading:"(\d\d):(\d\d):(\d\d)":"hours: $1, minutes $2, seconds: $3"]
Der Inhalt des Dummys Alarm soll in einem Text eingebunden werden:
[alarm:state:"(.*)":"state of alarm is $1"]
Die Definition von regulären Ausdrücken mit Nutzung der Perl-Variablen $1, $2 usw. kann in der Perldokumentation nachgeschlagen werden.
Durchschnitt, Median, Differenz, anteiliger Anstieg back
Die folgenden Funktionen werden auf die letzten gesendeten Werte eines Readings angewendet. Das angegebene Reading muss Events liefern, damit seine Werte intern im Modul gesammelt und die Berechnung der angegenen Funktion erfolgen kann.
Syntax
[<device>:<reading>:<function><number of last values>]
<number of last values> ist optional. Wird sie nicht angegeben, so werden bei Durchschnitt/Differenz/Anstieg die letzten beiden Werte, bei Median die letzten drei Werte, ausgewertet.
Durchschnitt
Funktion: avg
Bsp.:
define di_cold DOIF ([outdoor:temperature:avg5] < 10)(set cold on)
Wenn der Durchschnitt der letzten fünf Werte unter 10 Grad ist, dann wird die Anweisung ausgeführt.
Median
Mit Hilfe des Medians können punktuell auftretende Ausreißer eliminiert werden.
Funktion: med
Bsp.:
define di_frost DOIF ([$SELF:outTempMed] < 0) (set warning frost)
attr di_frost event_Readings outTempMed:[outdoor:temperature:med]
Die Definition über das Attribut event_Readings hat den Vorteil, dass der bereinigte Wert im definierten Reading visualisiert und geloggt werden kann (med entspricht med3).
Differenz
Es wird die Differenz zwischen dem letzten und dem x-ten zurückliegenden Wert berechnet.
Funktion: diff
Bsp.:
define temp_abfall DOIF ([outdoor:temperature:diff5] < -3) (set temp fall in temperature)
Wenn die Temperaturdifferenz zwischen dem letzten und dem fünftletzten Wert um mindestens drei Grad fällt, dann Anweisung ausführen.
anteiliger Anstieg
Funktion: inc
Berechnung:
(letzter Wert - zurückliegender Wert)/zurückliegender Wert
Bsp.:
define humidity_warning DOIF ([bathroom:humidiy:inc] > 0.1) (set bath speak open window)
Wenn die Feuchtigkeit im Bad der letzten beiden Werte um über zehn Prozent ansteigt, dann Anweisung ausführen (inc entspricht inc2).
Zu beachten:
Der Durchschnitt/Median/Differenz/Anstieg werden bereits gebildet, sobald die ersten Werte eintreffen. Beim ersten Wert ist der Durchschnitt bzw. Median logischerweise der Wert selbst,
Differenz und der Anstieg ist in diesem Fall 0. Die intern gesammelten Werte werden nicht dauerhaft gespeichert, nach einem Neustart sind sie gelöscht. Die angegebenen Readings werden intern automatisch für die Auswertung nach Zahlen gefiltert.
Angaben im Ausführungsteil (gilt nur für FHEM-Modus): back
Der Ausführungsteil wird durch runde Klammern eingeleitet. Es werden standardmäßig FHEM-Befehle angegeben, wie z. B.: ...(set lamp on)
Sollen mehrere FHEM-Befehle ausgeführt werden, so werden sie mit Komma statt mit Semikolon angegeben ... (set lamp1 on, set lamp2 off)
Falls ein Komma nicht als Trennzeichen zwischen FHEM-Befehlen gelten soll, so muss der FHEM-Ausdruck zusätzlich in runde Klammern gesetzt werden: ...((set lamp1,lamp2 on),set switch on)
Perlbefehle werden in geschweifte Klammern gesetzt: ... {system ("wmail Peter is at home")}
. In diesem Fall können die runden Klammern des Ausführungsteils weggelassen werden.
Perlcode kann im DEF-Editor wie gewohnt programmiert werden: ...{my $name="Peter"; system ("wmail $name is at home");}
FHEM-Befehle lassen sich mit Perl-Befehlen kombinieren: ... ({system ("wmail Peter is at home")}, set lamp on)
Aggregieren von Werten back
Mit Hilfe der Aggregationsfunktion können mehrere gleichnamige Readings im System ausgewertet werden, die einem bestimmten Kriterium entsprechen. Sie wird in eckigen Klammern durch ein # (aggregierter Wert) oder @ (Liste der passeden Devices) eingeleitet.
Es kann bestimmt werden: die Anzahl der Readings bzw. Devices, Durchschnittswert, Summe, höchster Wert, niedrigster Wert oder eine Liste der dazugehörigen Devices.
Die Aggregationsfunktion kann in einer DOIF-Bedingungen, im Ausführungsteil oder mit Hilfe des state-Attributs im Status angegeben werden. In der Bedingung und im Status reagiert sie auf Ereignistrigger. Das lässt sich durch ein vorangestelltes Fragezeichen unterbinden.
Die Angabe des Readings kann weggelassen werden, dann wird lediglich nach entsprechenden Devices gesucht.
Syntax:
[<function>:<format>:"<regex device>:<regex event>":<reading>|"<regex reading>":<condition>,<default>]
<function>:
# Anzahl der betroffenen Devices, der folgende Doppelpunkt kann weggelassen werden
@ kommagetrennte Liste Devices, der folgende Doppelpunkt kann weggelassen werden
#sum Summe
#max höchster Wert
#min niedrigster Wert
#average Durchschnitt
@max Device des höchsten Wertes
@min Device de niedrigsten Wertes
<format> d<number>
zum Runden des Wertes mit Nachkommastellen, a
für Aliasnamen bei Devicelisten, s(<splittoken>)
<splittoken> sind Trennzeichen in der Device-Liste
"<regex Device>:<regex Event>" spezifiziert sowohl die betroffenen Devices, als auch den Ereignistrigger, die Syntax entspricht der DOIF-Syntax für Ereignistrigger.
Die Angabe <regex Event> ist im Ausführungsteil nicht sinnvoll und sollte weggelassen werden.
<reading> Reading, welches überprüft werden soll
"<regex reading>"; Regex für Readings, die überprüft werden sollen
<condition> Aggregations-Bedingung, $_ ist der Platzhalter für den aktuellen Wert des internen Schleifendurchlaufs, Angaben in Anführungszeichen der Art "<value>" entsprechen $_ =~ "<value>" , hier sind alle Perloperatoren möglich.
<default> Default-Wert, falls kein Device gefunden wird, entspricht der Syntax des Default-Wertes bei Readingangaben
<format>, <reading>, <condition>, <default> sind optional
Syntax-Beispiele im Ausführungteil
Anzahl der Devices, die mit "window" beginnen:
[#"^window"]
Liste der Devices, die mit "window" beginnen, es werden Aliasnamen ausgegeben, falls definiert:
[@:a"^window"]
Liste der Devices, die mit "windows" beginnen und ein Reading "myreading" beinhalten:
[@"^window":myreading]
Liste der Devices, die mit "windows" beginnen und im Status das Wort "open" vorkommt:
[@"^window":state:"open"]
entspricht:
[@"^window":state:$_ =~ "open"]
siehe Aggregationsbedingung.
Kleinster Wert der Readings des Devices "abfall", in deren Namen "Gruenschnitt" vorkommt und die mit "_days" enden:
[#min:"^abfall$":"Gruenschnitt.*_days$"]
Durchschnitt von Readings aller Devices, die mit "T_" beginnen, in deren Reading-Namen "temp" vorkommt:
[#average:"^T_":"temp"]
In der Aggregationsbedingung können alle in FHEM definierten Perlfunktionen genutzt werden. Folgende Variablen sind vorbelegt und können ebenfalls benutzt werden:
$_ Inhalt des angegebenen Readings (s.o.)
$number Nach Zahl gefilteres Reading
$name Name des Devices
$TYPE Devices-Typ
$STATE Status des Devices (nicht das Reading state)
$room Raum des Devices
$group Gruppe des Devices
Beispiele für Definition der Aggregationsbedingung <condition>:
Liste der Devices, die mit "rooms" enden und im Reading "temperature" einen Wert größer 20 haben:
[@"rooms$":temperature:$_ > 20]
Liste der Devices im Raum "livingroom", die mit "rooms" enden und im Reading "temperature" einen Wert größer 20 haben:
[@"rooms$":temperature:$_ > 20 and $room eq "livingroom"]
Liste der Devices in der Gruppe "windows", die mit "rooms" enden, deren Status (nicht state-Reading) "on" ist:
[@"rooms$"::$STATE eq "on" and $group eq "windows"]
Liste der Devices, deren state-Reading "on" ist und das Attribut disable nicht auf "1" gesetzt ist:
[@"":state:$_ eq "on" and AttrVal($name,"disable","") ne "1"]
Aggregationsangaben in der DOIF-Bedingung reagieren zusätzlich auf Ereignistrigger, hier sollte die regex-Angabe für das Device um eine regex-Angabe für das zu triggernde Event erweitert werden.
Anzahl der Devices, die mit "window" beginnen. Getriggert wird, wenn eine Eventzeile beginnend mit "window" und dem Wort "open" vorkommt:
[#"^window:open"]
Anwendungsbeispiele
Statusanzeige: Offene Fenster:
define di_window DOIF
attr di_window state Offene Fenster: [@"^window:open":state:"open","keine"]
Statusanzeige: Alle Devices, deren Batterie nicht ok ist:
define di_battery DOIF
attr di_battery state [@":battery":battery:$_ ne "ok","alle OK"]
Statusanzeige: Durchschnittstemperatur aller Temperatursensoren in der Gruppe "rooms":
define di_average_temp DOIF
attr di_average_temp state [#average:d2:":temperature":temperature:$group eq "rooms"]
Fenster Status/Meldung:
define di_Fenster DOIF (["^Window:open"])
(push "Fenster $DEVICE wurde geöffnet. Es sind folgende Fenster offen: [@"^Window":state:"open"]")
DOELSEIF ([#"^Window:closed":state:"open"] == 0)
(push "alle Fenster geschlossen")
attr di_Fenster do always
attr di_Fenster cmdState [$SELF:Device] zuletzt geöffnet|alle geschlossen
Raumtemperatur-Überwachung:
define di_temp DOIF (([08:00] or [20:00]) and [?#"^Rooms":temperature: $_ < 20] != 0)
(push "In folgenden Zimmern ist zu kalt [@"^Rooms":temperature:$_ < 20,"keine"]")
DOELSE
(push "alle Zimmmer sind warm")
attr di_temp do always
attr di_Raumtemp state In folgenden Zimmern ist zu kalt: [@"^Rooms":temperature:$_ < 20,"keine"])
Es soll beim Öffnen eines Fensters eine Meldung über alle geöffneten Fenster erfolgen:
define di_Fenster DOIF (["^Window:open"]) (push "Folgende Fenster: [@"^Window:state:"open"] sind geöffnet")
attr di_Fenster do always
Wenn im Wohnzimmer eine Lampe ausgeschaltet wird, sollen alle anderen Lampen im Wohnzimmer ebenfalls ausgeschaltet werden, die noch an sind:
define di_lamp DOIF (["^lamp_livingroom: off"]) (set [@"^lamp_livingroom":state:"on","defaultdummy"] off)
attr di_lamp DOIF do always
Mit der Angabe des Default-Wertes "defaultdummy", wird verhindert, dass der set-Befehl eine Fehlermeldung liefert, wenn die Device-Liste leer ist. Der angegebene Default-Dummy muss zuvor definiert werden.
Für reine Perlangaben gibt es eine entsprechende Perlfunktion namens AggrDoIf(<function>,<regex Device>,<reading>,<condition>,<default>)
diese liefert bei der Angabe @ ein Array statt einer Stringliste, dadurch lässt sie sich gut bei foreach-Schleifen verwenden.
Beispiele
Perl-Modus:
define di_Fenster DOIF {if (["^Window:open"]) {foreach (AggrDoIf('@','^windows','state','"open"')) {Log3 "di_Fenster",3,"Das Fenster $_ ist noch offen"}}}
define di_Temperature DOIF {if (["^room:temperature"]) {foreach (AggrDoIf('@','^room','temperature','$_ < 15')) {Log3 "di_Temperatur",3,"im Zimmer $_ ist zu kalt"}}
Zeitsteuerung back
Zeitangaben in der Bedingung im Format: [HH:MM:SS]
oder [HH:MM]
oder [Zahl]
Anwendungsbeispiele:
Einschalten um 8:00 Uhr, ausschalten um 10:00 Uhr.
define di_light DOIF ([08:00]) (set switch on) DOELSEIF ([10:00]) (set switch off)
Perl-Modus:
define di_light DOIF
{[08:00];fhem_set"switch on"}
{[10:00];fhem_set"switch on"}
Zeitsteuerung mit mehreren Zeitschaltpunkten:
define di_light DOIF ([08:00] or [10:00] or [20:00]) (set switch on) DOELSEIF ([09:00] or [11:00] or [00:00]) (set switch off)
Perl-Modus:
define di_light DOIF
{if ([08:00] or [10:00] or [20:00]) {fhem_set"switch on"}}
{if ([09:00] or [11:00] or [00:00]) {fhem_set"switch off"}}
Relative Zeitangaben back
Zeitangaben, die mit Pluszeichen beginnen, werden relativ behandelt, d. h. die angegebene Zeit wird zum aktuellen Zeitpunkt hinzuaddiert.
Anwendungsbeispiel: Automatisches Speichern der Konfiguration im Stundentakt:
define di_save DOIF ([+01:00]) (save)
attr di_save do always
Perl-Modus:
define di_save DOIF {[+01:00];fhem"save"}
Ebenfalls lassen sich relative Angaben in Sekunden angeben. [+01:00] entspricht [+3600];
Zeitangaben nach Zeitraster ausgerichtet back
Das Format lautet: [:MM] MM sind Minutenangaben zwischen 00 und 59.
Anwendungsbeispiel: Viertelstunden-Gong
Perl-Modus:
define di_gong DOIF
{[:00];system"mplayer /opt/fhem/Sound/BigBen_00.mp3 -volume 90 −really−quiet &"}
{[:15];system"mplayer /opt/fhem/Sound/BigBen_15.mp3 -volume 90 −really−quiet &"}
{[:30];system"mplayer /opt/fhem/Sound/BigBen_30.mp3 -volume 90 −really−quiet &"}
{[:45];system"mplayer /opt/fhem/Sound/BigBen_45.mp3 -volume 90 −really−quiet &"}
Relative Zeitangaben nach Zeitraster ausgerichtet back
Das Format lautet: [+:MM] MM sind Minutenangaben zwischen 1 und 59.
Anwendungsbeispiel: Gong alle fünfzehn Minuten um XX:00 XX:15 XX:30 XX:45
define di_gong DOIF ([+:15]) (set Gong_mp3 playTone 1)
attr di_gong do always
Perl-Modus:
define di_gong DOIF {[+:15];fhem_set"Gong_mp3 playTone 1"}
Zeitangaben nach Zeitraster ausgerichtet alle X Stunden back
Format: [+[h]:MM] mit: h sind Stundenangaben zwischen 2 und 23 und MM Minuten zwischen 00 und 59
Anwendungsbeispiel: Es soll immer fünf Minuten nach einer vollen Stunde alle 2 Stunden eine Pumpe eingeschaltet werden, die Schaltzeiten sind 00:05, 02:05, 04:05 usw.
define di_gong DOIF ([+[2]:05]) (set pump on-for-timer 300)
attr di_gong do always
Perl-Modus:
define di_gong DOIF {[+[2]:05];fhem_set"pump on-for-timer 300"}
Wochentagsteuerung back
Hinter der Zeitangabe kann ein oder mehrere Wochentage getrennt mit einem Pipezeichen | angegeben werden. Die Syntax lautet:
[<time>|0123456789]
0-9 entspricht: 0-Sonntag, 1-Montag, ... bis 6-Samstag sowie 7 für Wochenende und Feiertage (entspricht $we), 8 für Arbeitstage (entspricht !$we) und 9 für Wochenende oder Feiertag morgen (entspricht intern $twe)
alternativ mit Buchstaben-Kürzeln:
[<time>|So Mo Di Mi Do Fr Sa WE AT MWE]
WE entspricht der Ziffer 7, AT der Ziffer 8 und MWE der Ziffer 9
oder entsprechend mit englischen Bezeichnern:
[<time>|Su Mo Tu We Th Fr Sa WE WD TWE]
-
Mit Hilfe des Attributes
weekdays
können beliebige Wochentagbezeichnungen definiert werden.
Die Syntax lautet:
weekdays <Bezeichnung für Sonntag>,<Bezeichnung für Montag>,...,<Bezeichnung für Wochenende oder Feiertag>,<Bezeichnung für Arbeitstage>,<Bezeichnung für Wochenende oder Feiertag morgen>
Beispiel: di_mydoif attr weekdays Son,Mon,Die,Mit,Don,Fre,Sam,Wochenende,Arbeitstag,WochenendeMorgen
Anwendungsbeispiel: Radio soll am Wochenende und an Feiertagen um 08:30 Uhr eingeschaltet und um 09:30 Uhr ausgeschaltet werden. Am Montag und Mittwoch soll das Radio um 06:30 Uhr eingeschaltet und um 07:30 Uhr ausgeschaltet werden. Hier mit englischen Bezeichnern:
define di_radio DOIF ([06:30|Mon Wochenende] or [08:30|Wochenende]) (set radio on) DOELSEIF ([07:30|Mon Wochenende] or [09:30|Wochenende]) (set radio off)
attr di_radio weekdays Son,Mon,Die,Mit,Don,Fre,Sam,Wochenende,Arbeitstag,WochenendeMorgen
Perl-Modus:
define di_radio DOIF
{if ([06:30|Mo We] or [08:30|WE]) {fhem_set"radio on"}}
{if ([07:30|Mo We] or [09:30|WE]) {fhem_set"radio off"}}
Bemerkung: Es ist unerheblich wie die definierten Wochenttagbezeichner beim Timer angegeben werden. Sie können mit beliebigen Trennzeichen oder ohne Trennzeichen direkt aneinander angegeben werden.
Anstatt einer direkten Wochentagangabe, kann ein Status oder Reading in eckigen Klammern angegeben werden. Dieser muss zum Triggerzeitpunkt mit der gewünschten Angabe für Wochentage, wie oben definiert, belegt sein.
Anwendungsbeispiel: Der Wochentag soll über einen Dummy bestimmt werden.
define dummy myweekday
set myweekday monday wednesday thursday weekend
define di_radio DOIF ([06:30|[myweekday]]) (set radio on) DOELSEIF ([07:30|[myweekday]]) (set radio off)
attr di_radio weekdays sunday,monday,thuesday,wednesday,thursday,friday,saturday,weekend,workdays,weekendtomorrow
Perl-Modus:
define di_radio DOIF
{[06:30|[myweekday]];fhem_set"radio on"}
{[07:30|[myweekday]];fhem_set"radio off"}
attr di_radio weekdays sunday,monday,thuesday,wednesday,thursday,friday,saturday,weekend,workdays,weekendtomorrow
Zeitsteuerung mit Zeitintervallen back
Zeitintervalle werden im Format angegeben: [<begin>-<end>]
,
für <begin>
bzw. <end>
wird das gleiche Zeitformat verwendet,
wie bei einzelnen Zeitangaben. Getriggert wird das Modul zum Zeitpunkt <begin>
und zum Zeitpunkt <end>
.
Soll ein Zeitintervall ohne Zeittrigger lediglich zur Abfrage dienen, so muss hinter der eckigen Klammer ein Fragezeichen angegeben werden (siehe Beispiele weiter unten).
Das Zeitintervall ist als logischer Ausdruck ab dem Zeitpunkt <begin>
wahr und ab dem Zeitpunkt <end>
nicht mehr wahr.
Anwendungsbeispiele:
Radio soll zwischen 8:00 und 10:00 Uhr an sein:
define di_radio DOIF ([08:00-10:00]) (set radio on) DOELSE (set radio off)
Perl-Modus:
define di_radio DOIF {if ([08:00-10:00]) {fhem_set"radio on"} else {fhem_set"radio off"}}
mit mehreren Zeitintervallen:
define di_radio DOIF ([08:00-10:00] or [20:00-22:00]) (set radio on) DOELSE (set radio off)
Perl-Modus:
define di_radio DOIF {if ([08:00-10:00] or [20:00-22:00]) {fhem_set"radio on"} else {fhem_set"radio off"}}
Nur montags, mittwochs und freitags:
define di_radio DOIF ([08:00-10:00|135]) (set radio on) DOELSE (set radio off)
Nur am Wochenende bzw. an Feiertagen lt. holiday-Datei (7 entspricht $we):
define di_radio DOIF ([08:00-10:00|7]) (set radio on) DOELSE (set radio off)
Zeitintervalle über Mitternacht:
define di_light DOIF ([22:00-07:00]) (set light on) DOELSE (set light off)
in Verbindung mit Wochentagen (einschalten am Freitag ausschalten am Folgetag):
define di_light DOIF ([22:00-07:00|5]) (set light on) DOELSE (set light off)
Zeitintervalle über mehrere Tage müssen als Zeitpunkte angegeben werden.
Einschalten am Freitag ausschalten am Montag:
define di_light DOIF ([22:00|5]) (set light on) DOELSEIF ([10:00|1]) (set light off)
Perl-Modus:
define di_light DOIF
{[22:00|5];fhem_set"light on"}
{[10:00|1];fhem_set"light off"}
Schalten mit Zeitfunktionen, hier: bei Sonnenaufgang und Sonnenuntergang:
define di_light DOIF ([{sunrise(900,"06:00","08:00")}]) (set outdoorlight off) DOELSEIF ([{sunset(900,"17:00","21:00")}]) (set outdoorlight on)
Perl-Modus:
define di_light DOIF
{[{sunrise(900,"06:00","08:00")}];fhem_set"outdoorlight off"}
{[{sunset(900,"17:00","21:00")}];fhem_set"outdoorlight on"}
Indirekten Zeitangaben back
Oft möchte man keine festen Zeiten im Modul angeben, sondern Zeiten, die man z. B. über Dummys über die Weboberfläche verändern kann.
Statt fester Zeitangaben können Status, Readings oder Internals angegeben werden. Diese müssen eine Zeitangabe im Format HH:MM oder HH:MM:SS oder eine Zahl beinhalten.
Anwendungsbeispiel: Lampe soll zu einer bestimmten Zeit eingeschaltet werden. Die Zeit soll über den Dummy time
einstellbar sein:
define time dummy
set time 08:00
define di_time DOIF ([[time]])(set lamp on)
attr di_time do always
Perl-Modus:
define di_time DOIF {[[time]];fhem_set"lamp on"}
Die indirekte Angabe kann ebenfalls mit einer Zeitfunktion belegt werden. Z. B.
set time {sunset()}
Das Dummy kann auch mit einer Sekundenzahl belegt werden, oder als relative Zeit angegeben werden, hier z. B. schalten alle 300 Sekunden:
define time dummy
set time 300
define di_time DOIF ([+[time]])(save)
attr di_time do always
Perl-Modus:
define di_time DOIF {[+[time]];fhem"save"}
Ebenfalls funktionieren indirekte Zeitangaben mit Zeitintervallen. Hier wird die Ein- und Ausschaltzeit jeweils über einen Dummy bestimmt:
define begin dummy
set begin 08:00
define end dummy
set end 10:00
define di_time DOIF ([[begin]-[end]]) (set radio on) DOELSE (set radio off)
Perl-Modus:
define di_time DOIF {if([[begin]-[end]]) {fhem_set"radio on"} else {fhem_set"radio off"}}
Indirekte Zeitangaben können auch als Übergabeparameter für Zeitfunktionen, wie z. B. sunset oder sunrise übergeben werden:
define di_time DOIF ([{sunrise(0,"[begin]","09:00")}-{sunset(0,"18:00","[end]")}]) (set lamp off) DOELSE (set lamp on)
Bei einer Änderung des angegebenen Status oder Readings wird die geänderte Zeit sofort im Modul aktualisiert.
Angabe eines Readings als Zeitangabe. Beispiel: Schalten anhand eines Twilight-Readings:
define di_time DOIF ([[myTwilight:ss_weather]])(set lamp on)
attr di_timer do always
Perl-Modus:
define di_time DOIF {[[myTwilight:ss_weather]];fhem_set"lamp on"}
Indirekte Zeitangaben lassen sich mit Wochentagangaben kombinieren, z. B.:
define di_time DOIF ([[begin]-[end]|7]) (set radio on) DOELSE (set radio off)
Perl-Modus:
define di_time DOIF {if ([[begin]-[end]|7]) {fhem_set"radio on"} else {fhem_set"radio off"}}
Zeitsteuerung mit Zeitberechnung back
Zeitberechnungen werden innerhalb der eckigen Klammern zusätzlich in runde Klammern gesetzt. Die berechneten Triggerzeiten können absolut oder relativ mit einem Pluszeichen vor den runden Klammern angegeben werden.
Es können beliebige Ausdrücke der Form HH:MM und Angaben in Sekunden als ganze Zahl in Perl-Rechenoperationen kombiniert werden.
Perlfunktionen, wie z. B. sunset(), die eine Zeitangabe in HH:MM liefern, werden in geschweifte Klammern gesetzt.
Zeiten im Format HH:MM bzw. Status oder Readings, die Zeitangaben in dieser Form beinhalten werden in eckige Klammern gesetzt.
Anwendungsbeispiele:
Lampe wird nach Sonnenuntergang zwischen 900 und 1500 (900+600) Sekunden zufällig zeitverzögert eingeschaltet. Ausgeschaltet wird die Lampe nach 23:00 Uhr um bis zu 600 Sekunden zufällig verzögert:
define di_light DOIF ([({sunset()}+900+int(rand(600)))])
(set lamp on)
DOELSEIF ([([23:00]+int(rand(600)))])
(set lamp off)
Perl-Modus:
define di_light DOIF
{[({sunset()}+900+int(rand(600)))];fhem_set"lamp on"}
{[([23:00]+int(rand(600)))];;fhem_set"lamp off"}
Zeitberechnung können ebenfalls in Zeitintervallen genutzt werden.
Licht soll eine Stunde vor gegebener Zeit eingeschaltet werden und eine Stunde danach wieder ausgehen:
define Fixtime dummy
set Fixtime 20:00
define di_light DOIF ([([Fixtime]-[01:00]) - ([Fixtime]+[01:00])])
(set lampe on)
DOELSE
(set lampe off)
Hier das Gleiche wie oben, zusätzlich mit Zufallsverzögerung von 300 Sekunden und nur an Wochenenden:
define di_light DOIF ([([Fixtime]-[01:00]-int(rand(300))) - ([Fixtime]+[01:00]+int(rand(300)))]|7])
(set lampe on)
DOELSE
(set lampe off)
Ein Änderung des Dummys Fixtime z. B. durch "set Fixtime ...", führt zur sofortiger Neuberechnung der Timer im DOIF-Modul.
Für die Zeitberechnung wird der Perlinterpreter benutzt, daher sind für die Berechnung der Zeit keine Grenzen gesetzt.
Intervall-Timer back
Syntax:
[<begin>-<end>,<relative timer>]
Innerhalb des definierten Zeitintervalls, triggert der definierte Timer. Außerhalb des Zeitintervall wird kein Timer gesetzt.
Anwendungsbeispiel: Zwischen 08:00 und 22:00 Uhr soll eine Pumpe jede halbe Stunde für fünf Minuten eingeschaltet werden:
define di_pump DOIF ([08:00-22:00,+:30])(set pump on-for-timer 300)
attr di_pump do always
Perl-Modus:
define di_pump DOIF {[08:00-22:00,+:30];fhem_set"pump on-for-timer 300"}
Es wird um 08:00, 08:30, 09:00, ..., 21:30 Uhr die Anweisung ausgeführt. Um 22:00 wird das letzte Mal getriggert, das Zeitintervall ist zu diesem Zeitpunkt nicht mehr wahr.
Es lassen sich ebenso indirekte Timer, Timer-Funktionen, Zeitberechnungen sowie Wochentage miteinander kombinieren.
define di_rand_lamp DOIF ([{sunset()}-[end:state],+(rand(600)+900)|Sa So])(set lamp on-for-timer 300)
attr di_rand_lamp do always
Perl-Modus:
define di_rand_lamp DOIF {[{sunset()}-[end:state],+(rand(600)+900)|Sa So];fhem_set"lamp on-for-timer 300"}
Kombination von Ereignis- und Zeitsteuerung mit logischen Abfragen back
Anwendungsbeispiel: Lampe soll ab 6:00 Uhr angehen, wenn es dunkel ist und wieder ausgehen, wenn es hell wird, spätestens aber um 9:00 Uhr:
define di_lamp DOIF ([06:00-09:00] and [sensor:brightness] < 40) (set lamp on) DOELSE (set lamp off)
Anwendungsbeispiel: Rollläden sollen an Arbeitstagen nach 6:25 Uhr hochfahren, wenn es hell wird, am Wochenende erst um 9:00 Uhr, herunter sollen sie wieder, wenn es dunkel wird:
define di_shutters DOIF ([sensor:brightness]>100 and [06:25-09:00|8] or [09:00|7]) (set shutters up) DOELSEIF ([sensor:brightness]<50) (set shutters down)
Zeitintervalle, Readings und Status ohne Trigger back
Angaben in eckigen Klammern, die mit einem Fragezeichen beginnen, führen zu keiner Triggerung des Moduls, sie dienen lediglich der Abfrage.
Anwendungsbeispiel: Licht soll zwischen 06:00 und 10:00 angehen, getriggert wird nur durch den Taster nicht um 06:00 bzw. 10:00 Uhr und nicht durch das Device Home
define di_motion DOIF ([?06:00-10:00] and [button] and [?Home] eq "present")(set lamp on-for-timer 600)
attr di_motion do always
Perl-Modus:
define di_motion DOIF {if ([?06:00-10:00] and [button] and [?Home] eq "present"){fhem_set"lamp on-for-timer 600"}}
Nutzung von Readings, Status oder Internals im Ausführungsteil back
Anwendungsbeispiel: Wenn ein Taster betätigt wird, soll Lampe1 mit dem aktuellen Zustand der Lampe2 geschaltet werden:
define di_button DOIF ([button]) (set lamp1 [lamp2])
attr di_button do always
Anwendungsbeispiel: Benachrichtigung beim Auslösen eines Alarms durch Öffnen eines Fensters:
define di_pushmsg DOIF ([window] eq "open" and [alarm] eq "armed") (set Pushover msg 'alarm' 'open windows [window:LastDevice]' '' 2 'persistent' 30 3600)
Berechnungen im Ausführungsteil back
Berechnungen können in geschweiften Klammern erfolgen. Aus Kompatibilitätsgründen, muss die Berechnung unmittelbar mit einer runden Klammer beginnen.
Innerhalb der Perlberechnung können Readings, Status oder Internals wie gewohnt in eckigen Klammern angegeben werden.
Anwendungsbeispiel: Es soll ein Vorgabewert aus zwei verschiedenen Readings ermittelt werden und an das set Kommando übergeben werden:
define di_average DOIF ([08:00]) (set TH_Modul desired {([default:temperature]+[outdoor:temperature])/2})
attr di_average do always
-
Ersatzwert für nicht existierende Readings oder Status back
Es kommt immer wieder vor, dass in der Definition des DOIF-Moduls angegebene Readings oder Status zur Laufzeit nicht existieren. Der Wert ist dann leer.
Bei der Definition von Status oder Readings kann für diesen Fall ein Vorgabewert oder sogar eine Perlberechnung am Ende des Ausdrucks kommagetrennt angegeben werden.
Syntax:
[<device>,<default value>]
oder
[<device>:<reading>,<default value>]
Beispiele:
[lamp,"off"]
[room:temperatur,20]
[brightness,3*[myvalue]+2]
[heating,AttrVal("mydevice","myattr","")]
[[mytime,"10:00"]]
Möchte man stattdessen einen bestimmten Wert global für das gesamte Modul definieren,
so lässt sich das über das Attribut notexist
bewerkstelligen. Ein angegebener Default-Wert beim Status oder beim Reading übersteuert das "notexist"-Attribut.
Syntax: attr <DOIF-module> notexist "<default value>"
-
Verzögerungen back
Verzögerungen für die Ausführung von Kommandos werden pro Befehlsfolge über das Attribut "wait" definiert. Syntax:
attr <DOIF-module> wait <Sekunden für Befehlsfolge des ersten DO-Falls>:<Sekunden für Befehlsfolge des zweiten DO-Falls>:...
Sollen Verzögerungen innerhalb von Befehlsfolgen stattfinden, so müssen diese Kommandos in eigene Klammern gesetzt werden, das Modul arbeitet dann mit Zwischenzuständen.
Beispiel: Bei einer Befehlssequenz, hier: (set lamp1 on, set lamp2 on)
, soll vor dem Schalten von lamp2
eine Verzögerung von einer Sekunde stattfinden.
Die Befehlsfolge muss zunächst mit Hilfe von Klammerblöcke in eine Befehlssequenz aufgespalten werden: (set lamp1 on)(set lamp2 on)
.
Nun kann mit dem wait-Attribut nicht nur für den Beginn der Sequenz, sondern für jeden Klammerblock eine Verzögerung, getrennt mit Komma, definieren werden,
hier also: wait 0,1
. Damit wird lamp1
sofort, lamp2
eine Sekunde danach geschaltet. Die Verzögerungszeit bezieht sich immer auf den vorherigen Befehl.
Beispieldefinition bei mehreren DO-Blöcken mit Befehlssequenzen:
DOIF (Bedingung1)
(set ...) ## erster Befehl der ersten Sequenz soll um eine Sekunde verzögert werden
(set ...) ## zweiter Befehl der ersten Sequenz soll um 2 Sekunden nach dem ersten Befehl verzögert werden
DOELSEIF (Bedingung2)
(set ...) ## erster Befehl der zweiten Sequenz soll um 3 Sekunden verzögert werden
(set ...) ## zweiter Befehl der zweiten Sequenz soll um 0,5 Sekunden nach dem ersten Befehl verzögert werden
attr <DOIF-module> wait 1,2:3,0.5
Das Aufspalten einer kommagetrennten Befehlskette in eine Befehlssequenz, wie im obigen Beispiel, sollte nicht vorgenommen werden, wenn keine Verzögerungen zwischen den Befehlen benötigt werden.
Denn bei einer Befehlssequenz werden Zwischenzustände cmd1_1, cmd1_2 usw. generiert, die Events erzeugen und damit unnötig FHEM-Zeit kosten.
Für Kommandos, die nicht verzögert werden sollen, werden Sekundenangaben ausgelassen oder auf Null gesetzt. Die Verzögerungen werden nur auf Events angewandt und nicht auf Zeitsteuerung. Eine bereits ausgelöste Verzögerung wird zurückgesetzt, wenn während der Wartezeit ein Kommando eines anderen DO-Falls, ausgelöst durch ein neues Ereignis, ausgeführt werden soll.
Statt Sekundenangaben können ebenfalls Status, Readings in eckigen Klammern, Perl-Funktionen sowie Perl-Berechnung angegeben werden. Dabei werden die Trennzeichen Komma und Doppelpunkt in Klammern geschützt und gelten dort nicht als Trennzeichen.
Diese Angaben können ebenfalls bei folgenden Attributen gemacht werden: cmdpause, repeatcmd, repeatsame, waitsame, waitdel
Beispiel:
attr my_doif wait 1:[mydummy:state]*3:rand(600)+100,Attr("mydevice","myattr","")
-
Verzögerungen von Timern back
Verzögerungen können mit Hilfe des Attributs timerWithWait
auf Timer ausgeweitet werden.
Anwendungsbeispiel: Lampe soll zufällig nach Sonnenuntergang verzögert werden.
define di_rand_sunset DOIF ([{sunset()}])(set lamp on)
attr di_rand_sunset wait rand(1200)
attr di_rand_sunset timerWithWait 1
attr di_rand_sunset do always
Anwendungsbeispiel: Benachrichtigung "Waschmaschine fertig", wenn Verbrauch mindestens 5 Minuten unter 2 Watt (Perl-Code wird in geschweifte Klammern gesetzt):
define di_washer DOIF ([power:watt]<2) ({system("wmail washer finished")})
attr di_washer wait 300
Eine erneute Benachrichtigung wird erst wieder ausgelöst, wenn zwischendurch der Verbrauch über 2 Watt angestiegen war.
Anwendungsbeispiel: Rollladen um 20 Minuten zeitverzögert bei Sonne runter- bzw. hochfahren (wenn der Zustand der Sonne wechselt, wird die Verzögerungszeit zurückgesetzt):
define di_shutters DOIF ([Sun] eq "on") (set shutters down) DOELSE (set shutters up)
attr di_shutters wait 1200:1200
Anwendungsbeispiel: Beschattungssteuerung abhängig von der Temperatur. Der Rollladen soll runter von 11:00 Uhr bis Sonnenuntergang, wenn die Temperatur über 26 Grad ist. Temperaturschwankungen um 26 Grad werden mit Hilfe des wait-Attributes durch eine 15 minutige Verzögerung ausgeglichen.
define di_shutters DOIF ([sensor:temperature] > 26 and [11:00-{sunset_abs()}] (set shutters down) DOELSE (set shutters up)
attr di_shutters wait 900:900
Anwendungsbeispiel: Belüftung in Kombination mit einem Lichtschalter mit Nachlaufsteuerung. Der Lüfter soll angehen, wenn das Licht mindestens 2 Minuten lang brennt oder die Luftfeuchtigkeit 65 % überschreitet, der Lüfter soll ausgehen, drei Minuten nachdem die Luftfeuchtigkeit unter 60 % fällt und das Licht aus ist bzw. das Licht ausgeht und die Luftfeuchtigkeit unter 60% ist. Definitionen lassen sich über die Weboberfläche (DEF-Eingabebereich) übersichtlich gestalten:
define di_fan DOIF ([light] eq "on")
(set fan on)
DOELSEIF ([sensor:humidity]>65)
(set fan on)
DOELSEIF ([light] eq "off" and [sensor:humidity]<60)
(set fan off)
attr di_fan wait 120:0:180
-
Zurücksetzen des Waittimers für das gleiche Kommando back
Im Gegensatz zu do always
wird ein Waittimer mit dem Attribut do resetwait
auch dann zurückgesetzt, wenn die gleiche Bedingung wiederholt wahr wird.
Damit können Ereignisse ausgelöst werden, wenn etwas innerhalb einer Zeitspanne nicht passiert.
Das Attribut do resetwait
impliziert eine beliebige Wiederholung wie do always
. Diese lässt sich allerdings mit dem Attribut repeatsame
einschränken s. u.
Anwendungsbeispiel: Meldung beim Ausbleiben eines Events
define di_push DOIF ([Tempsensor])(set pushmsg "sensor failed again")
attr di_push wait 1800
attr di_push do resetwait
-
Wiederholung von Befehlsausführung back
Wiederholungen der Ausführung von Kommandos werden pro Befehlsfolge über das Attribut repeatcmd
definiert. Syntax:
attr <DOIF-modul> repeatcmd <Sekunden für Befehlsfolge des ersten DO-Falls>:<Sekunden für Befehlsfolge des zweiten DO-Falls>:...
Statt Sekundenangaben können ebenfalls Status in eckigen Klammen oder Perlbefehle angegeben werden.
Die Wiederholung findet so lange statt, bis der Zustand des Moduls in einen anderen DO-Fall wechselt.
Anwendungsbeispiel: Nach dem Eintreffen des Ereignisses wird die push-Meldung stündlich wiederholt, bis Frost ungleich "on" ist.
define di_push DOIF ([frost] eq "on")(set pushmsg "danger of frost")
attr di_push repeatcmd 3600
Eine Begrenzung der Wiederholungen kann mit dem Attribut repeatsame vorgenommen werden
attr di_push repeatsame 3
Ebenso lässt sich das repeatcmd-Attribut mit Zeitangaben kombinieren.
Anwendungsbeispiel: Wiederholung ab einem Zeitpunkt
define di_alarm_clock DOIF ([08:00])(set alarm_clock on)
attr di_alarm_clock repeatcmd 300
attr di_alarm_clock repeatsame 3
attr di_alarm_clock do always
Ab 8:00 Uhr wird 3 mal der Weckton jeweils nach 5 Minuten wiederholt.
Anwendungsbeispiel: Warmwasserzirkulation
define di_pump_circ DOIF ([05:00-22:00])(set pump on)(set pump off) DOELSE (set pump off)
attr di_pump_circ wait 0,300
attr di_pump_circ repeatcmd 3600
Zwischen 5:00 und 22:00 Uhr läuft die Zirkulationspumpe alle 60 Minuten jeweils 5 Minuten lang.
Anwendungsbeispiel: Anwesenheitssimulation
define di_presence_simulation DOIF ([19:00-00:00])(set lamp on-for-timer {(int(rand(1800)+300))}) DOELSE (set lamp off)
attr di_presence_simulation repeatcmd rand(3600)+2200
-
Zwangspause für das Ausführen eines Kommandos seit der letzten Zustandsänderung back
Mit dem Attribut cmdpause <Sekunden für cmd_1>:<Sekunden für cmd_2>:...
wird die Zeitspanne in Sekunden angegeben für eine Zwangspause seit der letzten Zustandsänderung.
In der angegebenen Zeitspanne wird ein Kommando nicht ausgeführt, auch wenn die dazugehörige Bedingung wahr wird.
Anwendungsbeispiel: Meldung über Frostgefahr alle 60 Minuten
define di_frost DOIF ([outdoor:temperature] < 0) (set pushmsg "danger of frost")
attr di_frost cmdpause 3600
attr di_frost do always
-
Begrenzung von Wiederholungen eines Kommandos back
Mit dem Attribut repeatsame <maximale Anzahl von cmd_1>:<maximale Anzahl von cmd_2>:...
wird die maximale Anzahl hintereinander folgenden Ausführungen festgelegt.
Anwendungsbeispiel: Die Meldung soll maximal dreimal erfolgen mit einer Pause von mindestens 10 Minuten
define di_washer DOIF ([Watt]<2) (set pushmeldung "washer finished")
attr di_washer repeatsame 3
attr di_washer cmdpause 600
Das Attribut repeatsame
lässt sich mit do always
oder do resetwait
kombinieren.
Wenn die maximale Anzahl für ein Kommando ausgelassen oder auf Null gesetzt wird, so gilt für dieses Kommando der Defaultwert "einmalige Wiederholung";
in Kombination mit do always
bzw. do resetwait
gilt für dieses Kommando "beliebige Wiederholung".
Anwendungsbeispiel: cmd_1 soll beliebig oft wiederholt werden, cmd_2 maximal zweimal
attr di_repeat repeatsame 0:2
attr di_repeat do always
-
Ausführung eines Kommandos nach einer Wiederholung einer Bedingung back
Mit dem Attribut waitsame <Zeitspanne in Sekunden für cmd_1>:<Zeitspanne in Sekunden für das cmd_2>:...
wird ein Kommando erst dann ausgeführt, wenn innerhalb einer definierten Zeitspanne die entsprechende Bedingung zweimal hintereinander wahr wird.
Für Kommandos, für die waitsame
nicht gelten soll, werden die entsprechenden Sekundenangaben ausgelassen oder auf Null gesetzt.
Anwendungsbeispiel: Rollladen soll hoch, wenn innerhalb einer Zeitspanne von 2 Sekunden ein Taster betätigt wird
define di_shuttersup DOIF ([Button])(set shutters up)
attr di_shuttersup waitsame 2
attr di_shuttersup do always
-
Löschen des Waittimers nach einer Wiederholung einer Bedingung back
Das Gegenstück zum repeatsame
-Attribut ist das Attribut waitdel
. Die Syntax mit Sekundenangaben pro Kommando entspricht der, des wait-Attributs. Im Gegensatz zum wait-Attribut, wird ein laufender Timer gelöscht, falls eine Bedingung wiederholt wahr wird.
Sekundenangaben können pro Kommando ausgelassen oder auf Null gesetzt werden.
Anwendungsbeispiel: Rollladen soll herunter, wenn ein Taster innerhalb von zwei Sekunden nicht wiederholt wird
define di_shuttersdown DOIF ([Button])(set shutters down)
attr di_shuttersdown waitdel 2
attr di_shuttersdown do always
"di_shuttersdown" kann nicht mit dem vorherigen Anwendungsbeispiel "di_shuttersup" innerhalb eines DOIF-Moduls kombiniert werden, da in beiden Fällen die gleiche Bedingung vorkommt.
siehe auch Einknopf-Fernbedienung im Perl-Modus
Die Attribute wait
und waitdel
lassen sich für verschiedene Kommandos kombinieren. Falls das Attribut für ein Kommando nicht gesetzt werden soll, kann die entsprechende Sekundenzahl ausgelassen oder eine Null angegeben werden.
Beispiel: Für cmd_1 soll wait
gelten, für cmd_2 waitdel
attr di_cmd wait 2:0
attr di_cmd waitdel 0:2
-
Readingauswertung bei jedem Event des Devices back
Bei Angaben der Art [<Device>:<Reading>]
wird das Modul getriggert, wenn ein Ereignis zum angegebenen Device und Reading kommt. Soll das Modul, wie bei Statusangaben der Art [<Device>]
, auf alle Ereignisse des Devices reagieren, so muss das Attribut auf Null gesetzt werden.
Bemerkung: In früheren Versionen des Moduls war checkReadingEvent 0
die Voreinstellung des Moduls. Da die aktuelle Voreinstellung des Moduls checkReadingEvent 1
ist, hat das Setzen von
checkReadingEvent 1
keine weitere Funktion mehr.
-
Eindeutige Statuserkennung back
Bei Änderungen des Readings state wird in FHEM standardmäßig, im Gegensatz zu allen anderen Readings, der Readingname hier: "state: " im Event nicht vorangestellt.
Möchte man eindeutig eine Statusänderung eines Moduls erkennen, so lässt sich das mit dem Attribut addStateEvent
bewerksteligen.
Bei Statusänderungen eines Devices wird bei der Angabe des Attributes addStateEvent
im Event "state: " vorangestellt, darauf kann man dann gezielt im DOIF-Modul triggern.
Beispiel:
define di_lamp ([FB:"^state: on$"]) (set lamp on)
attr di_lamp do always
attr di_lamp addStateEvent
-
Triggerung durch selbst ausgelöste Events back
Standardmäßig unterbindet das DOIF-Modul Selbsttriggerung. D. h. das Modul reagiert nicht auf Events, die es selbst direkt oder indirekt auslöst. Dadurch werden Endlosschleifen verhindert.
Wenn das Attribut selftrigger wait
gesetzt ist, kann das DOIF-Modul auf selbst ausgelöste Events reagieren. Dazu müssen die entsprchenden Kommandos mit wait verzögert werden.
Bei der Angabe selftrigger all
reagiert das Modul grundsätzlich alle selbst ausgelösten Trigger.
Zu beachten ist, dass der Zustand des Moduls erst nach der Ausführung des Befehls gesetzt wird, dadurch wird die Zustandsverwaltung (ohne do always) ausgehebelt.
Die Auswertung des eigenen Zustands z. B. über [$SELF:cmd] funktioniert dagegen korrekt, weil dieser immer bei der eigenen Triggerung bereits gesetzt ist.
Bei der Verwendung des Attributes selftrigger all
sollte beachtet werden, dass bereits in der zweiten Rekursion,
wenn ein Befehl nicht durch wait verzögert wird, FHEM eine weitere Triggerung unterbindet, um Endlosschleifen zu verhindern.
-
Setzen der Timer mit Event back
Wenn das Attribut timerevent
ungleich Null gesetzt ist, wird beim Setzen der Timer im DOIF-Modul ein Event erzeugt. Das kann z. B. bei FHEM2FHEM nützlich sein, um die Timer-Readings zeitnah zu aktualisieren.
-
Zeitspanne eines Readings seit der letzten Änderung back
Bei Readingangaben kann die Zeitspanne mit [<Device>:<Reading>:sec]
in Sekunden seit der letzten Änderung bestimmt werden.
Anwendungsbeispiel: Überwachung eines Temperatursensors
define di_monitor DOIF ([+01:00] and [?sensor:temperature:sec]>3600)(set pushbullet message sensor failed)
attr di_monitor do always
Wenn der Temperatursensor seit über einer Stunde keinen Temperaturwert geliefert hat, dann soll eine Nachricht erfolgen.
-
Alle Bedingungen prüfen back
Bei der Abarbeitung der Bedingungen, werden nur die Bedingungen überprüft,
die zum ausgelösten Event das dazughörige Device bzw. die dazugehörige Triggerzeit beinhalten. Mit dem Attribut checkall lässt sich das Verhalten so verändern,
dass bei einem Event-Trigger auch Bedingungen geprüft werden, die das triggernde Device nicht beinhalten.
Folgende Parameter können angegeben werden:
checkall event
Es werden alle Bedingungen geprüft, wenn ein Event-Trigger auslöst.
checkall timer
Es werden alle Bedingungen geprüft, wenn ein Timer-Trigger auslöst.
checkall all
Es werden grundsätzlich alle Bedingungen geprüft.
Zu beachten ist, dass bei einer wahren Bedingung die dazugehörigen Befehle ausgeführt werden und die Abarbeitung immer beendet wird -
es wird also grundsätzlich immer nur ein Befehlszweig ausgeführt und niemals mehrere.
-
Darstellungselement mit Eingabemöglichkeit im Frontend und Schaltfunktion back
Die unter Dummy beschriebenen Attribute readingList und setList stehen auch im DOIF zur Verfügung. Damit wird erreicht, dass DOIF im Web-Frontend als Eingabeelement mit Schaltfunktion dienen kann. Zusätzliche Dummys sind nicht mehr erforderlich. Es können im Attribut setList, die in FHEMWEB angegebenen Modifier des Attributs widgetOverride verwendet werden.
Anwendungsbeispiel: Eine Schaltuhr mit time-Widget für die Ein- u. Ausschaltzeiten und der Möglichkeit über eine Auswahlliste manuell ein und aus zu schalten.
define time_switch DOIF (["$SELF:mybutton: on"] or [[$SELF:mybegin,"00:00"]])
(set lamp on)
DOELSEIF (["$SELF:mybutton: off"] or [[$SELF:myend,"00:00"]])
(set lamp off)
attr time_switch cmdState on|off
attr time_switch readingList mybutton mybegin myend
attr time_switch setList mybutton:on,off mybegin:time myend:time
attr time_switch webCmd mybutton:mybegin:myend
Anwendungsbeispiel: Ausführung von Befehlen abhängig einer Auswahl ohne Zusatzreading
define di_web DOIF ([$SELF:"myInput first"]) (do something) DOELSEIF ([$SELF:"myInput second"]) (do something else)
attr di_web setList myInput:first,second
Links
readingList
setList
webCmd
webCmdLabel
widgetOverride
weiterführendes Beispiel für Tablet-UI
benutzerdefinierte Readings
Bedingungsloses Ausführen von Befehlen
-
uiTable, DOIF Web-Interface back
Mit dem Attribut uiTable kann innerhalb eines DOIF-Moduls ein Web-Interface zur Visualisierung und Steuerung von Geräten in Form einer Tabelle erstellt werden.
Die Dokumentation zu diesem Attribut wurde mit bebilderten Beispielen im FHEM-Wiki erstellt: uiTable Dokumentation
Anwendungsbeispiele für Fortgeschrittene: uiTable für Fortgeschrittene im FHEM-Wiki
-
Status des Moduls back
Der Status des Moduls wird standardmäßig mit cmd_1, cmd_2, usw., bzw. cmd1_1 cmd1_2 usw. für Befehlssequenzen belegt. Dieser lässt sich über das Attribut "cmdState" mit Komma bzw. | getrennt umdefinieren:
attr <DOIF-modul> cmdState <Status für cmd1_1>,<Status für cmd1_2>,...| <Status für cmd2_1>,<Status für cmd2_2>,...|...
Beispiele:
attr di_lamp cmdState on|off
Pro Status können ebenfalls Status oder Readings in eckigen Klammern oder Perlfunktionen sowie Berechnungen in Klammern der Form {(...)} angegeben werden.
Die Trennzeichen Komma und | sind in Klammern und Anführungszeichen geschützt und gelten dort nicht als Trennzeichen.
Zustände cmd1_1, cmd1 und cmd2 sollen wie folgt umdefiniert werden:
attr di_mytwilight cmdState [mytwilight:ss_astro], {([mytwilight:twilight_weather]*2+10)}|My attribut is: {(Attr("mydevice","myattr",""))}
Reine Statusanzeige ohne Ausführung von Befehlen back
Der Ausführungsteil kann jeweils ausgelassen werden.
Anwendungsbeispiel: Aktuelle Außenfeuchtigkeit im Status
define di_hum DOIF ([outdoor:humidity]>70) DOELSEIF ([outdoor:humidity]>50) DOELSE
attr di_hum cmdState wet|normal|dry
-
Anpassung des Status mit Hilfe des Attributes
state
back
Es können beliebige Reading und Status oder Internals angegeben werden.
Anwendungsbeispiel: Aktuelle Außenfeuchtigkeit inkl. Klimazustand (Status des Moduls wurde mit cmdState definiert s. o.)
attr di_hum state The current humidity is [outdoor:humidity], it is [di_hum]
Es können beim Attribut state ebenfalls Berechnungen in geschweiften Klammern durchgeführt werden. Aus Kompatibilitätsgründen, muss die Berechnung mit einer runden Klammer beginnen.
Anwendungsbeispiel: Berechnung des Mittelwertes zweier Readings:
define di_average DOIF
attr di_average state Average of the two rooms is {([room1:temperature]+[room2:temperature])/2}
Der Status wird automatisch aktualisiert, sobald sich eine der Temperaturen ändert
Da man beliebige Perl-Ausdrücke verwenden kann, lässt sich z. B. der Mittelwert auf eine Stelle mit der Perlfunktion sprintf formatieren:
attr di_average state Average of the two rooms is {(sprintf("%.1f",([room1:temperature]+[room2:temperature])/2))}
-
Erzeugen berechneter Readings ohne Events back
Mit Hilfe des Attributes DOIF_Readings können eigene Readings innerhalb des DOIF definiert werden, auf die man im selben DOIF-Device zugreifen kann.
Die Nutzung ist insbesondere dann sinnvoll, wenn zyklisch sendende Sensoren, im Perl-Modus oder mit dem Attribut do always, abgefragt werden.
DOIF_Readings-Berechnungen funktionieren ressourcenschonend ohne Erzeugung FHEM-Events nach außen. Änderungen dieser Readings triggern intern das eigene DOIF-Modul, allerdings nur, wenn sich deren Inhalt ändert.
Syntax
attr <DOIF-Modul> DOIF_Readings <readingname1>:<definiton>, <readingname2>:<definition>,...
<definition>
: Beliebiger Perlausdruck ergänzt um DOIF-Syntax in eckigen Klammern. Angaben in eckigen Klammern wirken triggernd und aktualisieren das definierte Reading.
Beispiel
Perl-Modus:
define heating DOIF {if ([switch] eq "on" and [$SELF:frost]) {fhem_set"heating on"} else {fhem_set"heating off"}}
attr heating DOIF_Readings frost:([outdoor:temperature] < 0)
Das Reading frost triggert nur dann die definierte Abfrage, wenn sich sein Zustand ändert. Dadurch wird sichergestellt, dass ein wiederholtes Schalten der Heizung vermieden wird, obwohl der Sensor outdoor zyklisch sendet.
Beispiel: Push-Mitteilung über die durchschnittliche Temperatur aller Zimmer
define di_temp DOIF ([$SELF:temperature]>20) (push "Die Durchschnittstemperatur ist höher als 20 Grad, sie beträgt [$SELF:temperature]")
attr di_temp DOIF_Readings temperature:[#average:d2:":temperature":temperature]
Hierbei wird der aufwändig berechnete Durchschnittswert nur einmal berechnet, statt zwei mal, wenn man die Aggregationsfunktion direkt in der Bedingung und im Ausführungsteil angeben würde.
-
Erzeugen berechneter Readings mit Events back
Mit Hilfe des Attributes event_Readings können eigene Readings innerhalb des DOIF definiert werden. Dieses Atrribut hat die gleiche Syntax wie DOIF_Readings. Der Unterschied besteht darin, dass event_Readings im Gegensatz zu DOIF_Readings beim Setzen der definierten Readings jedes mal Events produziert.
Die Nutzung von event_Readings ist insb. dann sinnvoll, wenn man eventgesteuert außerhalb des Moduls auf die definierten Readings zugreifen möchte.
Syntax
attr <DOIF-Modul> event_Readings <readingname1>:<definiton>, <readingname2>:<definition>,...
<definition>
: Beliebiger Perlausdruck ergänzt um DOIF-Syntax in eckigen Klammern. Angaben in eckigen Klammern wirken triggernd und aktualisieren das definierte Reading.
Bsp.:
define outdoor DOIF ##
attr outdoor event_Readings\
median:[outdoor:temperature:med],\
average:[outdoor:temperature:avg10],\
diff: [outdoor:temperature:diff],\
increase: [outdoor:temperature:inc]
Auf die definierten Readings des Moduls outdoor (hier: median, average, diff und increase) kann in anderenen Modulen eventgesteuert zugegriffen werden.
Bemerkung: Sind Events des definierten Readings nicht erforderlich und nur die interne Triggerung des eigenen DOIF-Moduls interessant,
dann sollte man das Attribut DOIF_Readings nutzen, da es durch die interne Triggerung des Moduls weniger das System belastet als event_Readings.
-
Vorbelegung des Status mit Initialisierung nach dem Neustart back
Mit dem Attribut initialize
Wird der Status vorbelegt, mit Initialisierung nach dem Neustart.
Anwendungsbeispiel: Nach dem Neustart soll der Zustand von di_lamp
mit "initialized" vorbelegt werden. Das Reading cmd_nr
wird auf 0 gesetzt, damit wird ein Zustandswechsel provoziert, das Modul wird initialisiert - der nächste Trigger führt zum Ausführen eines Kommandos.
attr di_lamp initialize initialized
Das ist insb. dann sinnvoll, wenn das System ohne Sicherung der Konfiguration (unvorhergesehen) beendet wurde und nach dem Neustart die zuletzt gespeicherten Zustände des Moduls nicht mit den tatsächlichen übereinstimmen.
-
Ausführen von Befehlsketten beim Starten von FHEM back
Beim Hochfahren von FHEM lässt sich eine bestimme Aktion ausführen. Es kann dazu genutzt werden, um sofort nach dem Hochfahren des Systems einen definierten Zustand des Moduls zu erreichen.
Dabei wird sichergestellt, dass die angegebenen Befehle erst dann ausgeführt werden, wenn FHEM komplett hochgefahren ist.
Symtax:
attr <DOIF-Modul> startup <FHEM-Befehl oder Perl-Befehl in geschweiften Klammern mit DOIF-Syntax>
Die Syntax entspricht der eines DOIF-Ausführungsteils (runde Klammern brauchen nicht angegeben werden).
Beispiele:
attr di_test startup set $SELF cmd_1
attr di_test startup set $SELF checkall
attr di_test startup sleep 60;set lamp1 off;set lamp2 off
attr di_test startup {myfunction()},set lamp1 on,set lamp2 on
-
Deaktivieren des Moduls back
Ein DOIF-Modul kann mit Hilfe des Attributes disable, deaktiviert werden. Dabei werden alle Timer und Readings des Moduls gelöscht.
Soll das Modul nur vorübergehend deaktiviert werden, so kann das durch set <DOIF-modul> disable
geschehen.
Set-Befehle
-
Überprüfung aller DOIF-Bedingungen mit Ausführung eines DOIF-Zweiges back
Mit dem set-Befehl checkall
werden wie beim gleichnamigen Attribut alle DOIF-Bedingung überprüft, sobald eine Bedingung als wahr geprüft ist, wird das dazugehörige Kommando ausgeführt.
Zu beachten ist, dass nur der erste wahre DOIF-Zweig ausgeführt wird und dass nur Zustandsabfragen sowie Zeitintervalle sinnvoll überprüft werden können.
Ereignisabfragen sowie Zeitpunkt-Definitionen, sind zum Zeitpunkt der checkall-Abfrage normalerweise nicht wahr.
Beispiel:
attr di_test startup set $SELF checkall
-
Inaktivieren des Moduls back
Mit dem set-Befehl disable
wird ein DOIF-Modul inaktiviert. Hierbei bleiben alle Timer aktiv, sie werden aktualisiert - das Modul bleibt im Takt, allerdings werden keine Befehle ausgeführt.
Das Modul braucht mehr Rechenzeit, als wenn es komplett über das Attribut disable
deaktiviert wird. Ein inaktiver Zustand bleibt nach dem Neustart erhalten.
Ein inaktives Modul kann über set-Befehle enable
bzw. initialize
wieder aktiviert werden.
-
Aktivieren des Moduls back
Mit dem set-Befehl enable
wird ein inaktives DOIF-Modul wieder aktiviert. Im Gegensatz zum set-Befehl initialize
wird der letzte Zustand vor der Inaktivierung des Moduls wieder hergestellt.
Initialisieren des Moduls back
mit dem set-Befehl initialize
wird ein DOIF-Modul initialisiert. Ein inaktives DOIF-Modul wieder aktiviert.
Im Gegensatz zum set-Befehl enable
wird der letzte Zustand des Moduls gelöscht, damit wird ein Zustandswechsel herbeigeführt, der nächste Trigger führt zur Ausführung eines wahren DOIF-Zweiges.
Diese Eigenschaft kann auch dazu genutzt werden, ein bereits aktives Modul zu initialisieren.
-
Auführen von Befehlszweigen ohne Auswertung der Bedingung back
Mit set <DOIF-modul> cmd_<nr>
lässt sich ein Befehlszweig (cmd_1, cmd_2, usw.) bedingunglos ausführen.
Der Befehl hat folgende Eigenschaften:
1) der set-Befehl übersteuert alle Attribute wie z. B. wait, do, usw.
2) bei wait wird der erste Timer einer Sequenz ignoriert, alle folgenden Timer einer Sequenz werden jedoch beachtet
3) ein laufender Wait-Timer wird unterbrochen
4) beim deaktivierten oder im Modus disable befindlichen Modul wird der set Befehl ignoriert
Anwendungsbeispiel: Schaltbare Lampe über Fernbedienung und Webinterface
define di_lamp DOIF ([FB:"on"]) (set lamp on) DOELSEIF ([FB:"off"]) (set lamp off)
attr di_lamp devStateIcon cmd_1:on:cmd_2 initialized|cmd_2:off:cmd_1
Mit der Definition des Attributes devStateIcon
führt das Anklicken des on/off-Lampensymbol zum Ausführen von set di_lamp cmd_1
bzw. set di_lamp cmd_2
und damit zum Schalten der Lampe.
Wenn mit cmdState
eigene Zuständsbezeichnungen definiert werden, so können diese ebenfalls per set-Befehl angegeben werden.
define di_lamp DOIF ([FB:"on"]) (set lamp on) DOELSEIF ([FB:"off"]) (set lamp off)
attr di_lamp cmdState on|off
attr di_lamp setList on off
set di_lamp on
entspricht hier set di_lamp cmd_1
und set di_lamp off set di_lamp cmd_2
Zusätzlich führt die Definition von setList
zur Ausführung von set di_lamp on/off
durch das Anlicken des Lampensymbols wie im vorherigen Beispiel.
Weitere Anwendungsbeispiele back
Zweipunktregler a la THRESHOLD
define di_threshold DOIF ([sensor:temperature]<([$SELF:desired]-1))
(set heating on)
DOELSEIF ([sensor:temperature]>[$SELF:desired])
(set heating off)
attr di_threshold cmdState on|off
attr di_threshold readingList desired
attr di_threshold setList desired:17,18,19,20,21,22
attr di_threshold webCmd desired
Die Hysterese ist hier mit einem Grad vorgegeben. Die Vorwahltemperatur wird per Dropdown-Auswahl eingestellt.
on-for-timer
Die Nachbildung eines on-for-timers lässt sich wie folgt realisieren:
define di_on_for_timer ([detector:"motion"])
(set light on)
(set light off)
attr di_on_for_timer do resetwait
attr di_on_for_timer wait 0,30
Hiermit wird das Licht bei Bewegung eingeschaltet. Dabei wird, solange es brennt, bei jeder Bewegung die Ausschaltzeit neu auf 30 Sekunden gesetzt, "set light on" wird dabei nicht unnötig wiederholt.
siehe auch Treppenhauslicht mit Bewegungsmelder im Perl-Modus
Die Beispiele stellen nur eine kleine Auswahl von möglichen Problemlösungen dar. Da sowohl in der Bedingung (hier ist die komplette Perl-Syntax möglich), als auch im Ausführungsteil, keine Einschränkungen gegeben sind, sind die Möglichkeiten zur Lösung eigener Probleme mit Hilfe des Moduls sehr vielfältig.
Zu beachten back
In jeder Bedingung muss mindestens ein Trigger angegeben sein (Angaben in eckigen Klammern). Die entsprechenden DO-Fälle werden nur dann ausgewertet, wenn auch das entsprechende Event oder Zeit-Trigger ausgelöst wird.
Zeitangaben der Art:
define di_light DOIF ([08:00] and [10:00]) (set switch on)
sind nicht sinnvoll, da diese Bedingung nie wahr sein wird.
Angaben, bei denen aufgrund der Definition kein Zustandswechsel erfolgen kann z. B.:
define di_light DOIF ([08:00]) (set switch on)
attr di_light do always
müssen mit Attribut do always
definiert werden, damit sie nicht nur einmal, sondern jedes mal (hier jeden Tag) ausgeführt werden.
Bei Devices, die mit Zwischenzuständen arbeiten, insbesondere HM-Komponenten (Zwischenzustand: set_on, set_off), sollte die Definition möglichst genau formuliert werden, um unerwünschte Effekte zu vermeiden:
statt:
define di_lamp DOIF ([HM_switch] eq "on") (set lamp on) DOELSE (set lamp off)
konkreter spezifizieren:
define di_lamp DOIF ([HM_switch] eq "on") (set lamp on) DOELSEIF ([HM_switch] eq "off") (set lamp off)
Namenskonvention: Da der Doppelpunkt bei Readingangaben als Trennzeichen gilt, darf er nicht im Namen des Devices vorkommen. In solchen Fällen bitte das Device umbenennen.
Standardmäßig, ohne das Attribut do always
, wird das Wiederholen desselben Kommmandos vom Modul unterbunden. Daher sollte nach Möglichkeit eine Problemlösung mit Hilfe eines und nicht mehrerer DOIF-Module realisiert werden, getreu dem Motto "wer die Lampe einschaltet, soll sie auch wieder ausschalten".
Dadurch wird erreicht, dass unnötiges (wiederholendes) Schalten vom Modul unterbunden werden kann, ohne dass sich der Anwender selbst darum kümmern muss.
Mehrere Bedingungen, die zur Ausführung gleicher Kommandos führen, sollten zusammengefasst werden. Dadurch wird ein unnötiges Schalten aufgrund verschiedener Zustände verhindert.
Beispiel:
define di_lamp DOIF ([brightness] eq "off") (set lamp on) DOELSEIF ([19:00]) (set lamp on) DOELSE (set lamp off)
Hier wird um 19:00 Uhr Lampe eingeschaltet, obwohl sie evtl. vorher schon durch das Ereignis brightness "off" eingeschaltet wurde.
define di_lamp DOIF ([brightness] eq "off" or [19:00]) (set lamp on) DOELSE (set lamp off)
Hier passiert das nicht mehr, da die ursprünglichen Zustände cmd_1 und cmd_2 jetzt nur noch einen Zustand cmd_1 darstellen und dieser wird nicht wiederholt.
Kurzreferenz back
〈〉 kennzeichnet optionale Angaben
Definition
-
define <name> DOIF 〈(<Bedingung>) 〈〈(〈<Befehle>〉)〉 〈〈〈DOELSEIF (<Bedingung>) 〈(〈<Befehle>〉)〉〉 ... 〉〈DOELSE 〈(〈<Befehle>〉)〉〉〉〉〉
- Befehlstrennzeichen ist das Komma
(<Befehl>, <Befehl>, ...)
- Befehlssequenzen werden in runde Klammern gesetzt
(<Befehlssequenz A>) (<Befehlssequenz B>) ...
- Enthält ein Befehl Kommata, ist er zusätzlich in runde Klammern einzuschliessen
(<Befehlsteil a>, <Befehlsteil b> ... )
- Perl-Befehle
{<Perl-Befehl>}
sind in geschweifte Klammern einzuschliessen
- Jede Berechnung
{(<Berechnung>)〈<Berechnung>〉}
in einem Befehl ist in geschweifte Klammern einzuschliessen und muss mit einer geöffneten runden Klammer beginnen.
Readings
- Device
- Name des auslösenden Gerätes
- block_<block name>
- Zeigt die Ausführung eines Perl-Blocks an (Perl).
- cmd
- Nr. des letzten ausgeführten Befehls als Dezimalzahl oder 0 nach Initialisierung des DOIF, in der Form <Nr. des Befehlszweiges>〈.<Nr. der Sequenz>〉
- cmd_event
- Angabe des auslösenden Ereignisses
- cmd_nr
- Nr. des letzten ausgeführten Befehlszweiges
- cmd_seqnr
- Nr. der letzten ausgeführten Befehlssequenz
- e_<Device>_<Reading>|<Internal>|Events
- Bezeichner und Wert der auslösenden Geräte mit Readings, Internals oder Events
- error
- Enthält Fehlermeldungen oder Rückgabewerte von Befehlen, siehe Besonderheit des Error-Reading
- last_cmd
- letzter Status
- matched_event_c<lfd. Nr. der Bedingung>_<lfd. Nr. des Events>
- Wert, der mit dem Regulären Ausdruck übereinstimmt
- mode
- der Modus, in dem sich DOIF befindet: <enabled|disabled|deactivated>
- state
- Status des DOIF nach Befehlsausführung, Voreinstellung: cmd_<Nr. des Befehlszweiges>〈_<Nr. der Befehlssequenz>〉
- timer_<lfd. Nr.>_c<Nr. des Befehlszweiges>
- verwendete Timer mit Angabe des nächsten Zeitpunktes
- timer_<timer name>
- verwendete, benannte Timer mit Angabe des nächsten Zeitpunktes (Perl)
- wait_timer
- Angabe des aktuellen Wait-Timers
- warning
- Perl-Warnung bei der Auswertung einer Bedingung
- <A-Z>_<readingname>
- Readings, die mit einem Großbuchstaben und nachfolgendem Unterstrich beginnen, sind für User reserviert und werden auch zukünftig nicht vom Modul selbst benutzt.
Operanden in der Bedingung und den Befehlen und im Perl-Modus
- Status
[<Device>〈,<Default>〉]
- Readings
[<Device>:<Reading>〈,<Default>〉]
- Internals
[<Device>:&<Internal>〈,<Default>〉]
- Filtern allgemein nach Ausdrücken mit Ausgabeformatierung:
[<Device>:<Reading>|<Internal>:"<Filter>"〈:<Output>〉〈,<Default>〉]
- Filtern einer Zahl
[<Device>:<Reading>:d〈,<Default>〉]
- Zeitspanne eines Readings seit der letzten Änderung
[<Device>:<Reading>:sec〈,<Default>〉]
- $DEVICE
- für den Gerätenamen
- $EVENT
- für das zugehörige Ereignis
- $EVENTS
- für alle zugehörigen Ereignisse eines Triggers
- $SELF
- für den Gerätenamen des DOIF
- <Perl-Funktionen>
- vorhandene und selbsterstellte Perl-Funktionen
Operanden in der Bedingung und im Perl-Modus
- Events
[<Device>:"<Regex-Events>"]
oder ["<Regex-Devices>:<Regex-Events>"]
oder ["<Regex-Devices>"〈:"<Regex-Filter>"〉〈:<Output>〉,<Default>]
- für
<Regex>
gilt: ^<ist eindeutig>$
, ^<beginnt mit>
, <endet mit>$
, ""
entspricht ".*"
, Regex-Filter ist mit [^\:]*: (.*)
vorbelegt siehe auch Reguläre Ausdrücke und Events des Gerätes global
- Zeitpunkte
[<time>]
- als
[HH:MM]
, [HH:MM:SS]
oder [Zahl]
in Sekunden nach Mitternacht
- Zeitintervalle
[<begin>-<end>]
- als
[HH:MM]
, [HH:MM:SS]
oder [Zahl]
in Sekunden nach Mitternacht
- indirekte Zeitangaben
[[<indirekte Zeit>]]
- als
[HH:MM]
, [HH:MM:SS]
oder [Zahl]
in Sekunden nach Mitternacht, <indirekte Zeit>
ist ein Status, Reading oder Internal
- relative Zeitangaben
[+<time>]
- als
[HH:MM]
, [HH:MM:SS]
oder [Zahl]
in Sekunden
- ausgerichtete Zeitraster
[:MM]
- in Minuten zwischen 00 und 59
- rel. Zeitraster ausgerichtet
[+:MM]
- in Minuten zwischen 1 und 59
- rel. Zeitraster ausgerichtet alle X Stunden
[+[h]:MM]
- MM in Minuten zwischen 1 und 59, h in Stunden zwischen 2 und 23
- Wochentagsteuerung
[<time>|0123456789]
, [<begin>-<end>]|0123456789]
- Pipe, gefolgt von ein o. mehreren Ziffern. Bedeutung: 0 bis 6 für So. bis Sa., 7 für $we, Wochenende oder Feiertag, 8 für !$we, Werktags, 9 für $twe, Wochenende oder Feiertag morgen.
- berechnete Zeitangaben
[(<Berechnung, gibt Zeit in Sekunden zurück, im Sinne von time>)]
- Berechnungen sind mit runden Klammern einzuschliessen. Perlfunktionen, die HH:MM zurückgeben sind mit geschweiften Klammern einzuschliessen.
- Intervall-Timer
[<begin>-<end>,<relativ timer>]
- Löst zu den aus <relativ timer> berechneten Zeitpunkten im angegebenen Zeitintervall <begin>-<end> aus.
- Trigger verhindern
[?<devicename>]
, [?<devicename>:<readingname>]
, [?<devicename>:&<internalname>]
, [?<time specification>]
- Werden Status, Readings, Internals und Zeitangaben in der Bedingung mit einem Fragezeichen eingeleitet, triggern sie nicht.
- $device, $event, $events
- Perl-Variablen mit der Bedeutung der Schlüsselworte $DEVICE, $EVENT, $EVENTS
- $cmd
- Perl-Variablen mit der Bedeutung [$SELF:cmd]
- <Perl-Zeitvariablen>
- Variablen für Zeit- und Datumsangaben, $sec, $min, $hour, $mday, $month, $year, $wday, $yday, $isdst, $week, $hms, $hm, $md, $ymd, $we, $twe
set-Befehle
- disable
set <name> checkall
- Überprüfung aller DOIF-Bedingungen mit Ausführung eines wahren DOIF-Zweiges
- disable
set <name> disable
- blockiert die Befehlsausführung
- initialize
set <name> initialize
- initialisiert das DOIF und aktiviert die Befehlsausführung
- enable
set <name> enable
- aktiviert die Befehlsausführung, im Gegensatz zur obigen Initialisierung bleibt der letzte Zustand des Moduls erhalten
- cmd_<nr>
set <name> cmd_<nr>
- führt ohne Auswertung der Bedingung den Befehlszweig mit der Nummer <nr> aus
get-Befehle
- html
- liefert HTML-Code einer definierten uiTable zurück.
Attribute
- Verzögerungen
attr <name> wait <timer_1_1>,<timer_1_2>,...:<timer_2_1>,<timer_2_2>,...:...
- Zeit in Sekunden als direkte Angabe oder Berechnung, ein Doppelpunkt trennt die Timer der Bedingungsweige, ein Komma die Timer der Befehlssequenzen eines Bedingungszweiges.
- Verzögerung von Timern
attr <name> timerWithWait
- erweitert
wait
auf Zeitangaben
-
attr <name> do <always|resetwait>
always
wiederholt den Ausführungsteil, wenn die selbe Bedingung wiederholt wahr wird.
resetwait
setzt den Waittimer zurück, wenn die selbe Bedingung wiederholt wahr wird.
- Befehle wiederholen
attr <name> repeatcmd <timer Bedingungszweig 1>:<timer Bedingungszweig 2>:...
- Zeit in Sekunden als direkte Angabe oder Berechnung, nach der Befehle wiederholt werden.
- Pause für Wiederholung
attr <name> cmdpause <Pause cmd_1>:<Pause cmd_2>:...
- Zeit in Sekunden als direkte Angabe oder Berechnung, blockiert die Befehlsausführung während der Pause.
- Begrenzung von Wiederholungen
attr <name> repeatsame <maximale Anzahl von cmd_1>:<maximale Anzahl von cmd_2>:...
- Anzahl als direkte Angabe oder Berechnung, begrenzt die maximale Anzahl unmittelbar folgender Befehlsausführungen.
- Warten auf Wiederholung
attr <name> waitsame <Wartezeit cmd_1>:<Wartezeit cmd_2>:...
- Wartezeit in Sekunden als direkte Angabe oder Berechnung, für ein unmittelbar wiederholtes Zutreffen einer Bedingung.
- Löschen des Waittimers
attr <name> waitdel <timer_1_1>,<timer_1_2>,...:<timer_2_1>,<timer_2_2>,...:...
- Zeit in Sekunden als direkte Angabe oder Berechnung, ein laufender Timer wird gelöscht und die Befehle nicht ausgeführt, falls eine Bedingung vor Ablauf des Timers wiederholt wahr wird.
- Readingauswertung bei jedem Event des Devices
attr <name> checkReadingEvent <0|1>
- 0 deaktiviert, 1 keine Funktion mehr, entspricht internen der Voreinstellung des Moduls.
- Selbsttriggerung
attr <name> selftrigger <wait|all>
- lässt die Triggerung des Gerätes durch sich selbst zu.
wait
zugelassen für verzögerte Befehle, all
zugelassen auch für nicht durch wait verzögerte Befehle; es ist nur eine Rekusion möglich
- Event beim Setzen eines Timers
attr <name> timerevent <0|ungleich Null>
- erzeugt beim Setzen eines Timers ein Event. ungleich Null aktiviert, 0 deaktiviert
- Gerätestatus ersetzen
attr <name> cmdState <Ersatz cmd_1_1>,...,<Ersatz cmd_1>|<Ersatz cmd_2_1>,...,<Ersatz cmd_2>|...
- ersetzt die Standartwerte des Gerätestatus als direkte Angabe oder Berechnung, die Ersatzstatus von Befehlssequenzen werden durch Kommata, die von Befehlszweigen durch Pipe Zeichen getrennt.
- Befehle bei FHEM-Start ausführen
attr <name> startup <FHEM-Befehle>|{<Perl-Befehle mit DOIF-Syntax>}
- dynamischer Status
attr <name> state <content>
- <content> ist das Ergebnis eines Perl-Ausdrucks, DOIF-Syntax ([<device>:<reading>], usw.) triggert bei Event die Berechnung.
- Erzeugen berechneter Readings
attr <name> DOIF_Readings <readingname_1>:<content_1>,<readingname_2>:<content_2> ...
- <content_n> ist das Ergebnis von Perl-Ausdrücken, DOIF-Syntax ([<device>:<reading>], usw.) triggert bei Event die Berechnung.
- Ersatzwert für nicht existierende Readings oder Status
attr <name> notexist "<Ersatzwert>"
- Status Initialisierung nach Neustart
attr <name> initialize <Status nach Neustart>
- Gerät vollständig deaktivieren
attr <name> disable <0|1>
- 1 deaktiviert das Modul vollständig, 0 aktiviert es.
- Alle Bedingungen prüfen
attr <name> checkall <event|timer|all>
event
Alle Bedingungen werden geprüft, wenn ein Event-Trigger (Ereignisauslöser) auslöst.
timer
Alle Bedingungen werden geprüft, wenn ein Timer-Trigger (Zeitauslöser) auslöst.
all
Alle Bedingungen werden geprüft.
Die Befehle nach der ersten wahren Bedingung werden ausgeführt.
- Eindeutige Statuserkennung
attr <name> addStateEvent <0|ungleich Null>
- fügt einem Gerätestatus-Event "state:" hinzu. ungleich Null aktiviert, 0 deaktiviert, siehe auch addStateEvent
-
attr <name> readingList <Reading1> <Reading2> ...
- fügt zum set-Befehl direkt setzbare, durch Leerzeichen getrennte Readings hinzu.
attr <name> setList <Reading1>:〈<Modifier1>,〉<Value1>,<Value2>,<...> <Reading2>:〈<Modifier2>,〉<Value1>,<Value2>,<...> ...
- fügt einem Reading einen optionalen Widgetmodifier und eine Werteliste (, getrennt) hinzu. setList, widgetOverride, und webCmd
- User Interface für DOIF
attr <name> uiTable 〈{<perl code (format specification, template specification, function definition, control variable, ...)>}\n〉<template file import, method definition, table definition>
- format specification:
$TABLE = "<CSS-Attribute>"
ergänzt das table-Elemente um CSS-Attribute.
$TD{<rows>}{<columns>} = "<HTML Attribute>"
ergänzt td-Elemente um HTML-Attribute.
$TR{<rows>} = "<HTML Attribute>"
ergänzt tr-Elemente um HTML-Attribute.
$TC{<columns>} = "<HTML Attribute>"
ergänzt zu columns gehörende td-Elemente um HTML-Attribute.
- template specification:
$TPL{<name>} = "<Zeichenkette>"
speichert ein Template.
- function definition:
sub FUNC_<name> {<function BLOCK>}
definiert eine Funktion.
- control variables:
$ATTRIBUTESFIRST = 1;
organisiert die Detailansicht um.
$SHOWNOSTATE = 1;
blendet den Status in der Gerätezeile aus.
$SHOWNODEVICELINE = "<regex room>";
blendet die Gerätezeile aus, wenn <regex room> zum Raumnamen passt, gilt nicht für den Raum Everything.
$SHOWNODEVICELINK = 1;
schaltet das Ersetzen des Gerätenamen durch einen Link auf die Detailseite aus.
- template file import:
IMPORT <path with filename>
importiert eine Templatedatei.
- method definition:
DEF TPL_<name>(<definition with place holder $1,$2 usw.>)
erzeugt ein Methodentemplate zur wiederholten Nutzung in der Tabellendefinition.
- table definition:
- Schreiben die nachstehenden Elemente HTML-Code in die Tabellenzelle, so wird er interpretiert.
↵
oder ↵↵
trennt Tabellenzeilen.
|
oder |↵
trennt Tabellenzellen.
>↵
oder ,↵
sind zur Textstrukturierung zugelassen.
WID([<device>:<reading>],"<widget modifier>"〈,"<command>"〉)
bindet ein Widget an <device>:<reading>, <command> steht für set oder setreading, siehe widgetOverride und FHEMWEB-Widgets
STY(<content>,<CSS style attributes>)
schreibt den Inhalt von <content> in die Zelle und formatiert ihn mit <CSS style attributes>.
<content>
schreibt den Inhalt von <content> in die Zelle.
- <content> und <CSS style attributes> sind das Ergebnis von Perl-Ausdrücken. Enthalten sie DOIF-Syntax ([<device>:<reading>], usw.), werden sie dynamisch erzeugt.
PUP(<DOIF-name to show interface table>, <iconname[@color number]>)
- gibt ein Link zum Öffnen eines Popup-Fensters zurück.
- <DOIF-name to show interface table> Name des DOIF-Gerätes dessen Benutzerschnittstelle angezeigt werden soll.
- <iconname[@color number]|string> gibt ein Icon an, wenn das Icon nicht verfügbar ist, wird <string> angezeigt.
- readingFnAttributes
Perl-Funktionen
DOIF_hsv(<current value>, <lower value>, <upper value>, <lower HUE value>, <upper HUE value>, <saturation>, <lightness>)
- gibt eine im HSV-Raum interpolierte HTML Farbnummer zurück, mit Prefix #
- <current value> aktueller Wert, für den die Farbnummer erzeugt wird.
- <lower value> unterer Wert, des Bereiches auf den die Farbnummer skaliert wird.
- <upper value> oberer Wert, des Bereiches auf den die Farbnummer skaliert wird.
- <lower HUE value> unterer HUE-Wert, der mit dem unteren Wert korrespondiert (0-360).
- <upper HUE value> oberer HUE-Wert, der mit dem oberen Wert korrespondiert (0-360).
- <saturation> Farbsättigung (0-100).
- <lightness> Hellwert (0-100).
DOIF_rgb(<start color number>, <end color number>, <lower value>, <upper value>, <current value>)
- gibt eine linear interpolierte RGB Farbnummer zurück, abhängig vom Prefix der Start- o. Endfarbnummer mit oder ohne Prefix #.
- <start color number> Startfarbnummer des Farbbereiches, mit oder ohne Prefix #.
- <end color number> Endfarbnummer des Farbbereiches, mit oder ohne Prefix #.
- <lower value> unterer Wert, des Bereiches auf den die Farbnummer skaliert wird.
- <upper value> oberer Wert, des Bereiches auf den die Farbnummer skaliert wird.
- <current value> aktueller Wert, für den die Farbnummer erzeugt wird.
FW_makeImage(<iconname[@color number]>)
- gibt HTML-Code zurück, der ein FHEM icon einbindet.
- <color number> optionale Farbnummer in Großschreibung, mit oder ohne Prefix #.
- weitere Infos im Quelltext von 01_FHEMWEB.pm.
Perl Modus
Der Perl-Modus ist sowohl für einfache, als auch für komplexere Automatisierungsabläufe geeignet. Der Anwender hat mehr Einfluss auf den Ablauf der Steuerung als im FHEM-Modus.
Die Abläufe lassen sich, wie in höheren Programmiersprachen üblich, strukturiert programmieren. Zum Zeitpunkt der Definition werden alle DOIF-spezifischen Angaben in Perl übersetzt, zum Zeitpunkt der Ausführung wird nur noch Perl ausgeführt, dadurch wird maximale Performance gewährleistet.
Syntax Perl-Modus:
define <name> DOIF <Blockname> {<Ereignisblock: Perlcode mit Ereignis-/Zeittriggern in eckigen Klammern>}
Ein Ereignisblock wird ausgeführt, wenn dieser bedingt durch Ereignis- und Zeittrigger in eckigen Klammern innerhalb des Blocks, getriggert wird.
Es wird die vollständige Perl-Syntax unterstützt. Es können beliebig viele Ereignisblöcke innerhalb eines DOIF-Devices definiert werden. Sie werden unabhängig voneinander durch passende Trigger ausgeführt. Der Name eines Ereignisblocks ist optional.
Der Status des Moduls wird nicht vom Modul gesetzt, er kann vom Anwender mit Hilfe der Funktion set_State
verändert werden, siehe spezifische Perl-Funktionen im Perl-Modus.
FHEM-Befehle werden durch den Aufruf der Perlfunktion fhem("...")
ausgeführt. Für den häufig genutzten fhem-Befehl set wurde eine kompatible Perlfunktion namens fhem_set definiert.
Sie ist performanter und sollte bevorzugt verwendet werden, da das Parsen nach dem FHEM set-Befehl entfällt.
Der Benutzer kann mit der Funktion set_Exec
beliebig viele eigene Timer definieren, die unabhängig voneinander gesetzt und ausgewertet werden können, siehe Spezifische Perl-Funktionen im Perl-Modus.
Definitionen im FHEM-Modus mit do-Attribut der Form:
DOIF (<Bedingung mit Trigger>) (<FHEM-Befehle>) DOELSE (<FHEM-Befehle>)
lassen sich wie folgt in Perl-Modus übertragen:
DOIF {if (<Bedingung mit Trigger>) {fhem"<FHEM-Befehle>"} else {fhem"<FHEM-Befehle>"}}
Die Bedingungen des FHEM-Modus können ohne Änderungen in Perl-Modus übernommen werden.
Einfache Anwendungsbeispiele (vgl. Anwendungsbeispiele im FHEM-Modus):
define di_rc_tv DOIF {if ([remotecontol:"on"]) {fhem_set"tv on"} else {fhem_set"tv off"}}
define di_clock_radio DOIF {if ([06:30|Mo Di Mi] or [08:30|Do Fr Sa So]) {fhem_set"radio on"}} {if ([08:00|Mo Di Mi] or [09:30|Do Fr Sa So]) {fhem_set"radio off"}}
define di_lamp DOIF {if ([06:00-09:00] and [sensor:brightness] < 40) {fhem_set"lamp:FILTER=STATE!=on on"} else {fhem_set"lamp:FILTER=STATE!=off off"}}
Bemerkung: Im Gegensatz zum FHEM-Modus arbeitet der Perl-Modus ohne Auswertung des eigenen Status (Zustandsauswertung),
daher muss der Anwender selbst darauf achten, wiederholende Ausführungen zu vermeiden (im oberen Beispiel z.B. mit FILTER-Option). Elegant lässt sich das Problem der wiederholenden Ausführung bei zyklisch sendenden Sensoren mit Hilfe des Attributes DOIF_Readings lösen.
Es können beliebig viele Ereignisblöcke definiert werden, die unabhängig von einander durch einen oder mehrere Trigger ausgewertet und zur Ausführung führen können:
DOIF
{ if (<Bedingung mit Triggern>) ... }
{ if (<Bedingung mit Triggern>) ... }
...
Einzelne Ereignis-/Zeittrigger, die nicht logisch mit anderen Bedingungen oder Triggern ausgewertet werden müssen, können auch ohne if-Anweisung angegeben werden, z. B.:
DOIF
{["lamp:on"];...}
{[08:00];...}
...
Ereignis-/Zeittrigger sind intern Perlfunktionen, daher können sie an beliebiger Stelle im Perlcode angegeben werden, wo Perlfunktionen vorkommen dürfen, z. B.:
DOIF {Log 1,"state of lamp: ".[lamp:state]}
DOIF {fhem_set("lamp ".[remote:state])}
Es sind beliebige Hierarchietiefen möglich:
DOIF
{ if (<Bedingung>) {
if (<Bedingung>) {
if (<Bedingung mit Triggern>...
...
}
}
}
}
Bemerkung: Innerhalb eines Ereignisblocks muss mindestens ein Trigger definiert werden, damit der gesamte Block beim passenden Trigger ausgeführt wird.
Inhaltsübersicht Perl-Modus
Eigene Funktionen back
Ein besonderer Block ist der Block namens subs. In diesem Block werden Perlfunktionen definiert, die innerhalb des DOIFs genutzt werden.
Um eine möglichst hohe Kompatibilität zu Perl sicherzustellen, wird keine DOIF-Syntax in eckigen Klammern unterstützt, insb. gibt es keine Trigger, die den Block ausführen können.
Beispiel:
DOIF
subs { ## Definition von Perlfunktionen lamp_on und lamp_off
sub lamp_on {
fhem_set("lamp on");
set_State("on");
}
sub lamp_off {
fhem_set("lamp off");
set_State("off");
}
}
{[06:00];lamp_on()} ## Um 06:00 Uhr wird die Funktion lamp_on aufgerufen
{[08:00];lamp_off()} ## Um 08:00 Uhr wird die Funktion lamp_off aufgerufen
Eigene Funktionen mit Parametern back
Unter Verwendung von Funktionsparamerter lassen sich Definitionen oft vereinfachen, das obige Beispiel lässt sich mit Hilfe nur einer Funktion kürzer wie folgt definieren:
DOIF
subs { ## Definition der Perlfunktion lamp
sub lamp {
my ($state)=@_;  # Variable $state mit dem Parameter belegen
fhem_set("lamp $state");
set_State($state);
}
}
{[06:00];lamp("on")} ## Um 06:00 Uhr wird die Funktion lamp mit Parameter "on" aufgerufen
{[08:00];lamp("off")} ## Um 08:00 Uhr wird die Funktion lamp mit dem Parameter "off" aufgerufen
Eigener Namensraum back
Der Namensraum im Perl-Modus ist gekapselt. Selbstdefinierte Funktionen im DOIF-Device können nicht bereits existierende Perlfunktionen in FHEM (Namensraum main) überschreiben.
Funktionen aus dem Namensraum main müssen mit vorangestellem Doppelpunkt angegeben werden: ::<perlfunction>
Eigene Perlfunktionen, die in myutils ausgelagert sind, befinden sich ebenfalls im Namensraum main. Wenn sie ausschließich in DOIF-Devices benutzt werden sollen, so kann am Anfang vor deren Definition in myutils "package DOIF;" angegeben werden.
In diesen Fall sind auch diese Funktion im DOIF-Device bekannt - sie können dann ohne vorangestellten Doppelpunkt genutzt werden.
Folgende FHEM-Perlfunktionen wurden ebenfalls im DOIF-Namensraum definiert, sie können, wie gewohnt ohne Doppelpunkt genutzt werden:
fhem, Log, Log3, InternVal, InternalNum, OldReadingsVal, OldReadingsNum, OldReadingsTimestamp, ReadingsVal, ReadingsNum, ReadingsTimestamp, ReadingsAge, Value, OldValue, OldTimestamp, AttrVal, AttrNum
Spezifische Perl-Funktionen im Perl-Modus back
FHEM set-Befehl ausführen: fhem_set(<content>)
, mit <content> Übergabeparameter des FHEM set-Befehls
Beispiel: Lampe ausschalten:
fhem_set("lamp off");
entspricht:
fhem("set lamp off");
Der Aufruf der fhem_set-Funktion ist performater, da das Parsen nach dem set-Befehl im Gegensatz zum Aufruf mit der Funktion fhem
entfällt.
Ein beliebiges FHEM-Event absetzen: set_Event(<Event>)
Beispiel: Setze das Event "on":
set_Event("on");
Status setzen: set_State(<value>,<trigger>)
, mit <trigger>: 0 ohne Trigger, 1 mit Trigger, <trigger> ist optional, default ist 1
Beispiel: Status des eignen DOIF-Device auf "on" setzen:
set_State("on");
Status des eigenen DOIF-Devices holen: get_State()
Beispiel: Schalte lampe mit dem eigenen Status:
fhem_set("lamp ".get_State());
Reading des eigenen DOIF-Devices schreiben: set_Reading(<readingName>,<value>,<trigger>)
, mit <trigger>: 0 ohne Trigger, 1 mit Trigger, <trigger> ist optional, default ist 0
set_Reading("weather","cold");
Reading des eigenen DOIF-Devices holen: get_Reading(<readingName>)
Beispiel: Schalte Lampe mit dem Inhalt des eigenen Readings "dim":
fhem_set("lamp ".get_Reading("dim"));
Setzen mehrerer Readings des eigenen DOIF-Devices in einem Eventblock:
set_Reading_Begin()
set_Reading_Update(<readingName>,<value>,<change>)
, <change> ist optional
set_Reading_End(<trigger>)
, mit <trigger>: 0 ohne Trigger, 1 mit Trigger, <trigger>
Die obigen Funktionen entsprechen den FHEM-Perlfunktionen: readingsBegin, readingsBulkUpdate, readingsEndUpdate
.
Beispiel:
Die Readings "temperature" und "humidity" sollen in einem Eventblock mit dem zuvor belegten Inhalt der Variablen $temp bzw. $hum belegt werden.
set_Reading_Begin;
set_Reading_Update("temperature",$temp);
set_Reading_Update("humidity",$hum);
set_Reading_End(1);
Ausführungstimer back
Mit Hilfe von Ausführungstimern können Anweisungen verzögert ausgeführt werden. Im Gegensatz zum FHEM-Modus können beliebig viele Timer gleichzeitig genutzt werden.
Ein Ausführungstimer wird mit einem Timer-Namen eindeutig definiert. Über den Timer-Namen kann die Restlaufzeit abgefragt werden, ebenfalls kann er vor seinem Ablauf gelöscht werden.
Timer setzen: set_Exec(<timerName>, <seconds>, <perlCode>, <parameter>)
, mit <timerName>: beliebige Angabe, sie spezifiziert eindeutig einen Timer,
welcher nach Ablauf den angegebenen Perlcode <perlCode> aufruft. Falls als Perlcode eine Perlfunktion angegeben wird, kann optional ein Übergabeparameter <parameter> angegeben werden. Die Perlfunkion muss eindeutig sein und in FHEM zuvor deklariert worden sein.
Wird set_Exec mit dem gleichen <timerName> vor seinem Ablauf erneut aufgerufen, so wird der laufender Timer gelöscht und neugesetzt.
Timer holen: get_Exec(<timerName>)
, Returnwert: 0, wenn Timer abgelaufen oder nicht gesetzt ist, sonst Anzahl der Sekunden bis zum Ablauf des Timers
Laufenden Timer löschen: del_Exec(<timerName>)
Beispiel: Funktion namens "lamp" mit dem Übergabeparameter "on" 30 Sekunden verzögert aufrufen:
set_Exec("lamp_timer",30,'lamp','on');
alternativ
set_Exec("lamp_timer",30,'lamp("on")');
Beispiel: Lampe verzögert um 30 Sekunden ausschalten:
set_Exec("off",30,'fhem_set("lamp off")');
Beispiel: Das Event "off" 30 Sekunden verzögert auslösen:
set_Exec("off_Event",30,'set_Event("off")');
init-Block back
Wird ein Ereignisblock mit dem Namen init benannt, so wird dieser Block beim Systemstart ausgeführt. Er bietet sich insb. an, um Device-Variablen des Moduls vorzubelegen.
Device-Variablen back
Device-Variablen sind sogenannte Instanzvariablen, die global innerhalb eines DOIF-Devices genutzt werden können. Deren Inhalt bleibt von Trigger zu Trigger während der Laufzeit des System erhalten. Sie beginnen mit $_ und müssen nicht deklariert werden.
Wenn sie nicht vorbelegt werden, gelten sie als nicht definiert. Das lässt sich abfragen mit:
if (defined $_...) ...
Instanzvariablen überleben nicht den Neustart, sie können jedoch z.B. im init-Block, der beim Systemstart ausgewertet wird, aus Readings vorbelegt werden.
Bsp. Vorbelgung einer Instanzvariablen beim Systemstart mit dem Status des Moduls:
init {$_status=get_State()}
Instanzvariablen lassen sich indizieren, z. B.:
my $i=0;
$_betrag{$i}=100;
Ebenso funktionieren hash-Variablen z. B.:
$_betrag{heute}=100;
Blockierende Funktionsaufrufe (blocking calls) back
DOIF verwaltet blockierende Funktionsaufrufe, d.h. die in diesem Zusammenhang gestarteten FHEM-Instanzen werden gelöscht, beim Herunterfahren (shutdown), Wiedereinlesen der Konfiguration (rereadcfg) Änderung der Konfiguration (modify) und Deaktivieren des Gerätes (disabled).
Die Handhabung von blockierenden Funktionsaufrufen ist im FHEMwiki erklärt, s. Blocking Call.
Der von der Funktion BlockingCall zurückgegebene Datensatz ist unterhalb von $_blockingcalls abzulegen, z.B.
$_blockingcalls{<blocking call name>} = ::BlockingCall(<blocking function>, <argument>, <finish function>, <timeout>, <abort function>, <abort argument>) unless(defined($_blockingcalls{<blocking call name>}));
Für unterschiedliche blockierende Funktionen ist jeweils ein eigener Name (<blocking call name>) unterhalb von $_blockingcalls anzulegen.
Wenn <blocking function>, <finish function> und <abort function> im Package DOIF definiert werden, dann ist dem Funktionsnamen DOIF:: voranzustellen, im Aufruf der Funktion BlockingCall, z.B. DOIF::<blocking function>
$_blockingcalls ist eine für DOIF reservierte Variable und darf nur in der beschriebener Weise verwendet werden.
Nutzbare Attribute im Perl-Modus back
Anwendungsbeispiele im Perlmodus: back
Treppenhauslicht mit Bewegungsmelder
define di_light DOIF {
if (["FS:motion"]) { # bei Bewegung
fhem_set("lamp on") if ([?lamp] ne "on"); # Lampe einschalten, wenn sie nicht an ist
set_Exec("off",30,'fhem_set("lamp off")'); # Timer namens "off" für das Ausschalten der Lampe auf 30 Sekunden setzen bzw. verlängern
}
}
Einknopf-Fernbedienung
Anforderung: Wenn eine Taste innerhalb von zwei Sekunden zwei mal betätig wird, soll der Rollladen nach oben, bei einem Tastendruck nach unten.
define di_shutter DOIF {
if (["FS:^on$"] and !get_Exec("shutter")){ # wenn Taste betätigt wird und kein Timer läuft
set_Exec("shutter",2,'fhem_set("shutter down")'); # Timer zum shutter down auf zwei Sekunden setzen
} else { # wenn Timer läuft, d.h. ein weitere Tastendruck innerhalb von zwei Sekunden
del_Exec("shutter"); # Timer löschen
fhem_set("shutter up"); # Rollladen hoch
}
}
Aktion auslösen, wenn innerhalb einer bestimmten Zeitspanne ein Ereignis x mal eintritt
Im folgenden Beispiel wird die Nutzung von Device-Variablen demonstriert.
define di_count DOIF {
if (["FS:on"] and !get_Exec("counter")) { # wenn Ereignis (hier "FS:on") eintritt und kein Timer läuft
$_count=1; # setze count-Variable auf 1
set_Exec("counter",3600,'Log (3,"count: $_count action") if ($_count > 10)'); # setze Timer auf eine Stunde zum Protokollieren der Anzahl der Ereignisse, wenn sie über 10 ist
} else {
$_count++; # wenn Timer bereits läuft zähle Ereignis
}
}
Verzögerte Fenster-offen-Meldung mit Wiederholung für mehrere Fenster
define di_window DOIF
subs {
sub logwin { # Definition der Funktion namens "logwin"
my ($window)=@_; # übernehme Parameter in die Variable $window
Log 3,"Fenster offen, bitte schließen: $window"; # protokolliere Fenster-Offen-Meldung
set_Exec ("$window",1800,"logwin",$window); # setze Timer auf 30 Minuten für eine wiederholte Meldung
}
}
{ if (["_window$:open"]) {set_Exec ("$DEVICE",600,'logwin',"$DEVICE")}} # wenn, Fenster geöffnet wird, dann setze Timer auf Funktion zum Loggen namens "logwin"
{ if (["_window$:closed"]) {del_Exec ("$DEVICE")}} # wenn, Fenster geschlossen wird, dann lösche Timer
=end html_DE
=cut