home-assistant.github.io/components/switch.pilight/index.html
2016-08-22 08:21:43 +00:00

326 lines
No EOL
14 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>Pilight Switch - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to have switches using 433 MHz connected to a computer running pilight.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/switch.pilight/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Pilight Switch">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/switch.pilight/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to have switches using 433 MHz connected to a computer running pilight.">
<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="Pilight Switch">
<meta name="twitter:description" content="Instructions how to have switches using 433 MHz connected to a computer running pilight.">
<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">
Pilight Switch
</h1>
</header>
<hr class="divider">
<p>A switch platform that issues 433 MHz commands using <a href="https://www.pilight.org/">pilight</a> to turn a 433 MHz device on or off. The pilight HA hub has to be set up.</p>
<p>Additionally RF commands can be defined that trigger this switch to turn on and off. This allows you to also use the remote shipped with your 433 MHz switch without mixing up the HA states. You can even define several on/off commands, thus several RF remotes to toggle this switch.</p>
<p>To be really sure that HA knows the actual state of your device it is recommended to use the RF remote with codes unknown to any of your 433 MHz devices. Thus you use the remote to trigger this switch to send the correct RF code to the device.</p>
<p>To define a pilight switch, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">switch</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">pilight</span>
<span class="s">switches</span><span class="pi">:</span>
<span class="s">Bed light</span><span class="pi">:</span>
<span class="s">on_code</span><span class="pi">:</span>
<span class="s">protocol</span><span class="pi">:</span> <span class="s">intertechno_old</span> <span class="c1"># protocol has to be defined</span>
<span class="s">unit</span><span class="pi">:</span> <span class="s">3</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">4</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s1">'</span><span class="s">on'</span><span class="pi">:</span> <span class="s">1</span> <span class="c1"># on has to be in apostrophes to be parsed correctly</span>
<span class="s">off_code</span><span class="pi">:</span>
<span class="s">protocol</span><span class="pi">:</span> <span class="s">intertechno_old</span> <span class="c1"># protocol has to be defined</span>
<span class="s">unit</span><span class="pi">:</span> <span class="s">3</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">4</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s1">'</span><span class="s">off'</span><span class="pi">:</span> <span class="s">1</span> <span class="c1"># off has to be in apostrophes to be parsed correctly</span>
<span class="s">on_code_receive</span><span class="pi">:</span> <span class="c1"># optional</span>
<span class="s">protocol</span><span class="pi">:</span> <span class="s">daycom</span> <span class="c1"># protocol has to be defined</span>
<span class="s">systemcode</span><span class="pi">:</span> <span class="s">14462</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s">unit</span><span class="pi">:</span> <span class="s">6</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">34</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span> <span class="c1"># off has to be in apostrophes to be parsed correctly</span>
<span class="s">off_code_receive</span><span class="pi">:</span> <span class="c1"># optional</span>
<span class="s">protocol</span><span class="pi">:</span> <span class="s">daycom</span> <span class="c1"># protocol has to be defined</span>
<span class="s">systemcode</span><span class="pi">:</span> <span class="s">14462</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s">unit</span><span class="pi">:</span> <span class="s">6</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">34</span> <span class="c1"># these entries are protocol specific and can differ</span>
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span> <span class="c1"># on has to be in apostrophes to be parsed correctly</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>switches</strong> (<em>Required</em>): The array that contains all command switches.
<ul>
<li><strong>entry</strong> (<em>Required</em>): Name of the command switch. Multiple entries are possible.
<ul>
<li><strong>on_code</strong> (<em>Required</em>): The code to turn the device on.</li>
<li><strong>off_code</strong> (<em>Required</em>): The code to turn the device off.</li>
<li><strong>on_code_receive</strong> (<em>Optional</em>): If given, this command will turn the switch on if it is received by pilight.</li>
<li><strong>off_code_receive</strong> (<em>Optional</em>): If given, this command will turn the switch off if it is received by pilight.</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>For possible code entries look at the <a href="https://www.pilight.org/development/api/">pilight API</a>. All commands allowed by <a href="https://wiki.pilight.org/doku.php/psend">pilight-send</a> can be used.</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/switch.pilight.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/pilight.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 Polling
</div>
<div class='section'>
Introduced in release: 0.26
</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/pilight/'>
Pilight
</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.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>
<a href='/components/switch.mysensors/'>MySensors Switch</a>
</li>
<li>
<a href='/components/switch.orvibo/'>Orvibo Switch</a>
</li>
<li>
Pilight Switch
</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.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>