From b96227aec993433a757419f505fb04a8310fc6e3 Mon Sep 17 00:00:00 2001
From: pahenning <pahenning@2b470e98-0d58-463d-a4d8-8e2adae1ed80>
Date: Wed, 24 Oct 2012 18:57:49 +0000
Subject: [PATCH] git-svn-id: svn://svn.code.sf.net/p/fhem/code/trunk@2013
 2b470e98-0d58-463d-a4d8-8e2adae1ed80

---
 fhem/contrib/1-Wire/commandref.html | 175 +++++++++++++++++++++++++---
 1 file changed, 157 insertions(+), 18 deletions(-)

diff --git a/fhem/contrib/1-Wire/commandref.html b/fhem/contrib/1-Wire/commandref.html
index 90e85b8f7..67d5537ac 100755
--- a/fhem/contrib/1-Wire/commandref.html
+++ b/fhem/contrib/1-Wire/commandref.html
@@ -9,14 +9,16 @@
                 <li>via an active DS2480/DS2482/DS2490/DS9097U bus master interface attached to an
                     USB port or </li>
                 <li>via a passive DS9097 interface attached to an USB port or</li>
-                <li>via a network-attached CUNO</li>
+                <li>via a network-attached CUNO or through a COC on the RaspBerry Pi</li>
             </ul> Internally these interfaces are vastly different, read the corresponding <a
                 href="http://fhemwiki.de/wiki/Interfaces_f%C3%BCr_1-Wire"> Wiki pages </a>
             <br />
             <br />
             <b>Example</b><br />
             <ul>
-                <code>define OWio OWX /dev/ttyUSB1</code>
+                <code>define OWio1 OWX /dev/ttyUSB1</code>
+                <br />
+                <code>define OWio2 OWX COC</code>
                 <br />
             </ul>
             <br />
@@ -24,7 +26,7 @@
                 <b>Define</b></a>
             <ul>
                 <code>define &lt;name&gt; OWX &lt;serial-device&gt;</code> or <br />
-                <code>define &lt;name&gt; OWX &lt;cuno-device&gt;</code>
+                <code>define &lt;name&gt; OWX &lt;cuno/coc-device&gt;</code>
                 <br /><br /> Define a 1-Wire interface to communicate with a 1-Wire bus.<br />
                 <br />
                 <li>
@@ -82,7 +84,7 @@
             <ul>
                 <li><a name="OWXbuspower"><code>attr &lt;name&gt; buspower real|parasitic</code></a>
                     <br />tells FHEM whether power is supplied to the 1-Wire bus or not.</li>
-                <li>Standard attributes alias, comment, eventMap, logLevel, webCmd</li>
+                <li>Standard attributes alias, comment, <a href="#eventMap">eventMap</a>, <a href="#loglevel">loglevel</a>, <a href="#webCmd">webCmd</a></li>
             </ul>
         </ul>
         <!--+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
@@ -101,7 +103,7 @@
                 <br />
                 <code>attr OWX_AD DHigh 50.0</code>
                 <br />
-                <code>attr OWX_AD DName RelHumidity|humidity</code>
+                <code>attr OWX_AD DName relHumidity|humidity</code>
                 <br />
                 <code>attr OWX_AD DOffset -0.8088</code>
                 <br />
@@ -213,7 +215,13 @@
                             &lt;float&gt;</code></a>
                     <br />measurement value (on the scale determined by offset and factor) for high
                     alarm. </li>
-                <li>Standard attributes alias, comment, eventMap, logLevel, webCmd</li>
+                <li><a name="owad_event"><code>attr &lt;name&gt; event on-change|on-update
+                    </code></a>This attribte work similarly, but not identically to the standard event-on-update-change/event-on-update-reading attribute.
+                    <ul><li><code>event on-update</code> (default) will write a notify/FileLog event any time a measurement is received.</li>
+                        <li><code>event on-change</code> will write a notify/FileLog event only when a measurement is different from the previous one.</li>
+                        </ul>
+                </li>
+                <li>Standard attributes alias, comment, <a href="#eventMap">eventMap</a>, <a href="#loglevel">loglevel</a>, <a href="#webCmd">webCmd</a></li>
             </ul>
         </ul>
         <!--+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
@@ -317,7 +325,13 @@
                 <li><a name="owcount_cmode"><code>attr &lt;name&gt; &lt;channel&gt;Mode daily |
                             normal</code></a>
                     <br />factor multiplied to (reading+offset) in this channel. </li>
-                <li>Standard attributes alias, comment, eventMap, logLevel, webCmd</li>
+                <li><a name="owcount_event"><code>attr &lt;name&gt; event on-change|on-update
+                </code></a>This attribte work similarly, but not identically to the standard event-on-update-change/event-on-update-reading attribute.
+                    <ul><li><code>event on-update</code> (default) will write a notify/FileLog event any time a measurement is received.</li>
+                        <li><code>event on-change</code> will write a notify/FileLog event only when a measurement is different from the previous one.</li>
+                    </ul>
+                </li>
+                <li>Standard attributes alias, comment, <a href="#eventMap">eventMap</a>, <a href="#loglevel">loglevel</a>, <a href="#webCmd">webCmd</a></li>
             </ul>
         </ul>
         <!--+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
@@ -440,10 +454,116 @@
             <a name="owlcdattr">
                 <b>Attributes</b></a>
             <ul>
-                <li>Standard attributes alias, comment, eventMap, logLevel, webCmd</li>
+                <li>Standard attributes alias, comment, <a href="#eventMap">eventMap</a>, <a href="#loglevel">loglevel</a>, <a href="#webCmd">webCmd</a></li>
             </ul>
         </ul>
         <!--+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
+        <a name="OWMULTI"></a>
+        <h3>OWMULTI</h3>
+        <ul>FHEM module to commmunicate with 1-Wire multi-sensors, currently the DS2438 smart battery monitor<br /><br /> Note:<br /> This
+            1-Wire module so far works only with the OWX interface module. Please define an <a
+                href="#OWX">OWX</a> device first. <br />
+            <br /><b>Example</b><br />
+            <ul>
+                <code>define OWX_M OWMULTI 7C5034010000 45</code>
+                <br />
+                <code>attr OWX_M VName relHumidity|humidity</code>
+                <br />
+                <code>attr OWX_M VUnit percent|%</code>
+                <br />
+                <code>attr OWX_M VFunction (161.29 * V / VDD - 25.8065)/(1.0546 - 0.00216 * T)</code>
+                <br />
+            </ul><br />
+            <a name="OWMULTIdefine"></a>
+            <b>Define</b>
+            <ul>
+                <code>define &lt;name&gt; OWMULTI [&lt;model&gt;] &lt;id&gt; [&lt;interval&gt;]</code>
+                <br /><br /> Define a 1-Wire multi-sensor<br /><br />
+                <li>
+                    <code>[&lt;model&gt;]</code><br /> Defines the sensor model (and thus
+                    1-Wire family id), currently the following values are permitted: <ul>
+                        <li>model DS2438 with family id 26 (default if the model parameter is
+                            omitted). Measured is a temperature value, an external voltage and the current supply voltage</li>
+                    </ul>
+                </li>
+                <li>
+                    <code>&lt;id&gt;</code>
+                    <br />12-character unique ROM id of the converter device without family id and
+                    CRC code </li>
+                <li>
+                    <code>&lt;interval&gt;</code>
+                    <br />Measurement interval in seconds. The default is 300 seconds. </li>
+                <br />
+            </ul>
+            <br />
+            <a name="OWMULTIset">
+                <b>Set</b></a>
+            <ul>
+                <li><a name="owmulti_interval">
+                    <code>set &lt;name&gt; interval &lt;int&gt;</code></a><br /> Measurement
+                    interval in seconds. The default is 300 seconds. </li>
+            </ul>
+            <br />
+            <a name="OWMULTIget">
+                <b>Get</b></a>
+            <ul>
+                <li><a name="owmulti_id">
+                    <code>get &lt;name&gt; id</code></a>
+                    <br /> Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC </li>
+                <li><a name="owmulti_present">
+                    <code>get &lt;name&gt; present</code>
+                </a>
+                    <br /> Returns 1 if this 1-Wire device is present, otherwise 0. </li>
+                <li><a name="owmulti_interval2">
+                    <code>get &lt;name&gt; interval</code></a><br />Returns measurement interval
+                    in seconds. </li>
+                <li><a name="owmulti_reading">
+                    <code>get &lt;name&gt; reading</code></a><br />Obtain the measurement value from VFunction. </li>
+                <li><a name="owmulti_temperature">
+                    <code>get &lt;name&gt; temperature</code></a><br />Obtain the temperature value. </li>
+                <li><a name="owmulti_vdd">
+                    <code>get &lt;name&gt; VDD</code></a><br />Obtain the current supply voltage.
+                </li>
+                <li><a name="owmulti_raw">
+                    <code>get &lt;name&gt; V</code> or <code>get &lt;name&gt; raw</code></a><br />Obtain the raw external voltage measurement.
+                </li>
+            </ul>
+            <br />
+            <a name="OWMULTIattr">
+                <b>Attributes</b></a>
+            <ul>
+                <li><a name="owmulti_vname"><code>attr &lt;name&gt; VName
+                    &lt;string&gt;|&lt;string&gt;</code></a>
+                    <br />name for the channel | a type description for the measured value. </li>
+                <li><a name="owmulti_vunit"><code>attr &lt;name&gt; VUnit
+                    &lt;string&gt;|&lt;string&gt;</code></a>
+                    <br />unit of measurement for this channel | its abbreviation. </li>
+                <li><a name="owmulti_vfunction"><code>attr &lt;name&gt; VFunction
+                    &lt;string&gt;</code></a>
+                    <br />arbitrary functional expression involving the values VDD, V, T. Example see above.
+                    <ul>
+                    <li>VDD is replaced by the measured supply voltage in Volt,</li>
+                    <li> V by the measured external voltage,</li>
+                    <li>T by the measured and corrected temperature in its unit</li>
+                </ul></li>
+                <li><a name="owmulti_tempOffset"><code>attr &lt;name&gt; tempOffset
+                    &lt;float&gt;</code>
+                </a>
+                    <br />temperature offset in &deg;C added to the raw temperature reading. </li>
+                <li><a name="owmulti_tempUnit"><code>attr &lt;name&gt; tempUnit
+                    Celsius|Kelvin|Fahrenheit|C|K|F</code>
+                </a>
+                    <br />unit of measurement (temperature scale), default is Celsius = &deg;C </li>
+                <li><a name="owmulti_event"><code>attr &lt;name&gt; event on-change|on-update
+                </code></a>This attribte work similarly, but not identically to the standard event-on-update-change/event-on-update-reading attribute.
+                    <ul><li><code>event on-update</code> (default) will write a notify/FileLog event any time a measurement is received.</li>
+                        <li><code>event on-change</code> will write a notify/FileLog event only when a measurement is different from the previous one.</li>
+                    </ul>
+                </li>
+                <li>Standard attributes alias, comment, <a href="#eventMap">eventMap</a>, <a href="#loglevel">loglevel</a>, <a href="#webCmd">webCmd</a></li>
+            
+        </ul>
+        <!--+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
         <a name="OWSWITCH"></a>
         <h3>OWSWITCH</h3>
         <ul>FHEM module to commmunicate with 1-Wire Programmable Switches <br /><br /> Note:<br />
@@ -469,7 +589,9 @@
                     <code>[&lt;model&gt;]</code><br /> Defines the switch model (and thus 1-Wire
                     family id), currently the following values are permitted: <ul>
                         <li>model DS2413 with family id 3A (default if the model parameter is
-                            omitted)</li>
+                            omitted). 2 Channel switch with onboard memory</li>
+                        <li>model DS2406 with family id 12. 2 Channel switch </li>
+                        <li>model DS2406 with family id 29. 8 Channel switch</li>
                     </ul>
                 </li>
                 <li>
@@ -489,11 +611,12 @@
                     interval in seconds. The default is 300 seconds. </li>
                 <li><a name="owswitch_output">
                         <code>set &lt;name&gt; output &lt;channel-name&gt; ON |
-                    OFF</code></a><br />Switch channel on/off (A, B or named channel, see
-                    below)</li>
+                            OFF</code></a><br />Set value for channel (A,B,... or defined channel name). 1 = OFF, 0 = ON in normal usage. 
+                             See also the note above</li>
                 <li><a name="owswitch_gpio">
-                        <code>set &lt;name&gt; gpio &lt;value&gt;</code></a><br />Write state for
-                    all channels (for each bit 0=ON, 1=OFF)</li>
+                    <code>set &lt;name&gt; gpio &lt;value&gt;</code></a><br />Set values for channels (For 2 channels: 3 = A and B OFF, 1 = B ON 2 = A ON 0 = both ON)</li>
+                <li><a name="owswitch_init">
+                    <code>set &lt;name&gt; init yes</code></a><br /> Re-initialize the device</li>
             </ul>
             <br />
             <a name="OWSWITCHget">
@@ -510,8 +633,12 @@
                         <code>get &lt;name&gt; interval</code></a><br />Returns measurement interval
                     in seconds. </li>
                 <li><a name="owswitch_input">
-                        <code>get &lt;name&gt; INPUT &lt;channel-name&gt;</code></a><br />Obtain
-                    state of channel (A, B or named channel, see below)</li>
+                        <code>get &lt;name&gt; input &lt;channel-name&gt;</code></a><br />
+                        state for channel (A,B, ... or defined channel name)
+                        This value reflects the measured value, not necessarily the one set as
+                        output state, because the output transistors are open collector switches. A measured
+                        state of 1 = OFF therefore corresponds to an output state of 1 = OFF, but a measured
+                        state of 0 = ON can also be due to an external shortening of the output.</li>
                 <li><a name="owswitch_gpio">
                         <code>get &lt;name&gt; gpio</code></a><br />Obtain state of all
                     channels</li>
@@ -519,14 +646,20 @@
             <br />
             <a name="OWSWITCHattr">
                 <b>Attributes</b></a> For each of the following attributes, the channel
-            identification A,B may be used. <ul>
+            identification A,B,... may be used. <ul>
                 <li><a name="owswitch_cname"><code>attr &lt;name&gt; &lt;channel&gt;Name
                             &lt;string&gt;|&lt;string&gt;</code></a>
                     <br />name for the channel | a type description for the measured value. </li>
                 <li><a name="owswitch_cunit"><code>attr &lt;name&gt; &lt;channel&gt;Unit
                             &lt;string&gt;|&lt;string&gt;</code></a>
                     <br />display for on | off condition </li>
-                <li>Standard attributes alias, comment, eventMap, logLevel, webCmd</li>
+                <li><a name="owswitch_event"><code>attr &lt;name&gt; event on-change|on-update
+                </code></a>This attribte work similarly, but not identically to the standard event-on-update-change/event-on-update-reading attribute.
+                    <ul><li><code>event on-update</code> (default) will write a notify/FileLog event any time a measurement is received.</li>
+                        <li><code>event on-change</code> will write a notify/FileLog event only when a measurement is different from the previous one.</li>
+                    </ul>
+                </li>
+                <li>Standard attributes alias, comment, <a href="#eventMap">eventMap</a>, <a href="#loglevel">loglevel</a>, <a href="#webCmd">webCmd</a></li>
             </ul>
         </ul>
         <!--+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
@@ -637,7 +770,13 @@
                     </a>
                     <br /> low alarm temperature (on the temperature scale chosen by the attribute
                     value). </li>
-                <li>Standard attributes alias, comment, eventMap, logLevel, webCmd</li>
+                <li><a name="owtherm_event"><code>attr &lt;name&gt; event on-change|on-update
+                </code></a>This attribte work similarly, but not identically to the standard event-on-update-change/event-on-update-reading attribute.
+                    <ul><li><code>event on-update</code> (default) will write a notify/FileLog event any time a measurement is received.</li>
+                        <li><code>event on-change</code> will write a notify/FileLog event only when a measurement is different from the previous one.</li>
+                    </ul>
+                </li>
+                <li>Standard attributes alias, comment, <a href="#eventMap">eventMap</a>, <a href="#loglevel">loglevel</a>, <a href="#webCmd">webCmd</a></li>
             </ul>
         </ul>