jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-03-18 17:12:07 UTC

Browse source
This commit is contained in:
Travis CI 2017-03-18 17:12:07 +00:00
parent 7573fcba68
commit 67179bf8fe
994 changed files with 1768 additions and 68252 deletions
Download patch file Download diff file Expand all files Collapse all files

58
components/mysensors/index.html
View file

@ -3,17 +3,14 @@
<!--[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">
@ -21,39 +18,31 @@
<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" 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>
<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>
@ -64,38 +53,22 @@
</ul>
</nav>
</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>
@ -119,9 +92,7 @@
<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, 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>
@ -135,32 +106,23 @@
<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 or MQTT gateway to your network.</li>
<li>Configure the MySensors component in <code class="highlighter-rouge">configuration.yaml</code>.</li>
@ -174,7 +136,6 @@ The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway
</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
@ -254,25 +215,13 @@ The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway
<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>
<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'>
@ -442,13 +391,10 @@ The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
@ -458,7 +404,6 @@ The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway
<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>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
@ -470,7 +415,6 @@ The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
@ -478,4 +422,4 @@ The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
</html>