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

Site updated at 2015-09-13 01:24:41 UTC

Browse source
This commit is contained in:
Paulus Schoutsen 2015-09-12 18:24:41 -07:00
parent c16793d62c
commit 8c6ee3c712
24 changed files with 783 additions and 163 deletions
Download patch file Download diff file Expand all files Collapse all files

42
components/switch.command_switch.html
View file

@ -109,29 +109,30 @@ A switch platform that issues specific commands when it is turned on and off. Th
<p>To enable it, add the following lines to your <code>configuration.yaml</code>:</p>
<figure class='code'><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
</pre></td><td class='code'><pre><code class=''><span class='line'># Example configuration.yaml entry
</span><span class='line'>switch:
</span><span class='line'> platform: command_switch
</span><span class='line'> switches:
</span><span class='line'> kitchen_light:
</span><span class='line'> oncmd: switch_command on kitchen
</span><span class='line'> offcmd: switch_command off kitchen</span></code></pre></td></tr></table></div></figure>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">switch</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">command_switch</span>
</span><span class='line'> <span class="l-Scalar-Plain">switches</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">kitchen_light</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">oncmd</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">switch_command on kitchen</span>
</span><span class='line'> <span class="l-Scalar-Plain">offcmd</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">switch_command off kitchen</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>switches</strong> array (<em>Required</em>): Contains all command switches.
<li><strong>switches</strong> (<em>Required</em>): The array that contains all command switches.
<ul>
<li><strong>&lsquo;entry&rsquo;</strong> (<em>Required</em>): Name of the command switch. Multiple entries are possible.
<li><strong>entry</strong> (<em>Required</em>): Name of the command switch. Multiple entries are possible.
<ul>
<li><strong>oncmd</strong> (<em>Required</em>): The action to take for on.</li>
@ -143,6 +144,27 @@ A switch platform that issues specific commands when it is turned on and off. Th
</ul>
<p>The example below is doing the same as the <a href="/components/switch.arest.html">aREST switch</a>. The commandline tool <code>[curl](http://curl.haxx.se/)</code> is used to toogle a pin which is controllable through REST.</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">switch</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">command_switch</span>
</span><span class='line'> <span class="l-Scalar-Plain">switches</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">arest_pin4</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">oncmd</span><span class="p-Indicator">:</span> <span class="s">&quot;/usr/bin/curl</span><span class="nv"> </span><span class="s">-X</span><span class="nv"> </span><span class="s">GET</span><span class="nv"> </span><span class="s">http://192.168.1.10/digital/4/1&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">offcmd</span><span class="p-Indicator">:</span> <span class="s">&quot;/usr/bin/curl</span><span class="nv"> </span><span class="s">-X</span><span class="nv"> </span><span class="s">GET</span><span class="nv"> </span><span class="s">http://192.168.1.10/digital/4/0&quot;</span>
</span></code></pre></td></tr></table></div></figure>
</article>