Site updated at 2016-08-28 03:57:42 UTC

components/mysensors/index.html

@@ -93,7 +93,7 @@
 
 <h3><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h3>
 
-<p>Integrate your Serial or Ethernet MySensors Gateway by adding the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
+<p>Integrate your Serial, Ethernet or MQTT Client MySensors Gateway by adding the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
 
 <div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
 <span class="s">mysensors</span><span class="pi">:</span>
@@ -107,52 +107,153 @@
     <span class="pi">-</span> <span class="s">device</span><span class="pi">:</span> <span class="s1">'</span><span class="s">192.168.1.18'</span>
       <span class="s">persistence_file</span><span class="pi">:</span> <span class="s1">'</span><span class="s">path/mysensors3.json'</span>
       <span class="s">tcp_port</span><span class="pi">:</span> <span class="s">5003</span>
+    <span class="pi">-</span> <span class="s">device</span><span class="pi">:</span> <span class="s">mqtt</span>
+      <span class="s">persistence_file</span><span class="pi">:</span> <span class="s1">'</span><span class="s">path/mysensors4.json'</span>
+      <span class="s">topic_in_prefix</span><span class="pi">:</span> <span class="s1">'</span><span class="s">mygateway1-out'</span>
+      <span class="s">topic_out_prefix</span><span class="pi">:</span> <span class="s1">'</span><span class="s">mygateway1-in'</span>
   <span class="s">debug</span><span class="pi">:</span> <span class="s">true</span>
-  <span class="s">persistence</span><span class="pi">:</span> <span class="s">true</span>
-  <span class="s">version</span><span class="pi">:</span> <span class="s1">'</span><span class="s">1.5'</span>
   <span class="s">optimistic</span><span class="pi">:</span> <span class="s">false</span>
+  <span class="s">persistence</span><span class="pi">:</span> <span class="s">true</span>
+  <span class="s">retain</span><span class="pi">:</span> <span class="s">true</span>
+  <span class="s">version</span><span class="pi">:</span> <span class="s">2.0</span>
 </code></pre>
 </div>
 
 <p>Configuration variables:</p>
 
 <ul>
-  <li><strong>device</strong> (<em>Required</em>): The path to the serial gateway where it is connected to your Home Assistant host, or the address of the tcp ethernet gateway. Resolving DNS addresses is theoretically supported but not tested.</li>
+  <li><strong>device</strong> (<em>Required</em>): The path to the serial gateway where it is connected to your Home Assistant host, or the address of the tcp ethernet gateway, or <code class="highlighter-rouge">mqtt</code> to setup the MQTT gateway. Resolving DNS addresses is theoretically supported but not tested.</li>
   <li><strong>baud_rate</strong> (<em>Optional</em>): Specifies the baud rate of the connected serial gateway. Default is 115200.</li>
   <li><strong>tcp_port</strong> (<em>Optional</em>): Specifies the port of the connected tcp ethernet gateway. Default is 5003.</li>
+  <li><strong>topic_in_prefix</strong> (<em>Optional</em>): Set the prefix of the MQTT topic for messages coming from the MySensors gateway in to Home Assistant. Default is an empty string.</li>
+  <li><strong>topic_out_prefix</strong> (<em>Optional</em>): Set the prefix of the MQTT topic for messages going from Home Assistant out to the MySensors gateway. Default is an empty string.</li>
   <li><strong>debug</strong> (<em>Optional</em>): Enable or disable verbose debug logging. Default is false.</li>
   <li><strong>persistence</strong> (<em>Optional</em>): Enable or disable local persistence of sensor information. If this is disabled, then each sensor will need to send presentation messages after Home Assistant starts. Default is true.</li>
   <li><strong>persistence_file</strong> (<em>Optional</em>): The path to a file to save sensor information. The file extension determines the file type. Currently supported file types are ‘pickle’ and ‘json’.</li>
-  <li><strong>version</strong> (<em>Optional</em>): Specifies the MySensors protocol version to use. Supports 1.4 and 1.5. Default is 1.4.</li>
+  <li><strong>version</strong> (<em>Optional</em>): Specifies the MySensors protocol version to use. Supports 1.4, 1.5 and 2.0. Default is 1.4.</li>
   <li><strong>optimistic</strong> (<em>Optional</em>): Enable or disable optimistic mode for actuators (switch/light). Default is false. Set this to true if no state feedback from actuators is possible. Home Assistant will assume that the command succeeded and change state.</li>
+  <li><strong>retain</strong> (<em>Optional</em>): Enable or disable retain flag for published messages from Home Assistant when using the MQTT gateway. Default is true.</li>
 </ul>
 
+<p class="note">
+Not all features of MySensors 2.0 are yet supported by Home Assistant. As more features are added, they will be described here in the documentation. Go to the MySensors platform pages under “related components” to see what message types are currently supported.
+</p>
+
 <p>If you are using an original Arduino as a serial gateway, the port will be named <code class="highlighter-rouge">ttyACM*</code>. The exact number can be determined with the command shown below.</p>
 
 <div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ls /dev/ttyACM<span class="k">*</span>
 </code></pre>
 </div>
 
+<p>If using the MQTT gateway, you also need to have the <a href="/components/mqtt/">MQTT component</a> configured in Home Assistant. See below for a minimum MQTT configuration:</p>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">mqtt</span><span class="pi">:</span>
+  <span class="s">client_id</span><span class="pi">:</span> <span class="s">home-assistant-1</span>
+</code></pre>
+</div>
+
+<p class="note">
+The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway is supported.
+</p>
+
 <h3><a class="title-link" name="presentation" href="#presentation"></a> Presentation</h3>
 
 <p>Present a MySensors sensor or actuator, by following these steps:</p>
 
 <ol>
-  <li>Connect the serial gateway to your computer or the ethernet gateway to your network.</li>
-  <li>Configure the MySensors component in configuration.yaml.</li>
+  <li>Connect the serial gateway to your computer or the ethernet or MQTT gateway to your network.</li>
+  <li>Configure the MySensors component in <code class="highlighter-rouge">configuration.yaml</code>.</li>
   <li>Start hass.</li>
-  <li>Wait for “Connected to [device]” in the log output.</li>
   <li>Write and upload your MySensors sketch to the sensor. Make sure you:
     <ul>
-      <li>Either use a manual node id, or AUTO for requesting a node id from the controller, in the begin method for initialization of the MySensors library.</li>
       <li>Send sketch name.</li>
       <li>Present the sensor’s S_TYPE.</li>
-      <li>Send at least one initial value per V_TYPE.</li>
+      <li>Send at least one initial value per V_TYPE. In version 2.0 of MySensors this has to be done in the loop function. See below for an example in 2.0 of how to make sure the initial value has been received by the controller.</li>
     </ul>
   </li>
   <li>Start the sensor.</li>
 </ol>
 
+<div class="language-cpp highlighter-rouge"><pre class="highlight"><code><span class="cm">/*
+ * Documentation: http://www.mysensors.org
+ * Support Forum: http://forum.mysensors.org
+ *
+ * http://www.mysensors.org/build/relay
+ */</span>
+
+<span class="cp">#define MY_DEBUG
+#define MY_RADIO_NRF24
+#define MY_REPEATER_FEATURE
+#define MY_NODE_ID 1
+#include &lt;SPI.h&gt;
+#include &lt;MySensors.h&gt;
+#include &lt;Bounce2.h&gt;
+</span>
+<span class="cp">#define RELAY_PIN  5
+#define BUTTON_PIN  3
+#define CHILD_ID 1
+#define RELAY_ON 1
+#define RELAY_OFF 0
+</span>
+<span class="n">Bounce</span> <span class="n">debouncer</span> <span class="o">=</span> <span class="n">Bounce</span><span class="p">();</span>
+<span class="kt">bool</span> <span class="n">state</span> <span class="o">=</span> <span class="nb">false</span><span class="p">;</span>
+<span class="kt">bool</span> <span class="n">initialValueSent</span> <span class="o">=</span> <span class="nb">false</span><span class="p">;</span>
+
+<span class="n">MyMessage</span> <span class="n">msg</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">V_STATUS</span><span class="p">);</span>
+
+<span class="kt">void</span> <span class="nf">setup</span><span class="p">()</span>
+<span class="p">{</span>
+  <span class="n">pinMode</span><span class="p">(</span><span class="n">BUTTON_PIN</span><span class="p">,</span> <span class="n">INPUT_PULLUP</span><span class="p">);</span>
+  <span class="n">debouncer</span><span class="p">.</span><span class="n">attach</span><span class="p">(</span><span class="n">BUTTON_PIN</span><span class="p">);</span>
+  <span class="n">debouncer</span><span class="p">.</span><span class="n">interval</span><span class="p">(</span><span class="mi">10</span><span class="p">);</span>
+
+  <span class="c1">// Make sure relays are off when starting up
+</span>  <span class="n">digitalWrite</span><span class="p">(</span><span class="n">RELAY_PIN</span><span class="p">,</span> <span class="n">RELAY_OFF</span><span class="p">);</span>
+  <span class="n">pinMode</span><span class="p">(</span><span class="n">RELAY_PIN</span><span class="p">,</span> <span class="n">OUTPUT</span><span class="p">);</span>
+<span class="p">}</span>
+
+<span class="kt">void</span> <span class="nf">presentation</span><span class="p">()</span>  <span class="p">{</span>
+  <span class="n">sendSketchInfo</span><span class="p">(</span><span class="s">"Relay+button"</span><span class="p">,</span> <span class="s">"1.0"</span><span class="p">);</span>
+  <span class="n">present</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">S_BINARY</span><span class="p">);</span>
+<span class="p">}</span>
+
+<span class="kt">void</span> <span class="nf">loop</span><span class="p">()</span>
+<span class="p">{</span>
+  <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="n">initialValueSent</span><span class="p">)</span> <span class="p">{</span>
+    <span class="n">Serial</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="s">"Sending initial value"</span><span class="p">);</span>
+    <span class="n">send</span><span class="p">(</span><span class="n">msg</span><span class="p">.</span><span class="n">set</span><span class="p">(</span><span class="n">state</span><span class="o">?</span><span class="n">RELAY_ON</span><span class="o">:</span><span class="n">RELAY_OFF</span><span class="p">));</span>
+    <span class="n">Serial</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="s">"Requesting initial value from controller"</span><span class="p">);</span>
+    <span class="n">request</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">V_STATUS</span><span class="p">);</span>
+    <span class="n">wait</span><span class="p">(</span><span class="mi">2000</span><span class="p">,</span> <span class="n">C_SET</span><span class="p">,</span> <span class="n">V_STATUS</span><span class="p">);</span>
+  <span class="p">}</span>
+  <span class="k">if</span> <span class="p">(</span><span class="n">debouncer</span><span class="p">.</span><span class="n">update</span><span class="p">())</span> <span class="p">{</span>
+    <span class="k">if</span> <span class="p">(</span><span class="n">debouncer</span><span class="p">.</span><span class="n">read</span><span class="p">()</span><span class="o">==</span><span class="n">LOW</span><span class="p">)</span> <span class="p">{</span>
+      <span class="n">state</span> <span class="o">=</span> <span class="o">!</span><span class="n">state</span><span class="p">;</span>
+      <span class="c1">// Send new state and request ack back
+</span>      <span class="n">send</span><span class="p">(</span><span class="n">msg</span><span class="p">.</span><span class="n">set</span><span class="p">(</span><span class="n">state</span><span class="o">?</span><span class="n">RELAY_ON</span><span class="o">:</span><span class="n">RELAY_OFF</span><span class="p">),</span> <span class="nb">true</span><span class="p">);</span>
+    <span class="p">}</span>
+  <span class="p">}</span>
+<span class="p">}</span>
+
+<span class="kt">void</span> <span class="nf">receive</span><span class="p">(</span><span class="k">const</span> <span class="n">MyMessage</span> <span class="o">&amp;</span><span class="n">message</span><span class="p">)</span> <span class="p">{</span>
+  <span class="k">if</span> <span class="p">(</span><span class="n">message</span><span class="p">.</span><span class="n">isAck</span><span class="p">())</span> <span class="p">{</span>
+     <span class="n">Serial</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="s">"This is an ack from gateway"</span><span class="p">);</span>
+  <span class="p">}</span>
+
+  <span class="k">if</span> <span class="p">(</span><span class="n">message</span><span class="p">.</span><span class="n">type</span> <span class="o">==</span> <span class="n">V_STATUS</span><span class="p">)</span> <span class="p">{</span>
+    <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="n">initialValueSent</span><span class="p">)</span> <span class="p">{</span>
+      <span class="n">Serial</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="s">"Receiving initial value from controller"</span><span class="p">);</span>
+      <span class="n">initialValueSent</span> <span class="o">=</span> <span class="nb">true</span><span class="p">;</span>
+    <span class="p">}</span>
+    <span class="c1">// Change relay state
+</span>    <span class="n">state</span> <span class="o">=</span> <span class="p">(</span><span class="kt">bool</span><span class="p">)</span><span class="n">message</span><span class="p">.</span><span class="n">getInt</span><span class="p">();</span>
+    <span class="n">digitalWrite</span><span class="p">(</span><span class="n">RELAY_PIN</span><span class="p">,</span> <span class="n">state</span><span class="o">?</span><span class="n">RELAY_ON</span><span class="o">:</span><span class="n">RELAY_OFF</span><span class="p">);</span>
+    <span class="n">send</span><span class="p">(</span><span class="n">msg</span><span class="p">.</span><span class="n">set</span><span class="p">(</span><span class="n">state</span><span class="o">?</span><span class="n">RELAY_ON</span><span class="o">:</span><span class="n">RELAY_OFF</span><span class="p">));</span>
+  <span class="p">}</span>
+<span class="p">}</span>
+</code></pre>
+</div>
+
 <p>Visit the <a href="https://www.mysensors.org/download/sensor_api_15">library api</a> of MySensors for more information.</p>
 
 
@@ -204,6 +305,9 @@
         <li>
             <a href='/components/ecobee/'>Ecobee</a>
         </li>
+        <li>
+            <a href='/components/emulated_hue/'>Emulated Hue Bridge</a>
+        </li>
         <li>
             <a href='/components/enocean/'>EnOcean</a>
         </li>