531 lines
No EOL
19 KiB
HTML
531 lines
No EOL
19 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 Switch - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to integrate MySensors switches into Home Assistant.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/switch.mysensors/">
|
|
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="MySensors Switch">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/switch.mysensors/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate MySensors switches 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 Switch">
|
|
<meta name="twitter:description" content="Instructions how to integrate MySensors switches 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 Switch
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<p>Integrates MySensors switches 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 and higher</h5>
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>S_TYPE</th>
|
|
<th>V_TYPE</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>S_DOOR</td>
|
|
<td>V_ARMED</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_MOTION</td>
|
|
<td>V_ARMED</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_SMOKE</td>
|
|
<td>V_ARMED</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_LIGHT</td>
|
|
<td>V_LIGHT</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_LOCK</td>
|
|
<td>V_LOCK_STATUS</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_IR</td>
|
|
<td>V_IR_SEND, 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_LIGHT</td>
|
|
<td>V_STATUS</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_BINARY</td>
|
|
<td>[V_STATUS or V_LIGHT]</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_SPRINKLER</td>
|
|
<td>V_STATUS</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_WATER_LEAK</td>
|
|
<td>V_ARMED</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_SOUND</td>
|
|
<td>V_ARMED</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_VIBRATION</td>
|
|
<td>V_ARMED</td>
|
|
</tr>
|
|
<tr>
|
|
<td>S_MOISTURE</td>
|
|
<td>V_ARMED</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p>All V_TYPES for each S_TYPE above are required to activate the actuator for the platform. Use either V_LIGHT or V_STATUS depending on library version for cases where that V_TYPE is required.</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="services" href="#services"></a> Services</h3>
|
|
|
|
<p>The MySensors switch platform exposes a service to change an IR code attribute for an IR switch device and turn the switch on. The IR switch will automatically be turned off after being turned on, if <code>optimistic</code> is set to <code>true</code> in the <a href="/components/mysensors/#configuration">config</a> for the MySensors component. This will simulate a push button on a remote. If <code>optimistic</code> is <code>false</code>, the MySensors device will have to report its updated state to reset the switch. See the <a href="#ir-switch-sketch">example sketch</a> for the IR switch below.</p>
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Service</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>mysensors_send_ir_code</td>
|
|
<td>Set an IR code as a state attribute for a MySensors IR device switch and turn the switch on.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p>The service can be used as part of an automation script. For example:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment"># Example configuration.yaml automation entry</span>
|
|
<span class="key">automation</span>:
|
|
- <span class="string"><span class="content">alias: turn hvac on</span></span>
|
|
<span class="key">trigger</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">time</span></span>
|
|
<span class="key">after</span>: <span class="string"><span class="content">'5:30:00'</span></span>
|
|
<span class="key">action</span>:
|
|
<span class="key">service</span>: <span class="string"><span class="content">switch.mysensors_send_ir_code</span></span>
|
|
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.hvac_1_1</span></span>
|
|
<span class="key">data</span>:
|
|
<span class="key">V_IR_SEND</span>: <span class="string"><span class="content">'0xC284'</span></span> <span class="comment"># the IR code to send</span>
|
|
|
|
- <span class="string"><span class="content">alias: turn hvac off</span></span>
|
|
<span class="key">trigger</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">time</span></span>
|
|
<span class="key">after</span>: <span class="string"><span class="content">'0:30:00'</span></span>
|
|
<span class="key">action</span>:
|
|
<span class="key">service</span>: <span class="string"><span class="content">switch.mysensors_send_ir_code</span></span>
|
|
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.hvac_1_1</span></span>
|
|
<span class="key">data</span>:
|
|
<span class="key">V_IR_SEND</span>: <span class="string"><span class="content">'0xC288'</span></span> <span class="comment"># the IR code to send</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h3><a class="title-link" name="example-sketches" href="#example-sketches"></a> Example sketches</h3>
|
|
|
|
<h4><a class="title-link" name="switch-sketch" href="#switch-sketch"></a> Switch sketch</h4>
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment">/*
|
|
* Documentation: http://www.mysensors.org
|
|
* Support Forum: http://forum.mysensors.org
|
|
*
|
|
* http://www.mysensors.org/build/relay
|
|
*/</span>
|
|
|
|
<span class="preprocessor">#include</span> <span class="include"><MySensor.h></span>
|
|
<span class="preprocessor">#include</span> <span class="include"><SPI.h></span>
|
|
|
|
<span class="preprocessor">#define</span> SN <span class="string"><span class="delimiter">"</span><span class="content">Relay</span><span class="delimiter">"</span></span>
|
|
<span class="preprocessor">#define</span> SV <span class="string"><span class="delimiter">"</span><span class="content">1.0</span><span class="delimiter">"</span></span>
|
|
<span class="preprocessor">#define</span> CHILD_ID <span class="integer">1</span>
|
|
<span class="preprocessor">#define</span> RELAY_PIN <span class="integer">3</span>
|
|
|
|
MySensor gw;
|
|
MyMessage msgRelay(CHILD_ID, V_STATUS);
|
|
|
|
<span class="directive">void</span> setup()
|
|
{
|
|
gw.begin(incomingMessage);
|
|
gw.sendSketchInfo(SN, SV);
|
|
<span class="comment">// Initialize the digital pin as an output.</span>
|
|
pinMode(RELAY_PIN, OUTPUT);
|
|
gw.present(CHILD_ID, S_BINARY);
|
|
gw.send(msgRelay.set(<span class="integer">0</span>));
|
|
}
|
|
|
|
<span class="directive">void</span> loop()
|
|
{
|
|
gw.process();
|
|
}
|
|
|
|
<span class="directive">void</span> incomingMessage(<span class="directive">const</span> MyMessage &message)
|
|
{
|
|
<span class="keyword">if</span> (message.type == V_STATUS) {
|
|
<span class="comment">// Change relay state.</span>
|
|
digitalWrite(RELAY_PIN, message.getBool() ? <span class="integer">1</span> : <span class="integer">0</span>);
|
|
gw.send(msgRelay.set(message.getBool() ? <span class="integer">1</span> : <span class="integer">0</span>));
|
|
}
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="ir-switch-sketch" href="#ir-switch-sketch"></a> IR switch sketch</h4>
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment">/*
|
|
* Documentation: http://www.mysensors.org
|
|
* Support Forum: http://forum.mysensors.org
|
|
*
|
|
* http://www.mysensors.org/build/ir
|
|
*/</span>
|
|
|
|
<span class="preprocessor">#include</span> <span class="include"><MySensor.h></span>
|
|
<span class="preprocessor">#include</span> <span class="include"><SPI.h></span>
|
|
<span class="preprocessor">#include</span> <span class="include"><IRLib.h></span>
|
|
|
|
<span class="preprocessor">#define</span> SN <span class="string"><span class="delimiter">"</span><span class="content">IR Sensor</span><span class="delimiter">"</span></span>
|
|
<span class="preprocessor">#define</span> SV <span class="string"><span class="delimiter">"</span><span class="content">1.0</span><span class="delimiter">"</span></span>
|
|
<span class="preprocessor">#define</span> CHILD_ID <span class="integer">1</span>
|
|
|
|
MySensor gw;
|
|
|
|
<span class="predefined-type">char</span> code[<span class="integer">10</span>] = <span class="string"><span class="delimiter">"</span><span class="content">abcd01234</span><span class="delimiter">"</span></span>;
|
|
<span class="predefined-type">char</span> oldCode[<span class="integer">10</span>] = <span class="string"><span class="delimiter">"</span><span class="content">abcd01234</span><span class="delimiter">"</span></span>;
|
|
MyMessage msgCodeRec(CHILD_ID, V_IR_RECEIVE);
|
|
MyMessage msgCode(CHILD_ID, V_IR_SEND);
|
|
MyMessage msgSendCode(CHILD_ID, V_LIGHT);
|
|
|
|
<span class="directive">void</span> setup()
|
|
{
|
|
gw.begin(incomingMessage);
|
|
gw.sendSketchInfo(SN, SV);
|
|
gw.present(CHILD_ID, S_IR);
|
|
<span class="comment">// Send initial values.</span>
|
|
gw.send(msgCodeRec.set(code));
|
|
gw.send(msgCode.set(code));
|
|
gw.send(msgSendCode.set(<span class="integer">0</span>));
|
|
}
|
|
|
|
<span class="directive">void</span> loop()
|
|
{
|
|
gw.process();
|
|
<span class="comment">// IR receiver not implemented, just a dummy report of code when it changes</span>
|
|
<span class="keyword">if</span> (String(code) != String(oldCode)) {
|
|
Serial.print(<span class="string"><span class="delimiter">"</span><span class="content">Code received </span><span class="delimiter">"</span></span>);
|
|
Serial.println(code);
|
|
gw.send(msgCodeRec.set(code));
|
|
strcpy(oldCode, code);
|
|
}
|
|
}
|
|
|
|
<span class="directive">void</span> incomingMessage(<span class="directive">const</span> MyMessage &message) {
|
|
<span class="keyword">if</span> (message.type==V_LIGHT) {
|
|
<span class="comment">// IR sender not implemented, just a dummy print.</span>
|
|
<span class="keyword">if</span> (message.getBool()) {
|
|
Serial.print(<span class="string"><span class="delimiter">"</span><span class="content">Sending code </span><span class="delimiter">"</span></span>);
|
|
Serial.println(code);
|
|
}
|
|
gw.send(msgSendCode.set(message.getBool() ? <span class="integer">1</span> : <span class="integer">0</span>));
|
|
<span class="comment">// Always turn off device</span>
|
|
gw.wait(<span class="integer">100</span>);
|
|
gw.send(msgSendCode.set(<span class="integer">0</span>));
|
|
}
|
|
<span class="keyword">if</span> (message.type == V_IR_SEND) {
|
|
<span class="comment">// Retrieve the IR code value from the incoming message.</span>
|
|
String codestring = message.getString();
|
|
codestring.toCharArray(code, <span class="keyword">sizeof</span>(code));
|
|
Serial.print(<span class="string"><span class="delimiter">"</span><span class="content">Changing code to </span><span class="delimiter">"</span></span>);
|
|
Serial.println(code);
|
|
gw.send(msgCode.set(code));
|
|
}
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</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.io/tree/master/source/_components/switch.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/switch/'>the Switches 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/light.mysensors/'>
|
|
MySensors Light
|
|
</a></li>
|
|
<li><a href='/components/sensor.mysensors/'>
|
|
MySensors Sensor
|
|
</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Switch</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/switch.acer_projector/'>Acer Projector Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.wemo/'>Belkin WeMo Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.command_line/'>Command line Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.dlink/'>D-Link Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.edimax/'>Edimax Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.enocean/'>EnOcean Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.flux/'>Flux Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.hikvision/'>Hikvision Camera Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.homematic/'>Homematic Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.mqtt/'>MQTT Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.modbus/'>Modbus Switch</a>
|
|
</li>
|
|
<li>
|
|
MySensors Switch
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.orvibo/'>Orvibo Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.pulseaudio_loopback/'>PulseAudio Loopback Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.qwikswitch/'>QwikSwitch Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.rest/'>RESTful Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.rfxtrx/'>RFXtrx Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.rpi_gpio/'>Raspberry PI GPIO Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.rpi_rf/'>Raspberry Pi RF Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.scsgate/'>SCSGate Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.tplink/'>TPLink Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.tellstick/'>TellStick Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.tellduslive/'>Telldus Live Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.template/'>Template switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.thinkingcleaner/'>Thinking Cleaner Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.transmission/'>Transmission Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.vera/'>Vera Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.verisure/'>Verisure SmartPlug</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.wake_on_lan/'>Wake on LAN Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.wink/'>Wink Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.zwave/'>Z-Wave Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.zigbee/'>ZigBee Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.arest/'>aREST Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.mfi/'>mFi Switch</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.mystrom/'>myStrom Switch</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> |