00_ElsnerWS: commandref: link structure changed

git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@24741 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
klaus.schauer 2021-07-13 16:29:27 +00:00
parent f8ceafe878
commit 2dfef956dd

View File

@ -995,7 +995,7 @@ sub ElsnerWS_Shutdown($) {
=item summary_DE ElsnerWS Elsner Wetterstation P03/3-RS485 oder P04/3-RS485 Auswertemodul
=begin html
<a name="ElsnerWS"></a>
<a id="ElsnerWS"></a>
<h3>ElsnerWS</h3>
<ul>
The ElsnerWS weather evaluation modul serves as a connecting link between the
@ -1025,11 +1025,11 @@ sub ElsnerWS_Shutdown($) {
<li>Adjustable switching thresholds and delay times</li>
<li>Day/night signal</li>
<li>Display of date, time, sun azimuth, sun elevation, longitude and latitude</li>
<li>Execution of custom alarm commands, see <a href="#ElsnerWS_customCmdAlarmOff">customCmdAlarmOff</a> and
<a href="#ElsnerWS_customCmdAlarmOn">customCmdAlarmOn</a>.</li>
<li>Execution of custom alarm commands, see <a href="#ElsnerWS-attr-customCmdAlarmOff">customCmdAlarmOff</a> and
<a href="#ElsnerWS-attr-customCmdAlarmOn">customCmdAlarmOn</a>.</li>
<li>Execution of custom up and down commands that can be triggered by the readings dayNight, isRaining, isStormy,
isSunny, isSunnyEast, isSunnySouth, isSunnyWest and isWindy, see <a href="#ElsnerWS_customCmdDown">customCmdDown</a> and
<a href="#ElsnerWS_customCmdUp">customCmdUp</a>.</li>
isSunny, isSunnyEast, isSunnySouth, isSunnyWest and isWindy, see <a href="#ElsnerWS-attr-customCmdDown">customCmdDown</a> and
<a href="#ElsnerWS-attr-customCmdUp">customCmdUp</a>.</li>
</ul><br>
<b>Prerequisites</b>
@ -1054,7 +1054,7 @@ sub ElsnerWS_Shutdown($) {
are successfully tested at a Raspberry PI in conjunction with the weather sensor.
</ul><br>
<a name="ElsnerWSDefine"></a>
<a id="ElsnerWS-Define"></a>
<b>Define</b>
<ul>
<code>define &lt;name&gt; ElsnerWS comtype=&lt;comtype&gt; devicename=&lt;devicename&gt;</code><br><br>
@ -1070,61 +1070,61 @@ sub ElsnerWS_Shutdown($) {
searched for a ready-to-operate weather station during the Fhem boot.
</ul><br>
<a name="ElsnerWSattr"></a>
<a id="ElsnerWS-attr"></a>
<b>Attributes</b>
<ul>
<ul>
<li><a name="ElsnerWS_brightnessDayNight">brightnessDayNight</a> E_min/lx:E_max/lx,
<li><a id="ElsnerWS-attr-brightnessDayNight">brightnessDayNight</a> E_min/lx:E_max/lx,
[brightnessDayNight] = 0...99000:0...99000, 10:20 is default.<br>
Set switching thresholds for reading dayNight based on the reading brightness.
</li>
<li><a name="ElsnerWS_brightnessDayNightCtrl">brightnessDayNightCtrl</a> custom|sensor,
<li><a id="ElsnerWS-attr-brightnessDayNightCtrl">brightnessDayNightCtrl</a> custom|sensor,
[brightnessDayNightCtrl] = custom|sensor, sensor is default.<br>
Control the dayNight reading through the device-specific or custom threshold and delay.
</li>
<li><a name="ElsnerWS_brightnessDayNightDelay">brightnessDayNightDelay</a> t_reset/s:t_set/s,
<li><a id="ElsnerWS-attr-brightnessDayNightDelay">brightnessDayNightDelay</a> t_reset/s:t_set/s,
[brightnessDayNightDelay] = 0...3600:0...3600, 600:600 is default.<br>
Set switching delay for reading dayNight based on the reading brightness. The reading dayNight is reset or set
if the thresholds are permanently undershot or exceed during the delay time.
</li>
<li><a name="ElsnerWS_brightnessSunny">brightnessSunny</a> E_min/lx:E_max/lx,
<li><a id="ElsnerWS-attr-brightnessSunny">brightnessSunny</a> E_min/lx:E_max/lx,
[brightnessSunny] = 0...99000:0...99000, 20000:40000 is default.<br>
Set switching thresholds for reading isSunny based on the reading brightness.
</li>
<li><a name="ElsnerWS_brightnessSunnyDelay">brightnessSunnyDelay</a> t_reset/s:t_set/s,
<li><a id="ElsnerWS-attr-brightnessSunnyDelay">brightnessSunnyDelay</a> t_reset/s:t_set/s,
[brightnessSunnyDelay] = 0...3600:0...3600, 120:30 is default.<br>
Set switching delay for reading isSunny based on the reading brightness. The reading isSunny is reset or set
if the thresholds are permanently undershot or exceed during the delay time.
</li>
<li><a name="ElsnerWS_brightnessSunnyEast">brightnessSunnyEast</a> E_min/lx:E_max/lx,
<li><a id="ElsnerWS-attr-brightnessSunnyEast">brightnessSunnyEast</a> E_min/lx:E_max/lx,
[brightnessSunnyEast] = 0...99000:0...99000, 20000:40000 is default.<br>
Set switching thresholds for reading isSunnyEast based on the reading sunEast.
</li>
<li><a name="ElsnerWS_brightnessSunnyEastDelay">brightnessSunnyEastDelay</a> t_reset/s:t_set/s,
<li><a id="ElsnerWS-attr-brightnessSunnyEastDelay">brightnessSunnyEastDelay</a> t_reset/s:t_set/s,
[brightnessSunnyEastDelay] = 0...3600:0...3600, 120:30 is default.<br>
Set switching delay for reading isSunnyEast based on the reading sunEast. The reading isSunnyEast is reset or set
if the thresholds are permanently undershot or exceed during the delay time.
</li>
<li><a name="ElsnerWS_brightnessSunnySouth">brightnessSunnySouth</a> E_min/lx:E_max/lx,
<li><a id="ElsnerWS-attr-brightnessSunnySouth">brightnessSunnySouth</a> E_min/lx:E_max/lx,
[brightnessSunnySouth] = 0...99000:0...99000, 20000:40000 is default.<br>
Set switching thresholds for reading isSunnySouth based on the reading sunSouth.
</li>
<li><a name="ElsnerWS_brightnessSunnySouthDelay">brightnessSunnySouthDelay</a> t_reset/s:t_set/s,
<li><a id="ElsnerWS-attr-brightnessSunnySouthDelay">brightnessSunnySouthDelay</a> t_reset/s:t_set/s,
[brightnessSunnySouthDelay] = 0...3600:0...3600, 120:30 is default.<br>
Set switching delay for reading isSunnySouth based on the reading sunSouth. The reading isSunnySouth is reset or set
if the thresholds are permanently undershot or exceed during the delay time.
</li>
<li><a name="ElsnerWS_brightnessSunnyWest">brightnessSunnyWest</a> E_min/lx:E_max/lx,
<li><a id="ElsnerWS-attr-brightnessSunnyWest">brightnessSunnyWest</a> E_min/lx:E_max/lx,
[brightnessSunnyWest] = 0...99000:0...99000, 20000:40000 is default.<br>
Set switching thresholds for reading isSunnyWest based on the reading sunWest.
</li>
<li><a name="ElsnerWS_brightnessSunnyWestDelay">brightnessSunnyWestDelay</a> t_reset/s:t_set/s,
<li><a id="ElsnerWS-attr-brightnessSunnyWestDelay">brightnessSunnyWestDelay</a> t_reset/s:t_set/s,
[brightnessSunnyWestDelay] = 0...3600:0...3600, 120:30 is default.<br>
Set switching delay for reading isSunnyWest based on the reading sunWest. The reading isSunnyWest is reset or set
if the thresholds are permanently undershot or exceed during the delay time.
</li>
<li><a name="ElsnerWS_customCmdAlarmOff">customCmdAlarmOff</a> &lt;command&gt;<br>
<a name="ElsnerWS_customCmdAlarmOn">customCmdAlarmOn</a> &lt;command&gt;<br>
<li><a id="ElsnerWS-attr-customCmdAlarmOff">customCmdAlarmOff</a> &lt;command&gt;<br>
<a id="ElsnerWS-attr-customCmdAlarmOn">customCmdAlarmOn</a> &lt;command&gt;<br>
Command being executed if an alarm is set (on) or deleted (off). If &lt;command&gt; is enclosed in {},
then it is a perl expression, if it is enclosed in "", then it is a shell command,
else it is a "plain" fhem.pl command (chain). In the &lt;command&gt; you can access the name of the device by using $NAME, $TYPE
@ -1137,10 +1137,10 @@ sub ElsnerWS_Shutdown($) {
scripts, and will be textually replaced for Fhem commands.<br>
The alarm commands have a higher priority than the up and down commands.
</li>
<li><a name="ElsnerWS_customCmdDown">customCmdDown</a> &lt;command&gt;<br>
<a name="ElsnerWS_customCmdUp">customCmdUp</a> &lt;command&gt;<br>
The command is executed if the Up or Down command is triggered, see <a href="#ElsnerWS_customCmdDownTrigger">customCmdDownTrigger</a> or
<a href="#ElsnerWS_customCmdUpTrigger">customCmdUpTrigger</a>. If &lt;command&gt; is enclosed in {},
<li><a id="ElsnerWS-attr-customCmdDown">customCmdDown</a> &lt;command&gt;<br>
<a id="ElsnerWS-attr-customCmdUp">customCmdUp</a> &lt;command&gt;<br>
The command is executed if the Up or Down command is triggered, see <a href="#ElsnerWS-attr-customCmdDownTrigger">customCmdDownTrigger</a> or
<a href="#ElsnerWS-attr-customCmdUpTrigger">customCmdUpTrigger</a>. If &lt;command&gt; is enclosed in {},
then it is a perl expression, if it is enclosed in "", then it is a shell command,
else it is a "plain" fhem.pl command (chain). In the &lt;command&gt; you can access the name of the device by using $NAME, $TYPE
and the current readings<br>
@ -1152,13 +1152,13 @@ sub ElsnerWS_Shutdown($) {
scripts, and will be textually replaced for Fhem commands.<br>
The alarm commands have a higher priority than the up and down commands.
</li>
<li><a name="ElsnerWS_customCmdDownPeriod">customCmdDownPeriod</a> once|threeTimes|3|10|180|600<br>
<a name="ElsnerWS_customCmdUpPeriod">customCmdUpPeriod</a> once|threeTimes|3|10|180|600<br>
<li><a id="ElsnerWS-attr-customCmdDownPeriod">customCmdDownPeriod</a> once|threeTimes|3|10|180|600<br>
<a id="ElsnerWS-attr-customCmdUpPeriod">customCmdUpPeriod</a> once|threeTimes|3|10|180|600<br>
[customCmdDownPeriod] = once|threeTimes|3|10|180|600, once is default.<br>
Number or period of custom command to be executed.
</li>
<li><a name="ElsnerWS_customCmdDownTrigger">customCmdDownTrigger</a> dayNight|isRaining|isStormy|isSunny|isSunnyEast|isSunnySouth|isSunnyWest|isWindy<br>
The commands in the attribute <a href="#ElsnerWS_customCmdDown">customCmdDown</a> are executed if one of the selected readings is triggered as follows:
<li><a id="ElsnerWS-attr-customCmdDownTrigger">customCmdDownTrigger</a> dayNight|isRaining|isStormy|isSunny|isSunnyEast|isSunnySouth|isSunnyWest|isWindy<br>
The commands in the attribute <a href="#ElsnerWS-attr-customCmdDown">customCmdDown</a> are executed if one of the selected readings is triggered as follows:
<ul>
<li>[dayNight] = night</li>
<li>[isRaining] = no</li>
@ -1169,10 +1169,10 @@ sub ElsnerWS_Shutdown($) {
<li>[isSunnyWest] = yes</li>
<li>[isWindy] = no</li>
</ul>
The commands in the attribute <a href="#ElsnerWS_customCmdDown">customCmdDown</a> are executed periodically every second if the attribute is not set.
The commands in the attribute <a href="#ElsnerWS-attr-customCmdDown">customCmdDown</a> are executed periodically every second if the attribute is not set.
</li>
<li><a name="ElsnerWS_customCmdUpTrigger">customCmdUpTrigger</a> dayNight|isRaining|isStormy|isSunny|isSunnyEast|isSunnySouth|isSunnyWest|isWindy<br>
The commands in the attribute <a href="#ElsnerWS_customCmdUp">customCmdUp</a> are executed if one of the selected readings is triggered as follows:
<li><a id="ElsnerWS-attr-customCmdUpTrigger">customCmdUpTrigger</a> dayNight|isRaining|isStormy|isSunny|isSunnyEast|isSunnySouth|isSunnyWest|isWindy<br>
The commands in the attribute <a href="#ElsnerWS-attr-customCmdUp">customCmdUp</a> are executed if one of the selected readings is triggered as follows:
<ul>
<li>[dayNight] = day</li>
<li>[isRaining] = yes</li>
@ -1183,43 +1183,43 @@ sub ElsnerWS_Shutdown($) {
<li>[isSunnyWest] = no</li>
<li>[isWindy] = yes</li>
</ul>
The commands in the attribute <a href="#ElsnerWS_customCmdUp">customCmdUp</a> are executed periodically every second if the attribute is not set.
The commands in the attribute <a href="#ElsnerWS-attr-customCmdUp">customCmdUp</a> are executed periodically every second if the attribute is not set.
</li>
<li><a name="ElsnerWS_customCmdPriority">customCmdPriority</a> down|up,
<li><a id="ElsnerWS-attr-customCmdPriority">customCmdPriority</a> down|up,
[customCmdPriority] = down|up, up is default.<br>
Priority of custom commands. If both the up and down command are triggered, only the prioritized command is executed.
</li>
<li><a href="#readingFnAttributes">readingFnAttributes</a></li>
<li><a name="ElsnerWS_signOfLife">signOfLife</a> off|on,
<li><a id="ElsnerWS-attr-signOfLife">signOfLife</a> off|on,
[signOfLife] = off|on, on is default.<br>
Monitoring of the periodic telegrams from sensor.
</li>
<li><a name="ElsnerWS_signOfLifeInterval">signOfLifeInterval</a> t/s,
<li><a id="ElsnerWS-attr-signOfLifeInterval">signOfLifeInterval</a> t/s,
[signOfLifeInterval] = 1 ... 15, 3 is default.<br>
Monitoring period in seconds of the periodic telegrams from sensor.
</li>
<li><a name="ElsnerWS_timeEvent">timeEvent</a> no|yes,
<li><a id="ElsnerWS-attr-timeEvent">timeEvent</a> no|yes,
[timeEvent] = no|yes, no is default.<br>
Update the reading time periodically.
</li>
<li><a name="ElsnerWS_updateGlobalAttr">updateGlobalAttr</a> no|yes,
<li><a id="ElsnerWS-attr-updateGlobalAttr">updateGlobalAttr</a> no|yes,
[updateGlobalAttr] = no|yes, no is default.<br>
Update the global attributes latitude and longitude with the received GPS coordinates.
</li>
<li><a name="ElsnerWS_windSpeedStormy">windSpeedStormy</a> v_min/m/s:v_max/m/s,
<li><a id="ElsnerWS-attr-windSpeedStormy">windSpeedStormy</a> v_min/m/s:v_max/m/s,
[windSpeedStormy] = 0...35:0...35, 13.9:17.2 (windStrength = 7 B - 8 B) is default.<br>
Set switching thresholds for reading isStormy based on the reading windSpeed.
</li>
<li><a name="ElsnerWS_windSpeedStormyDelay">windSpeedStormyDelay</a> t_reset/s:t_set/s,
<li><a id="ElsnerWS-attr-windSpeedStormyDelay">windSpeedStormyDelay</a> t_reset/s:t_set/s,
[windSpeedStormyDelay] = 0...3600:0...3600, 60:3 is default.<br>
Set switching delay for reading isStormy based on the reading windSpeed. The reading isStormy is reset or set
if the thresholds are permanently undershot or exceed during the delay time.
</li>
<li><a name="ElsnerWS_windSpeedWindy">windSpeedWindy</a> v_min/m/s:v_max/m/s,
<li><a id="ElsnerWS-attr-windSpeedWindy">windSpeedWindy</a> v_min/m/s:v_max/m/s,
[windSpeedWindy] = 0...35:0...35, 1.6:3.4 (windStrength = 2 B - 3 B) is default.<br>
Set switching thresholds for reading isWindy based on the reading windSpeed.
</li>
<li><a name="ElsnerWS_windSpeedWindyDelay">windSpeedWindyDelay</a> t_reset/s:t_set/s,
<li><a id="ElsnerWS-attr-windSpeedWindyDelay">windSpeedWindyDelay</a> t_reset/s:t_set/s,
[windSpeedWindyDelay] = 0...3600:0...3600, 60:3 is default.<br>
Set switching delay for reading isWindy based on the reading windSpeed. The reading isWindy is reset or set
if the thresholds are permanently undershot or exceed during the delay time.
@ -1227,7 +1227,7 @@ sub ElsnerWS_Shutdown($) {
</ul>
</ul><br>
<a name="ElsnerWSevents"></a>
<a id="ElsnerWS-events"></a>
<b>Generated events</b>
<ul>
<ul>