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
parent
67636dfb35
commit
7c1daca025
@ -1865,8 +1865,8 @@ HUEBridge_Attr($$$)
|
||||
Create fhem devices for all bridge devices.</li>
|
||||
<li>autodetect<br>
|
||||
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
|
||||
can be created by <code>set <bridge> autocreate</code>.</li>
|
||||
devices can be listed with <code>get <bridge> devices</code> and the corresponding fhem devices
|
||||
can be created by <code>set <bridge> autocreate</code>.</li>
|
||||
<li>delete <name>|<id><br>
|
||||
Deletes the given device in the bridge and deletes the associated fhem device.</li>
|
||||
<li>creategroup <name> <lights><br>
|
||||
|
||||
@ -520,7 +520,7 @@ mailcheck_Read($)
|
||||
<ul>
|
||||
<code>define <name> mailcheck <host> <user> <password> [<folder>]</code><br>
|
||||
<br>
|
||||
<user> and <lt><password> 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.
|
||||
<user> and <password> 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>
|
||||
|
||||
Defines a mailcheck device.<br><br>
|
||||
|
||||
@ -1718,7 +1718,7 @@ readingsGroup_Attr($$$;$)
|
||||
Notes:
|
||||
<ul>
|
||||
<li><device> can be of the form INTERNAL=VALUE where INTERNAL is the name of an internal value and VALUE is a regex.</li>
|
||||
<li><device> can be of the form ATTRIBUTE&VALUE where ATTRIBUTE is the name of an attribute and VALUE is a regex.</li>
|
||||
<li><device> can be of the form ATTRIBUTE&VALUE where ATTRIBUTE is the name of an attribute and VALUE is a regex.</li>
|
||||
<li><device> can be of the form <STRING> or <{perl}> where STRING or the string returned by perl is
|
||||
inserted as a line in the readings list. skipped if STRING is undef.</li>
|
||||
<li><device> 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>The suffix :d retrieves the first number.</li>
|
||||
<li>The suffix :i retrieves the integer part of the first number.</li>
|
||||
<li>The suffix :r<n> retrieves the first number and rounds it to <n> decimal places. If <n> is missing, then rounds it to one decimal place.</li>
|
||||
<li>The suffix :r<n> retrieves the first number and rounds it to <n> decimal places. If <n> 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 :sec returns the number of seconds since the reading was set. probably not realy usefull with readingsGroups.</li>
|
||||
</ul></li>
|
||||
@ -1994,7 +1994,7 @@ readingsGroup_Attr($$$;$)
|
||||
<li>Sie können anstelle von + und ? ein Präfix i :, r: oder a: verwenden. Analog zur devspec-Filterung.</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 :r<n> ruft die erste Zahl ab und rundet sie auf <n> Nachkommastellen ab. Wenn <n> fehlt, wird es auf eine Dezimalstelle gerundet.</li>
|
||||
<li>Der Suffix :r<n> ruft die erste Zahl ab und rundet sie auf <n> Nachkommastellen ab. Wenn <n> fehlt, wird es auf eine Dezimalstelle gerundet.</li>
|
||||
<li>Der Suffix :t gibt den Zeitstempel zurück (funktioniert nur mit Readings).</li>
|
||||
<li>Der Suffix :sec gibt die Anzahl der Sekunden seit dem das Reading gesetzt wurde zurück. Wahrscheinlich nicht nützlich mit readingsGroups.</li>
|
||||
</ul></li>
|
||||
|
||||
@ -740,7 +740,7 @@ readingsHistory_Attr($$$)
|
||||
<ul>
|
||||
<li><device> 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 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 <device> add ...' are displayed.</li>
|
||||
</ul><br>
|
||||
|
||||
Examples:
|
||||
|
||||
@ -410,7 +410,7 @@ readingsProxy_Attr($$$;$)
|
||||
has access to $DEVICE, $READING, $CMD and $ARGS.<br>
|
||||
undef -> do nothing<br>
|
||||
"" -> pass through<br>
|
||||
(<value>,1) -> directly return <value>, don't call parent getFn<br>
|
||||
(<value>,1) -> directly return <value>, don't call parent getFn<br>
|
||||
everything else -> use this instead</li>
|
||||
<li>setFn<br>
|
||||
perl expresion that will return the set command forwarded to the parent device.
|
||||
|
||||
@ -1865,11 +1865,11 @@ harmony_decrypt($)
|
||||
<a name="harmony_Set"></a>
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<li>activity <id>|<name> [<channel>]<br>
|
||||
<li>activity <id>|<name> [<channel>]<br>
|
||||
switch to this activit and optionally switch to <channel></li>
|
||||
<li>channel <channel><br>
|
||||
switch to <channel> in the current activity</li>
|
||||
<li>command [<id>|<name>] <command> [duration=<duration>]<br>
|
||||
<li>command [<id>|<name>] <command> [duration=<duration>]<br>
|
||||
send the given ir command for the current activity or for the given device</li>
|
||||
<li>getConfig<br>
|
||||
request the configuration from the hub</li>
|
||||
@ -1885,7 +1885,7 @@ harmony_decrypt($)
|
||||
default -> 60 minutes</li>
|
||||
<li>sync<br>
|
||||
syncs the hub to the myHarmony config</li>
|
||||
<li>hidDevice [<id>|<name>]<br>
|
||||
<li>hidDevice [<id>|<name>]<br>
|
||||
sets the target device for keyboard commands, if no device is given -> set the target to the
|
||||
default device for the current activity.</li>
|
||||
<li>text <text><br>
|
||||
@ -1894,7 +1894,7 @@ harmony_decrypt($)
|
||||
moves the cursor by bluetooth/smart keaboard dongle. <direction> can be one of: up, down, left, right, pageUp, pageDown, home, end.</li>
|
||||
<li>special <key><br>
|
||||
sends special key by bluetooth/smart keaboard dongle. <key> can be one of: previousTrack, nextTrack, stop, playPause, volumeUp, volumeDown, mute.</li>
|
||||
<li>autocreate [<id>|<name>]<br>
|
||||
<li>autocreate [<id>|<name>]<br>
|
||||
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>
|
||||
<li>update<br>
|
||||
@ -1909,7 +1909,7 @@ harmony_decrypt($)
|
||||
<li>active<br>
|
||||
activates the current device (see inactive).</li>
|
||||
</ul>
|
||||
The command, hidDevice, text, cursor and special commmands are also available for the autocreated devices. The <id>|<name> paramter hast to be omitted.<br><br>
|
||||
The command, hidDevice, text, cursor and special commmands are also available for the autocreated devices. The <id>|<name> paramter hast to be omitted.<br><br>
|
||||
|
||||
<a name="harmony_Get"></a>
|
||||
<b>Get</b>
|
||||
@ -1919,19 +1919,19 @@ harmony_decrypt($)
|
||||
parm = power -> list power state for each device in activity</li>
|
||||
<li>devices [<param>]<br>
|
||||
lists all devices</li>
|
||||
<li>commands [<id>|<name>]<br>
|
||||
<li>commands [<id>|<name>]<br>
|
||||
lists the commands for the specified activity or for all activities</li>
|
||||
<li>deviceCommands [<id>|<name>]<br>
|
||||
<li>deviceCommands [<id>|<name>]<br>
|
||||
lists the commands for the specified device or for all devices</li>
|
||||
<li>activityDetail [<id>|<name>]</li>
|
||||
<li>deviceDetail [<id>|<name>]</li>
|
||||
<li>activityDetail [<id>|<name>]</li>
|
||||
<li>deviceDetail [<id>|<name>]</li>
|
||||
<li>configDetail</li>
|
||||
<li>currentActivity<br>
|
||||
returns the current activity name</li>
|
||||
<li>showAccount<br>
|
||||
display obfuscated user and password in cleartext</li>
|
||||
</ul>
|
||||
The commands commmand is also available for the autocreated devices. The <id>|<name> paramter hast to be omitted.<br><br>
|
||||
The commands commmand is also available for the autocreated devices. The <id>|<name> paramter hast to be omitted.<br><br>
|
||||
|
||||
|
||||
<a name="harmony_Attr"></a>
|
||||
|
||||
@ -714,7 +714,7 @@ alexa_Attr($$$)
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<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>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ CommandCopy($$)
|
||||
=pod
|
||||
=item command
|
||||
=item summary copy a fhem device
|
||||
=item summary_DE kopiert ein FHEM Ger&aauml;t
|
||||
=item summary_DE kopiert ein FHEM Gerät
|
||||
=begin html
|
||||
|
||||
<a name="copy"></a>
|
||||
|
||||
@ -1335,7 +1335,7 @@ logProxy_Get($@)
|
||||
</ul>
|
||||
|
||||
<li>ConstX:<time>,<y>[,<y2>]<br>
|
||||
Will draw a vertical line (or point) at <time> between <y> to <y2>.<br>
|
||||
Will draw a vertical line (or point) at <time> between <y> to <y2>.<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:
|
||||
<ul>
|
||||
@ -1345,8 +1345,8 @@ logProxy_Get($@)
|
||||
<code>#logProxy ConstX:logProxy_shiftTime($from,60*60*2),$data{min1},$data{max1}</code><br>
|
||||
</ul></li><br>
|
||||
|
||||
<li>ConstY:<value>[,<from>[,<to>]]<br>
|
||||
Will draw a horizontal line at <value>, optional only between the from and to times.<br>
|
||||
<li>ConstY:<value>[,<from>[,<to>]]<br>
|
||||
Will draw a horizontal line at <value>, 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>
|
||||
Examples:
|
||||
<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>
|
||||
</ul></li><br>
|
||||
|
||||
<li>Polar:[<options>]:<values><br>
|
||||
<li>Polar:[<options>]:<values><br>
|
||||
Will draw a polar/spiderweb diagram with the given values. <values> has to evaluate to a perl array.<br>
|
||||
If <values> contains numbers these values are plottet and the last value will be connected to the first.<br>
|
||||
If <values> 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 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 <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 following example will plot the temperature and desiredTemperature values of all devices named MAX.*:
|
||||
<ul>
|
||||
<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::{[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 "<IN>" 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 "<IN>" using 1:2 axes x1y1 notitle ls l2 lw 1 with lines,\</code><br>
|
||||
<code>plot "<IN>" 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 "<IN>" 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>
|
||||
</ul><br>
|
||||
options is a comma separated list of zero or more of:<br>
|
||||
<ul>
|
||||
@ -1397,7 +1397,7 @@ logProxy_Get($@)
|
||||
</ul>
|
||||
</li><br>
|
||||
|
||||
<li>Func:<perl expression><br>
|
||||
<li>Func:<perl expression><br>
|
||||
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
|
||||
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:<SPEC1>:consumption\x3a::</code><br><br>
|
||||
will become:<br><br>
|
||||
<code>#logProxy DbLog:<myDb>:<myDevice>:<myReading></code></br>
|
||||
<code>#logProxy FileLog:FileLog_<SPEC1>:4:<SPEC1>.power\x3a::</code><br>
|
||||
<code>#logProxy FileLog:FileLog_<SPEC1>:4:<SPEC1>.consumption\x3a::</code><br>
|
||||
<code>#logProxy FileLog:FileLog_<SPEC1>:4:<SPEC1>.power\x3a::</code><br>
|
||||
<code>#logProxy FileLog:FileLog_<SPEC1>:4:<SPEC1>.consumption\x3a::</code><br>
|
||||
</ul>
|
||||
|
||||
</ul>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user