jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/switch.pilight/index.html
Travis CI 740f7d4f4b Site updated at 2017-04-30 17:39:49 UTC
2017-04-30 17:39:49 +00:00

372 lines
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="/docs/">Docs</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>The <code class="highlighter-rouge">pilight</code> switch platform is issuing 433 MHz commands using <a href="https://www.pilight.org/">pilight</a> to turn a 433 MHz device on or off. The Pilight Home Assistant 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 Home Assistant states. You can even define several on/off commands, thus several RF remotes to toggle this switch.</p>
<p>To be really sure that Home Assistant 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="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="s1">'</span><span class="s">on'</span><span class="pi">:</span> <span class="s">1</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="s1">'</span><span class="s">off'</span><span class="pi">:</span> <span class="s">1</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>switches</strong> array (<em>Required</em>): The list 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>Variables for the different codes (<code class="highlighter-rouge">on_code</code> and <code class="highlighter-rouge">off_code</code>):</p>
<ul>
<li><strong>protocol</strong> (<em>Required</em>): Protocol to use, eg. <code class="highlighter-rouge">intertechno_old</code> or <code class="highlighter-rouge">daycom</code>.</li>
<li><strong>systemcode</strong> (<em>Optional</em>): The systemcode of the device.</li>
<li><strong>unit</strong> (<em>Optional</em>): The unit to use.</li>
<li><strong>id</strong> (<em>Optional</em>): ID of the device</li>
<li><strong>state</strong> (<em>Optional</em>): <code class="highlighter-rouge">'on'</code> or <code class="highlighter-rouge">'off'</code> has to be in apostrophes to be parsed correctly.</li>
<li><strong>‘off’</strong> (<em>Optional</em>): <code class="highlighter-rouge">1</code> or <code class="highlighter-rouge">0</code></li>
<li><strong>‘on’</strong> (<em>Optional</em>): <code class="highlighter-rouge">1</code> or <code class="highlighter-rouge">0</code></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. Which means that if for a certain protocol there are different parameters used, you should be able to replace the variables above by the proper ones required by the specific protocol. When using the <code class="highlighter-rouge">elro_800_switch</code> or <code class="highlighter-rouge">mumbi</code> protocol for example, you will have to replace the variable <code class="highlighter-rouge">unit</code> with <code class="highlighter-rouge">unitcode</code> or there will be errors occuring.</p>
<p>Variables for the different receive codes (<code class="highlighter-rouge">on_code_receive</code> and <code class="highlighter-rouge">off_code_receive</code>):</p>
<ul>
<li><strong>echo</strong> (<em>Optional</em>) Set to <code class="highlighter-rouge">true</code> if the on-/off-code should be sent if the given code was received.</li>
</ul>
<p>This is useful if you have paired your sender directly with the receiver to prevent sending the signal twice.</p>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">switch</span><span class="pi">:</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="s">unit</span><span class="pi">:</span> <span class="s">3</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">4</span>
<span class="s1">'</span><span class="s">on'</span><span class="pi">:</span> <span class="s">1</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="s">unit</span><span class="pi">:</span> <span class="s">3</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">4</span>
<span class="s1">'</span><span class="s">off'</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">on_code_receive</span><span class="pi">:</span>
<span class="s">protocol</span><span class="pi">:</span> <span class="s">daycom</span>
<span class="s">systemcode</span><span class="pi">:</span> <span class="s">14462</span>
<span class="s">unit</span><span class="pi">:</span> <span class="s">6</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">34</span>
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
<span class="s">off_code_receive</span><span class="pi">:</span>
<span class="s">protocol</span><span class="pi">:</span> <span class="s">daycom</span>
<span class="s">systemcode</span><span class="pi">:</span> <span class="s">14462</span>
<span class="s">unit</span><span class="pi">:</span> <span class="s">6</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">34</span>
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</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/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>
<li><a href='/components/sensor.pilight/'>
Pilight Sensor
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Switch</h1>
<ul class='divided'>
<li>
<a href='/components/switch.anel_pwrctrl/'>ANEL PwrCtrl Switch</a>
</li>
<li>
<a href='/components/switch.fritzdect/'>AVM FRITZ!DECT Switch</a>
</li>
<li>
<a href='/components/switch.acer_projector/'>Acer Projector Switch</a>
</li>
<li>
<a href='/components/switch.android_ip_webcam/'>Android IP Webcam Settings</a>
</li>
<li>
<a href='/components/switch.bbb_gpio/'>BeagleBone Black GPIO Switch</a>
</li>
<li>
<a href='/components/switch.wemo/'>Belkin WeMo Switch</a>
</li>
<li>
<a href='/components/switch.broadlink/'>Broadlink RM 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.digitalloggers/'>Digital Loggers Switch</a>
</li>
<li>
<a href='/components/switch.digital_ocean/'>Digital Ocean 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.hook/'>Hook Switch</a>
</li>
<li>
<a href='/components/switch.isy994/'>ISY994 Switch</a>
</li>
<li>
<a href='/components/switch.insteon_local/'>Insteon (Local) Switch</a>
</li>
<li>
<a href='/components/switch.insteon_plm/'>Insteon PLM Switch</a>
</li>
<li>
<a href='/components/switch.kankun/'>Kankun SP3 Wifi Switch</a>
</li>
<li>
<a href='/components/switch.litejet/'>LiteJet Switch</a>
</li>
<li>
<a href='/components/switch.lutron_caseta/'>Lutron Caseta Switch</a>
</li>
<li>
<a href='/components/switch.mqtt/'>MQTT Switch</a>
</li>
<li>
<a href='/components/switch.mochad/'>Mochad 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.neato/'>Neato Robotics Switch</a>
</li>
<li>
<a href='/components/switch.netio/'>Netio 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.rflink/'>RFLink 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.zoneminder/'>ZoneMinder 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>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</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>
Reference in a new issue View git blame Copy permalink