FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-01-31 12:49:34 +00:00
Code Issues Releases Wiki Activity

99_SUNRISE_EL.pm: rewrite english doc (Forum #118899)

Browse Source 
git-svn-id: https://svn.fhem.de/fhem/trunk@24249 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
rudolfkoenig 2021-04-14 05:45:49 +00:00
parent c486f92762
commit 0f1903a01c
1 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
fhem/FHEM/99_SUNRISE_EL.pm
View File

@ -443,36 +443,39 @@ isday</pre>
alternatives. <br><br> alternatives. <br><br>
sunrise() and sunset() return the absolute time of the next sunrise/sunset, sunrise() and sunset() return the absolute time of the next sunrise/sunset,
adding 24 hours if the next event is tomorrow, to use it in the timespec of adding 24 hours if the next event is tomorrow<br>
an at device or for the on-till command for FS20 devices.<br>
sunrise_rel() and sunset_rel() return the relative time to the next sunrise_rel() and sunset_rel() return the relative time to the next
sunrise/sunset. <br> sunrise/sunset. <br>
sunrise_abs() and sunset_abs() return the absolute time of the corresponding sunrise_abs() and sunset_abs() return the absolute time of the corresponding
event today (no 24 hours added).<br> event today (no 24 hours added).<br>
sunrise_abs_dat() and sunset_abs_dat() return the absolute time of the sunrise_abs_dat() and sunset_abs_dat() return the absolute time of the
corresponding event to a given date(no 24 hours added).<br> corresponding event to a given date.<br>
All functions take up to three arguments:<br> <b>Note:</b> use sunrise/sunset in the timespec of an at device or on-till
command as the _rel and _abs variants do not work correctly there.</br><br>
All functions take up to four arguments:<br>
<ul> <ul>
<li>The first specifies an offset (in seconds), which will be added to the <li>altitude (optional)
event.</li> altitude defines a horizon value which then is used instead of the
<li>The second and third specify min and max values (format: "HH:MM").</li> $defaultaltit in SUNRISE_EL.pm.<br> Possible values are: "REAL",
"CIVIL", "NAUTIC", "ASTRONOMIC" or a positive or negative number
prefixed with "HORIZON="<br>
REAL is 0, CIVIL is -6, NAUTIC is -12, ASTRONOMIC is -18 degrees above
horizon.<br>
</li>
<li>time-offset in seconds, which will be added to the event.
</li>
<li>min and max values (format: "HH:MM").
If min < max, than the day starts not before min, and ends not after max.
If min > max, than the day starts not after max, and ends not before min.
</li>
</ul> </ul>
<br> <br>
isday() can be used in some notify or at commands to check if the sun is up isday() can be used in some notify or at commands to check if the sun is up
or down. isday() ignores the seconds parameter, but respects min and max. or down. isday() ignores the time-offset parameter, but respects min and max.
If min < max, than the day starts not before min, and ends not after max.
If min > max, than the day starts not after max, and ends not before min.
<br><br> <br><br>
Optionally, for all functions you can set first argument which defines a
horizon value which then is used instead of the $defaultaltit in
SUNRISE_EL.pm.<br> Possible values are: "REAL", "CIVIL", "NAUTIC",
"ASTRONOMIC" or a positive or negative number preceded by "HORIZON="<br> REAL
is 0, CIVIL is -6, NAUTIC is -12, ASTRONOMIC is -18 degrees above
horizon.<br><br>
Examples:<br> Examples:<br>
<ul> <ul>
<PRE> <PRE>