2
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-01-31 18:59:33 +00:00

Added alias & some reformatting

git-svn-id: https://svn.fhem.de/fhem/trunk@554 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
rudolfkoenig 2010-01-20 08:55:45 +00:00
parent ca6c0d2f67
commit d5f841ef03

View File

@ -19,29 +19,29 @@
<b>fhem commands</b> <b>fhem commands</b>
<ul> <ul>
<a href="#attr">attr</a> &nbsp; <a href="#attr">attr</a>&nbsp;&nbsp;
<a href="#define">define</a> &nbsp; <a href="#define">define</a>&nbsp;&nbsp;
<a href="#delete">delete</a> &nbsp; <a href="#delete">delete</a>&nbsp;&nbsp;
<a href="#deleteattr">deleteattr</a> &nbsp; <a href="#deleteattr">deleteattr</a>&nbsp;&nbsp;
<a href="#get">get</a> &nbsp; <a href="#get">get</a>&nbsp;&nbsp;
<a href="#getstate">getstate</a> &nbsp; <a href="#getstate">getstate</a>&nbsp;&nbsp;
<a href="#help">?,help</a> &nbsp; <a href="#help">?,help</a>&nbsp;&nbsp;
<a href="#include">include</a> &nbsp; <a href="#include">include</a>&nbsp;&nbsp;
<a href="#inform">inform</a> &nbsp; <a href="#inform">inform</a>&nbsp;&nbsp;
<a href="#list">list</a> &nbsp; <a href="#list">list</a>&nbsp;&nbsp;
<a href="#modify">modify</a> &nbsp; <a href="#modify">modify</a>&nbsp;&nbsp;
<a href="#quit">quit</a> &nbsp; <a href="#quit">quit</a>&nbsp;&nbsp;
<a href="#reload">reload</a> &nbsp; <a href="#reload">reload</a>&nbsp;&nbsp;
<a href="#rename">rename</a> &nbsp; <a href="#rename">rename</a>&nbsp;&nbsp;
<a href="#rereadcfg">rereadcfg</a> &nbsp; <a href="#rereadcfg">rereadcfg</a>&nbsp;&nbsp;
<a href="#save">save</a> &nbsp; <a href="#save">save</a>&nbsp;&nbsp;
<a href="#set">set</a> &nbsp; <a href="#set">set</a>&nbsp;&nbsp;
<a href="#setdefaultattr">setdefaultattr</a> &nbsp; <a href="#setdefaultattr">setdefaultattr</a>&nbsp;&nbsp;
<a href="#setstate">setstate</a> &nbsp; <a href="#setstate">setstate</a>&nbsp;&nbsp;
<a href="#shutdown">shutdown</a> &nbsp; <a href="#shutdown">shutdown</a>&nbsp;&nbsp;
<a href="#sleep">sleep</a> &nbsp; <a href="#sleep">sleep</a>&nbsp;&nbsp;
<a href="#trigger">trigger</a> &nbsp; <a href="#trigger">trigger</a>&nbsp;&nbsp;
<a href="#xmllist">xmllist</a> &nbsp; <a href="#xmllist">xmllist</a>&nbsp;&nbsp;
</ul> </ul>
@ -50,62 +50,62 @@
<ul> <ul>
<a href="#global">global</a><br> <a href="#global">global</a><br>
<a href="#BS">BS</a> &nbsp; <a href="#BS">BS</a>&nbsp;&nbsp;
<a href="#CM11">CM11</a> &nbsp; <a href="#CM11">CM11</a>&nbsp;&nbsp;
<a href="#CUL">CUL</a> &nbsp; <a href="#CUL">CUL</a>&nbsp;&nbsp;
<a href="#CUL_EM">CUL_EM</a> &nbsp; <a href="#CUL_EM">CUL_EM</a>&nbsp;&nbsp;
<a href="#CUL_FHTTK">CUL_FHTTK</a> &nbsp; <a href="#CUL_FHTTK">CUL_FHTTK</a>&nbsp;&nbsp;
<a href="#CUL_WS">CUL_WS</a> &nbsp; <a href="#CUL_WS">CUL_WS</a>&nbsp;&nbsp;
<a href="#CUL_RFR">CUL_RFR</a> &nbsp; <a href="#CUL_RFR">CUL_RFR</a>&nbsp;&nbsp;
<a href="#DbLog">DbLog</a> &nbsp; <a href="#DbLog">DbLog</a>&nbsp;&nbsp;
<a href="#EM">EM</a> &nbsp; <a href="#EM">EM</a>&nbsp;&nbsp;
<a href="#EMEM">EMEM</a> &nbsp; <a href="#EMEM">EMEM</a>&nbsp;&nbsp;
<a href="#EMGZ">EMGZ</a> &nbsp; <a href="#EMGZ">EMGZ</a>&nbsp;&nbsp;
<a href="#EMWZ">EMWZ</a> &nbsp; <a href="#EMWZ">EMWZ</a>&nbsp;&nbsp;
<a href="#FHT">FHT</a> &nbsp; <a href="#FHT">FHT</a>&nbsp;&nbsp;
<a href="#FHZ">FHZ</a> &nbsp; <a href="#FHZ">FHZ</a>&nbsp;&nbsp;
<a href="#FS20">FS20</a> &nbsp; <a href="#FS20">FS20</a>&nbsp;&nbsp;
<a href="#HMS">HMS</a> &nbsp; <a href="#HMS">HMS</a>&nbsp;&nbsp;
<a href="#FHEMWEB">FHEMWEB</a> &nbsp; <a href="#FHEMWEB">FHEMWEB</a>&nbsp;&nbsp;
<a href="#IPWE">IPWE</a> &nbsp; <a href="#IPWE">IPWE</a>&nbsp;&nbsp;
<a href="#KS300">KS300</a> &nbsp; <a href="#KS300">KS300</a>&nbsp;&nbsp;
<a href="#LIRC">LIRC</a> &nbsp; <a href="#LIRC">LIRC</a>&nbsp;&nbsp;
<a href="#M232">M232</a> &nbsp; <a href="#M232">M232</a>&nbsp;&nbsp;
<a href="#M232Counter">M232Counter</a> &nbsp; <a href="#M232Counter">M232Counter</a>&nbsp;&nbsp;
<a href="#M232Voltage">M232Voltage</a> &nbsp; <a href="#M232Voltage">M232Voltage</a>&nbsp;&nbsp;
<a href="#OWFS">OWFS</a> &nbsp; <a href="#OWFS">OWFS</a>&nbsp;&nbsp;
<a href="#OWTEMP">OWTEMP</a> &nbsp; <a href="#OWTEMP">OWTEMP</a>&nbsp;&nbsp;
<a href="#DS18S20">DS18S20</a> &nbsp; <a href="#DS18S20">DS18S20</a>&nbsp;&nbsp;
<a href="#SCIVT">SCIVT</a> &nbsp; <a href="#SCIVT">SCIVT</a>&nbsp;&nbsp;
<a href="#structure">structure</a> &nbsp; <a href="#structure">structure</a>&nbsp;&nbsp;
<a href="#WS2000">WS2000</a> &nbsp; <a href="#WS2000">WS2000</a>&nbsp;&nbsp;
<a href="#WS3600">WS3600</a> &nbsp; <a href="#WS3600">WS3600</a>&nbsp;&nbsp;
<a href="#SISPM">SISPM</a> &nbsp; <a href="#SISPM">SISPM</a>&nbsp;&nbsp;
<a href="#SIS_PMS">SIS_PMS</a> &nbsp; <a href="#SIS_PMS">SIS_PMS</a>&nbsp;&nbsp;
<a href="#WS300">WS300</a> &nbsp; <a href="#WS300">WS300</a>&nbsp;&nbsp;
<a href="#Weather">Weather</a> &nbsp; <a href="#Weather">Weather</a>&nbsp;&nbsp;
<a href="#USF1000">USF1000</a> &nbsp; <a href="#USF1000">USF1000</a>&nbsp;&nbsp;
<a href="#X10">X10</a> &nbsp; <a href="#X10">X10</a>&nbsp;&nbsp;
<a href="#xxLG7000">xxLG7000</a> &nbsp; <a href="#xxLG7000">xxLG7000</a>&nbsp;&nbsp;
<a href="#LGTV">LGTV</a> &nbsp; <a href="#LGTV">LGTV</a>&nbsp;&nbsp;
<a href="#FHEMRENDERER">FHEMRENDERER</a> &nbsp; <a href="#FHEMRENDERER">FHEMRENDERER</a>&nbsp;&nbsp;
</ul> </ul>
<br> <br>
<b>Helper modules</b> <b>Helper modules</b>
<ul> <ul>
<a href="#FileLog">FileLog</a> &nbsp; <a href="#FileLog">FileLog</a>&nbsp;&nbsp;
<a href="#PachLog">PachLog</a> &nbsp; <a href="#PachLog">PachLog</a>&nbsp;&nbsp;
<a href="#SUNRISE_EL">SUNRISE_EL</a> &nbsp; <a href="#SUNRISE_EL">SUNRISE_EL</a>&nbsp;&nbsp;
<a href="#at">at</a> &nbsp; <a href="#at">at</a>&nbsp;&nbsp;
<a href="#autocreate">autocreate</a> &nbsp; <a href="#autocreate">autocreate</a>&nbsp;&nbsp;
<a href="#dummy">dummy</a> &nbsp; <a href="#dummy">dummy</a>&nbsp;&nbsp;
<a href="#dumpdef">dumpdef</a> &nbsp; <a href="#dumpdef">dumpdef</a>&nbsp;&nbsp;
<a href="#holiday">holiday</a> &nbsp; <a href="#holiday">holiday</a>&nbsp;&nbsp;
<a href="#notify">notify</a> &nbsp; <a href="#notify">notify</a>&nbsp;&nbsp;
<a href="#watchdog">watchdog</a> &nbsp; <a href="#watchdog">watchdog</a>&nbsp;&nbsp;
<a href="#weblink">weblink</a> &nbsp; <a href="#weblink">weblink</a>&nbsp;&nbsp;
</ul> </ul>
@ -309,6 +309,12 @@ A line ending with \ will be concatenated with the next one, so long lines
Filter/group devices. Recognized by web-pgm2 and web-pgm3. Filter/group devices. Recognized by web-pgm2 and web-pgm3.
Devices in the room hidden will not appear in the web output.</li> Devices in the room hidden will not appear in the web output.</li>
<a name="alias"></a>
<li>alias<br>
Second name (alias), whished for by Martin. Cannot be used
directly in fhem, as "set <aliasname> on" wont be recognized, only
"set alias=<aliasname> on"</li>
<a name="showtime"></a> <a name="showtime"></a>
<li>showtime<br> <li>showtime<br>
Used in the webfrontend pgm2 to show the time of last activity Used in the webfrontend pgm2 to show the time of last activity
@ -447,15 +453,13 @@ A line ending with \ will be concatenated with the next one, so long lines
<br><br> <br><br>
Output a short space seperated status for &lt;devspec&gt;. It is useful for Output a short space seperated status for &lt;devspec&gt;. It is useful for
monitoring the device in e.g. Cacti.<br> monitoring the device in e.g. Cacti.<br>
Examples: Examples:<pre>
<ul> getstate lamp
<pre><code> getstate lamp
state:1 state:1
getstate fl getstate fl
ack:0 actuator:2 day-temp:21.5 desired-temp:22.5 [...] measured-temp:22.9 [...] ack:0 actuator:2 day-temp:21.5 desired-temp:22.5 [...]
</code></pre> </pre>
</ul>
Note: to use this command copy the file contrib/getstate/99_getstate.pm into Note: to use this command copy the file contrib/getstate/99_getstate.pm into
your FHEM directory. your FHEM directory.
<br> <br>
@ -759,7 +763,8 @@ A line ending with \ will be concatenated with the next one, so long lines
<pre> fhem> xmllist <pre> fhem> xmllist
&lt;FHZINFO&gt; &lt;FHZINFO&gt;
&lt;internal_LIST&gt; &lt;internal_LIST&gt;
&lt;internal name="global" state="internal" sets="" attrs="room configfile logfile modpath pidfilename port statefile userattr verbose version"&gt; &lt;internal name="global" state="internal"
sets="" attrs="room configfile logfile ..."&gt;
&lt;INT key="DEF" value="&lt;no definition&gt;"/&gt; &lt;INT key="DEF" value="&lt;no definition&gt;"/&gt;
&lt;INT key="NR" value="0"/&gt; &lt;INT key="NR" value="0"/&gt;
&lt;INT key="STATE" value="internal"/&gt; &lt;INT key="STATE" value="internal"/&gt;
@ -3876,7 +3881,14 @@ Terminating
<b>Attributes</b> <b>Attributes</b>
<ul> <ul>
<li><a href="#fixedrange">fixedrange</a></li> <a name="fixedrange"></a>
<li>fixedrange<br/>
Can be applied to weblink devices.<br/>
Contains two time specs in the form YYYY-MM-DD separated by a space.
In plotmode gnuplot-scroll or SVG the given time-range will be used,
and no scrolling for this weblinks will be possible. Needed e.g. for
looking at last-years data without scrolling.
</li><br> </li> </ul>
<li><a href="#plotsize">plotsize</a></li> <li><a href="#plotsize">plotsize</a></li>
<li><a href="#plotmode">plotmode</a></li> <li><a href="#plotmode">plotmode</a></li>
<a name="label"> <a name="label">
@ -3950,6 +3962,19 @@ Terminating
i.e the default http address is http://localhost:8083/fhem i.e the default http address is http://localhost:8083/fhem
</li><br> </li><br>
<a name="fwmodpath"></a>
<li>fwmodpath<br/>
Path to the style, png, gplot and html files. Defaults to <a
href="#modpath">modpath</a>/FHEM . Used to configure different fhem
servers, e.g. one with small gnuplots for android phones and one with
SVG for the desktop browser. </li><br>
<a name="fwcompress"></a>
<li>fwcompress<br/>
Compress the output with the gzip method if the browser supports it.
Defaults to 1. Set it to 0 if you have a slow CPU with a fast
connection.</li><br>
<a name="refresh"></a> <a name="refresh"></a>
<li>refresh<br/> <li>refresh<br/>
If set, a http-equiv="refresh" entry will be genererated with the given If set, a http-equiv="refresh" entry will be genererated with the given
@ -3990,14 +4015,6 @@ Terminating
the weblink. the weblink.
</li><br> </li><br>
<a name="fixedrange"></a>
<li>fixedrange<br/>
Can be applied to weblink devices (FHEMWEB).<br/>
Contains two time specs in the form YYYY-MM-DD separated by a space.
In plotmode gnuplot-scroll or SVG the given time-range will be used,
and no scrolling for this weblinks will be possible. Needed e.g. for
looking at last-years data without scrolling.
</li><br> </li> </ul>
</ul> </ul>
</ul> </ul>
@ -4029,8 +4046,7 @@ Terminating
</ul> </ul>
<br> <br>
Examples: Examples:<PRE>
<PRE>
# absolute ones: # absolute ones:
define a1 at 17:00:00 set lamp on # fhem command define a1 at 17:00:00 set lamp on # fhem command
define a2 at 17:00:00 { Log 1, "Teatime" } # Perl command define a2 at 17:00:00 { Log 1, "Teatime" } # Perl command
@ -4038,8 +4054,8 @@ Terminating
define a4 at *17:00:00 set lamp on # every day define a4 at *17:00:00 set lamp on # every day
# relative ones # relative ones
define a5 at +00:00:10 set lamp on # switch the lamp on in 10 seconds define a5 at +00:00:10 set lamp on # lamp on in 10 sec
define a6 at +00:00:02 set lamp on-for-timer 1 # Blink once in 2 seconds define a6 at +00:00:02 set lamp on-for-timer 1 # Blink once in 2 sec
define a7 at +*{3}00:00:02 set lamp on-for-timer 1 # Blink 3 times define a7 at +*{3}00:00:02 set lamp on-for-timer 1 # Blink 3 times
# Blink 3 times if the piri sends a command # Blink 3 times if the piri sends a command
@ -4063,7 +4079,6 @@ Terminating
# Switch lamp1 on at sunset, not before 18:00 and not after 21:00 # Switch lamp1 on at sunset, not before 18:00 and not after 21:00
define a15 at *{sunset(0,"18:00","21:00")} set lamp1 on define a15 at *{sunset(0,"18:00","21:00")} set lamp1 on
</PRE> </PRE>
Notes:<br> Notes:<br>