mirror of
https://github.com/fhem/fhem-mirror.git
synced 2024-06-17 05:40:11 +00:00
be9bcae66a
git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@24129 2b470e98-0d58-463d-a4d8-8e2adae1ed80
813 lines
26 KiB
Perl
813 lines
26 KiB
Perl
##############################################
|
|
# $Id$
|
|
package main;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use Time::HiRes qw(gettimeofday);
|
|
|
|
#####################################
|
|
sub
|
|
at_Initialize($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
$hash->{DefFn} = "at_Define";
|
|
$hash->{UndefFn} = "at_Undef";
|
|
$hash->{SetFn} = "at_Set";
|
|
$hash->{AttrFn} = "at_Attr";
|
|
$hash->{StateFn} = "at_State";
|
|
$hash->{AttrList} = "disable:0,1 disabledForIntervals $readingFnAttributes ".
|
|
"skip_next:0,1 alignTime computeAfterInit";
|
|
$hash->{FW_detailFn} = "at_fhemwebFn";
|
|
}
|
|
|
|
|
|
my %at_stt;
|
|
my $at_detailFnCalled;
|
|
|
|
sub
|
|
at_SecondsTillTomorrow($) # 86400, if tomorrow is no DST change
|
|
{
|
|
my $t = shift;
|
|
my $dayHour = int($t/3600);
|
|
|
|
if(!$at_stt{$dayHour}) {
|
|
my @l1 = localtime($t);
|
|
my @l2 = localtime($t+86400);
|
|
$at_stt{$dayHour} = 86400+($l1[8]-$l2[8])*3600;
|
|
}
|
|
|
|
return $at_stt{$dayHour};
|
|
}
|
|
|
|
|
|
#####################################
|
|
sub
|
|
at_Define($$)
|
|
{
|
|
my ($hash, $def) = @_;
|
|
my ($name, undef, $tm, $command) = split("[ \t\n]+", $def, 4);
|
|
|
|
if(!$command) {
|
|
if($hash->{OLDDEF}) { # Called from modify, where command is optional
|
|
RemoveInternalTimer($hash);
|
|
(undef, $command) = split("[ \t]+", $hash->{OLDDEF}, 2);
|
|
$hash->{DEF} = "$tm $command";
|
|
} else {
|
|
return "Usage: define <name> at [timespec or datespec] <command>";
|
|
}
|
|
}
|
|
|
|
return "Wrong timespec, use \"[+][*[{count}]]<time or func>\""
|
|
if($tm !~ m/^(\+)?(\*(\{\d+\})?)?(.+)$/);
|
|
my ($rel, $rep, $cnt, $tspec) = ($1, $2, $3, $4);
|
|
|
|
my ($abstime, $err, $hr, $min, $sec, $fn);
|
|
if($tspec =~ m/^\d{10}$/) {
|
|
$abstime = $tspec;
|
|
|
|
} elsif($tspec =~ m/^(\d{4})-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)$/) {
|
|
my ($y,$m,$d,$h,$m2,$s) = ($1,$2,$3,$4,$5,$6);
|
|
$abstime = mktime($s,$m2,$h,$d,$m-1,$y-1900, 0,0,-1);
|
|
|
|
} else {
|
|
($err, $hr, $min, $sec, $fn) = GetTimeSpec($tspec);
|
|
if($err) { # $fn contains the result, try again
|
|
my $ntspec = ($fn ? $fn : "");
|
|
$fn = undef;
|
|
if($ntspec =~ m/^\d{10}$/) {
|
|
$abstime = $ntspec;
|
|
|
|
} elsif($ntspec =~ m/^(\d{4})-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)$/) {
|
|
my ($y,$m,$d,$h,$m2,$s) = ($1,$2,$3,$4,$5,$6);
|
|
$abstime = mktime($s,$m2,$h,$d,$m-1,$y-1900, 0,0,-1);
|
|
|
|
} else {
|
|
return $err;
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
return "datespec is not allowed with +" if($abstime && $rel);
|
|
|
|
if($hash->{CL}) { # Do not check this for definition
|
|
$err = perlSyntaxCheck($command, ());
|
|
return $err if($err);
|
|
}
|
|
|
|
$rel = "" if(!defined($rel));
|
|
$rep = "" if(!defined($rep));
|
|
$cnt = "" if(!defined($cnt));
|
|
delete $hash->{VOLATILE} if (defined($hash->{VOLATILE}));
|
|
$hash->{RELATIVE} = ($rel ? "yes" : "no");
|
|
$hash->{PERIODIC} = ($rep ? "yes" : "no");
|
|
$hash->{TIMESPEC} = $tspec;
|
|
$hash->{COMMAND} = $command;
|
|
|
|
|
|
my $ot = $data{AT_TRIGGERTIME} ? $data{AT_TRIGGERTIME} : gettimeofday();
|
|
$ot = int($ot) if(!$rel); # No way to specify subseconds
|
|
my $nt = $ot;
|
|
|
|
if($abstime) {
|
|
$nt = $abstime;
|
|
|
|
} elsif($rel eq "+") {
|
|
$nt += ($hr*3600+$min*60+$sec); # Relative time
|
|
|
|
} else {
|
|
my @lt = localtime($ot);
|
|
($lt[2], $lt[1], $lt[0]) = ($hr+0, $min+0, $sec+0);
|
|
$lt[8] = -1; # Forum #52074
|
|
$nt = mktime(@lt);
|
|
$nt += at_SecondsTillTomorrow($nt) if($ot >= $nt); # Do it tomorrow...
|
|
|
|
}
|
|
|
|
my @lt = localtime($nt);
|
|
my $ntm = sprintf("%02d:%02d:%02d", $lt[2], $lt[1], $lt[0]);
|
|
if($rep) { # Setting the number of repetitions
|
|
$cnt =~ s/[{}]//g;
|
|
return undef if($cnt eq "0");
|
|
$cnt = 0 if(!$cnt);
|
|
$cnt--;
|
|
delete($hash->{VOLATILE}); # Modify
|
|
$hash->{REP} = $cnt;
|
|
} else {
|
|
$hash->{VOLATILE} = 1; # Write these entries to the statefile
|
|
delete($hash->{REP}); # Modify
|
|
}
|
|
|
|
my $alTime = AttrVal($name, "alignTime", undef);
|
|
|
|
if(!$data{AT_RECOMPUTE} && $alTime) {
|
|
my $ret = at_adjustAlign($hash, $alTime);
|
|
return $ret if($ret);
|
|
|
|
} else {
|
|
my $fmt = FmtDateTime($nt);
|
|
$hash->{TRIGGERTIME} = $nt;
|
|
$hash->{TRIGGERTIME_FMT} = $fmt;
|
|
if($hash->{PERIODIC} eq "no") { # Need for restart
|
|
$fmt =~ s/ /T/;
|
|
$hash->{DEF} = $fmt." ".$hash->{COMMAND};
|
|
}
|
|
RemoveInternalTimer($hash);
|
|
InternalTimer($nt, "at_Exec", $hash, 0);
|
|
$hash->{NTM} = $ntm if($rel eq "+" || $fn);
|
|
my $d = IsDisabled($name); # 1
|
|
my $val = ($d==3 ? "inactive" : ($d ? "disabled":("Next: ".
|
|
($abstime ? FmtDateTime($nt) : FmtTime($nt)) )));
|
|
readingsSingleUpdate($hash, "state", $val,
|
|
!$hash->{READINGS}{state} || $hash->{READINGS}{state}{VAL} ne $val);
|
|
}
|
|
|
|
return undef;
|
|
}
|
|
|
|
sub
|
|
at_Undef($$)
|
|
{
|
|
my ($hash, $name) = @_;
|
|
$hash->{DELETED} = 1;
|
|
RemoveInternalTimer($hash);
|
|
return undef;
|
|
}
|
|
|
|
sub
|
|
at_Exec($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
return if($hash->{DELETED}); # Just deleted
|
|
my $name = $hash->{NAME};
|
|
|
|
my $skip = AttrVal($name, "skip_next", ReadingsVal($name, "skip_next", 0));
|
|
if($skip) {
|
|
delete $attr{$name}{skip_next};
|
|
readingsDelete($hash,"skip_next");
|
|
}
|
|
$hash->{TEMPORARY} = 1 if($hash->{VOLATILE}); # 68680
|
|
delete $hash->{VOLATILE};
|
|
|
|
if(!$skip && !IsDisabled($name)) {
|
|
Log3 $name, 5, "exec at command $name";
|
|
my $ret = AnalyzeCommandChain(undef, SemicolonEscape($hash->{COMMAND}));
|
|
Log3 $name, 3, "$name: $ret" if($ret);
|
|
}
|
|
|
|
return if($hash->{DELETED}); # Deleted in the Command
|
|
|
|
my $count = $hash->{REP};
|
|
my $def = $hash->{DEF};
|
|
|
|
# Avoid drift when the timespec is relative
|
|
$data{AT_TRIGGERTIME} = $hash->{TRIGGERTIME} if($def =~ m/^\+/);
|
|
|
|
if($count) {
|
|
$def =~ s/\{\d+\}/{$count}/ if($def =~ m/^\+?\*\{\d+\}/); # Replace count
|
|
Log3 $name, 5, "redefine at command $name as $def";
|
|
|
|
$data{AT_RECOMPUTE} = 1; # Tell sunrise compute the next day
|
|
at_Define($hash, "$name at $def"); # Recompute the next TRIGGERTIME
|
|
delete($data{AT_RECOMPUTE});
|
|
|
|
} else {
|
|
CommandDelete(undef, $name); # We are done
|
|
|
|
}
|
|
delete($data{AT_TRIGGERTIME});
|
|
}
|
|
|
|
sub
|
|
at_adjustAlign($$)
|
|
{
|
|
my($hash, $attrVal) = @_;
|
|
|
|
my ($tm, $command) = split("[ \t]+", $hash->{DEF}, 2);
|
|
$tm =~ m/^(\+)?(\*(\{\d+\})?)?(.*)$/;
|
|
my ($rel, $rep, $cnt, $tspec) = ($1, $2, $3, $4);
|
|
return "startTimes: $hash->{NAME} is not relative" if(!$rel);
|
|
|
|
my ($err, $ttime) = computeAlignTime($tspec, $attrVal,$hash->{TRIGGERTIME});
|
|
return "$hash->{NAME} $err" if($err);
|
|
|
|
RemoveInternalTimer($hash);
|
|
InternalTimer($ttime, "at_Exec", $hash, 0);
|
|
$hash->{TRIGGERTIME} = $ttime;
|
|
$hash->{TRIGGERTIME_FMT} = FmtDateTime($ttime);
|
|
$hash->{STATE} = "Next: " . FmtTime($ttime);
|
|
$hash->{NTM} = FmtTime($ttime);
|
|
readingsSingleUpdate($hash, "state", $hash->{STATE}, 1)
|
|
if(!IsDisabled($hash->{NAME}));
|
|
return undef;
|
|
}
|
|
|
|
sub
|
|
at_Set($@)
|
|
{
|
|
my ($hash, @a) = @_;
|
|
|
|
my %sets =(modifyTimeSpec=>1,inactive=>0,active=>0,execNow=>0,"skip_next"=>0);
|
|
my $cmd = join(" ", sort keys %sets);
|
|
$cmd =~ s/modifyTimeSpec/modifyTimeSpec:time/ if($at_detailFnCalled);
|
|
$at_detailFnCalled = 0;
|
|
return "no set argument specified" if(int(@a) < 2);
|
|
return "Unknown argument $a[1], choose one of $cmd"
|
|
if(!defined($sets{$a[1]}));
|
|
|
|
if($a[1] eq "modifyTimeSpec") {
|
|
my ($err, undef) = GetTimeSpec($a[2]);
|
|
return $err if($err);
|
|
|
|
my $def = ($hash->{RELATIVE} eq "yes" ? "+":"").
|
|
($hash->{PERIODIC} eq "yes" ? "*":"").
|
|
$a[2];
|
|
$hash->{OLDDEF} = $hash->{DEF};
|
|
my $ret = at_Define($hash, "$hash->{NAME} at $def");
|
|
delete $hash->{OLDDEF};
|
|
return $ret;
|
|
|
|
} elsif($a[1] eq "inactive") {
|
|
readingsSingleUpdate($hash, "state", "inactive", 1);
|
|
return undef;
|
|
|
|
} elsif($a[1] eq "active") {
|
|
readingsSingleUpdate($hash,"state","Next: ".FmtTime($hash->{TRIGGERTIME}),1)
|
|
if(!AttrVal($hash->{NAME}, "disable", undef));
|
|
return undef;
|
|
|
|
} elsif($a[1] eq "execNow") {
|
|
my $name = $hash->{NAME};
|
|
my $ret = AnalyzeCommandChain(undef, SemicolonEscape($hash->{COMMAND}));
|
|
Log3 $name, 3, "$name: $ret" if($ret);
|
|
|
|
} elsif($a[1] eq "skip_next") {
|
|
setReadingsVal($hash, $a[1], 1, TimeNow());
|
|
return undef;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
sub
|
|
at_Attr(@)
|
|
{
|
|
my ($cmd, $name, $attrName, $attrVal) = @_;
|
|
my $do = 0;
|
|
|
|
my $hash = $defs{$name};
|
|
|
|
if($cmd eq "set" && $attrName eq "computeAfterInit" &&
|
|
$attrVal && !$init_done) {
|
|
InternalTimer(1, sub(){
|
|
$hash->{OLDDEF} = $hash->{DEF};
|
|
at_Define($hash, "$name at $hash->{DEF}");
|
|
delete($hash->{OLDDEF});
|
|
}, $name, 0);
|
|
return undef;
|
|
}
|
|
|
|
if($cmd eq "set" && $attrName eq "alignTime") {
|
|
return "alignTime needs a list of timespec parameters" if(!$attrVal);
|
|
my $ret = at_adjustAlign($hash, $attrVal);
|
|
return $ret if($ret);
|
|
}
|
|
|
|
if($cmd eq "set" && $attrName eq "stateFormat" && !$init_done) {
|
|
$attr{$name}{stateFormat} = $attrVal;
|
|
evalStateFormat($hash);
|
|
return undef;
|
|
}
|
|
|
|
if($cmd eq "set" && $attrName eq "disable") {
|
|
$do = (!defined($attrVal) || $attrVal) ? 1 : 2;
|
|
}
|
|
$do = 2 if($cmd eq "del" && (!$attrName || $attrName eq "disable"));
|
|
return if(!$do);
|
|
my $val = ($do == 1 ? "disabled" :
|
|
"Next: " . FmtTime($hash->{TRIGGERTIME}));
|
|
readingsSingleUpdate($hash, "state", $val, 1);
|
|
return undef;
|
|
}
|
|
|
|
#############
|
|
# Adjust one-time relative at's after reboot, the execution time is stored as
|
|
# state
|
|
sub
|
|
at_State($$$$)
|
|
{
|
|
my ($hash, $tim, $vt, $val) = @_;
|
|
|
|
if($vt eq "state" && $val eq "inactive") {
|
|
readingsSingleUpdate($hash, "state", "inactive", 1);
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
#########################
|
|
sub
|
|
at_fhemwebFn($$$$)
|
|
{
|
|
my ($FW_wname, $d, $room, $pageHash) = @_; # pageHash is set for summaryFn.
|
|
my $hash = $defs{$d};
|
|
|
|
$at_detailFnCalled = 1 if(!$pageHash);
|
|
|
|
my $ts = $hash->{TIMESPEC}; $ts =~ s/'/\\'/g;
|
|
my $isPerl = ($ts =~ m/^{(.*)}/);
|
|
$ts = $1 if($isPerl);
|
|
|
|
my $h1 .= "<div class='makeTable wide'><span>Change wizard</span>".
|
|
"<table class='block wide' id='atWizard' nm='$hash->{NAME}' ts='$ts' ".
|
|
"rl='$hash->{RELATIVE}' ".
|
|
"pr='$hash->{PERIODIC}' ip='$isPerl' class='block wide'>".<<'EOF';
|
|
<tr class="even"><td>Change the timespec:</td></tr>
|
|
<tr class="odd">
|
|
<td>Relative <input type="checkbox" id="aw_rl" value="yes">
|
|
Periodic <input type="checkbox" id="aw_pr" value="yes">
|
|
Use perl function for timespec <input type="checkbox" id="aw_ip"></td>
|
|
</tr><tr class="even"><td><input type="text" name="aw_pts"></td>
|
|
</tr><tr class="even"><td><input type="text" name="aw_ts"></td>
|
|
</tr><tr class="odd"><td><input type="button" id="aw_md"
|
|
value="Change the timespec"></td>
|
|
</tr>
|
|
EOF
|
|
|
|
my $j1 = << 'EOF';
|
|
<script type="text/javascript">
|
|
{
|
|
var t=$("#atWizard"), ip=$(t).attr("ip"), ts=$(t).attr("ts");
|
|
FW_replaceWidget("[name=aw_ts]", "aw_ts", ["time"], "12:00");
|
|
$("[name=aw_ts] input[type=text]").attr("id", "aw_ts");
|
|
|
|
function ipClick() {
|
|
var c = $("#aw_ip").prop("checked");
|
|
$("[name=aw_ts]") .closest("tr").css("display",!c ? "table-row" : "none");
|
|
$("[name=aw_pts]").closest("tr").css("display", c ? "table-row" : "none");
|
|
}
|
|
$("#aw_rl").prop("checked", $(t).attr("rl")=="yes");
|
|
$("#aw_pr").prop("checked", $(t).attr("pr")=="yes");
|
|
$("#aw_ip").prop("checked", ip);
|
|
$("[name=aw_ts]").val(ip ? "12:00" : ts);
|
|
$("[name=aw_pts]").val(ip ? ts : 'sunset()');
|
|
$("#aw_ip").change(ipClick);
|
|
ipClick();
|
|
$("#aw_md").click(function(){
|
|
var nm = $(t).attr("nm");
|
|
var def = nm+" ";
|
|
def += $("#aw_rl").prop("checked") ? "+":"";
|
|
def += $("#aw_pr").prop("checked") ? "*":"";
|
|
def += $("#aw_ip").prop("checked") ?
|
|
"{"+$("[name=aw_pts]").val()+"}" : $("[name=aw_ts]").val();
|
|
def = def.replace(/\+/g, "%2b");
|
|
def = def.replace(/;/g, ";;");
|
|
location = location.pathname+"?detail="+nm+"&cmd=modify "+addcsrf(def);
|
|
});
|
|
}
|
|
</script>
|
|
EOF
|
|
|
|
my @d = split(" ",$hash->{DEF},2);
|
|
LoadModule("notify");
|
|
my ($h2, $j2) = notfy_addFWCmd($d, $d[0], 2);
|
|
return "$h1$h2</table></div><br>$j1$j2";
|
|
}
|
|
|
|
sub
|
|
at_ultimo(;$$$)
|
|
{
|
|
my ($h,$m,$s) = @_;
|
|
$h //= 23;
|
|
$m //= 59;
|
|
$s //= 0;
|
|
my $add = $data{AT_RECOMPUTE} ? DAYSECONDS : 0;
|
|
my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
|
|
localtime(time+$add);
|
|
my ($nm, $ny) = ($mon == 11) ? (0,$year+1) : ($mon+1,$year);
|
|
return mktime($s,$m,$h,1,$nm,$ny) - DAYSECONDS;
|
|
}
|
|
|
|
1;
|
|
|
|
=pod
|
|
=item summary start an FHEM command at a later time
|
|
=item summary_DE FHEM Befehl zu einem späteren Zeitpunkt starten
|
|
=item helper
|
|
=begin html
|
|
|
|
<a id="at"></a>
|
|
<h3>at</h3>
|
|
<ul>
|
|
|
|
Start an arbitrary FHEM command at a later time.<br>
|
|
<br>
|
|
|
|
<a id="at-define"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<code>define <name> at [<timespec>|<datespec>]
|
|
<command></code><br>
|
|
<br>
|
|
<code><timespec></code> format: [+][*{N}]<timedet><br>
|
|
<ul>
|
|
The optional <code>+</code> indicates that the specification is
|
|
<i>relative</i>(i.e. it will be added to the current time).<br>
|
|
The optional <code>*</code> indicates that the command should be
|
|
executed <i>repeatedly</i>.<br>
|
|
The optional <code>{N}</code> after the * indicates,that the command
|
|
should be repeated <i>N-times</i> only.<br>
|
|
|
|
<timespec> is either HH:MM, HH:MM:SS or {perlfunc()}. perlfunc must
|
|
return a string in timedet format. Note: {perlfunc()} may not contain
|
|
any spaces or tabs.<br>
|
|
|
|
<datespec> is either ISO8601 (YYYY-MM-DDTHH:MM:SS) or number of
|
|
seconds since 1970 or {perlfunc()}.
|
|
</ul>
|
|
<br>
|
|
|
|
Examples:
|
|
<PRE>
|
|
# absolute ones:
|
|
define a1 at 17:00:00 set lamp on # fhem command
|
|
define a2 at 17:00:00 { Log 1, "Teatime" } # Perl command
|
|
define a3 at 17:00:00 "/bin/echo "Teatime" > /dev/console" # shell command
|
|
define a4 at *17:00:00 set lamp on # every day
|
|
|
|
# relative ones
|
|
define a5 at +00:00:10 set lamp on # switch on in 10 seconds
|
|
define a6 at +00:00:02 set lamp on-for-timer 1 # Blink once in 2 seconds
|
|
define a7 at +*{3}00:00:02 set lamp on-for-timer 1 # Blink 3 times
|
|
|
|
# Blink 3 times if the piri sends a command
|
|
define n1 notify piri:on.* define a8 at +*{3}00:00:02 set lamp on-for-timer 1
|
|
|
|
# Switch the lamp on from sunset to 11 PM
|
|
define a9 at +*{sunset_rel()} set lamp on
|
|
define a10 at *23:00:00 set lamp off
|
|
|
|
# More elegant version, works for sunset > 23:00 too
|
|
define a11 at +*{sunset_rel()} set lamp on-till 23:00
|
|
|
|
# Only do this on weekend
|
|
define a12 at +*{sunset_rel()} { fhem("set lamp on-till 23:00") if($we) }
|
|
|
|
# Switch lamp1 and lamp2 on from 7:00 till 10 minutes after sunrise
|
|
define a13 at *07:00 set lamp1,lamp2 on-till {sunrise(+600)}
|
|
|
|
# Switch the lamp off 2 minutes after sunrise each day
|
|
define a14 at *{sunrise(+120)} set lamp on
|
|
|
|
# Switch lamp1 on at sunset, not before 18:00 and not after 21:00
|
|
define a15 at *{sunset(0,"18:00","21:00")} set lamp1 on
|
|
|
|
</PRE>
|
|
|
|
Notes:<br>
|
|
<ul>
|
|
<li>if no <code>*</code> is specified, then a command will be executed
|
|
only once, and then the <code>at</code> entry will be deleted. In
|
|
this case the command will be saved to the statefile (as it
|
|
considered volatile, i.e. entered by cronjob) and not to the
|
|
configfile (see the <a href="#save">save</a> command.)
|
|
</li>
|
|
|
|
<li>if the current time is greater than the time specified, then the
|
|
command will be executed tomorrow.</li>
|
|
|
|
<li>For even more complex date handling you either have to call fhem from
|
|
cron or filter the date in a perl expression, see the last example and
|
|
the section <a href="#perl">Perl special</a>.
|
|
</li>
|
|
<li>To execute a FHEM command on every last day of the month,<br/>
|
|
the function <code>at_ultimo()</code> can be used as perlfunc for
|
|
datespec.</br>
|
|
<code>define at_ultimo at *{at_ultimo()} set lamp1 off</code><br/>
|
|
This will create an at device which will be executed at 23:59:00
|
|
on the last day of month.</br>
|
|
at_ultimo() can take additional parameters to specify an other time
|
|
on this day<br/>
|
|
<code>define at_ultimo at *{at_ultimo(12,23,45)} set lamp1
|
|
off</code><br/>
|
|
This will create an at device which will be executed ad 12:34:45
|
|
on the last day of month.<br/>
|
|
</li>
|
|
</ul>
|
|
<br>
|
|
</ul>
|
|
|
|
|
|
<a id="at-set"></a>
|
|
<b>Set</b>
|
|
<ul>
|
|
<a id="at-set-modifyTimeSpec"></a>
|
|
<li>modifyTimeSpec <timespec><br>
|
|
Change the execution time. Note: the N-times repetition is ignored.
|
|
It is intended to be used in combination with
|
|
<a href="#webCmd">webCmd</a>, for an easier modification from the room
|
|
overview in FHEMWEB.</li>
|
|
<a id="at-set-inactive"></a>
|
|
<li>inactive<br>
|
|
Inactivates the current device. Note the slight difference to the
|
|
disable attribute: using set inactive the state is automatically saved
|
|
to the statefile on shutdown, there is no explicit save necesary.<br>
|
|
This command is intended to be used by scripts to temporarily
|
|
deactivate the at.<br>
|
|
The concurrent setting of the disable attribute is not recommended.
|
|
</li>
|
|
<a id="at-set-active"></a>
|
|
<li>active<br>
|
|
Activates the current device (see inactive).</li>
|
|
<a id="at-set-execNow"></a>
|
|
<li>execNow<br>
|
|
Execute the command associated with the at. The execution of a relative
|
|
at is not affected by this command.</li>
|
|
<a id="at-set-skip_next"></a>
|
|
<li>skip_next<br>
|
|
skip the next execution. Just like the attribute with the same name,
|
|
but better suited for webCmd.
|
|
</li>
|
|
|
|
</ul><br>
|
|
|
|
<a id="at-get"></a>
|
|
<b>Get</b> <ul>N/A</ul><br>
|
|
|
|
<a id="at-attr"></a>
|
|
<b>Attributes</b>
|
|
<ul>
|
|
<a id="at-attr-alignTime"></a>
|
|
<li>alignTime<br>
|
|
Applies only to relative at definitions: adjust the time of the next
|
|
command execution so, that it will also be executed at the desired
|
|
alignTime. The argument is a timespec, see above for the
|
|
definition.<br>
|
|
Example:<br>
|
|
<ul>
|
|
# Make sure that it chimes when the new hour begins<br>
|
|
define at2 at +*01:00 set Chime on-for-timer 1<br>
|
|
attr at2 alignTime 00:00<br>
|
|
</ul>
|
|
</li><br>
|
|
|
|
<a id="at-attr-computeAfterInit"></a>
|
|
<li>computeAfterInit<br>
|
|
If perlfunc() in the timespec relies on some other/dummy readings, then
|
|
it will return a wrong time upon FHEM start, as the at define is
|
|
processed before the readings are known. If computeAfterInit is set,
|
|
FHEM will recompute timespec after the initialization is finished.
|
|
</li><br>
|
|
|
|
<li><a href="#disable">disable</a></li>
|
|
<li><a href="#disabledForIntervals">disabledForIntervals</a></li>
|
|
|
|
<a id="at-attr-skip_next"></a>
|
|
<li>skip_next<br>
|
|
Used for at commands: skip the execution of the command the next
|
|
time.</li><br>
|
|
|
|
<li><a href="#perlSyntaxCheck">perlSyntaxCheck</a></li>
|
|
|
|
</ul>
|
|
<br>
|
|
</ul>
|
|
|
|
=end html
|
|
|
|
=begin html_DE
|
|
|
|
<a id="at"></a>
|
|
<h3>at</h3>
|
|
<ul>
|
|
|
|
Startet einen beliebigen FHEM Befehl zu einem späteren Zeitpunkt.<br>
|
|
<br>
|
|
|
|
<a id="at-define"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<code>define <name> at [<timespec>|<datespec>]
|
|
<command></code><br>
|
|
<br>
|
|
<code><timespec></code> Format: [+][*{N}]<timedet><br>
|
|
<ul>
|
|
Das optionale <code>+</code> zeigt, dass die Angabe <i>relativ</i> ist
|
|
(also zur jetzigen Zeit dazugezählt wird).<br>
|
|
|
|
Das optionale <code>*</code> zeigt, dass die Ausführung
|
|
<i>wiederholt</i> erfolgen soll.<br>
|
|
|
|
Das optionale <code>{N}</code> nach dem * bedeutet, dass der Befehl genau
|
|
<i>N-mal</i> wiederholt werden soll.<br>
|
|
|
|
<timespec> ist entweder HH:MM, HH:MM:SS oder {perlfunc()}.
|
|
perlfunc muss ein String in timedet Format zurückliefern. Achtung:
|
|
{perlfunc()} darf keine Leerzeichen enthalten.<br>
|
|
|
|
<datespec> ist entweder ISO8601 (YYYY-MM-DDTHH:MM:SS) oder Anzahl
|
|
der Sekunden seit 1970 oder {perlfunc()}.
|
|
|
|
</ul>
|
|
<br>
|
|
|
|
Beispiele:
|
|
<PRE>
|
|
# Absolute Beispiele:
|
|
define a1 at 17:00:00 set lamp on # fhem Befehl
|
|
define a2 at 17:00:00 { Log 1, "Teatime" } # Perl Befehl
|
|
define a3 at 17:00:00 "/bin/echo "Teatime" > /dev/console" # shell Befehl
|
|
define a4 at *17:00:00 set lamp on # Jeden Tag
|
|
|
|
# Realtive Beispiele:
|
|
define a5 at +00:00:10 set lamp on # Einschalten in 10 Sekunden
|
|
define a6 at +00:00:02 set lamp on-for-timer 1 # Einmal blinken in 2 Sekunden
|
|
define a7 at +*{3}00:00:02 set lamp on-for-timer 1 # Blinke 3 mal
|
|
|
|
# Blinke 3 mal wenn piri einen Befehl sendet
|
|
define n1 notify piri:on.* define a8 at +*{3}00:00:02 set lamp on-for-timer 1
|
|
|
|
# Lampe von Sonnenuntergang bis 23:00 Uhr einschalten
|
|
define a9 at +*{sunset_rel()} set lamp on
|
|
define a10 at *23:00:00 set lamp off
|
|
|
|
# Elegantere Version, ebenfalls von Sonnenuntergang bis 23:00 Uhr
|
|
define a11 at +*{sunset_rel()} set lamp on-till 23:00
|
|
|
|
# Nur am Wochenende ausführen
|
|
define a12 at +*{sunset_rel()} { fhem("set lamp on-till 23:00") if($we) }
|
|
|
|
# Schalte lamp1 und lamp2 ein von 7:00 bis 10 Minuten nach Sonnenaufgang
|
|
define a13 at *07:00 set lamp1,lamp2 on-till {sunrise(+600)}
|
|
|
|
# Schalte lamp jeden Tag 2 Minuten nach Sonnenaufgang aus
|
|
define a14 at *{sunrise(+120)} set lamp on
|
|
|
|
# Schalte lamp1 zum Sonnenuntergang ein, aber nicht vor 18:00 und nicht nach 21:00
|
|
define a15 at *{sunset(0,"18:00","21:00")} set lamp1 on
|
|
|
|
</PRE>
|
|
|
|
Hinweise:<br>
|
|
<ul>
|
|
<li>wenn kein <code>*</code> angegeben wird, wird der Befehl nur einmal
|
|
ausgeführt und der entsprechende <code>at</code> Eintrag danach
|
|
gelöscht. In diesem Fall wird der Befehl im Statefile gespeichert
|
|
(da er nicht statisch ist) und steht nicht im Config-File (siehe auch <a
|
|
href="#save">save</a>).</li>
|
|
|
|
<li>wenn die aktuelle Zeit größer ist als die angegebene Zeit,
|
|
dann wird der Befehl am folgenden Tag ausgeführt.</li>
|
|
|
|
<li>Für noch komplexere Datums- und Zeitabläufe muss man den
|
|
Aufruf entweder per cron starten oder Datum/Zeit mit perl weiter
|
|
filtern. Siehe hierzu das letzte Beispiel und das <a href="#perl">Perl
|
|
special</a>. </li>
|
|
|
|
<li>Um einen FHEM Befehl immer am letzten Tag des Monats auszuführen,
|
|
kann die Funktion <code>at_ultimo()</code> als perlfunc für eine
|
|
datespec verwendet werden.</br>
|
|
<code>define at_ultimo at *{at_ultimo()} set lamp1 off</code><br/>
|
|
Hiermit wird ein at device erzeugt, der immer am letzten Tag des
|
|
Monats um 23:59:00 Uhr ausgeführt wird.<br/>
|
|
at_ultimo() kann drei optionale Parameter verarbeiten, um eine andere
|
|
Uhrzeit anzugeben.<br/>
|
|
<code>define at_ultimo at *{at_ultimo(12,23,45)} set lamp1
|
|
off</code><br/>
|
|
Es wird ein at device erzeugt, das immer um 12:34:45 am Monatsletzten
|
|
ausgeführt wird.<br/>
|
|
</li>
|
|
</ul>
|
|
<br>
|
|
</ul>
|
|
|
|
|
|
<a id="at-set"></a>
|
|
<b>Set</b>
|
|
<ul>
|
|
<a id="at-set-modifyTimeSpec"></a>
|
|
<li>modifyTimeSpec <timespec><br>
|
|
Ändert die Ausführungszeit. Achtung: die N-malige
|
|
Wiederholungseinstellung wird ignoriert. Gedacht zur einfacheren
|
|
Modifikation im FHEMWEB Raumübersicht, dazu muss man
|
|
modifyTimeSpec in <a href="webCmd">webCmd</a> spezifizieren.
|
|
</li>
|
|
<a id="at-set-inactive"></a>
|
|
<li>inactive<br>
|
|
Deaktiviert das entsprechende Gerät. Beachte den leichten
|
|
semantischen Unterschied zum disable Attribut: "set inactive"
|
|
wird bei einem shutdown automatisch in fhem.state gespeichert, es ist
|
|
kein save notwendig.<br>
|
|
Der Einsatzzweck sind Skripte, um das at temporär zu
|
|
deaktivieren.<br>
|
|
Das gleichzeitige Verwenden des disable Attributes wird nicht empfohlen.
|
|
</li>
|
|
<a id="at-set-active"></a>
|
|
<li>active<br>
|
|
Aktiviert das entsprechende Gerät, siehe inactive.
|
|
</li>
|
|
<a id="at-set-execNow"></a>
|
|
<li>execNow<br>
|
|
Führt das mit dem at spezifizierte Befehl aus. Beeinflußt
|
|
nicht die Ausführungszeiten relativer Spezifikationen.
|
|
</li>
|
|
<a id="at-set-skip_next"></a>
|
|
<li>skip_next<br>
|
|
genau wie der gleichnamige Attribut, verhindert die nächste
|
|
Ausführung. Als set Befehl, eignet sich besser für webCmd.
|
|
</li>
|
|
</ul><br>
|
|
|
|
|
|
<a id="atget"></a>
|
|
<b>Get</b> <ul>N/A</ul><br>
|
|
|
|
<a id="at-attr"></a>
|
|
<b>Attribute</b>
|
|
<ul>
|
|
<a id="at-attr-alignTime"></a>
|
|
<li>alignTime<br>
|
|
Nur für relative Definitionen: Stellt den Zeitpunkt der
|
|
Ausführung des Befehls so, dass er auch zur alignTime
|
|
ausgeführt wird. Dieses Argument ist ein timespec. Siehe oben
|
|
für die Definition<br>
|
|
|
|
Beispiel:<br>
|
|
<ul>
|
|
# Stelle sicher das es gongt wenn eine neue Stunde beginnt.<br>
|
|
define at2 at +*01:00 set Chime on-for-timer 1<br>
|
|
attr at2 alignTime 00:00<br>
|
|
</ul>
|
|
</li><br>
|
|
|
|
<a id="at-attr-computeAfterInit"></a>
|
|
<li>computeAfterInit<br>
|
|
Falls perlfunc() im timespec Readings or Statusinformationen
|
|
benögt, dann wird sie eine falsche Zeit beim FHEM-Start
|
|
zurückliefern, da zu diesem Zeitpunkt die Readings noch nicht aktiv
|
|
sind. Mit gesetztem computeAfterInit wird perlfunc nach Setzen aller
|
|
Readings erneut ausgeführt. (Siehe Forum #56706)
|
|
</li><br>
|
|
|
|
<li><a href="#disable">disable</a></li>
|
|
<li><a href="#disabledForIntervals">disabledForIntervals</a></li>
|
|
|
|
<a id="at-attr-skip_next"></a>
|
|
<li>skip_next<br>
|
|
Wird bei at Befehlen verwendet um die nächste Ausführung zu
|
|
überspringen</li><br>
|
|
|
|
<li><a href="#perlSyntaxCheck">perlSyntaxCheck</a></li>
|
|
<li><a href="#readingFnAttributes">readingFnAttributes</a></li>
|
|
|
|
</ul>
|
|
<br>
|
|
|
|
</ul>
|
|
|
|
=end html_DE
|
|
|
|
=cut
|