jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/switch/index.html
Travis CI c51868698c Site updated at 2016-04-08 08:33:10 UTC
2016-04-08 08:33:10 +00:00

290 lines
No EOL
10 KiB
HTML
Raw Blame History

<!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>Switches - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to setup your switches with Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/switch/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Switches">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/switch/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to setup your switches with 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="Switches">
<meta name="twitter:description" content="Instructions how to setup your switches with 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='/topics/'>Advanced Topics</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 and SSE</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">
Switches
</h1>
</header>
<hr class="divider">
<p>Keeps track which switches are in your environment, their state and allows you to control them.</p>
<ul>
<li>Maintains a state per switch and a combined state <code>all_switches</code>.</li>
<li>Registers services <code>switch/turn_on</code>, <code>switch/turn_off</code>, and <code>switch/toggle</code> to control switches.</li>
</ul>
<h3><a class="title-link" name="use-the-services" href="#use-the-services"></a> Use the services</h3>
<p>Go the the <strong>Developer Tools</strong>, then to <strong>Call Service</strong> in the frontend, and choose <code>switch/turn_on</code> or <code>switch/turn_off</code> from the list of available services (<strong>Available services:</strong> on the left). Enter something like the sample below into the <strong>Service Data</strong> field and hit <strong>CALL SERVICE</strong>.</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre>{<span class="key"><span class="delimiter">&quot;</span><span class="content">entity_id</span><span class="delimiter">&quot;</span></span>:<span class="string"><span class="delimiter">&quot;</span><span class="content">livingroom_pin2</span><span class="delimiter">&quot;</span></span>}
</pre></div>
</div>
</div>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>entity_id</code></td>
<td>yes</td>
<td>Only act on specific switch. Else targets all.</td>
</tr>
</tbody>
</table>
</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.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
</div>
<h1 class='title delta'>Platforms</h1>
<ul class='divided'>
<li><a href='/components/switch.arduino/'>
Arduino 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.hikvision/'>
Hikvision Camera 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.pulseaudio_loopback/'>
PulseAudio Loopback 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><a href='/components/switch.template/'>
Template 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>
</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>
Reference in a new issue View git blame Copy permalink