629 lines
36 KiB
HTML
629 lines
36 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>MySensors - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate MySensors sensors into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/mysensors/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="MySensors">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/mysensors/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate MySensors sensors into Home Assistant.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
<meta name="twitter:title" content="MySensors">
|
||
<meta name="twitter:description" content="Instructions how to integrate MySensors sensors into Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
<body >
|
||
<header class='site-header'>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/docs/">Docs</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
<article class="page">
|
||
<header>
|
||
<h1 class="title indent">
|
||
MySensors
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <a href="https://www.mysensors.org">MySensors</a> project combines Arduino boards with NRF24L01 radio boards to build sensor networks. The component will automatically add all available devices to Home Assistant, after <a href="#presentation">presentation</a> is done.</p>
|
||
<h3><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h3>
|
||
<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>
|
||
<span class="s">gateways</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">device</span><span class="pi">:</span> <span class="s1">'</span><span class="s">/dev/ttyUSB0'</span>
|
||
<span class="s">persistence_file</span><span class="pi">:</span> <span class="s1">'</span><span class="s">path/mysensors.json'</span>
|
||
<span class="s">baud_rate</span><span class="pi">:</span> <span class="s">38400</span>
|
||
<span class="s">nodes</span><span class="pi">:</span>
|
||
<span class="s">1</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">kitchen'</span>
|
||
<span class="s">3</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">living_room'</span>
|
||
<span class="pi">-</span> <span class="s">device</span><span class="pi">:</span> <span class="s1">'</span><span class="s">/dev/ttyACM0'</span>
|
||
<span class="s">persistence_file</span><span class="pi">:</span> <span class="s1">'</span><span class="s">path/mysensors2.json'</span>
|
||
<span class="s">baud_rate</span><span class="pi">:</span> <span class="s">115200</span>
|
||
<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">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="s1">'</span><span class="s">2.0'</span>
|
||
</code></pre>
|
||
</div>
|
||
<div class="config-vars">
|
||
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
|
||
<dl class="">
|
||
<dt><a class="title-link" name="gateways" href="#gateways"></a> gateways</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Required)</span><span class="description">A list of gateways to set up.</span></p>
|
||
</dd>
|
||
<dd>
|
||
<dl class="nested">
|
||
<dt><a class="title-link" name="device" href="#device"></a> device</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">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.</span></p>
|
||
</dd>
|
||
<dt><a class="title-link" name="baud_rate" href="#baud_rate"></a> baud_rate</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Optional)</span><span class="description">Specifies the baud rate of the connected serial gateway.</span></p>
|
||
<p class="default">Default value: 115200</p>
|
||
</dd>
|
||
<dt><a class="title-link" name="tcp_port" href="#tcp_port"></a> tcp_port</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Optional)</span><span class="description">Specifies the port of the connected TCP Ethernet gateway.</span></p>
|
||
<p class="default">Default value: 5003</p>
|
||
</dd>
|
||
<dt><a class="title-link" name="topic_in_prefix" href="#topic_in_prefix"></a> topic_in_prefix</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Set the prefix of the MQTT topic for messages coming from the MySensors gateway in to Home Assistant.</span></p>
|
||
<p class="default">Default value: </p>
|
||
</dd>
|
||
<dt><a class="title-link" name="topic_out_prefix" href="#topic_out_prefix"></a> topic_out_prefix</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Set the prefix of the MQTT topic for messages going from Home Assistant out to the MySensors gateway.</span></p>
|
||
<p class="default">Default value: </p>
|
||
</dd>
|
||
<dt><a class="title-link" name="nodes" href="#nodes"></a> nodes</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Optional)</span><span class="description">A mapping of node ids to node settings, eg custom name.</span></p>
|
||
</dd>
|
||
<dd>
|
||
<dl class="nested">
|
||
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The name the node will be renamed to. This nodename becomes part of the entity_id. Default entity_id is [sketch_name]_[node_id]_[child_id] and when this name is set, the entity_id becomes [name]_[child_id].</span></p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dt><a class="title-link" name="debug" href="#debug"></a> debug</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Optional)</span><span class="description">This option has been deprecated. Please remove this from your config if you have it included. Use the <a href="/components/logger/">logger component</a> to filter log messages on log level.</span></p>
|
||
</dd>
|
||
<dt><a class="title-link" name="persistence" href="#persistence"></a> persistence</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Optional)</span><span class="description">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.</span></p>
|
||
<p class="default">Default value: true</p>
|
||
</dd>
|
||
<dt><a class="title-link" name="persistence_file" href="#persistence_file"></a> persistence_file</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The path to a file to save sensor information. The file extension determines the file type. Currently supported file types are ‘pickle’ and ‘json’.</span></p>
|
||
<p class="default">Default value: path/to/config/directory/mysensors.pickle</p>
|
||
</dd>
|
||
<dt><a class="title-link" name="version" href="#version"></a> version</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Specifies the MySensors protocol version to use. Supports 1.4, 1.5 and 2.0.</span></p>
|
||
<p class="default">Default value: 1.4</p>
|
||
</dd>
|
||
<dt><a class="title-link" name="optimistic" href="#optimistic"></a> optimistic</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Optional)</span><span class="description">Enable or disable optimistic mode for actuators (switch/light). Set this to true if no state feedback from actuators is possible. Home Assistant will assume that the command succeeded and change state.</span></p>
|
||
<p class="default">Default value: false</p>
|
||
</dd>
|
||
<dt><a class="title-link" name="retain" href="#retain"></a> retain</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Optional)</span><span class="description">Enable or disable retain flag for published messages from Home Assistant when using the MQTT gateway.</span></p>
|
||
<p class="default">Default value: true</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<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 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>Write and upload your MySensors sketch to the sensor. Make sure you:
|
||
<ul>
|
||
<li>Send sketch name.</li>
|
||
<li>Present the sensor’s S_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 <SPI.h>
|
||
#include <MySensors.h>
|
||
#include <Bounce2.h>
|
||
</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">&</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>
|
||
<h3><a class="title-link" name="heartbeats" href="#heartbeats"></a> Heartbeats</h3>
|
||
<p>Sending a heartbeat from the MySensors device to Home Assistant activates the SmartSleep functionality in Home Assistant. This means that messages are buffered and only sent to the device upon receiving a heartbeat from the device. State changes are stored so that only the last requested state change is sent to the device. Other types of messages are queued in a FIFO queue. SmartSleep is useful for battery powered actuators that are waiting for commands. See the MySensors library API for information on how to send heartbeats and sleep device.</p>
|
||
<h3><a class="title-link" name="message-validation" href="#message-validation"></a> Message validation</h3>
|
||
<p>Messages sent to or from Home Assistant from or to a MySensors device will be validated according to the MySensors <a href="https://www.mysensors.org/download/serial_api_20">serial API</a>. If a message doesn’t pass validation, it will be dropped and not be passed forward either to or from Home Assistant. Make sure you follow the serial API for your version of MySensors when writing your Arduino sketch.</p>
|
||
<p>If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the <code class="highlighter-rouge">mysensors</code> component and the <code class="highlighter-rouge">mysensors</code> package.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">logger</span><span class="pi">:</span>
|
||
<span class="s">default</span><span class="pi">:</span> <span class="s">info</span>
|
||
<span class="s">logs</span><span class="pi">:</span>
|
||
<span class="s">homeassistant.components.mysensors</span><span class="pi">:</span> <span class="s">debug</span>
|
||
<span class="s">mysensors</span><span class="pi">:</span> <span class="s">debug</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>The log should inform you of messages that failed validation or if a child value is missing that is required for a certain child type. Note that the log will log all possible combinations of platforms for a child type that failed validation. It is normal to see some platforms fail validation if the child type supports multiple platforms and your sketch doesn’t send all corresponding value types. Eg. the S_BARO child type supports both V_PRESSURE and V_FORECAST value types. If you only send a V_PRESSURE value, an S_BARO entity with V_PRESSURE value will be set up for the sensor platform. But the log will inform of a sensor platform that failed validation due to missing V_FORECAST value type for the S_BARO child. Home Assistant will log failed validations of child values at warning level if one required value type for a platform has been received, but other required value types are missing. Most failed validations are logged at debug level.</p>
|
||
<p>Message validation was introduced in version 0.52 of Home Assistant.</p>
|
||
<p>Visit the <a href="http://www.mysensors.org/download">library api</a> of MySensors for more information.</p>
|
||
</article>
|
||
</div>
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/mysensors.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/mysensors.png' />
|
||
</div>
|
||
<div class='section'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Push
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/binary_sensor.mysensors/'>
|
||
MySensors Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/cover.mysensors/'>
|
||
MySensors Cover
|
||
</a></li>
|
||
<li><a href='/components/device_tracker.mysensors/'>
|
||
MySensors Device Tracker
|
||
</a></li>
|
||
<li><a href='/components/climate.mysensors/'>
|
||
MySensors HVAC
|
||
</a></li>
|
||
<li><a href='/components/light.mysensors/'>
|
||
MySensors Light
|
||
</a></li>
|
||
<li><a href='/components/notify.mysensors/'>
|
||
MySensors Notify
|
||
</a></li>
|
||
<li><a href='/components/sensor.mysensors/'>
|
||
MySensors Sensor
|
||
</a></li>
|
||
<li><a href='/components/switch.mysensors/'>
|
||
MySensors Switch
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Hub</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/apcupsd/'>APCUPSd</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/abode/'>Abode Home Security</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarmdecoder/'>AlarmDecoder Alarm</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/amcrest/'>Amcrest IP Camera</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/android_ip_webcam/'>Android IP Webcam</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/apple_tv/'>Apple TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/arlo/'>Arlo</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/axis/'>Axis</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/wemo/'>Belkin WeMo</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/blink/'>Blink</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/bloomsky/'>BloomSky</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/digital_ocean/'>Digital Ocean</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/doorbird/'>DoorBird</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/dyson/'>Dyson</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/eight_sleep/'>Eight Sleep</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/emulated_hue/'>Emulated Hue Bridge</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/enocean/'>EnOcean</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/ffmpeg/'>FFmpeg</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/homematic/'>Homematic</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tradfri/'>IKEA Trådfri (Tradfri)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/isy994/'>ISY994 Controller</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/insteon_local/'>Insteon (local)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/insteon_hub/'>Insteon Hub</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/insteon_plm/'>Insteon PLM</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/joaoapps_join/'>Joaoapps Join</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/juicenet/'>Juicenet</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/knx/'>KNX</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/kira/'>Kira</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/lametric/'>LaMetric</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/litejet/'>LiteJet</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/lutron/'>Lutron</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/lutron_caseta/'>Lutron Caseta</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mqtt/'>MQTT</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/raincloud/'>Melnor Raincloud</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/microsoft_face/'>Microsoft Face</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mochad/'>Mochad</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/modbus/'>Modbus</a>
|
||
</li>
|
||
<li>
|
||
MySensors
|
||
</li>
|
||
<li>
|
||
<a href='/components/neato/'>Neato Robotics</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/nest/'>Nest</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/netatmo/'>Netatmo</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/nuimo_controller/'>Nuimo controller</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/octoprint/'>OctoPrint</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/pilight/'>Pilight</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/qwikswitch/'>QwikSwitch QSUSB Hub</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rflink/'>RFLink</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/ring/'>Ring</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/scsgate/'>SCSGate</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/spc/'>SPC</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/satel_integra/'>Satel Integra Alarm</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/skybell/'>Skybell</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sleepiq/'>SleepIQ</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tado/'>Tado</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/telegram_bot/'>Telegram chatbot</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tellstick/'>TellStick</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tellduslive/'>Telldus Live</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tesla/'>Tesla</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thethingsnetwork/'>The Things Network</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/toon/'>Toon</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/twilio/'>Twilio</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/usps/'>USPS</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/velbus/'>Velbus</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/velux/'>Velux</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/vera/'>Vera</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/verisure/'>Verisure</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/volvooncall/'>Volvo On Call</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/wink/'>Wink</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/xiaomi_aqara/'>Xiaomi Gateway (Aqara)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zwave/'>Z-Wave</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/comfoconnect/'>Zehnder ComfoAir Q Ventilation</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zha/'>Zigbee Home Automation</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zoneminder/'>ZoneMinder</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/ecobee/'>ecobee</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|