home-assistant.github.io/components/switch.template/index.html
2016-02-13 08:04:22 +00:00

357 lines
No EOL
15 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>Template switch - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<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/home-assistant-logo-2164x2164.png">
<meta name="twitter:card" content="summary">
<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/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='/getting-started/templating/'>Templating</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</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">
Template Switch
</h1>
</header>
<hr class="divider">
<p>The <code>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>hidden</code> so they dont appear themselves.</p>
<p>To enable Template switches in your installation, add the following to your <code>configuration.yaml</code> file:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
<span class="key">switch</span>:
<span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
<span class="key">switches</span>:
<span class="key">skylight</span>:
<span class="key">friendly_name</span>: <span class="string"><span class="content">'Skylight'</span></span>
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sensor.skylight.state }}'</span></span>
<span class="key">turn_on</span>:
<span class="key">service</span>: <span class="string"><span class="content">switch.turn_on</span></span>
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.skylight_open</span></span>
<span class="key">turn_off</span>:
<span class="key">service</span>: <span class="string"><span class="content">switch.turn_on</span></span>
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.skylight_close</span></span>
</pre></div>
</div>
</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="/getting-started/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>
</ul>
</li>
</ul>
<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="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="key">switch</span>:
<span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
<span class="key">switches</span>:
<span class="key">copy</span>:
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.switch.source.state }}'</span></span>
<span class="key">turn_on</span>:
<span class="key">service</span>: <span class="string"><span class="content">switch.turn_on</span></span>
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.source</span></span>
<span class="key">turn_off</span>:
<span class="key">service</span>: <span class="string"><span class="content">switch.turn_off</span></span>
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.source</span></span>
</pre></div>
</div>
</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="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="key">switch</span>:
<span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
<span class="key">switches</span>:
<span class="key">blind</span>:
<span class="key">friendly_name</span>: <span class="string"><span class="content">'Blind'</span></span>
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ state }}'</span></span>
<span class="key">turn_on</span>:
<span class="key">service</span>: <span class="string"><span class="content">switch.toggle</span></span>
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.blind_toggle</span></span>
<span class="key">turn_off</span>:
<span class="key">service</span>: <span class="string"><span class="content">switch.toggle</span></span>
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.blind_toggle</span></span>
</pre></div>
</div>
</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="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="key">switch</span>:
<span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
<span class="key">switches</span>:
<span class="key">skylight</span>:
<span class="key">friendly_name</span>: <span class="string"><span class="content">'Skylight'</span></span>
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sensor.skylight.state }}'</span></span>
<span class="key">turn_on</span>:
<span class="key">service</span>: <span class="string"><span class="content">switch.turn_on</span></span>
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.skylight_open</span></span>
<span class="key">turn_off</span>:
<span class="key">service</span>: <span class="string"><span class="content">switch.turn_on</span></span>
<span class="key">entity_id</span>: <span class="string"><span class="content">switch.skylight_close</span></span>
</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/balloob/home-assistant.io/tree/master/source/_components/switch.template.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
</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/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.wemo/'>Belkin WeMo Switch</a>
</li>
<li>
<a href='/components/switch.command_switch/'>Command line Switch</a>
</li>
<li>
<a href='/components/switch.edimax/'>Edimax 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.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.scsgate/'>SCSGate 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.transmission/'>Transmission Switch</a>
</li>
<li>
<a href='/components/switch.vera/'>Vera 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://github.com/balloob/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>