mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-01-31 12:49:34 +00:00
Perl specials rewrite
git-svn-id: https://svn.fhem.de/fhem/trunk@980 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
rudolfkoenig
parent
bdd07a055a
commit
e36dec11a4
@ -4198,21 +4198,27 @@ Attributes:<br>
|
|||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
The perl specials in the definitions of the set and get commands can contain macros. Apart from the rules
|
The perl specials in the definitions of the set and get commands can
|
||||||
outlined in the <a href="#perl">documentation of perl specials</a> in fhem, the following rules apply:<br><br>
|
contain macros. Apart from the rules outlined in the <a
|
||||||
|
href="#perl">documentation of perl specials</a> in fhem, the following
|
||||||
|
rules apply:<br><br>
|
||||||
<ul>
|
<ul>
|
||||||
<li>The character @ will be replaced with the device
|
<li>The character @ will be replaced with the device
|
||||||
name. To use @ in the text itself, use the double mode (@@).</li>
|
name. To use @ in the text itself, use the double mode (@@).</li>
|
||||||
|
|
||||||
<li>The macro <code>%NAME</code> will expand to the device name (same as <code>@</code>).</li>
|
<li>The macro <code>%NAME</code> will expand to the device name (same
|
||||||
|
as <code>@</code>).</li>
|
||||||
|
|
||||||
<li>The macro <code>%<parameter></code> will expand to the current value of the
|
<li>The macro <code>%<parameter></code> will expand to the
|
||||||
named parameter. This can be either a parameter from the device definition or a parameter
|
current value of the named parameter. This can be either a parameter
|
||||||
from the set or get command.</li>
|
from the device definition or a parameter from the set or get
|
||||||
|
command.</li>
|
||||||
|
|
||||||
<li>The macro substitution occurs before perl evaluates the expression. It is a plain text substitution.</li>
|
<li>The macro substitution occurs before perl evaluates the
|
||||||
|
expression. It is a plain text substitution.</li>
|
||||||
|
|
||||||
<li>If in doubt what happens, run the commands with loglevel 5 and observe the log file.</li>
|
<li>If in doubt what happens, run the commands with loglevel 5 and
|
||||||
|
observe the log file.</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</ul>
|
</ul>
|
||||||
@ -7041,7 +7047,7 @@ isday</pre>
|
|||||||
In this case only one specific graphic will be rendered assuming that plotmode is 'gnuplot-scroll':<br>
|
In this case only one specific graphic will be rendered assuming that plotmode is 'gnuplot-scroll':<br>
|
||||||
A graphic will be rendered for 'device', where device is a FileLog, based on the type 'type' based on the given 'logfile'<br>
|
A graphic will be rendered for 'device', where device is a FileLog, based on the type 'type' based on the given 'logfile'<br>
|
||||||
The 'zoom' will be either qday/day/week/month/year (same as used in FHEMWEB).<br>
|
The 'zoom' will be either qday/day/week/month/year (same as used in FHEMWEB).<br>
|
||||||
The offset 'off' is either 0 (then the second part can be omitted, or -1/-2.... to jump back in time.<br>
|
The offset 'off' is either 0 (then the second part can be omitted), or -1/-2.... to jump back in time.<br>
|
||||||
The resulting filename will be 'attr-tmpfile file-name.png'<br>
|
The resulting filename will be 'attr-tmpfile file-name.png'<br>
|
||||||
<br>
|
<br>
|
||||||
NOTE: If you want to use zoom AND offset then you have to concatenate via '&' !!<br>
|
NOTE: If you want to use zoom AND offset then you have to concatenate via '&' !!<br>
|
||||||
@ -7221,90 +7227,132 @@ isday</pre>
|
|||||||
|
|
||||||
<a name="perl"></a>
|
<a name="perl"></a>
|
||||||
<h3>Perl specials</h3>
|
<h3>Perl specials</h3>
|
||||||
<ul>
|
If you want to automate some tasks via fhem, then you'll probably use <a
|
||||||
<li>To test perl oneliners, type them on the prompt by enclosing it in {}, e.g.<br>
|
href="#at">at</a> or <a href="#notify">notify</a>. For more complex tasks
|
||||||
<ul>
|
you'll use either a shell-Skript or a perl "oneliner" as the at/notify
|
||||||
{ Log 1, "Hallo" }
|
argument. This chapter gives some tips in using the perl oneliners.<br><br>
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li>To store some macros, see the Notes in the <a href="#notify">notify</a>
|
<li>To test perl oneliners, type them on the telnet prompt (or FHEMWEB text
|
||||||
description.</li>
|
input) by enclosing it in {}, one line at once. The last line will only
|
||||||
|
write something in the logfile, the output of the other lines is directly
|
||||||
|
visible.
|
||||||
|
<ul>
|
||||||
|
{ "Hello" }<br>
|
||||||
|
{ 1+3*4 }<br>
|
||||||
|
{ `ls /etc` }<br>
|
||||||
|
{ Log 1, "Hello" }<br>
|
||||||
|
</ul>
|
||||||
|
<br>
|
||||||
|
|
||||||
<li>To use fhem commands from the perl expression, use the function "fhem",
|
<li>
|
||||||
which takes a string argument, this string will be evaluated as a fhem
|
Perl expressions are separated by ;, in fhem oneliners they have to
|
||||||
command chain.<br>
|
escaped with ;;<br>
|
||||||
Example:
|
<ul>
|
||||||
<ul>
|
{ my $a = 1+1;; Log 1, "Hello $a" }
|
||||||
define n1 notify piri:on { fhem "set light on" }
|
</ul>
|
||||||
</ul></li>
|
<br>
|
||||||
|
|
||||||
<li>To make date and time handling easier, before evaluating a perl
|
<li>To use fhem commands from the perl expression, use the function fhem(),
|
||||||
expression the variables $sec, $min, $hour, $mday, $month, $year, $wday,
|
which takes a string argument, this string will be evaluated as a fhem
|
||||||
$yday, $isdst are set (see perldoc -f localtime), with the exception that
|
command:<br>
|
||||||
$month is in the range of 1 to 12, and $year is also corrected by 1900 (as
|
<ul>
|
||||||
one would normally expect). Additionally $we is 1 if it is weekend (i.e
|
{ fhem "set light on" }<br>
|
||||||
$wday == 0 || $wday == 6), and 0 otherwise. If the <a
|
define n1 notify piri:on { fhem "set light on" }
|
||||||
href="#holiday2we">holida2we</a> global attribute is set, $we is 1 for
|
</ul>
|
||||||
holidays too.
|
<br>
|
||||||
Example:
|
|
||||||
|
|
||||||
<ul>
|
<li>Notify can be used to store macros for manual execution. Use the <a
|
||||||
define n2 notify piri:on { if($hour > 18 || $hour < 5) { fhem "set
|
href="#trigger">trigger</a> command to execute the macro:<br>
|
||||||
light on" } }
|
<ul>
|
||||||
</ul></li>
|
define MyMacro notify MyMacro { Log 1, "Hello"}<br>
|
||||||
|
trigger MyMacro<br>
|
||||||
|
define MacroWithArg notify MyMacro { Log 1, "Hello %"}<br>
|
||||||
|
trigger MyMacro MyArg<br>
|
||||||
|
</ul>
|
||||||
|
<br>
|
||||||
|
|
||||||
<li>
|
|
||||||
The following small helper functions are defined in 99_Util.pm (which will
|
|
||||||
be loaded automatically):
|
|
||||||
<ul>
|
|
||||||
<li>min(a,b), max(a,b)</li>
|
|
||||||
<li>time_str2num("YYYY-MM-DD HH:MM:SS") returns a numerical value,
|
|
||||||
which makes computation of time differences easier</li>
|
|
||||||
<li>abstime2rel("HH:MM:SS") converts an absolute time to a relative one,
|
|
||||||
to compare it with the sunrise commands in the following example:<br>
|
|
||||||
# Switch lamp1 on at sunrise, but not before 07:00<br>
|
|
||||||
define a13 at +*{max(abstime2rel("07:00"),sunrise_rel())} set lamp1
|
|
||||||
on
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li>
|
<li>To make date and time handling easier, the variables $sec, $min, $hour,
|
||||||
<b>Note</b>: do not forget to escape the semicolon (;) with two semicolons
|
$mday, $month, $year, $wday, $yday, $isdst are available in the perl
|
||||||
(;;), else your perl code will be interpreted as an fhem command and you
|
oneliners (see also perldoc -f localtime). Exceptions: $month is in the
|
||||||
most certainly get syntax errors.
|
range of 1 to 12, and $year is corrected by 1900 (as I would expect).<br>
|
||||||
</li>
|
Additionally the variabe $we is 1 if it is weekend (i.e $wday == 0 or
|
||||||
|
$wday == 6), and 0 otherwise. If the <a href="#holiday2we">holida2we</a>
|
||||||
|
global attribute is set, $we is 1 for holidays too.<br>
|
||||||
|
<ul>
|
||||||
|
define n2 notify piri:on { if($hour > 18 || $hour < 5) {
|
||||||
|
fhem "set light on" } }<br>
|
||||||
|
define roll_en *07:45:00 { fhem "trigger SwitchAllRoll on" if(!$we) }<br>
|
||||||
|
define roll_en *08:30:00 { fhem "trigger SwitchAllRoll on" if($we) }<br>
|
||||||
|
|
||||||
<li>
|
</ul>
|
||||||
The current value (the string you see in paranthesis in the output of the
|
<br>
|
||||||
list command) is available in the <code>value</code> hash; to access it
|
|
||||||
use <code>Value("name")</code>. If you need the old value (and time) of
|
|
||||||
the currently triggered device, then you can access it with
|
|
||||||
<code>OldValue("name")</code> and <code>OldTimestamp("name")</code>.<br>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li>
|
<li>
|
||||||
To access the numerical value of an FS20 command (e.g. toggle), use the
|
The following helper functions are defined in 99_Util.pm (which will
|
||||||
hash <code>fs20_c2b</code>. E.g. { Log 2, $fs20_c2b{"toggle"} }
|
be loaded automatically, as every module with prefix 99):
|
||||||
</li>
|
<ul>
|
||||||
|
<li>min(a,b), max(a,b)</li>
|
||||||
|
<li>time_str2num("YYYY-MM-DD HH:MM:SS") returns a numerical value,
|
||||||
|
which makes computation of time differences easier</li>
|
||||||
|
<li>abstime2rel("HH:MM:SS") converts an absolute time to a relative one,
|
||||||
|
to compare it with the sunrise commands in the following example:<br>
|
||||||
|
# Switch lamp1 on at sunrise, but not before 07:00<br>
|
||||||
|
define a13 at +*{max(abstime2rel("07:00"),sunrise_rel())} set lamp1
|
||||||
|
on<br>
|
||||||
|
# Note that this functionality is easier to achieve with:<br>
|
||||||
|
define a13 at +*{sunrise_rel(0,"07:00",undef)} set lamp1 on<br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li>
|
<li>
|
||||||
By using the 99_SUNRISE_EL.pm module, you have access to the following
|
To access the device states/attributes, use the following functions:
|
||||||
functions: <br>
|
<br>
|
||||||
<ul>
|
<ul>
|
||||||
sunset_rel()<br>
|
<li>Value(<devicename>)<br>
|
||||||
sunset_abs()<br>
|
returns the state of the device (the string you see in paranthesis in
|
||||||
sunrise_rel()<br>
|
the output of the list command).
|
||||||
sunrise_abs()<br>
|
<br><br>
|
||||||
isday()<br>
|
<li>OldValue(<devicename>)
|
||||||
</ul>
|
<li>OldTimestamp(<devicename>)<br>
|
||||||
The _rel functions should be used as "at" spec, and the _abs functions as
|
returns the old value/timestamp of the device.
|
||||||
argument to the on-till argument of the set command.<br>
|
<br><br>
|
||||||
isday returns 1 if the sun is visible, and 0 else.
|
<li>
|
||||||
</li>
|
ReadingsVal(<devicename>,<reading>,<defaultvalue>)<br>
|
||||||
|
Return the reading (the value in the Readings section of "list device")
|
||||||
|
<br><br>
|
||||||
|
<li>
|
||||||
|
AttrVal(<devicename>,<attribute>,<defaultvalue>)<br>
|
||||||
|
Return the attribute of the device
|
||||||
|
<br><br>
|
||||||
|
{ Value("wz") }<br>
|
||||||
|
{ OldValue("wz") }<br>
|
||||||
|
{ time_str2num(OldTimestamp("wz")) }<br>
|
||||||
|
{ ReadingsVal("wz", "measured-temp", "20")+0 }<br>
|
||||||
|
{ AttrVal("wz", "room", "none") }<br>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<li>
|
||||||
|
By using the 99_SUNRISE_EL.pm module, you have access to the following
|
||||||
|
functions: <br>
|
||||||
|
<ul>
|
||||||
|
sunset_rel($offset, $min, $max)<br>
|
||||||
|
sunset_abs($offset, $min, $max)<br>
|
||||||
|
sunrise_rel($offset, $min, $max)<br>
|
||||||
|
sunrise_abs($offset, $min, $max)<br>
|
||||||
|
isday()<br>
|
||||||
|
</ul>
|
||||||
|
offset is in seconds, and the format of min/max is "HH:MM" or "HH:MM:SS".
|
||||||
|
isday returns 1 if the sun is visible, and 0 else.
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user