From 097e7a66215ff1d4ce6e38c4cb40b1e91bd58250 Mon Sep 17 00:00:00 2001
From: rudolfkoenig <rudolfkoenig@2b470e98-0d58-463d-a4d8-8e2adae1ed80>
Date: Mon, 30 Jul 2012 09:49:33 +0000
Subject: [PATCH] ZWave added

git-svn-id: https://fhem.svn.sourceforge.net/svnroot/fhem/trunk/fhem@1772 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
 docs/commandref.html | 299 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 294 insertions(+), 5 deletions(-)

diff --git a/docs/commandref.html b/docs/commandref.html
index 0cfea3bf9..e6ccf703e 100644
--- a/docs/commandref.html
+++ b/docs/commandref.html
@@ -107,9 +107,9 @@
       <a href="#M232">M232</a> &nbsp;
       <a href="#M232Counter">M232Counter</a> &nbsp;
       <a href="#M232Voltage">M232Voltage</a> &nbsp;
-	  <a href="#MSG">MSG</a> &nbsp;
-	  <a href="#MSGFile">MSGFile</a> &nbsp;
-	  <a href="#MSGMail">MSGMail</a> &nbsp;
+      <a href="#MSG">MSG</a> &nbsp;
+      <a href="#MSGFile">MSGFile</a> &nbsp;
+      <a href="#MSGMail">MSGMail</a> &nbsp;
       <a href="#NetIO230B">NetIO230B</a> &nbsp;
       <a href="#OREGON">OREGON</a> &nbsp;
       <a href="#OWFS">OWFS</a> &nbsp;
@@ -143,6 +143,8 @@
       <a href="#WS3600">WS3600</a> &nbsp;
       <a href="#X10">X10</a> &nbsp;
       <a href="#xxLG7000">xxLG7000</a> &nbsp;
+      <a href="#ZWDongle">ZWDongle</a> &nbsp;
+      <a href="#ZWave">ZWave</a> &nbsp;
 
 
   </ul>
@@ -8505,6 +8507,292 @@ KlikAanKlikUit, NEXA, CHACON, HomeEasy UK. <br> You need to define an RFXtrx433
   <br>
 </ul>
 
+<a name="ZWDongle"></a>
+<h3>ZWDongle</h3>
+<ul>
+  This module serves a ZWave dongle, which is attached via USB or TCP/IP, and
+  enables the use of ZWave devices (see also the <a href="#ZWave">ZWave</a>
+  module). It was tested wit a Goodway WD6001, but since the protocol is
+  standardized, it should work with other devices too. A notable exception is
+  the USB device from Merten.
+  <br><br>
+  <a name="ZWDongledefine"></a>
+  <b>Define</b>
+  <ul>
+    <code>define &lt;name&gt; ZWDongle &lt;device&gt;</code>
+  <br>
+  <br>
+  Upon initial connection the module will get the homeId of the attached
+  device. Since the DevIo module is used to open the device, you can also use
+  devices connected via  TCP/IP. See <a href="#CULdefine">this</a> paragraph on
+  device naming details.
+  <br>
+  Example:
+  <ul>
+    <code>define zwdongle_1 ZWDongle /dev/cu.PL2303-000014FA@115200</code><br>
+  </ul>
+  </ul>
+  <br>
+
+  <a name="ZWDongleset"></a>
+  <b>Set</b>
+  <ul>
+
+  <li>addNode [on|off]<br>
+    Activate (or deactivate) inclusion mode. The controller (i.e. the dongle)
+    will accept inclusion (i.e. pairing/learning) requests only while in this
+    mode. After activating inclusion mode usually you have to press a switch
+    three times within 1.5 seconds on the node to be included into the network
+    of the controller. If autocreate is active, a fhem device will be created
+    after inclusion.
+
+  <li>removeNode [on|off]<br>
+    Activate (or deactivate) exclusion mode. Note: the corresponding fhem
+    device have to be deleted manually.
+
+  <li>createNode id<br>
+    Request the class information for the specified node, and create a fhem
+    device upon reception of the answer. Used for previously included nodes,
+    see the nodeList get command below.
+
+  </ul>
+  <br>
+
+  <a name="ZWDongleget"></a>
+  <b>Get</b>
+  <ul>
+  <li>nodeList<br>
+    return the list of included nodeIds. Can be used to recreate fhem-nodes
+    with the createNode command.
+
+  <li>homeId<br>
+    return the six hex-digit homeId of the controller.
+
+  <li>caps, ctrlCaps, version<br>
+    return different controller specific information. Needed by developers only.
+
+  <li>nodeInfo<br>
+    return node specific information. Needed by developers only.
+
+
+  <li>raw<br>
+    Send raw data to the controller. Developer only.
+  </ul>
+  <br>
+
+  <a name="ZWDongleattr"></a>
+  <b>Attributes</b>
+  <ul>
+    <li><a href="#dummy">dummy</a></li>
+    <li><a href="#do_not_notify">do_not_notify</a></li>
+    <li><a href="#loglevel">loglevel</a></li>
+    <li><a href="#model">model</a></li>
+  </ul>
+  <br>
+
+  <a name="ZWDongleevents"></a>
+  <b>Generated events:</b>
+  <ul>
+  <li>ZW_ADD_NODE_TO_NETWORK [learnReady|nodeFound|controller|done|failed]
+  <li>ZW_REMOVE_NODE_TO_NETWORK [learnReady|nodeFound|slave|controller|done|failed]
+  <li>UNDEFINED ZWave_${type6}_$id ZWave $homeId $id $classes"
+  </ul>
+
+</ul>
+
+
+<a name="ZWave"></a>
+<h3>ZWave</h3>
+<ul>
+  This module is used to control ZWave devices via FHEM, see <a
+  href="http://www.z-wave.com">www.z-wave.com</a> on details for this device family.
+  This module is a client of the <a href="#ZWDongle">ZWDongle</a> module, which
+  is directly attached to the controller via USB or TCP/IP.
+  <br><br>
+  <a name="ZWavedefine"></a>
+  <b>Define</b>
+  <ul>
+    <code>define &lt;name&gt; ZWave &lt;homeId&gt; &lt;id&gt; [classes]</code>
+  <br>
+  <br>
+  &lt;homeId&gt; is the homeId of the controller node, and id is the id of the
+  slave node in the network of this controller.<br>
+  classes is a hex-list of ZWave device classes. This argument is usually
+  specified by autocreate when creating a device. If you wish to manually
+  create a device, use the classes attribute instead, see below for details.
+  Defining a ZWave device the first time is usually done by autocreate. 
+  <br>
+  Example:
+  <ul>
+    <code>define lamp ZWave 00ce2074 9</code><br>
+    <code>attr lamp classes SWITCH_BINARY BASIC MANUFACTURER_SPECIFIC VERSION SWITCH_ALL ASSOCIATION METER CONFIGURATION ALARM<code><br>
+  </ul>
+  </ul>
+  <br>
+
+  Note: the sets/gets/generated events of a gven node depend on the classes
+  supported by this node. If a node supports 3 classes, then the union of
+  these sets/gets/events will be available for this node.<br>
+  Commands for battery operated nodes will be queues internally, and sent when
+  the node sends a message. Answer to get commands appear then as events, the
+  corresponding readings will be updated.
+  <br><br>
+
+  <a name="ZWaveset"></a>
+  <b>Set</b>
+  <ul>
+
+  <br><b>Class BASIC</b>
+  <li>basicValue value<br>
+    Send value (0-255) to this device. The interpretation is device dependent,
+    e.g. for a SWITCH_BINARY device 0 is off and anything else is on.
+
+  <br><br><b>Class SWITCH_BINARY</b>
+  <li>on<br>
+    switch the device on
+  <li>off<br>
+    switch the device off
+  <li>reportOn,reportOff<br>
+    activate/deactivate the reporting of device state changes to the association group.
+
+  <br><br><b>Class CONFIGURATION</b>
+  <li>configByte cfgAddress 8bitValue<br>
+      configWord cfgAddress 16bitValue<br>
+      configLong cfgAddress 32bitValue<br>
+    Send a configuration value for the parameter cfgAddress. cfgAddress and
+    value is node specific.
+  <li>configDefault cfgAddress<br>
+    Reset the configuration parameter for the cfgAddress parameter to its default value.
+    See the device documentation to determine this value.
+
+  <br><br><b>Class WAKE_UP</b>
+  <li>wakeupInterval value<br>
+  Set the wakeup interval of battery operated devices to the given value in
+  seconds. Upon wakeup the device sends a wakeup notification.
+
+  <br><br><b>Class ASSOCIATION</b>
+  <li>associationAdd groupId nodeId ...<br>
+  Add the specified list of nodeIds to the assotion group groupId.<br>
+  Note: upon creating a fhem-device for the first time fhem will automatically
+  add the controller to the first association group of the node corresponding
+  to the fhem device, i.e it issues a "set name associationAdd 1 controllerNodeId"
+
+  <li>associationDel groupId nodeId ...<br>
+  Remove the specified list of nodeIds from the assotion group groupId.
+
+  </ul>
+  <br>
+
+  <a name="ZWaveget"></a>
+  <b>Get</b>
+  <ul>
+
+  <br><b>Class BASIC</b>
+  <li>basicStatus<br>
+    return the status of the node as basicReport:XY. The value (XY) depends on
+    the node, e.g a SWITCH_BINARY device report 00 for off and FF (255) for on.
+
+  <br><br><b>Class SWITCH_BINARY</b>
+  <li>swbStatus<br>
+    return the status of the node, as state:on or state:off.
+
+  <br><br><b>Class SENSOR_BINARY</b>
+  <li>sbStatus<br>
+    return the status of the node, as state:open or state:closed.
+
+  <br><br><b>Class CONFIGURATION</b>
+  <li>config cfgAddress<br>
+    return the value of the configuration parameter cfgAddress. The value is
+    device specific.
+
+  <br><br><b>Class ALARM</b>
+  <li>alarm alarmId<br>
+    return the value for alarmId. The value is device specific.
+
+  <br><br><b>Class BATTERY</b>
+  <li>battery<br>
+    return the charge of the battery in %, as battery:value %
+
+  <br><br><b>Class WAKE_UP</b>
+  <li>wakeupInterval<br>
+    return the wakeup interval in seconds, in the form<br>
+    wakeupReport:interval:seconds target:id
+
+  <br><br><b>Class ASSOCIATION</b>
+  <li>association groupId<br>
+    return the list of nodeIds in the association group groupId in the form:<br>
+    assocGroup_X:Max:Y Nodes:id,id...
+
+  <br><br><b>Class VERSION</b>
+  <li>version<br>
+    return the version information of this node in the form:<br>
+    Lib:A Prot:x.y App:a.b
+
+  </ul>
+  <br>
+
+  <a name="ZWaveattr"></a>
+  <b>Attributes</b>
+  <ul>
+    <li><a href="#IODev">IODev</a></li>
+    <li><a href="#do_not_notify">do_not_notify</a></li>
+    <li><a href="#ignore">ignore</a></li>
+    <li><a href="#dummy">dummy</a></li>
+    <li><a href="#showtime">showtime</a></li>
+    <li><a href="#loglevel">loglevel</a></li>
+    <li><a href="#model">model</a></li>
+    <li><a href="#classes">classes</a>
+      This attribute is needed by the ZWave module, as the list of the possible
+      set/get commands depends on it. It contains a space separated list of
+      class names (capital letters).
+      </li>
+  </ul>
+  <br>
+
+  <a name="ZWaveevents"></a>
+  <b>Generated events:</b>
+  <ul>
+
+  <br><b>Class BASIC</b>
+  <li>basicReport:XY
+
+  <br><br><b>Class SWITCH_BINARY</b>
+  <li>state:on
+  <li>state:off
+
+  <br><br><b>Class SENSOR_BINARY</b>
+  <li>state:open
+  <li>state:closed
+
+  <br><br><b>Class METER</b>
+  <li>power:val [kWh|kVAh|W|pulseCount]
+  <li>gas:val [m3|feet3|pulseCount]
+  <li>water:val [m3|feet3|USgallons|pulseCount]
+
+  <br><br><b>Class CONFIGURATION</b>
+  <li>config_X:Y
+
+  <br><br><b>Class ALARM</b>
+  <li>alarm_type_X:level Y
+
+  <br><br><b>Class BATTERY</b>
+  <li>battery:chargelevel %
+
+  <br><br><b>Class WAKE_UP</b>
+  <li>wakeup:notification
+  <li>wakeupReport:interval:X target:Y
+
+  <br><br><b>Class ASSOCIATION</b>
+  <li>assocGroup_X:Max:Y Nodes:A,B,...
+
+  <br><br><b>Class VERSION</b>
+  <li>Lib:A Prot:x.y App:a.b
+
+  </ul>
+</ul>
+
+
+
 
 <a name="weblink"></a>
 <h3>weblink</h3>
@@ -10134,8 +10422,9 @@ KlikAanKlikUit, NEXA, CHACON, HomeEasy UK. <br> You need to define an RFXtrx433
     Log events to <code>&lt;filename&gt;</code>. The log format is
     <pre>
       YYYY:MM:DD_HH:MM:SS &lt;device&gt; &lt;event&gt;</pre>
-    The regexp will be checked against the (complete!) device name
-    or against the (complete!) devicename:event combination.
+    The regexp will be checked against the device name
+    devicename:event or timestamp:devicename:event combination. 
+    The regexp must match the complete string, not just a part of it.
     <br>
     <code>&lt;filename&gt;</code> may contain %-wildcards of the 
     POSIX strftime function of the underlying OS (see your strftime manual).