mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-02-08 05:15:10 +00:00
293 lines
8.1 KiB
Perl
Executable File
293 lines
8.1 KiB
Perl
Executable File
##############################################
|
|
# $Id$
|
|
package main;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use Time::HiRes qw(gettimeofday);
|
|
|
|
#####################################
|
|
sub
|
|
sequence_Initialize($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
$hash->{DefFn} = "sequence_Define";
|
|
$hash->{UndefFn} = "sequence_Undef";
|
|
$hash->{NotifyFn} = "sequence_Notify";
|
|
$hash->{AttrList} = "disable:0,1 triggerPartial:1,0 showtime:1,0 reportEvents:1,0";
|
|
}
|
|
|
|
|
|
#####################################
|
|
# define sq1 sequence reg1 [timeout reg2]
|
|
sub
|
|
sequence_Define($$)
|
|
{
|
|
my ($hash, $def) = @_;
|
|
my @def = split("[ \t]+", $def);
|
|
|
|
my $name = shift(@def);
|
|
my $type = shift(@def);
|
|
|
|
return "Usage: define <name> sequence <re1> <timeout1> <re2> ".
|
|
"[<timeout2> <re3> ...]"
|
|
if(int(@def) % 2 == 0 || int(@def) < 3);
|
|
|
|
# "Syntax" checking
|
|
for(my $i = 0; $i < int(@def); $i += 2) {
|
|
my $re = $def[$i];
|
|
my $to = $def[$i+1];
|
|
eval { "Hallo" =~ m/^$re$/ };
|
|
return "Bad regexp 1: $@" if($@);
|
|
return "Bad timeout spec $to"
|
|
if(defined($to) && $to !~ m/^\d*.?\d$/);
|
|
}
|
|
|
|
$hash->{RE} = $def[0];
|
|
$hash->{IDX} = 0;
|
|
$hash->{MAX} = int(@def);
|
|
$hash->{STATE} = "active";
|
|
return undef;
|
|
}
|
|
|
|
#####################################
|
|
sub
|
|
sequence_Notify($$)
|
|
{
|
|
my ($hash, $dev) = @_;
|
|
|
|
my $ln = $hash->{NAME};
|
|
return "" if($attr{$ln} && $attr{$ln}{disable});
|
|
|
|
my $n = $dev->{NAME};
|
|
my $re = $hash->{RE};
|
|
my $max = int(@{$dev->{CHANGED}});
|
|
|
|
for (my $i = 0; $i < $max; $i++) {
|
|
my $s = $dev->{CHANGED}[$i];
|
|
$s = "" if(!defined($s));
|
|
next if($n !~ m/^$re$/ && "$n:$s" !~ m/^$re$/);
|
|
|
|
RemoveInternalTimer($ln);
|
|
my $idx = $hash->{IDX} + 2;
|
|
Log3 $ln, 5, "sequence $ln matched $idx";
|
|
my @d = split("[ \t]+", $hash->{DEF});
|
|
$hash->{EVENTS} = "" if(!$hash->{EVENTS});
|
|
$hash->{EVENTS} .= " $n:$s";
|
|
|
|
if($idx > $hash->{MAX}) { # Last element reached
|
|
|
|
my $tt = "trigger";
|
|
$tt .= $hash->{EVENTS} if(AttrVal($ln, "reportEvents", undef));
|
|
delete($hash->{EVENTS});
|
|
|
|
Log3 $ln, 5, "sequence $ln $tt";
|
|
setReadingsVal($hash, "state", "active", TimeNow());
|
|
DoTrigger($ln, $tt);
|
|
$idx = 0;
|
|
|
|
} else {
|
|
|
|
$hash->{RE} = $d[$idx];
|
|
my $nt = gettimeofday() + $d[$idx-1];
|
|
InternalTimer($nt, "sequence_Trigger", $ln, 0);
|
|
|
|
}
|
|
|
|
$hash->{IDX} = $idx;
|
|
$hash->{RE} = $d[$idx];
|
|
last;
|
|
}
|
|
return "";
|
|
}
|
|
|
|
sub
|
|
sequence_Trigger($)
|
|
{
|
|
my ($ln) = @_;
|
|
my $hash = $defs{$ln};
|
|
my @d = split("[ \t]+", $hash->{DEF});
|
|
$hash->{RE} = $d[0];
|
|
my $idx = $hash->{IDX}/2;
|
|
$hash->{IDX} = 0;
|
|
my $tt = "partial_$idx";
|
|
Log3 $ln, 5, "sequence $ln timeout on $idx ($tt)";
|
|
$tt .= $hash->{EVENTS} if(AttrVal($ln, "reportEvents", undef));
|
|
delete($hash->{EVENTS});
|
|
|
|
DoTrigger($ln, $tt) if(AttrVal($ln, "triggerPartial", undef));
|
|
}
|
|
|
|
sub
|
|
sequence_Undef($$)
|
|
{
|
|
my ($hash, $name) = @_;
|
|
RemoveInternalTimer($name);
|
|
return undef;
|
|
}
|
|
|
|
1;
|
|
|
|
=pod
|
|
=item helper
|
|
=begin html
|
|
|
|
<a name="sequence"></a>
|
|
<h3>sequence</h3>
|
|
<ul>
|
|
<br>
|
|
|
|
<a name="sequencedefine"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<code>define <name> sequence <re1> <timeout1>
|
|
<re2> [<timeout2> <re3> ...]</code>
|
|
<br><br>
|
|
|
|
A sequence is used to allow to trigger events for a certain combination of
|
|
button presses on a remote. E.g. to switch on a lamp when pressing the
|
|
Btn1:on, then Btn2:off and at last Btn1:on one after the other you could
|
|
define the following:<br>
|
|
<br>
|
|
<ul>
|
|
<code>
|
|
define lampseq sequence Btn1:on 0.5 Btn2:off 0.5 Btn1:on<br>
|
|
define lampon notify lampseq:trigger set lamp on
|
|
</code>
|
|
</ul>
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="sequenceset"></a>
|
|
<b>Set</b> <ul>N/A</ul><br>
|
|
|
|
<a name="sequenceget"></a>
|
|
<b>Get</b> <ul>N/A</ul><br>
|
|
|
|
<a name="sequenceattr"></a>
|
|
<b>Attributes</b>
|
|
<ul>
|
|
<li><a href="#disable">disable</a></li>
|
|
<li><a href="#showtime">showtime</a></li>
|
|
<li><a href="#triggerPartial">triggerPartial</a><br>
|
|
if set (to 1), and not all the events of a sequence are received, then a
|
|
partial_X event is generated by the sequence. Example:<br><code><ul>
|
|
fhem> define seq sequence d1:on 1 d1:on 1 d1:on<br>
|
|
fhem> attr seq triggerPartial<br>
|
|
fhem> set d1 on;; sleep 0.5;; set d1 on<br>
|
|
</ul></code>
|
|
generates the event seq partial_2. This can be used to assign different
|
|
tasks for a single button, depending on the number of times it is
|
|
pressed.
|
|
</li><br>
|
|
<li><a href="#reportEvents">reportEvents</a><br>
|
|
if set (to 1), report the events (space separated) after the
|
|
"trigger" or "partial_X" keyword. This way one can create more general
|
|
sequences, and create different notifies to react:<br>
|
|
<ul><code>
|
|
define seq sequence remote:btn.* remote:btn.*<br>
|
|
attr seq reportEvents<br>
|
|
define n_b1b2 notify seq:trigger.remote:btn1.remote:btn2 set lamp1 on<br>
|
|
define n_b2b1 notify seq:trigger.remote:btn2.remote:btn1 set lamp1 off<br>
|
|
</code></ul>
|
|
</li>
|
|
</ul>
|
|
<br>
|
|
|
|
</ul>
|
|
|
|
=end html
|
|
|
|
=begin html_DE
|
|
|
|
<a name="sequence"></a>
|
|
<h3>sequence</h3>
|
|
<ul>
|
|
<br>
|
|
|
|
<a name="sequencedefine"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<code>define <name> sequence <re1> <timeout1>
|
|
<re2> [<timeout2> <re3> ...]</code>
|
|
<br><br>
|
|
|
|
Ein sequence kann verwendet werden, um ein neues Event zu generieren, wenn
|
|
eine bestimmte Folge von anderen Events in einem festgelegten Zeitraum
|
|
eingetroffen ist. Z.Bsp. um eine Lampe dann einzuschalten, falls Btn1:on,
|
|
dann Btn2:off und zum Schluss Btn3:on innerhalb einer Sekunde gedrückt
|
|
wurde, definiert man folgendes:<br>
|
|
<ul>
|
|
<code>
|
|
define lampseq sequence Btn1:on 0.5 Btn2:off 0.5 Btn1:on<br>
|
|
define lampon notify lampseq:trigger set lamp on
|
|
</code>
|
|
</ul>
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="sequenceset"></a>
|
|
<b>Set</b> <ul>N/A</ul><br>
|
|
|
|
<a name="sequenceget"></a>
|
|
<b>Get</b> <ul>N/A</ul><br>
|
|
|
|
<a name="sequenceattr"></a>
|
|
<b>Attributes</b>
|
|
<ul>
|
|
<li><a href="#disable">disable</a></li>
|
|
<li><a href="#triggerPartial">triggerPartial</a><br>
|
|
Falls gesetzt (auf 1), und nicht alle erwarteten Events eingetroffen
|
|
sind, dann wird ein partial_X Event generiert, wobei X durch Anzahl der
|
|
eingetroffenen Events ersetzt wird. Beispiel:<br><code><ul>
|
|
fhem> define seq sequence d1:on 1 d1:on 1 d1:on<br>
|
|
fhem> attr seq triggerPartial<br>
|
|
fhem> set d1 on;; sleep 0.5;; set d1 on<br>
|
|
</ul></code>
|
|
erzeugt das Event "seq partial_2". Dies kann verwendet werden, um z.Bsp.
|
|
einer Taste unterschiedliche Aufgaben zuzuweisen, jenachdem wie oft sie
|
|
gedrückt wurde.
|
|
</li>
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="sequenceattr"></a>
|
|
<b>Attributes</b>
|
|
<ul>
|
|
<li><a href="#disable">disable</a></li>
|
|
<li><a href="#showtime">showtime</a></li>
|
|
<li><a href="#triggerPartial">triggerPartial</a><br>
|
|
Falls gesetzt (auf 1), und nicht alle erwarteten Events eingetroffen
|
|
sind, dann wird ein partial_X Event generiert, wobei X durch Anzahl der
|
|
eingetroffenen Events ersetzt wird. Beispiel:<br><code><ul>
|
|
fhem> define seq sequence d1:on 1 d1:on 1 d1:on<br>
|
|
fhem> attr seq triggerPartial<br>
|
|
fhem> set d1 on;; sleep 0.5;; set d1 on<br>
|
|
</ul></code>
|
|
erzeugt das Event "seq partial_2". Dies kann verwendet werden, um z.Bsp.
|
|
einer Taste unterschiedliche Aufgaben zuzuweisen, jenachdem wie oft sie
|
|
gedrückt wurde.
|
|
</li><br>
|
|
|
|
<li><a href="#reportEvents">reportEvents</a><br>
|
|
Falls gesetzt (auf 1), meldet trigger die empfangenen Events (Leerzeichen
|
|
getrennt) nach dem "trigger" oder "partial_X" Schlüsselwort.
|
|
Das kann verwendet werden, um generische sequence Instanzen zu definieren:
|
|
<br>
|
|
<ul><code>
|
|
define seq sequence remote:btn.* remote:btn.*<br>
|
|
attr seq reportEvents<br>
|
|
define n_b1b2 notify seq:trigger.remote:btn1.remote:btn2 set lamp1 on<br>
|
|
define n_b2b1 notify seq:trigger.remote:btn2.remote:btn1 set lamp1 off<br>
|
|
</code></ul>
|
|
</li>
|
|
</ul>
|
|
<br>
|
|
|
|
</ul>
|
|
|
|
=end html_DE
|
|
|
|
=cut
|