Site updated at 2016-10-08 18:28:01 UTC
This commit is contained in:
Travis CI
parent
c33649c7ed
commit
85df6d11f5
522 changed files with 7493 additions and 3477 deletions
382
components/cover.mysensors/index.html
Normal file
382
components/cover.mysensors/index.html
Normal file
|
|
@ -0,0 +1,382 @@
|
|||
<!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 Cover - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions how to integrate MySensors covers into Home Assistant.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/components/cover.mysensors/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="MySensors Cover">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/components/cover.mysensors/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions how to integrate MySensors covers 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 Cover">
|
||||
<meta name="twitter:description" content="Instructions how to integrate MySensors covers 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='/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>
|
||||
</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 Cover
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>Integrates MySensors covers into Home Assistant. See the <a href="/components/mysensors/">main component</a> for configuration instructions.</p>
|
||||
|
||||
<p>The following actuator types are supported:</p>
|
||||
|
||||
<h5>MySensors version 1.4</h5>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>S_TYPE</th>
|
||||
<th>V_TYPE</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>S_COVER</td>
|
||||
<td>V_UP, V_DOWN, V_STOP, [V_DIMMER or V_LIGHT]</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h5>MySensors version 1.5 and higher</h5>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>S_TYPE</th>
|
||||
<th>V_TYPE</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>S_COVER</td>
|
||||
<td>V_UP, V_DOWN, V_STOP, [V_PERCENTAGE or V_STATUS]</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<p>All V_TYPES above are required. Use V_PERCENTAGE (or V_DIMMER) if you know the exact position of the cover in percent, use V_STATUS (or V_LIGHT) if you don’t.</p>
|
||||
|
||||
<p>For more information, visit the <a href="https://www.mysensors.org/download/serial_api_20">serial api</a> of MySensors.</p>
|
||||
|
||||
<h3><a class="title-link" name="example-sketch" href="#example-sketch"></a> Example sketch</h3>
|
||||
|
||||
<div class="language-cpp highlighter-rouge"><pre class="highlight"><code><span class="cm">/*
|
||||
* Documentation: http://www.mysensors.org
|
||||
* Support Forum: http://forum.mysensors.org
|
||||
*/</span>
|
||||
|
||||
<span class="c1">// Enable debug prints to serial monitor
|
||||
</span><span class="cp">#define MY_DEBUG
|
||||
#define MY_RADIO_NRF24
|
||||
</span>
|
||||
<span class="cp">#include <MySensors.h>
|
||||
#define SN "Cover"
|
||||
#define SV "1.1"
|
||||
</span>
|
||||
<span class="c1">// Actuators for moving the cover up and down respectively.
|
||||
</span><span class="cp">#define COVER_UP_ACTUATOR_PIN 2
|
||||
#define COVER_DOWN_ACTUATOR_PIN 3
|
||||
</span><span class="c1">// Sensors for finding out when the cover has reached its up/down position.
|
||||
// These could be simple buttons or linear hall sensors.
|
||||
</span><span class="cp">#define COVER_UP_SENSOR_PIN 4
|
||||
#define COVER_DOWN_SENSOR_PIN 5
|
||||
</span>
|
||||
<span class="cp">#define CHILD_ID 0
|
||||
</span>
|
||||
<span class="c1">// Internal representation of the cover state.
|
||||
</span><span class="k">enum</span> <span class="n">State</span> <span class="p">{</span>
|
||||
<span class="n">IDLE</span><span class="p">,</span>
|
||||
<span class="n">UP</span><span class="p">,</span> <span class="c1">// Window covering. Up.
|
||||
</span> <span class="n">DOWN</span><span class="p">,</span> <span class="c1">// Window covering. Down.
|
||||
</span><span class="p">};</span>
|
||||
|
||||
<span class="k">static</span> <span class="kt">int</span> <span class="n">state</span> <span class="o">=</span> <span class="n">IDLE</span><span class="p">;</span>
|
||||
<span class="k">static</span> <span class="kt">int</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="c1">// 0=cover is down, 1=cover is up
|
||||
</span><span class="k">static</span> <span class="kt">bool</span> <span class="n">initial_state_sent</span> <span class="o">=</span> <span class="nb">false</span><span class="p">;</span>
|
||||
<span class="n">MyMessage</span> <span class="n">upMessage</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">V_UP</span><span class="p">);</span>
|
||||
<span class="n">MyMessage</span> <span class="n">downMessage</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">V_DOWN</span><span class="p">);</span>
|
||||
<span class="n">MyMessage</span> <span class="n">stopMessage</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">V_STOP</span><span class="p">);</span>
|
||||
<span class="n">MyMessage</span> <span class="n">statusMessage</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">sendState</span><span class="p">()</span> <span class="p">{</span>
|
||||
<span class="c1">// Send current state and status to gateway.
|
||||
</span> <span class="n">send</span><span class="p">(</span><span class="n">upMessage</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">UP</span><span class="p">));</span>
|
||||
<span class="n">send</span><span class="p">(</span><span class="n">downMessage</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">DOWN</span><span class="p">));</span>
|
||||
<span class="n">send</span><span class="p">(</span><span class="n">stopMessage</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">IDLE</span><span class="p">));</span>
|
||||
<span class="n">send</span><span class="p">(</span><span class="n">statusMessage</span><span class="p">.</span><span class="n">set</span><span class="p">(</span><span class="n">status</span><span class="p">));</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">COVER_UP_SENSOR_PIN</span><span class="p">,</span> <span class="n">INPUT</span><span class="p">);</span>
|
||||
<span class="n">pinMode</span><span class="p">(</span><span class="n">COVER_DOWN_SENSOR_PIN</span><span class="p">,</span> <span class="n">INPUT</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="n">SN</span><span class="p">,</span> <span class="n">SV</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_COVER</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">initial_state_sent</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="n">sendState</span><span class="p">();</span>
|
||||
<span class="n">initial_state_sent</span> <span class="o">=</span> <span class="nb">true</span><span class="p">;</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">state</span> <span class="o">==</span> <span class="n">IDLE</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="n">digitalWrite</span><span class="p">(</span><span class="n">COVER_UP_ACTUATOR_PIN</span><span class="p">,</span> <span class="n">LOW</span><span class="p">);</span>
|
||||
<span class="n">digitalWrite</span><span class="p">(</span><span class="n">COVER_DOWN_ACTUATOR_PIN</span><span class="p">,</span> <span class="n">LOW</span><span class="p">);</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">state</span> <span class="o">==</span> <span class="n">UP</span> <span class="o">&&</span> <span class="n">digitalRead</span><span class="p">(</span><span class="n">COVER_UP_SENSOR_PIN</span><span class="p">)</span> <span class="o">==</span> <span class="n">HIGH</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">"Cover is up."</span><span class="p">);</span>
|
||||
<span class="c1">// Update status and state; send it to the gateway.
|
||||
</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
|
||||
<span class="n">state</span> <span class="o">=</span> <span class="n">IDLE</span><span class="p">;</span>
|
||||
<span class="n">sendState</span><span class="p">();</span>
|
||||
<span class="c1">// Actuators will be disabled in next loop() iteration.
|
||||
</span> <span class="p">}</span>
|
||||
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">state</span> <span class="o">==</span> <span class="n">DOWN</span> <span class="o">&&</span> <span class="n">digitalRead</span><span class="p">(</span><span class="n">COVER_DOWN_SENSOR_PIN</span><span class="p">)</span> <span class="o">==</span> <span class="n">HIGH</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">"Cover is down."</span><span class="p">);</span>
|
||||
<span class="c1">// Update status and state; send it to the gateway.
|
||||
</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
|
||||
<span class="n">state</span> <span class="o">=</span> <span class="n">IDLE</span><span class="p">;</span>
|
||||
<span class="n">sendState</span><span class="p">();</span>
|
||||
<span class="c1">// Actuators will be disabled in next loop() iteration.
|
||||
</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">type</span> <span class="o">==</span> <span class="n">V_UP</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="c1">// Set state to covering up and send it back to the gateway.
|
||||
</span> <span class="n">state</span> <span class="o">=</span> <span class="n">UP</span><span class="p">;</span>
|
||||
<span class="n">sendState</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">"Moving cover up."</span><span class="p">);</span>
|
||||
|
||||
<span class="c1">// Activate actuator until the sensor returns HIGH in loop().
|
||||
</span> <span class="n">digitalWrite</span><span class="p">(</span><span class="n">COVER_UP_ACTUATOR_PIN</span><span class="p">,</span> <span class="n">HIGH</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_DOWN</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="c1">// Set state to covering up and send it back to the gateway.
|
||||
</span> <span class="n">state</span> <span class="o">=</span> <span class="n">DOWN</span><span class="p">;</span>
|
||||
<span class="n">sendState</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">"Moving cover down."</span><span class="p">);</span>
|
||||
<span class="c1">// Activate actuator until the sensor returns HIGH in loop().
|
||||
</span> <span class="n">digitalWrite</span><span class="p">(</span><span class="n">COVER_DOWN_ACTUATOR_PIN</span><span class="p">,</span> <span class="n">HIGH</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_STOP</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="c1">// Set state to idle and send it back to the gateway.
|
||||
</span> <span class="n">state</span> <span class="o">=</span> <span class="n">IDLE</span><span class="p">;</span>
|
||||
<span class="n">sendState</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">"Stopping cover."</span><span class="p">);</span>
|
||||
|
||||
<span class="c1">// Actuators will be switched off in loop().
|
||||
</span> <span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</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/cover.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'>
|
||||
Introduced in release: 0.30
|
||||
</div>
|
||||
<div class='section'>
|
||||
This is a platform for
|
||||
<a href='/components/cover/'>the Covers component</a>.
|
||||
</div>
|
||||
<div class='section'>
|
||||
<h1 class='title delta'>Related components</h1>
|
||||
<ul class='divided'>
|
||||
<li><a href='/components/mysensors/'>
|
||||
MySensors
|
||||
</a></li>
|
||||
<li><a href='/components/binary_sensor.mysensors/'>
|
||||
MySensors Binary Sensor
|
||||
</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/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 Cover</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/cover.command_line/'>Command Line Cover</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/cover.homematic/'>Homematic Cover</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/cover.isy994/'>ISY994 Cover</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/cover.mqtt/'>MQTT Cover</a>
|
||||
</li>
|
||||
<li>
|
||||
MySensors Cover
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/scene.hunterdouglas_powerview/'>PowerView Scenes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/cover.rfxtrx/'>RFXtrx Cover</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/cover.rpi_gpio/'>Raspberry Pi Cover</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/cover.scsgate/'>SCSGate Cover</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/cover.vera/'>Vera Cover</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/cover.wink/'>Wink Cover</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/cover.zwave/'>Z-Wave Cover</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>.<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>
|
||||
</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>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue