added commandref.html for 20_OWFS.pm, 21_OWTEMP.pm
git-svn-id: https://fhem.svn.sourceforge.net/svnroot/fhem/trunk/fhem@472 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
m_fischer
@@ -71,6 +71,9 @@
|
|||||||
<a href="#M232">M232</a>
|
<a href="#M232">M232</a>
|
||||||
<a href="#M232Counter">M232Counter</a>
|
<a href="#M232Counter">M232Counter</a>
|
||||||
<a href="#M232Voltage">M232Voltage</a>
|
<a href="#M232Voltage">M232Voltage</a>
|
||||||
|
<a href="#OWFS">OWFS</a>
|
||||||
|
<a href="#OWTEMP">OWTEMP</a>
|
||||||
|
<a href="#DS18S20">DS18S20</a>
|
||||||
<a href="#SCIVT">SCIVT</a>
|
<a href="#SCIVT">SCIVT</a>
|
||||||
<a href="#structure">structure</a>
|
<a href="#structure">structure</a>
|
||||||
<a href="#WS2000">WS2000</a>
|
<a href="#WS2000">WS2000</a>
|
||||||
@@ -2774,6 +2777,250 @@ A line ending with \ will be concatenated with the next one, so long lines
|
|||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<a name="OWFS"></a>
|
||||||
|
<h3>OWFS</h3>
|
||||||
|
<ul>
|
||||||
|
OWFS is a suite of programs that designed to make the 1-wire bus and its
|
||||||
|
devices easily accessible. The underlying priciple is to create a virtual
|
||||||
|
filesystem, with the unique ID being the directory, and the individual
|
||||||
|
properties of the device are represented as simple files that can be read
|
||||||
|
and written.<br><br>
|
||||||
|
|
||||||
|
Note:<br>
|
||||||
|
You need the owperl module from <a href="http://owfs.org/index.php?page=owperl">http://owfs.org/</a>.
|
||||||
|
<br><br>
|
||||||
|
|
||||||
|
<a name="OWFSdefine"></a>
|
||||||
|
<b>Define</b>
|
||||||
|
<ul>
|
||||||
|
<code>define <name> OWFS <owserver-ip:port> <model> <id></code>
|
||||||
|
<br><br>
|
||||||
|
|
||||||
|
Define a 1-wire device to communicate with an OWFS-Server.<br><br>
|
||||||
|
|
||||||
|
<code><owserver-ip:port></code>
|
||||||
|
<ul>
|
||||||
|
IP-address:port from OW-Server.
|
||||||
|
</ul>
|
||||||
|
<code><model></code>
|
||||||
|
<ul>
|
||||||
|
Define the <a href="#owfs_type">type</a> of the input device.
|
||||||
|
Currently supportet: <code>DS1420</code>
|
||||||
|
</ul>
|
||||||
|
<code><id></code>
|
||||||
|
<ul>
|
||||||
|
Corresponding to the <a href="#owfs_id">id</a> of the input device.
|
||||||
|
<br><br>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
Note:<br>
|
||||||
|
If the <code>owserver-ip:port</code> is called <code>none</code>, then
|
||||||
|
no device will be opened, so you can experiment without hardware attached.<br><br>
|
||||||
|
|
||||||
|
Example:
|
||||||
|
<ul>
|
||||||
|
<code>define DS9490R OWFS 127.0.0.1:4304 DS1420 93302D000000</code><br>
|
||||||
|
</ul>
|
||||||
|
<br>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<b>Set</b> <ul>N/A</ul><br>
|
||||||
|
|
||||||
|
<a name="OWFSget"></a>
|
||||||
|
<b>Get</b>
|
||||||
|
<ul>
|
||||||
|
<code>get <name> <value></code>
|
||||||
|
<br><br>
|
||||||
|
where <code>value</code> is one of:<br>
|
||||||
|
<ul>
|
||||||
|
<li><a name="owfs_address"></a>
|
||||||
|
<code>address</code> (read-only)<br>
|
||||||
|
The entire 64-bit unique ID. address starts with the family code.<br>
|
||||||
|
Given as upper case hexidecimal digits (0-9A-F).
|
||||||
|
</li>
|
||||||
|
<li><a name="owfs_crc8"></a>
|
||||||
|
<code>crc8</code> (read-only)<br>
|
||||||
|
The 8-bit error correction portion. Uses cyclic redundancy check. Computed
|
||||||
|
from the preceeding 56 bits of the unique ID number.<br>
|
||||||
|
Given as upper case hexidecimal digits (0-9A-F).
|
||||||
|
</li>
|
||||||
|
<li><a name="owfs_family"></a>
|
||||||
|
<code>family</code> (read-only)<br>
|
||||||
|
The 8-bit family code. Unique to each type of device.<br>
|
||||||
|
Given as upper case hexidecimal digits (0-9A-F).
|
||||||
|
</li>
|
||||||
|
<li><a name="owfs_id"></a>
|
||||||
|
<code>id</code> (read-only)<br>
|
||||||
|
The 48-bit middle portion of the unique ID number. Does not include the
|
||||||
|
family code or CRC.<br>
|
||||||
|
Given as upper case hexidecimal digits (0-9A-F).
|
||||||
|
</li>
|
||||||
|
<li><a name="owfs_locator"></a>
|
||||||
|
<code>locator</code> (read-only)<br>
|
||||||
|
Uses an extension of the 1-wire design from iButtonLink company that
|
||||||
|
associated 1-wire physical connections with a unique 1-wire code. If
|
||||||
|
the connection is behind a Link Locator the locator will show a unique
|
||||||
|
8-byte number (16 character hexidecimal) starting with family code FE.<br>
|
||||||
|
If no Link Locator is between the device and the master, the locator
|
||||||
|
field will be all FF.
|
||||||
|
</li>
|
||||||
|
<li><a name="owfs_present"></a>
|
||||||
|
<code>present</code> (read-only)<br>
|
||||||
|
Is the device currently present on the 1-wire bus?
|
||||||
|
</li>
|
||||||
|
<li><a name="owfs_type"></a>
|
||||||
|
<code>type</code> (read-only)<br>
|
||||||
|
Part name assigned by Dallas Semi. E.g. DS2401 Alternative packaging
|
||||||
|
(iButton vs chip) will not be distiguished.
|
||||||
|
</li>
|
||||||
|
<br>
|
||||||
|
</ul>
|
||||||
|
Examples:
|
||||||
|
<ul>
|
||||||
|
<code>get DS9490R type</code><br>
|
||||||
|
<code>DS9490R type => DS1420</code><br><br>
|
||||||
|
<code>get DS9490R address</code><br>
|
||||||
|
<code>DS9490R address => 8193302D0000002B</code>
|
||||||
|
</ul>
|
||||||
|
<br>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<b>Attributes</b>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#attrdummy">dummy</a></li>
|
||||||
|
<li><a href="#do_not_notify">do_not_notify</a></li>
|
||||||
|
<li><a href="#loglevel">loglevel</a></li>
|
||||||
|
<li><a href="#showtime">showtime</a></li>
|
||||||
|
<li><a name="owfs_temp-scale"></a>
|
||||||
|
temp-scale<br>
|
||||||
|
Specifies the temperature-scale unit:
|
||||||
|
<ul>
|
||||||
|
<li><code>C</code><br>
|
||||||
|
Celsius. This is the default.</li>
|
||||||
|
<li><code>F</code><br>
|
||||||
|
Fahrenheit</li>
|
||||||
|
<li><code>K</code><br>
|
||||||
|
Kelvin</li>
|
||||||
|
<li><code>R</code><br>
|
||||||
|
Rankine</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<br>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<a name="OWTEMP"></a>
|
||||||
|
<h3>OWTEMP</h3>
|
||||||
|
<ul>
|
||||||
|
High-Precision 1-Wire Digital Thermometer.
|
||||||
|
<br><br>
|
||||||
|
|
||||||
|
Note:<br>
|
||||||
|
Please define an <a href="#OWFS">OWFS</a> device first.
|
||||||
|
<br><br>
|
||||||
|
|
||||||
|
<a name="OWTEMPdefine"></a>
|
||||||
|
<b>Define</b>
|
||||||
|
<ul>
|
||||||
|
<code>define <name> OWTEMP <id> [<interval>] [<alarminterval>]</code>
|
||||||
|
<br><br>
|
||||||
|
|
||||||
|
Define a 1-wire Digital Thermometer device.<br><br>
|
||||||
|
|
||||||
|
<code><id></code>
|
||||||
|
<ul>
|
||||||
|
Corresponding to the <a href="#owfs_id">id</a> of the input device.
|
||||||
|
</ul>
|
||||||
|
<code><interval></code>
|
||||||
|
<ul>
|
||||||
|
Sets the status polling intervall in seconds to the given value. The default is 300 seconds.
|
||||||
|
</ul>
|
||||||
|
<code><alarminterval></code>
|
||||||
|
<ul>
|
||||||
|
Sets the alarm polling intervall in seconds to the given value. The default is 300 seconds.
|
||||||
|
<br><br>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
Note:<br>
|
||||||
|
Currently supported <a href="#owfs_type">type</a>: <code>DS18S20</code>.<br><br>
|
||||||
|
|
||||||
|
Example:
|
||||||
|
<ul>
|
||||||
|
<code>define KG.hz.TF.01 OWTEMP 93302D000000 300 60</code><br>
|
||||||
|
</ul>
|
||||||
|
<br>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<a name="OWTEMPset"></a>
|
||||||
|
<b>Set</b>
|
||||||
|
<ul>
|
||||||
|
<code>set <name> <value></code>
|
||||||
|
<br><br>
|
||||||
|
where <code>value</code> is one of:<br>
|
||||||
|
<ul>
|
||||||
|
<li><a name="owtemp_templow"></a>
|
||||||
|
<code>templow</code> (read-write)<br>
|
||||||
|
The upper limit for the low temperature alarm state.
|
||||||
|
</li>
|
||||||
|
<li><a name="owtemp_temphigh"></a>
|
||||||
|
<code>temphigh</code> (read-write)<br>
|
||||||
|
The lower limit for the high temperature alarm state.
|
||||||
|
</li>
|
||||||
|
<li><a name="owtemp_ALARMINT"></a>
|
||||||
|
<code>ALARMINT</code> (write-only)<br>
|
||||||
|
Sets the alarm polling intervall in seconds to the given value.
|
||||||
|
</li>
|
||||||
|
<li><a name="owtemp_INTERVAL"></a>
|
||||||
|
<code>INTERVAL</code> (write-only)<br>
|
||||||
|
Sets the status polling intervall in seconds to the given value.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</ul><br>
|
||||||
|
|
||||||
|
<a name="OWTEMPget"></a>
|
||||||
|
<b>Get</b>
|
||||||
|
<ul>
|
||||||
|
<code>get <name> <value></code>
|
||||||
|
<br><br>
|
||||||
|
where <code>value</code> is one of:<br>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#owfs_address">address</a> (read-only)</li>
|
||||||
|
<li><a href="#owfs_crc8">crc8</a> (read-only)</li>
|
||||||
|
<li><a href="#owfs_family">family</a> (read-only)</li>
|
||||||
|
<li><a href="#owfs_id">id</a> (read-only)</li>
|
||||||
|
<li><a href="#owfs_locator">locator</a> (read-only)</li>
|
||||||
|
<li><a href="#owfs_present">present</a> (read-only)</li>
|
||||||
|
<li><a name="owtemp_temperature"></a>
|
||||||
|
<code>temperature</code> (read-only)<br>
|
||||||
|
Read by the chip at high resolution (~12 bits). Units are selected from
|
||||||
|
the defined OWFS Device. See <a href="#owfs_temp-scale">temp-scale</a> for choices.
|
||||||
|
</li>
|
||||||
|
<li><a href="#owtemp_templow">templow</a> (read-write)</li>
|
||||||
|
<li><a href="#owtemp_temphigh">temphigh</a> (read-write)</li>
|
||||||
|
<li><a href="#owfs_type">type</a> (read-only)</li>
|
||||||
|
<br>
|
||||||
|
</ul>
|
||||||
|
Examples:
|
||||||
|
<ul>
|
||||||
|
<code>get KG.hz.TF.01 type</code><br>
|
||||||
|
<code>KG.hz.TF.01 type => DS18S20</code><br><br>
|
||||||
|
<code>get KG.hz.TF.01 temperature</code><br>
|
||||||
|
<code>KG.hz.TF.01 temperature => 38.2500 (Celsius)</code>
|
||||||
|
</ul>
|
||||||
|
<br>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<b>Attributes</b>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#do_not_notify">do_not_notify</a></li>
|
||||||
|
<li><a href="#loglevel">loglevel</a></li>
|
||||||
|
<li><a href="#showtime">showtime</a></li>
|
||||||
|
</ul>
|
||||||
|
<br>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
<a name="structure"></a>
|
<a name="structure"></a>
|
||||||
<h3>structure</h3>
|
<h3>structure</h3>
|
||||||
<ul>
|
<ul>
|
||||||
|
|||||||
Reference in New Issue
Block a user