2
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-03-03 16:56:54 +00:00

docu fixes (Forum: #84992)

git-svn-id: https://svn.fhem.de/fhem/trunk@16299 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
justme-1968 2018-03-01 08:06:55 +00:00
parent 67636dfb35
commit 7c1daca025
9 changed files with 32 additions and 32 deletions

View File

@ -1865,8 +1865,8 @@ HUEBridge_Attr($$$)
Create fhem devices for all bridge devices.</li> Create fhem devices for all bridge devices.</li>
<li>autodetect<br> <li>autodetect<br>
Initiate the detection of new ZigBee devices. After aproximately one minute any newly detected Initiate the detection of new ZigBee devices. After aproximately one minute any newly detected
devices can be listed with <code>get <bridge> devices</code> and the corresponding fhem devices devices can be listed with <code>get &lt;bridge&gt; devices</code> and the corresponding fhem devices
can be created by <code>set <bridge> autocreate</code>.</li> can be created by <code>set &lt;bridge&gt; autocreate</code>.</li>
<li>delete &lt;name&gt;|&lt;id&gt;<br> <li>delete &lt;name&gt;|&lt;id&gt;<br>
Deletes the given device in the bridge and deletes the associated fhem device.</li> Deletes the given device in the bridge and deletes the associated fhem device.</li>
<li>creategroup &lt;name&gt; &lt;lights&gt;<br> <li>creategroup &lt;name&gt; &lt;lights&gt;<br>

View File

@ -520,7 +520,7 @@ mailcheck_Read($)
<ul> <ul>
<code>define &lt;name&gt; mailcheck &lt;host&gt; &lt;user&gt; &lt;password&gt; [&lt;folder&gt;]</code><br> <code>define &lt;name&gt; mailcheck &lt;host&gt; &lt;user&gt; &lt;password&gt; [&lt;folder&gt;]</code><br>
<br> <br>
&lt;user&gt; and <lt>&lt;password&gt; can be of the form {perl-code}. no spaces are allowed. for both evals $NAME and $HOST is set to the name and host of the mailcheck device and $USER is set to the user in the password eval. &lt;user&gt; and &lt;password&gt; can be of the form {perl-code}. no spaces are allowed. for both evals $NAME and $HOST is set to the name and host of the mailcheck device and $USER is set to the user in the password eval.
<br> <br>
Defines a mailcheck device.<br><br> Defines a mailcheck device.<br><br>

View File

@ -1718,7 +1718,7 @@ readingsGroup_Attr($$$;$)
Notes: Notes:
<ul> <ul>
<li>&lt;device&gt; can be of the form INTERNAL=VALUE where INTERNAL is the name of an internal value and VALUE is a regex.</li> <li>&lt;device&gt; can be of the form INTERNAL=VALUE where INTERNAL is the name of an internal value and VALUE is a regex.</li>
<li>&lt;device&gt; can be of the form ATTRIBUTE&VALUE where ATTRIBUTE is the name of an attribute and VALUE is a regex.</li> <li>&lt;device&gt; can be of the form ATTRIBUTE&amp;VALUE where ATTRIBUTE is the name of an attribute and VALUE is a regex.</li>
<li>&lt;device&gt; can be of the form &lt;STRING&gt; or &lt;{perl}&gt; where STRING or the string returned by perl is <li>&lt;device&gt; can be of the form &lt;STRING&gt; or &lt;{perl}&gt; where STRING or the string returned by perl is
inserted as a line in the readings list. skipped if STRING is undef.</li> inserted as a line in the readings list. skipped if STRING is undef.</li>
<li>&lt;device&gt; can be a devspec (see <a href="#devspec">devspec</a>) with at least one FILTER expression.</li> <li>&lt;device&gt; can be a devspec (see <a href="#devspec">devspec</a>) with at least one FILTER expression.</li>
@ -1732,7 +1732,7 @@ readingsGroup_Attr($$$;$)
<li>You can use an i:, r: or a: prefix instead of + and ? analogue to the devspec filtering.</li> <li>You can use an i:, r: or a: prefix instead of + and ? analogue to the devspec filtering.</li>
<li>The suffix :d retrieves the first number.</li> <li>The suffix :d retrieves the first number.</li>
<li>The suffix :i retrieves the integer part of the first number.</li> <li>The suffix :i retrieves the integer part of the first number.</li>
<li>The suffix :r&lt;n&gt; retrieves the first number and rounds it to &lt;n&gt; decimal places. If <n> is missing, then rounds it to one decimal place.</li> <li>The suffix :r&lt;n&gt; retrieves the first number and rounds it to &lt;n&gt; decimal places. If &lt;n&gt; is missing, then rounds it to one decimal place.</li>
<li>The suffix :t returns the timestamp (works only for readings).</li> <li>The suffix :t returns the timestamp (works only for readings).</li>
<li>The suffix :sec returns the number of seconds since the reading was set. probably not realy usefull with readingsGroups.</li> <li>The suffix :sec returns the number of seconds since the reading was set. probably not realy usefull with readingsGroups.</li>
</ul></li> </ul></li>
@ -1994,7 +1994,7 @@ readingsGroup_Attr($$$;$)
<li>Sie k&ouml;nnen anstelle von + und ? ein Pr&auml;fix i :, r: oder a: verwenden. Analog zur devspec-Filterung.</li> <li>Sie k&ouml;nnen anstelle von + und ? ein Pr&auml;fix i :, r: oder a: verwenden. Analog zur devspec-Filterung.</li>
<li>Der Suffix :d ruft die erste Nummer ab.</li> <li>Der Suffix :d ruft die erste Nummer ab.</li>
<li>Der Suffix :i ruft den ganzzahligen Teil der ersten Zahl ab.</li> <li>Der Suffix :i ruft den ganzzahligen Teil der ersten Zahl ab.</li>
<li>Der Suffix :r&lt;n&gt; ruft die erste Zahl ab und rundet sie auf &lt;n&gt; Nachkommastellen ab. Wenn <n> fehlt, wird es auf eine Dezimalstelle gerundet.</li> <li>Der Suffix :r&lt;n&gt; ruft die erste Zahl ab und rundet sie auf &lt;n&gt; Nachkommastellen ab. Wenn &lt;n&gt; fehlt, wird es auf eine Dezimalstelle gerundet.</li>
<li>Der Suffix :t gibt den Zeitstempel zur&uuml;ck (funktioniert nur mit Readings).</li> <li>Der Suffix :t gibt den Zeitstempel zur&uuml;ck (funktioniert nur mit Readings).</li>
<li>Der Suffix :sec gibt die Anzahl der Sekunden seit dem das Reading gesetzt wurde zur&uuml;ck. Wahrscheinlich nicht n&uuml;tzlich mit readingsGroups.</li> <li>Der Suffix :sec gibt die Anzahl der Sekunden seit dem das Reading gesetzt wurde zur&uuml;ck. Wahrscheinlich nicht n&uuml;tzlich mit readingsGroups.</li>
</ul></li> </ul></li>

View File

@ -740,7 +740,7 @@ readingsHistory_Attr($$$)
<ul> <ul>
<li>&lt;device&gt; can be of the form INTERNAL=VALUE where INTERNAL is the name of an internal value and VALUE is a regex.</li> <li>&lt;device&gt; can be of the form INTERNAL=VALUE where INTERNAL is the name of an internal value and VALUE is a regex.</li>
<li>If regex is a comma separatet list it will be used as an enumeration of allowed readings.</li> <li>If regex is a comma separatet list it will be used as an enumeration of allowed readings.</li>
<li>if no device/reading argument is given only lines with 'set <device> add ...' are displayed.</li> <li>if no device/reading argument is given only lines with 'set &lt;device&gt; add ...' are displayed.</li>
</ul><br> </ul><br>
Examples: Examples:

View File

@ -410,7 +410,7 @@ readingsProxy_Attr($$$;$)
has access to $DEVICE, $READING, $CMD and $ARGS.<br> has access to $DEVICE, $READING, $CMD and $ARGS.<br>
undef -> do nothing<br> undef -> do nothing<br>
"" -> pass through<br> "" -> pass through<br>
(<value>,1) -> directly return <value>, don't call parent getFn<br> (&lt;value&gt;,1) -> directly return &lt;value&gt;, don't call parent getFn<br>
everything else -> use this instead</li> everything else -> use this instead</li>
<li>setFn<br> <li>setFn<br>
perl expresion that will return the set command forwarded to the parent device. perl expresion that will return the set command forwarded to the parent device.

View File

@ -1865,11 +1865,11 @@ harmony_decrypt($)
<a name="harmony_Set"></a> <a name="harmony_Set"></a>
<b>Set</b> <b>Set</b>
<ul> <ul>
<li>activity &lt;id&gt;|&ltname&gt; [&lt;channel&gt;]<br> <li>activity &lt;id&gt;|&lt;name&gt; [&lt;channel&gt;]<br>
switch to this activit and optionally switch to &lt;channel&gt;</li> switch to this activit and optionally switch to &lt;channel&gt;</li>
<li>channel &lt;channel&gt;<br> <li>channel &lt;channel&gt;<br>
switch to &lt;channel&gt; in the current activity</li> switch to &lt;channel&gt; in the current activity</li>
<li>command [&lt;id&gt;|&ltname&gt;] &lt;command&gt; [duration=&lt;duration&gt;]<br> <li>command [&lt;id&gt;|&lt;name&gt;] &lt;command&gt; [duration=&lt;duration&gt;]<br>
send the given ir command for the current activity or for the given device</li> send the given ir command for the current activity or for the given device</li>
<li>getConfig<br> <li>getConfig<br>
request the configuration from the hub</li> request the configuration from the hub</li>
@ -1885,7 +1885,7 @@ harmony_decrypt($)
default -> 60 minutes</li> default -> 60 minutes</li>
<li>sync<br> <li>sync<br>
syncs the hub to the myHarmony config</li> syncs the hub to the myHarmony config</li>
<li>hidDevice [&lt;id&gt;|&ltname&gt;]<br> <li>hidDevice [&lt;id&gt;|&lt;name&gt;]<br>
sets the target device for keyboard commands, if no device is given -> set the target to the sets the target device for keyboard commands, if no device is given -> set the target to the
default device for the current activity.</li> default device for the current activity.</li>
<li>text &lt;text&gt;<br> <li>text &lt;text&gt;<br>
@ -1894,7 +1894,7 @@ harmony_decrypt($)
moves the cursor by bluetooth/smart keaboard dongle. &lt;direction&gt; can be one of: up, down, left, right, pageUp, pageDown, home, end.</li> moves the cursor by bluetooth/smart keaboard dongle. &lt;direction&gt; can be one of: up, down, left, right, pageUp, pageDown, home, end.</li>
<li>special &lt;key&gt;<br> <li>special &lt;key&gt;<br>
sends special key by bluetooth/smart keaboard dongle. &lt;key&gt; can be one of: previousTrack, nextTrack, stop, playPause, volumeUp, volumeDown, mute.</li> sends special key by bluetooth/smart keaboard dongle. &lt;key&gt; can be one of: previousTrack, nextTrack, stop, playPause, volumeUp, volumeDown, mute.</li>
<li>autocreate [&lt;id&gt;|&ltname&gt;]<br> <li>autocreate [&lt;id&gt;|&lt;name&gt;]<br>
creates a fhem device for a single/all device(s) in the harmony hub. if activities are startet the state creates a fhem device for a single/all device(s) in the harmony hub. if activities are startet the state
of these devices will be updatet with the power state defined in these activites.</li> of these devices will be updatet with the power state defined in these activites.</li>
<li>update<br> <li>update<br>
@ -1909,7 +1909,7 @@ harmony_decrypt($)
<li>active<br> <li>active<br>
activates the current device (see inactive).</li> activates the current device (see inactive).</li>
</ul> </ul>
The command, hidDevice, text, cursor and special commmands are also available for the autocreated devices. The &lt;id&gt;|&ltname&gt; paramter hast to be omitted.<br><br> The command, hidDevice, text, cursor and special commmands are also available for the autocreated devices. The &lt;id&gt;|&lt;name&gt; paramter hast to be omitted.<br><br>
<a name="harmony_Get"></a> <a name="harmony_Get"></a>
<b>Get</b> <b>Get</b>
@ -1919,19 +1919,19 @@ harmony_decrypt($)
parm = power -> list power state for each device in activity</li> parm = power -> list power state for each device in activity</li>
<li>devices [&lt;param&gt;]<br> <li>devices [&lt;param&gt;]<br>
lists all devices</li> lists all devices</li>
<li>commands [&lt;id&gt;|&ltname&gt;]<br> <li>commands [&lt;id&gt;|&lt;name&gt;]<br>
lists the commands for the specified activity or for all activities</li> lists the commands for the specified activity or for all activities</li>
<li>deviceCommands [&lt;id&gt;|&ltname&gt;]<br> <li>deviceCommands [&lt;id&gt;|&lt;name&gt;]<br>
lists the commands for the specified device or for all devices</li> lists the commands for the specified device or for all devices</li>
<li>activityDetail [&lt;id&gt;|&ltname&gt;]</li> <li>activityDetail [&lt;id&gt;|&lt;name&gt;]</li>
<li>deviceDetail [&lt;id&gt;|&ltname&gt;]</li> <li>deviceDetail [&lt;id&gt;|&lt;name&gt;]</li>
<li>configDetail</li> <li>configDetail</li>
<li>currentActivity<br> <li>currentActivity<br>
returns the current activity name</li> returns the current activity name</li>
<li>showAccount<br> <li>showAccount<br>
display obfuscated user and password in cleartext</li> display obfuscated user and password in cleartext</li>
</ul> </ul>
The commands commmand is also available for the autocreated devices. The &lt;id&gt;|&ltname&gt; paramter hast to be omitted.<br><br> The commands commmand is also available for the autocreated devices. The &lt;id&gt;|&lt;name&gt; paramter hast to be omitted.<br><br>
<a name="harmony_Attr"></a> <a name="harmony_Attr"></a>

View File

@ -714,7 +714,7 @@ alexa_Attr($$$)
<b>Set</b> <b>Set</b>
<ul> <ul>
<li>reload [name]<br> <li>reload [name]<br>
Reloads the device <it>name</it> or all devices in alexa-fhem. Subsequently you have to start a device discovery Reloads the device <code>name</code> or all devices in alexa-fhem. Subsequently you have to start a device discovery
for the home automation skill in the amazon alexa app.</li> for the home automation skill in the amazon alexa app.</li>
</ul> </ul>

View File

@ -55,7 +55,7 @@ CommandCopy($$)
=pod =pod
=item command =item command
=item summary copy a fhem device =item summary copy a fhem device
=item summary_DE kopiert ein FHEM Ger&aauml;t =item summary_DE kopiert ein FHEM Ger&auml;t
=begin html =begin html
<a name="copy"></a> <a name="copy"></a>

View File

@ -1335,7 +1335,7 @@ logProxy_Get($@)
</ul> </ul>
<li>ConstX:&lt;time&gt;,&lt;y&gt;[,&lt;y2&gt;]<br> <li>ConstX:&lt;time&gt;,&lt;y&gt;[,&lt;y2&gt;]<br>
Will draw a vertical line (or point) at &lttime&gt; between &lt;y&gt; to &lt;y2&gt;.<br> Will draw a vertical line (or point) at &lt;time&gt; between &lt;y&gt; to &lt;y2&gt;.<br>
Everything after the : is evaluated as a perl expression that hast to return one time string and one or two y values.<br> Everything after the : is evaluated as a perl expression that hast to return one time string and one or two y values.<br>
Examples: Examples:
<ul> <ul>
@ -1345,8 +1345,8 @@ logProxy_Get($@)
<code>#logProxy ConstX:logProxy_shiftTime($from,60*60*2),$data{min1},$data{max1}</code><br> <code>#logProxy ConstX:logProxy_shiftTime($from,60*60*2),$data{min1},$data{max1}</code><br>
</ul></li><br> </ul></li><br>
<li>ConstY:&ltvalue&gt;[,&lt;from&gt;[,&lt;to&gt;]]<br> <li>ConstY:&lt;value&gt;[,&lt;from&gt;[,&lt;to&gt;]]<br>
Will draw a horizontal line at &ltvalue&gt;, optional only between the from and to times.<br> Will draw a horizontal line at &lt;value&gt;, optional only between the from and to times.<br>
Everything after the : is evaluated as a perl expression that hast to return one value and optionaly one or two time strings.<br> Everything after the : is evaluated as a perl expression that hast to return one value and optionaly one or two time strings.<br>
Examples: Examples:
<ul> <ul>
@ -1357,12 +1357,12 @@ logProxy_Get($@)
<code>#logProxy ConstY:$data{avg2},logProxy_shiftTime($from,60*60*12),logProxy_shiftTime($from,-60*60*12)</code> <code>#logProxy ConstY:$data{avg2},logProxy_shiftTime($from,60*60*12),logProxy_shiftTime($from,-60*60*12)</code>
</ul></li><br> </ul></li><br>
<li>Polar:[&ltoptions&gt;]:&lt;values&gt;<br> <li>Polar:[&lt;options&gt;]:&lt;values&gt;<br>
Will draw a polar/spiderweb diagram with the given values. &lt;values&gt; has to evaluate to a perl array.<br> Will draw a polar/spiderweb diagram with the given values. &lt;values&gt; has to evaluate to a perl array.<br>
If &lt;values&gt; contains numbers these values are plottet and the last value will be connected to the first.<br> If &lt;values&gt; contains numbers these values are plottet and the last value will be connected to the first.<br>
If &lt;values&gt; contains strings these strings are used as labels for the segments.<br> If &lt;values&gt; contains strings these strings are used as labels for the segments.<br>
The axis are drawn automaticaly if the values are strings or if no values are given but the segments option is set.<br> The axis are drawn automaticaly if the values are strings or if no values are given but the segments option is set.<br>
The corrosponding SVG device should have the plotsize attribute set (eg: attr <mySvg> plotsize 340,300) and the used gplot file has to contain xrange and yrange entries and the x- and y-axis labes should be switched off with xtics, ytics and y2tics entries.<br> The corrosponding SVG device should have the plotsize attribute set (eg: attr &lt;mySvg&gt; plotsize 340,300) and the used gplot file has to contain xrange and yrange entries and the x- and y-axis labes should be switched off with xtics, ytics and y2tics entries.<br>
The following example will plot the temperature and desiredTemperature values of all devices named MAX.*: The following example will plot the temperature and desiredTemperature values of all devices named MAX.*:
<ul> <ul>
<code>set xtics ()</code><br> <code>set xtics ()</code><br>
@ -1377,10 +1377,10 @@ logProxy_Get($@)
<code>#logProxy Polar::{[map{ReadingsVal($_,"temperature",0)}devspec2array("MAX.*")]}</code><br> <code>#logProxy Polar::{[map{ReadingsVal($_,"temperature",0)}devspec2array("MAX.*")]}</code><br>
<code>#logProxy Polar::{[devspec2array("MAX.*")]}</code><br><br> <code>#logProxy Polar::{[devspec2array("MAX.*")]}</code><br><br>
<code>plot "<IN>" using 1:2 axes x1y1 title 'Ist' ls l0 lw 1 with lines,\</code><br> <code>plot "&lt;IN&gt;" using 1:2 axes x1y1 title 'Ist' ls l0 lw 1 with lines,\</code><br>
<code>plot "<IN>" using 1:2 axes x1y1 title 'Soll' ls l1fill lw 1 with lines,\</code><br> <code>plot "&lt;IN&gt;" using 1:2 axes x1y1 title 'Soll' ls l1fill lw 1 with lines,\</code><br>
<code>plot "<IN>" using 1:2 axes x1y1 notitle ls l0 lw 1 with points,\</code><br> <code>plot "&lt;IN&gt;" using 1:2 axes x1y1 notitle ls l0 lw 1 with points,\</code><br>
<code>plot "<IN>" using 1:2 axes x1y1 notitle ls l2 lw 1 with lines,\</code><br> <code>plot "&lt;IN&gt;" using 1:2 axes x1y1 notitle ls l2 lw 1 with lines,\</code><br>
</ul><br> </ul><br>
options is a comma separated list of zero or more of:<br> options is a comma separated list of zero or more of:<br>
<ul> <ul>
@ -1397,7 +1397,7 @@ logProxy_Get($@)
</ul> </ul>
</li><br> </li><br>
<li>Func:&ltperl expression&gt;<br> <li>Func:&lt;perl expression&gt;<br>
Specifies a perl expression that returns the data to be plotted and its min, max and last value. It can not contain Specifies a perl expression that returns the data to be plotted and its min, max and last value. It can not contain
space or : characters. The data has to be space or : characters. The data has to be
one string of newline separated entries of the form: <code>yyyy-mm-dd_hh:mm:ss value</code><br>Example: one string of newline separated entries of the form: <code>yyyy-mm-dd_hh:mm:ss value</code><br>Example:
@ -1446,8 +1446,8 @@ logProxy_Get($@)
<code>#FileLog 4:&lt;SPEC1&gt;:consumption\x3a::</code><br><br> <code>#FileLog 4:&lt;SPEC1&gt;:consumption\x3a::</code><br><br>
will become:<br><br> will become:<br><br>
<code>#logProxy DbLog:&lt;myDb&gt;:&lt;myDevice&gt;:&lt;myReading&gt;</code></br> <code>#logProxy DbLog:&lt;myDb&gt;:&lt;myDevice&gt;:&lt;myReading&gt;</code></br>
<code>#logProxy FileLog:FileLog_&lt;SPEC1&gt;:4:<SPEC1>.power\x3a::</code><br> <code>#logProxy FileLog:FileLog_&lt;SPEC1&gt;:4:&lt;SPEC1&gt;.power\x3a::</code><br>
<code>#logProxy FileLog:FileLog_&lt;SPEC1&gt;:4:<SPEC1>.consumption\x3a::</code><br> <code>#logProxy FileLog:FileLog_&lt;SPEC1&gt;:4:&lt;SPEC1&gt;.consumption\x3a::</code><br>
</ul> </ul>
</ul> </ul>