376 lines
No EOL
17 KiB
HTML
376 lines
No EOL
17 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>Template switch - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate Template switches into Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/switch.template/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Template switch">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/switch.template/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate Template 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="Template switch">
|
||
<meta name="twitter:description" content="Instructions how to integrate Template 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">
|
||
Template Switch
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">template</code> platform creates switches that combine components.</p>
|
||
|
||
<p>For example, if you have a garage door with a toggle switch that operates the motor and a sensor that allows you know whether the door is open or closed, you can combine these into a switch that knows whether the garage door is open or closed.</p>
|
||
|
||
<p>This can simplify the gui, and make it easier to write automations. You can mark the components you have combined as <code class="highlighter-rouge">hidden</code> so they don’t appear themselves.</p>
|
||
|
||
<p>To enable Template switches in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</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">template</span>
|
||
<span class="s">switches</span><span class="pi">:</span>
|
||
<span class="s">skylight</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Skylight'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">is_state('sensor.skylight', 'on') }}'</span>
|
||
<span class="s">turn_on</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.turn_on</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.skylight_open</span>
|
||
<span class="s">turn_off</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.turn_on</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.skylight_close</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>switches</strong> array (<em>Required</em>): List of your switches.
|
||
<ul>
|
||
<li><strong>friendly_name</strong> (<em>Optional</em>): Name to use in the Frontend.</li>
|
||
<li><strong>value_template</strong> (<em>Required</em>): Defines a <a href="/topics/templating/">template</a> to set the state of the switch.</li>
|
||
<li><strong>turn_on</strong> (<em>Required</em>): Defines an <a href="/getting-started/automation/">action</a> to run when the switch is turned on.</li>
|
||
<li><strong>turn_off</strong> (<em>Required</em>): Defines an <a href="/getting-started/automation/">action</a> to run when the switch is turned off.</li>
|
||
<li><strong>entity_id</strong> (<em>Optional</em>): Add a list of entity IDs so the switch only reacts to state changes of these entities. This will reduce the number of times the switch will try to update it’s state.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<h2><a class="title-link" name="considerations" href="#considerations"></a> Considerations</h2>
|
||
|
||
<p>If you are using the state of a platform that takes extra time to load, the template switch may get an ‘unknown’ state during startup. This results in error messages in your log file until that platform has completed loading. If you use is_state() function in your template, you can avoid this situation. For example, you would replace ‘{{ states.switch.source.state }}’ with this equivalent that returns true/false and never gives an unknown result:
|
||
‘{{ is_state(‘switch.source’, ‘on’) }}’</p>
|
||
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
|
||
<p>In this section you find some real life examples of how to use this switch.</p>
|
||
|
||
<h3><a class="title-link" name="copy-switch" href="#copy-switch"></a> Copy switch</h3>
|
||
|
||
<p>This example shows a switch that copies another switch.</p>
|
||
|
||
<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">template</span>
|
||
<span class="s">switches</span><span class="pi">:</span>
|
||
<span class="s">copy</span><span class="pi">:</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">is_state('switch.source', 'on') }}'</span>
|
||
<span class="s">turn_on</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.turn_on</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.source</span>
|
||
<span class="s">turn_off</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.turn_off</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.source</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<h3><a class="title-link" name="toggle-switch" href="#toggle-switch"></a> Toggle switch</h3>
|
||
|
||
<p>This example shows a switch that takes its state from a sensor, and toggles a switch.</p>
|
||
|
||
<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">template</span>
|
||
<span class="s">switches</span><span class="pi">:</span>
|
||
<span class="s">blind</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Blind'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">state</span><span class="nv"> </span><span class="s">}}'</span>
|
||
<span class="s">turn_on</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.toggle</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.blind_toggle</span>
|
||
<span class="s">turn_off</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.toggle</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.blind_toggle</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<h3><a class="title-link" name="sensor-and-two-switches" href="#sensor-and-two-switches"></a> Sensor and two switches</h3>
|
||
|
||
<p>This example shows a switch that takes its state from a sensor, and uses two momentary switches to control a device.</p>
|
||
|
||
<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">template</span>
|
||
<span class="s">switches</span><span class="pi">:</span>
|
||
<span class="s">skylight</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Skylight'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">is_state('sensor.skylight.state', 'on') }}'</span>
|
||
<span class="s">turn_on</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.turn_on</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.skylight_open</span>
|
||
<span class="s">turn_off</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.turn_on</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.skylight_close</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.template.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/home-assistant.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.13
|
||
</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/binary_sensor.template/'>
|
||
Template Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/sensor.template/'>
|
||
Template 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.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>
|
||
<a href='/components/switch.pilight/'>Pilight 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>
|
||
Template switch
|
||
</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> |