362 lines
No EOL
12 KiB
HTML
362 lines
No EOL
12 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 Light - Home Assistant</title>
|
|
<meta name="author" content="Paulus Schoutsen">
|
|
<meta name="description" content="Instructions how to integrate MySensors lights into Home Assistant.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/light.mysensors/">
|
|
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="MySensors Light">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/light.mysensors/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate MySensors lights into Home Assistant.">
|
|
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
|
|
|
<meta name="twitter:card" content="summary">
|
|
<meta name="twitter:site" content="@home_assistant">
|
|
|
|
<meta name="twitter:title" content="MySensors Light">
|
|
<meta name="twitter:description" content="Instructions how to integrate MySensors lights into Home Assistant.">
|
|
<meta name="twitter:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.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>Getting started <i class="icon icon-caret-down"></i></a>
|
|
<ul>
|
|
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
|
|
<li><a href='/getting-started/configuration/'>Configuration Basics</a></li>
|
|
<li><a href='/getting-started/devices/'>Adding devices</a></li>
|
|
<li><a href='/getting-started/presence-detection/'>Presence Detection</a></li>
|
|
<li><a href='/getting-started/automation/'>Automation</a></li>
|
|
<li><a href='/topics/'>Advanced Topics</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href='/components/'>Components</a></li>
|
|
<li><a href='/cookbook'>Examples</a></li>
|
|
<li>
|
|
<a>Developers <i class="icon icon-caret-down"></i></a>
|
|
<ul>
|
|
<li><a href="/developers/">Setup Development</a></li>
|
|
<li><a href="/developers/architecture/">Architecture</a></li>
|
|
<li><a href="/developers/frontend/">Frontend Development</a></li>
|
|
<li><a href="/developers/creating_components/">
|
|
Creating Components
|
|
</a></li>
|
|
<li><a href="/developers/add_new_platform/">
|
|
Adding Platform Support
|
|
</a></li>
|
|
<li><a href="/developers/api/">API and SSE</a></li>
|
|
<li><a href="/developers/credits/">Credits</a></li>
|
|
</ul>
|
|
</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 Light
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<p>Integrates MySensors lights 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_DIMMER</td>
|
|
<td>V_DIMMER*, 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_DIMMER</td>
|
|
<td>[V_DIMMER* or V_PERCENTAGE*], [V_LIGHT* or V_STATUS*]</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_RGB_LIGHT</td>
|
|
<td>V_RGB*, [V_LIGHT* or V_STATUS*], [V_DIMMER or V_PERCENTAGE]</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p>V_TYPES with a star (*) denotes required V_TYPES. Use either V_LIGHT or V_STATUS and either V_DIMMER or V_PERCENTAGE for an applicable actuator.</p>
|
|
|
|
<p>For more information, visit the <a href="https://www.mysensors.org/download/serial_api_15">serial api</a> of MySensors.</p>
|
|
|
|
<h3><a class="title-link" name="example-sketch" href="#example-sketch"></a> Example sketch</h3>
|
|
|
|
<p>```c++<br />
|
|
/*<br />
|
|
* Documentation: http://www.mysensors.org<br />
|
|
* Support Forum: http://forum.mysensors.org<br />
|
|
*<br />
|
|
* http://www.mysensors.org/build/dimmer<br />
|
|
*/</p>
|
|
|
|
<p>#include <mysensor.h>
|
|
#include <spi.h></spi.h></mysensor.h></p>
|
|
|
|
<p>#define SN “DimmableRGBLED”<br />
|
|
#define SV “1.0”<br />
|
|
#define CHILD_ID 1<br />
|
|
#define LED_PIN 5</p>
|
|
|
|
<p>MySensor gw;</p>
|
|
|
|
<p>char rgb[7] = “ffffff”; // RGB value.<br />
|
|
int currentLevel = 0; // Current dimmer level.<br />
|
|
MyMessage dimmerMsg(CHILD_ID, V_PERCENTAGE);<br />
|
|
MyMessage lightMsg(CHILD_ID, V_STATUS);<br />
|
|
MyMessage rgbMsg(CHILD_ID, V_RGB);</p>
|
|
|
|
<p>void setup()<br />
|
|
{<br />
|
|
gw.begin(incomingMessage);<br />
|
|
gw.sendSketchInfo(SN, SV);<br />
|
|
gw.present(CHILD_ID, S_RGB_LIGHT);<br />
|
|
// Send initial values.<br />
|
|
gw.send(lightMsg.set(currentLevel > 0 ? 1 : 0));<br />
|
|
gw.send(dimmerMsg.set(currentLevel));<br />
|
|
gw.send(rgbMsg.set(rgb));<br />
|
|
}</p>
|
|
|
|
<p>void loop()<br />
|
|
{<br />
|
|
gw.process();<br />
|
|
}</p>
|
|
|
|
<p>void incomingMessage(const MyMessage &message) {<br />
|
|
if (message.type == V_RGB) {<br />
|
|
// Retrieve the RGB value from the incoming message.<br />
|
|
// RGB LED not implemented, just a dummy print.<br />
|
|
String hexstring = message.getString();<br />
|
|
hexstring.toCharArray(rgb, sizeof(rgb));<br />
|
|
Serial.print(“Changing color to “);<br />
|
|
Serial.println(rgb);<br />
|
|
gw.send(rgbMsg.set(rgb));<br />
|
|
}</p>
|
|
|
|
<p>if (message.type == V_STATUS || message.type == V_PERCENTAGE) {<br />
|
|
// Retrieve the light status or dimmer level from the incoming message.<br />
|
|
int requestedLevel = atoi(message.data);</p>
|
|
|
|
<pre><code>// Adjust incoming level if this is a V_LIGHT update [0 == off, 1 == on].
|
|
requestedLevel *= (message.type == V_STATUS ? 100 : 1);
|
|
|
|
// Clip incoming level to valid range of 0 to 100
|
|
requestedLevel = requestedLevel > 100 ? 100 : requestedLevel;
|
|
requestedLevel = requestedLevel < 0 ? 0 : requestedLevel;
|
|
|
|
// Change level value of LED pin.
|
|
analogWrite(LED_PIN, (int)(requestedLevel / 100. * 255));
|
|
currentLevel = requestedLevel;
|
|
|
|
// Update the gateway with the current V_STATUS and V_PERCENTAGE.
|
|
gw.send(lightMsg.set(currentLevel > 0 ? 1 : 0));
|
|
gw.send(dimmerMsg.set(currentLevel));
|
|
} } ```
|
|
</code></pre>
|
|
|
|
|
|
|
|
</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.io/tree/master/source/_components/light.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'>
|
|
This is a platform for
|
|
<a href='/components/light/'>the Lights 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/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 Light</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/light.wemo/'>Belkin WeMo Lights</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.blinksticklight/'>Blinkstick</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.hyperion/'>Hyperion</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.lifx/'>LIFX</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.limitlessled/'>LimitlessLED</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.mqtt/'>MQTT Light</a>
|
|
</li>
|
|
<li>
|
|
MySensors Light
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.hue/'>Philips Hue</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.rfxtrx/'>RFXtrx Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.scsgate/'>SCSGate Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.tellstick/'>TellStick Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.vera/'>Vera Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.wink/'>Wink Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.zwave/'>Z-Wave Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.zigbee/'>ZigBee Light</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://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
|
|
|
<div class="credit">
|
|
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>
|
|
|
|
<!--[if lt IE 7]>
|
|
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
|
|
<![endif]-->
|
|
|
|
<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> |