jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-03-18 17:12:07 UTC

Browse source
This commit is contained in:
Travis CI 2017-03-18 17:12:07 +00:00
parent 7573fcba68
commit 67179bf8fe
994 changed files with 1768 additions and 68252 deletions
Download patch file Download diff file Expand all files Collapse all files

62
components/switch.command_line/index.html
View file

@ -3,17 +3,14 @@
<!--[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>Command line Switch - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to have switches call command line commands.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/switch.command_line/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Command line Switch">
<meta property="og:site_name" content="Home Assistant">
@ -21,39 +18,31 @@
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to have switches call command line commands.">
<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="Command line Switch">
<meta name="twitter:description" content="Instructions how to have switches call command line commands.">
<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>
@ -64,36 +53,21 @@
</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">
Command Line Switch
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">command_line</code> switch platform issues specific commands when it is turned on and off. This might very well become our most powerful platform as it allows anyone to integrate any type of switch into Home Assistant that can be controlled from the command line, including calling other scripts!</p>
<p>To enable it, 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">command_line</span>
@ -103,9 +77,7 @@
<span class="s">command_off</span><span class="pi">:</span> <span class="s">switch_command off kitchen</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>switches</strong> (<em>Required</em>): The array that contains all command switches.
<ul>
@ -121,19 +93,12 @@
</ul>
</li>
</ul>
<p>A note on <code class="highlighter-rouge">friendly_name</code>:</p>
<p>When set, the <code class="highlighter-rouge">friendly_name</code> had been previously used for API calls and backend configuration instead of the <code class="highlighter-rouge">object_id</code> (“identifier”), but <a href="https://github.com/home-assistant/home-assistant/pull/4343">this behavior is changing</a> to make the <code class="highlighter-rouge">friendly_name</code> for display purposes only. This allows users to set an <code class="highlighter-rouge">identifier</code> that emphasizes uniqueness and predictability for API and config purposes but have a prettier <code class="highlighter-rouge">friendly_name</code> still show up in the UI. As an additional benefit, if a user wanted to change the <code class="highlighter-rouge">friendly_name</code> / display name (e.g. from “Kitchen Lightswitch” to “Kitchen Switch” or “Living Room Light”, or remove the <code class="highlighter-rouge">friendly_name</code> altogether), he or she could do so without needing to change existing automations or API calls. See aREST device below for an example.</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="arest-device" href="#arest-device"></a> aREST device</h3>
<p>The example below is doing the same as the <a href="/components/switch.arest/">aREST switch</a>. The commandline tool <a href="http://curl.haxx.se/"><code class="highlighter-rouge">curl</code></a> is used to toggle a pin which is controllable through REST.</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">command_line</span>
@ -146,17 +111,12 @@
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Kitchen Lightswitch</span>
</code></pre>
</div>
<p>Given this example, in the UI one would see the <code class="highlighter-rouge">friendly_name</code> of “Kitchen Light”. However, the <code class="highlighter-rouge">identifier</code> is <code class="highlighter-rouge">arest_pin_four</code>, making the <code class="highlighter-rouge">entity_id</code> <code class="highlighter-rouge">switch.arest_pin_four</code>, which is what one would use in <a href="https://home-assistant.io/components/automation/"><code class="highlighter-rouge">automation</code></a> or in <a href="https://home-assistant.io/developers/">API calls</a>.</p>
<h3><a class="title-link" name="shutdown-your-local-host" href="#shutdown-your-local-host"></a> Shutdown your local host</h3>
<p>This switch will shutdown your system that is hosting Home Assistant.</p>
<p class="note warning">
This switch will shutdown your host immediately, there will be no confirmation.
</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">command_line</span>
@ -165,11 +125,8 @@ This switch will shutdown your host immediately, there will be no confirmation.
<span class="s">command_off</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/usr/sbin/poweroff"</span>
</code></pre>
</div>
<h3><a class="title-link" name="control-your-vlc-player" href="#control-your-vlc-player"></a> Control your VLC player</h3>
<p>This switch will control a local VLC media player (<a href="https://community.home-assistant.io/t/vlc-player/106">Source</a>).</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">command_line</span>
@ -179,11 +136,8 @@ This switch will shutdown your host immediately, there will be no confirmation.
<span class="s">command_off</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pkill</span><span class="nv"> </span><span class="s">vlc"</span>
</code></pre>
</div>
<h3><a class="title-link" name="control-foscam-motion-sensor" href="#control-foscam-motion-sensor"></a> Control Foscam Motion Sensor</h3>
<p>This switch will control the motion sensor of Foscam Webcams which Support CGI Commands (<a href="http://www.ipcamcontrol.net/files/Foscam%20IPCamera%20CGI%20User%20Guide-V1.0.4.pdf">Source</a>). This switch supports statecmd, which checks the current state of motion detection.</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">command_line</span>
@ -195,23 +149,14 @@ This switch will shutdown your host immediately, there will be no confirmation.
<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">value</span><span class="nv"> </span><span class="s">==</span><span class="nv"> </span><span class="s">"1"</span><span class="nv"> </span><span class="s">}}'</span>
</code></pre>
</div>
<ul>
<li>Replace admin and password with an “Admin” privileged Foscam user</li>
<li>Replace ipaddress with the local IP address of your Foscam</li>
</ul>
</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.command_line.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
@ -406,13 +351,10 @@ This switch will shutdown your host immediately, there will be no confirmation.
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
@ -422,7 +364,6 @@ This switch will shutdown your host immediately, there will be no confirmation.
<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 />
@ -434,7 +375,6 @@ This switch will shutdown your host immediately, there will be no confirmation.
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
@ -442,4 +382,4 @@ This switch will shutdown your host immediately, there will be no confirmation.
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
</html>