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

Site updated at 2015-09-10 19:39:00 UTC

Browse source
This commit is contained in:
Paulus Schoutsen 2015-09-10 12:39:00 -07:00
parent 718cb79e66
commit 3ce314c0a7
82 changed files with 2127 additions and 953 deletions
Download patch file Download diff file Expand all files Collapse all files

38
components/arduino.html
View file

@ -127,8 +127,12 @@
</span></code></pre></td></tr></table></div></figure>
<p>The port where is your board connected to your Home Assistant host. If you are using an original Arduino the port will be named <code>ttyACM*</code>. The exact
number can be determined with <code>ls /dev/ttyACM*</code>.</p>
<p>Configuration variables:</p>
<ul>
<li><strong>port</strong> (<em>Required</em>): The port where your board is connected to your Home Assistant host. If you are using an original Arduino the port will be named <code>ttyACM*</code>. The exact number can be determined with <code>ls /dev/ttyACM*</code>.</li>
</ul>
<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>
</pre></td><td class='code'><pre><code class='bash'><span class='line'>ls /dev/ttyACM*
@ -171,9 +175,20 @@ A word of caution: The Arduino boards are not storing states. This means that wi
</span></code></pre></td></tr></table></div></figure>
<p>The digital pins are numbered from 0 to 13. The available pins are 2 till 13. For testing purposes you can use pin 13 because with that pin you can control the internal LED.</p>
<p>Configuration variables:</p>
<p>The name field of the pins array will be used in the frontend.</p>
<ul>
<li><strong>pins</strong> array (<em>Required</em>): Pins to use.
<ul>
<li><strong>name</strong>: Name that will be used in the frontend for the pin.</li>
<li><strong>type</strong>: The type of the pin. At the moment only &lsquo;digital&rsquo; is supported.</li>
</ul>
</li>
</ul>
<p>The digital pins are numbered from 0 to 13. The available pins are 2 till 13. For testing purposes you can use pin 13 because with that pin you can control the internal LED.</p>
<h2>Sensor Configuration</h2>
@ -204,9 +219,20 @@ A word of caution: The Arduino boards are not storing states. This means that wi
</span></code></pre></td></tr></table></div></figure>
<p>The 6 analog pins are numbered from A0 to A5.</p>
<p>Configuration variables:</p>
<p>The name field of the pins array will be used in the frontend.</p>
<ul>
<li><strong>pins</strong> array (<em>Required</em>): Pins to use.
<ul>
<li><strong>name</strong>: Name that will be used in the frontend for the pin.</li>
<li><strong>type</strong>: The type of the pin. At the moment only &lsquo;analog&rsquo; is supported.</li>
</ul>
</li>
</ul>
<p>The 6 analog pins are numbered from A0 to A5.</p>
</article>

18
components/camera.generic.html
View file

@ -110,6 +110,8 @@
<p>Home Assistant will serve the images via its server, making it possible to view your IP camera&rsquo;s while outside of your network.</p>
<p>To enable this sensor in your installation, add the following to your <code>configuration.yaml</code> file:</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>
@ -120,13 +122,23 @@
</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">camera</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">generic</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">my sample camera</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">MY_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">MY_PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">still_image_url</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">http://194.218.96.92/jpg/image.jpg</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">my sample camera</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PASSWORD</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>still_image_url</strong> <em>Required</em>: The URL your camera serves the image on, eg. <a href="http://192.168.1.21:2112/">http://192.168.1.21:2112/</a></li>
<li><strong>name</strong> <em>Optional</em>: This parameter allows you to override the name of your camera.</li>
<li><strong>username</strong> <em>Optional</em>: The username for accessing your camera.</li>
<li><strong>password</strong> <em>Optional</em>: The password for accessing your camera.</li>
</ul>
</article>

20
components/device_tracker.actiontec.html
View file

@ -107,8 +107,12 @@
<p><img src='/images/supported_brands/actiontec.png' class='brand pull-right' />
This platform allows you to detect presence by looking at connected devices to an <a href="http://www.actiontec.com/">Actiontec</a> device.</p>
<p>Supported devices:
- MI424WR (Verizon FIOS)</p>
<p>Supported devices (tested):</p>
<ul>
<li>MI424WR (Verizon FIOS)</li>
</ul>
<p class='note warning'>
This device tracker needs telnet to be enabled on the router.
@ -123,15 +127,27 @@ This device tracker needs telnet to be enabled on the router.
<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">device_tracker</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">actiontec</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ROUTER_IP</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">home_interval</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">MINUTES</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, e.g. 192.168.1.1.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
<li><strong>home_interval</strong> (<em>Optional</em>): If the home_interval is set then the component will not let a device be AWAY if it has been HOME in the last home_interval minutes. This is in addition to the 3 minute wait built into the device_tracker component.</li>
</ul>
<p>See the <a href="/components/device_tracker.html">device tracker component page</a> for instructions how to configure the people to be tracked.</p>

19
components/device_tracker.aruba.html
View file

@ -104,7 +104,15 @@
<hr class="divider">
<p>This platform allows you to detect presence by looking at connected devices to an <a href="http://www.arubanetworks.com/products/networking/aruba-instant/">Aruba Instant</a> device. This has been tested on an ARUBA AP-105.</p>
<p><img src='/images/supported_brands/aruba.png' class='brand pull-right' />
This platform allows you to detect presence by looking at connected devices to an <a href="http://www.arubanetworks.com/products/networking/aruba-instant/">Aruba Instant</a> device.</p>
<p>Supported devices (tested):</p>
<ul>
<li>ARUBA AP-105</li>
</ul>
<p class='note warning'>
This device tracker needs telnet to be enabled on the router.
@ -128,6 +136,15 @@ This device tracker needs telnet to be enabled on the router.
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> <em>Required</em>: The IP address of your router, e.g. 192.168.1.1.</li>
<li><strong>username</strong> <em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> <em>Required</em>: The password for your given admin account.</li>
</ul>
<p>See the <a href="/components/device_tracker.html">device tracker component page</a> for instructions how to configure the people to be tracked.</p>

14
components/device_tracker.asuswrt.html
View file

@ -107,6 +107,11 @@
<p><img src='/images/supported_brands/asus.png' class='brand pull-right' />
This platform offers presence detection by looking at connected devices to a <a href="http://event.asus.com/2013/nw/ASUSWRT/">ASUSWRT</a> based router.</p>
<p class='note warning'>
This device tracker needs telnet to be enabled on the router.
</p>
<p>To use an ASUSWRT router in your installation, add the following to your <code>configuration.yaml</code> file:</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>
@ -124,7 +129,14 @@ This platform offers presence detection by looking at connected devices to a <a
</span></code></pre></td></tr></table></div></figure>
<p>This device tracker needs telnet to be enabled on the router.</p>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, e.g. 192.168.1.1.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
</ul>
<p>See the <a href="/components/device_tracker.html">device tracker component page</a> for instructions how to configure the people to be tracked.</p>

15
components/device_tracker.ddwrt.html
View file

@ -118,12 +118,21 @@ This platform offers presence detection by looking at connected devices to a <a
</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">device_tracker</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">ddwrt</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">192.168.1.1</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">admin</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ROUTER_IP_ADDRESS</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_PASSWORD</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, e.g. 192.168.1.1.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
</ul>
<p>See the <a href="/components/device_tracker.html">device tracker component page</a> for instructions how to configure the people to be tracked.</p>

23
components/device_tracker.html
View file

@ -107,11 +107,15 @@
<p>Home Assistant can get information from your wireless router to track which devices are connected. There are three different types of supported wireless routers:</p>
<ul>
<li><a href="/components/device_tracker.actiontec.html">Actiontec</a></li>
<li><a href="/components/device_tracker.aruba.html">Aruba</a></li>
<li><a href="/components/device_tracker.asuswrt.html">ASUSWRT</a></li>
<li><a href="/components/device_tracker.ddwrt.html">DD-WRT</a></li>
<li><a href="/components/device_tracker.tomato.html">tomato</a></li>
<li><a href="/components/device_tracker.netgear.html">netgear</a></li>
<li><a href="/components/device_tracker.luci.html">luci (OpenWRT)</a></li>
<li><a href="/components/device_tracker.netgear.html">netgear</a></li>
<li><a href="/components/device_tracker.tomato.html">tomato</a></li>
<li><a href="/components/device_tracker.tplink.html">TP-Link</a></li>
<li><a href="/components/device_tracker.thomson.html">Thomsom</a></li>
</ul>
@ -119,16 +123,19 @@
<p>To get started add the following lines to your <code>configuration.yaml</code> (example for Netgear):</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>
</pre></td><td class='code'><pre><code class=''><span class='line'>device_tracker:
</span><span class='line'> platform: netgear
</span><span class='line'> host: 192.168.1.1
</span><span class='line'> username: admin
</span><span class='line'> password: MY_PASSWORD</span></code></pre></td></tr></table></div></figure>
<span class='line-number'>6</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry for Netgear device</span>
</span><span class='line'><span class="l-Scalar-Plain">device_tracker</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">netgear</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">192.168.1.1</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">admin</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_PASSWORD</span>
</span></code></pre></td></tr></table></div></figure>
<p>Once tracking, the <code>device_tracker</code> component will maintain a file in your config dir called <code>known_devices.csv</code>. Edit this file to adjust which devices have to be tracked. Here you can also setup a url for each device to be used as the entity picture.</p>

15
components/device_tracker.luci.html
View file

@ -116,12 +116,21 @@ Before this scanner can be used you have to install the luci RPC package on Open
</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">device_tracker</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">luci</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">192.168.1.1</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">admin</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ROUTER_IP_ADDRESS</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_PASSWORD</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, e.g. 192.168.1.1.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
</ul>
<p>See the <a href="/components/device_tracker.html">device tracker component page</a> for instructions how to configure the people to be tracked.</p>

15
components/device_tracker.netgear.html
View file

@ -116,12 +116,21 @@ This platform allows you to detect presence by looking at connected devices to a
</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">device_tracker</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">netgear</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">192.168.1.1</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">admin</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ROUTER_IP</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_PASSWORD</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, e.g. 192.168.1.1.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
</ul>
<p>See the <a href="/components/device_tracker.html">device tracker component page</a> for instructions how to configure the people to be tracked.</p>

18
components/device_tracker.tomato.html
View file

@ -117,13 +117,23 @@ Tomato requires an extra config variable called <code>http_id</code>. The value
</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">device_tracker</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">tomato</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">192.168.1.1</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">admin</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">http_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ABCDEFG</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ROUTER_IP_ADDRESS</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_ADMIN_PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">http_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_HTTP_ID</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, e.g. 192.168.1.1.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
<li><strong>http_id</strong> (<em>Required</em>): The value can be obtained by logging in to the Tomato admin interface and search for <code>http_id</code> in the page source code.</li>
</ul>
<p>See the <a href="/components/device_tracker.html">device tracker component page</a> for instructions how to configure the people to be tracked.</p>

9
components/device_tracker.tplink.html
View file

@ -122,6 +122,15 @@ This platform allows you to detect presence by looking at connected devices to a
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, e.g. 192.168.1.1.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
</ul>
<p>See the <a href="/components/device_tracker.html">device tracker component page</a> for instructions how to configure the people to be tracked.</p>

5
components/discovery.html
View file

@ -125,6 +125,11 @@ Home Assistant can discover and automatically configure zeroconf/mDNS and uPnP d
<p>If you are developing a new platform, please read <a href="/developers/add_new_platform.html#discovery">how to make your platform discoverable</a>.</p>
<p class='note warning'>
There is currently a <a href='https://bitbucket.org/al45tair/netifaces/issues/17/dll-fails-to-load-windows-81-64bit'>known issue</a> with running this playform on a 64-bit version of Python.
</p>
</article>

219
components/ifttt.html Normal file
View file

@ -0,0 +1,219 @@
<!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>IFTTT - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to setup IFTTT within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="IFTTT">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/ifttt.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Instructions how to setup IFTTT within Home Assistant.">
<meta property="og: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='/images/favicon-192x192.png'> Home Assistant
</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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration.html'>Initial configuration</a></li>
<li><a href='/components/'>Component overview</a></li>
<li><a href='/getting-started/android.html'>Setting up Android</a></li>
</ul>
</li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture.html">Architecture</a></li>
<li><a href="/developers/frontend.html">Frontend development</a></li>
<li><a href="/developers/creating_components.html">
Creating components
</a></li>
<li><a href="/developers/add_new_platform.html">
Adding platform support
</a></li>
<li><a href="/developers/api.html">API</a></li>
<li><a href="/developers/credits.html">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">
IFTTT
</h1>
</header>
<hr class="divider">
<p><img src='/images/supported_brands/ifttt.png' class='brand pull-right' />
<a href="https://ifttt.com">IFTTT</a> is a web service that allows users to create chains of simple conditional statements, so called &ldquo;recipes&rdquo;. With the ifttt component you can trigger recipes through the &ldquo;maker&rdquo; channel.</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>
</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">ifttt</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">key</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">xxxxx-x-xxxxxxxxxxxxx</span>
</span></code></pre></td></tr></table></div></figure>
<p>Key is your API key which can be obtained by viewing the properties of the <a href="https://ifttt.com/maker">Maker Channel</a>.</p>
<p class='img'>
<img src='/images/components/ifttt/finding_key.png' />
Property screen of the Maker Channel
</p>
<p>Once you have added your key to <code>configuration.yaml</code>, restart your Home Assistant server. This will load up the IFTTT component and make a service available to trigger events in IFTTT.</p>
<p class='note'>
After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow.
</p>
<h3><a class='title-link' name='testing-your-trigger' href='#testing-your-trigger'></a> Testing your trigger</h3>
<p>You can use the developer tools to test your <a href="https://ifttt.com/maker">Maker Channel</a> trigger. To do this, open the Home Assistant UI, open the sidebar, click on the first icon in the developer tools. This should get you to the &lsquo;Call Service&rsquo; screen. Fill in the following values:</p>
<table>
<thead>
<tr>
<th>Field </th>
<th> Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>domain </td>
<td> <code>ifttt</code></td>
</tr>
<tr>
<td>service </td>
<td> <code>trigger</code></td>
</tr>
<tr>
<td>Service Data </td>
<td> <code>{"event": "EventName", "value1": "Hello World"}</code></td>
</tr>
</tbody>
</table>
<p class='img'>
<img src='/images/components/ifttt/testing_service.png' />
When your screen looks like this, click the &#8216;call service&#8217; button.
</p>
<h3><a class='title-link' name='setting-up-a-recipe' href='#setting-up-a-recipe'></a> Setting up a recipe</h3>
<p class='img'>
<img src='/images/components/ifttt/setup_trigger.png' />
You need to setup a unique trigger for each event you sent to IFTTT.
</p>
</article>
</div>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</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>

29
components/index.html
View file

@ -165,7 +165,7 @@
</tr>
<tr>
<td></td>
<td><a href='/components/sensor.dht.html'><img src='/images/supported_brands/dht.png' class='brand overview' /></a></td>
<td><a href='/components/sensor.dht.html'>DHTxx</a> reads the temperature and humidity.</td>
</tr>
@ -209,12 +209,17 @@
<tr>
<td></td>
<td><a href='/components/sensor.rfxtrx.html'>RFXtrx</a> sensors monitors values from RFXtrx sensors.</td>
<td><a href='/components/sensor.rfxtrx.html'>RFXtrx</a> sensors monitors values from RFXtrx devices.</td>
</tr>
<tr>
<td><a href='/components/mqtt.html'><img src='/images/supported_brands/mqtt.png' class='brand overview'/></a></td>
<td><a href='/components/mqtt.html'>MQTT</a> allows sending and recieving MQTT messages.</td>
<td><a href='/components/mqtt.html'>MQTT</a> allows sending and recieving MQTT messages, incl. <a href='/components/switch.mqtt.html'>switches</a> and <a href='/components/sensor.mqtt.html'>sensors</a>.</td>
</tr>
<tr>
<td><a href='/components/sensor.arest.html'><img src='/images/supported_brands/arest.png' class='brand overview' /></a></td>
<td><a href='/components/sensor.arest.html'>aREST</a> sensors monitors values from aREST enabled devices.</td>
</tr>
</table>
@ -246,7 +251,7 @@
</tr>
<tr>
<td></td>
<td><a href='/components/device_tracker.aruba.html'><img src='/images/supported_brands/aruba.png' class='brand overview' /></a></td>
<td><a href='/components/device_tracker.aruba.html'>Aruba routers</a></td>
</tr>
@ -307,7 +312,7 @@
<tr>
<td><a href='/components/media_player.cast.html'><img src='/images/supported_brands/google_cast.png' class='brand overview' /></a></td>
<td><a href='/components/media_player.cast.html'>Google Cast devices</a></td>
<td><a href='/components/media_player.cast.html'>Google Cast</a></td>
</tr>
<tr>
@ -325,6 +330,11 @@
<td><a href='/components/media_player.squeezebox.html'>Logitech Squeezebox</a></td>
</tr>
<tr>
<td><a href='/components/media_player.denon.html'><img src='/images/supported_brands/denon.png' class='brand overview' /></a></td>
<td><a href='/components/media_player.denon.html'>Denon Network Receivers</a></td>
</tr>
</table>
</div>
@ -552,7 +562,7 @@ the manufacturers of these devices.
<div class="grid">
<div class="grid__item one-whole lap-two-thirds">
<h2 class="title">Web services</h2>
<p>The web services displays data grabbed from an external source.</p>
<p>The web services displays data grabbed from an external source or interact with them.</p>
<table>
@ -573,7 +583,12 @@ the manufacturers of these devices.
<tr>
<td><a href='/components/sensor.swiss_public_transport.html'><img src='/images/supported_brands/appointment-new.png' class='brand overview' /></a></td>
<td><a href='/components/sensor.swiss_public_transport.html'>Swiss Public Transport</a> displays Swiss timetable data for traveling.</td>
<td><a href='/components/sensor.swiss_public_transport.html'>Swiss Public Transport</a> displays Swiss timetable data for traveling.</td>
</tr>
<tr>
<td><a href='/components/ifttt.html'><img src='/images/supported_brands/ifttt.png' class='brand overview' /></a></td>
<td><a href='/components/ifttt.html'>IFTTT</a> allows the triggering of recipes.</td>
</tr>
</table>

53
components/isy994.html
View file

@ -116,8 +116,7 @@ Devices</a>.</p>
that is configured on the controller. Using the programs on the controller,
custom switches and sensors can also be created.</p>
<p>To integrate your ISY994 controller with Home Assistant, add the following
section to your <code>configuration.yaml</code> file:</p>
<p>To integrate your ISY994 controller with Home Assistant, add the following section to your <code>configuration.yaml</code> file:</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>
@ -127,46 +126,34 @@ section to your <code>configuration.yaml</code> file:</p>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
<span class='line-number'>9</span>
<span class='line-number'>10</span>
<span class='line-number'>11</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">isy994</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="c1"># requried</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ISY_ADDRESS</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ISY_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ISY_PASSWORD</span>
</span><span class='line'>
</span><span class='line'> <span class="c1"># optional</span>
</span><span class='line'> <span class="l-Scalar-Plain">sensor_string</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">SENSOR_STRING</span>
</span><span class='line'> <span class="l-Scalar-Plain">hidden_string</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">HIDDEN_STRING</span>
</span><span class='line'> <span class="l-Scalar-Plain">tls</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">TLS_VERSION</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ISY_ADDRESS</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ISY_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ISY_PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">sensor_string</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">SENSOR_STRING</span>
</span><span class='line'> <span class="l-Scalar-Plain">hidden_string</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">HIDDEN_STRING</span>
</span><span class='line'> <span class="l-Scalar-Plain">tls</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">TLS_VERSION</span>
</span></code></pre></td></tr></table></div></figure>
<p>The ISY_ADDRESS should be in full URL format. For example:
<a href="http://192.168.10.100:80">http://192.168.10.100:80</a></p>
<p>Configuration variables:</p>
<p>The ISY_USERNAME and ISY_PASSWORD are the configured username and password used
to access the ISY interface.</p>
<p>The SENSOR_STRING is a string that is used to identify which devices are to be
assumed to be sensors instead of lights of switches. By default, this string is
&lsquo;Sensor&rsquo;. If this string is found in the device name, Home Assistant will
assume it is as a sensor.</p>
<p>The HIDDEN_STRING is a string that is used to identify which devices are to be
<ul>
<li><strong>host</strong> (<em>Required</em>): The host entry should be in full URL format, eg. <a href="http://192.168.10.100:80">http://192.168.10.100:80</a></li>
<li><strong>username</strong> (<em>Required</em>): The username that used to access the ISY interface.</li>
<li><p><strong>password</strong> (<em>Required</em>): The password that used to access the ISY interface.</p></li>
<li><p><strong>sensor_string</strong> (<em>Optional</em>): This is the string that is used to identify which devices are to be assumed to be sensors instead of lights of switches. By default, this string is &lsquo;Sensor&rsquo;. If this string is found in the device name, Home Assistant will
assume it is as a sensor.</p></li>
<li><strong>hidden_string</strong> (<em>Optional</em>): The HIDDEN_STRING is a string that is used to identify which devices are to be
hidden on Home Assistant&rsquo;s front page. This string will be stripped from the
device&rsquo;s name before being used. By default, this value is &lsquo;{HIDE ME}&rsquo;.</p>
device&rsquo;s name before being used. By default, this value is &lsquo;{HIDE ME}&rsquo;.</li>
<li><strong>tls</strong> (<em>Optional</em>): This entry should refelct the version of TLS that the ISY controller is using for HTTPS encryption. This value can be either 1.1 or 1.2. If this value is not set, it is assumed to be version 1.1. This is the default for most users.
ISY994 Pro users may likely be using 1.2. When using HTTPS in the host entry, it is best practice to set this value.</li>
</ul>
<p>The TLS_VERSION value is the version of TLS that the ISY controller is using
for HTTPS encryption. This value can be either 1.1 or 1.2. If this value is not
set, it is assumed to be version 1.1. This is the default for most users.
ISY994 Pro users may likely be using 1.2. When using HTTPS in the ISY_ADDRESS
string, it is best practice to set this value.</p>
<p>Once the ISY controller is configured, it will automatically import any lights,
switches, and sensors it can locate.</p>
<p>Once the ISY controller is configured, it will automatically import any lights, switches, and sensors it can locate.</p>
<h3>Creating Custom Switches</h3>

14
components/keyboard.html
View file

@ -123,6 +123,20 @@ The <code>keyboard</code> component simulates key presses on the host machine. I
</pre></td><td class='code'><pre><code class=''><span class='line'>keyboard:</span></code></pre></td></tr></table></div></figure>
<h2><a class='title-link' name='dependencies' href='#dependencies'></a> Dependencies</h2>
<p>You may need to install platform-specific <a href="https://github.com/SavinaRoja/PyUserInput#dependencies">dependencies for PyUserInput</a> in order to use the keyboard component. In most cases this can be done by running:</p>
<figure class='code'><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
</pre></td><td class='code'><pre><code class=''><span class='line'>pip3 install [package name]</span></code></pre></td></tr></table></div></figure>
<h4><a class='title-link' name='windows' href='#windows'></a> Windows</h4>
<p>x64 Windows users may have trouble installing pywin through pip. Using an <a href="http://sourceforge.net/projects/pywin32/files/pywin32/">executable installer</a> should work around this issue.</p>
<p><a href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#pyhook">Similar installers</a> (unofficial) for pyhook have been ported to python 3.4 and should help with x64 pip issues with pyhook.</p>
</article>

10
components/light.limitlessled.html
View file

@ -120,13 +120,21 @@ The limitlessled can control your <a href="http://www.limitlessled.com/">Limitle
</pre></td><td class='code'><pre><code class=''><span class='line'># Example configuration.yaml entry
</span><span class='line'>light:
</span><span class='line'> platform: limitlessled
</span><span class='line'> host: 192.168.1.10
</span><span class='line'> host: IP_ADDRESS
</span><span class='line'> group_1_name: Living Room
</span><span class='line'> group_2_name: Bedroom
</span><span class='line'> group_3_name: Office
</span><span class='line'> group_4_name: Kitchen</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): IP address of the device, eg. 192.168.1.32</li>
<li><strong>group_X_name</strong> (<em>Required</em>): Name of the group. Multiple entries with a consecutive number.</li>
</ul>
</article>

18
components/media_player.cast.html
View file

@ -109,14 +109,22 @@ Google Cast devices will be automatically discovered if you enable <a href="/com
<p>Chromecast platform can also be forced to load by adding 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>
</pre></td><td class='code'><pre><code class=''><span class='line'>media_player:
</span><span class='line'> platform: chromecast
</span><span class='line'> # Optional. Will scan for devices if left out
</span><span class='line'> host: 192.168.1.9</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">media_player</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">chromecast</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">192.168.1.9</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> <em>Optional</em>: Use only if you don&rsquo;t want to scan for devices.</li>
</ul>

193
components/media_player.denon.html Normal file
View file

@ -0,0 +1,193 @@
<!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>Denon Network Receivers support - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to integrate Denon Network Receivers into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Denon Network Receivers support">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/media_player.denon.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Instructions how to integrate Denon Network Receivers into Home Assistant.">
<meta property="og: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='/images/favicon-192x192.png'> Home Assistant
</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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration.html'>Initial configuration</a></li>
<li><a href='/components/'>Component overview</a></li>
<li><a href='/getting-started/android.html'>Setting up Android</a></li>
</ul>
</li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture.html">Architecture</a></li>
<li><a href="/developers/frontend.html">Frontend development</a></li>
<li><a href="/developers/creating_components.html">
Creating components
</a></li>
<li><a href="/developers/add_new_platform.html">
Adding platform support
</a></li>
<li><a href="/developers/api.html">API</a></li>
<li><a href="/developers/credits.html">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">
Denon Network Receivers Support
</h1>
</header>
<hr class="divider">
<p><img src='/images/supported_brands/denon.png' class='brand pull-right' />
The denon platform allows you to control a <a href="http://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo">Denon Network Receivers</a> from Home Assistant.</p>
<p>Supported devices:</p>
<ul>
<li>Denon DRA-N5</li>
<li>Denon RCD-N8 (untested)</li>
</ul>
<p>To add a Denon Network Receiver to your installation, add the following to your <code>configuration.yaml</code> file:</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>
</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">media_player</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">denon</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">IP_ADDRESS</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Music station</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): IP address of the device. Example: 192.168.1.32</li>
<li><strong>name</strong> (<em>Optional</em>): Name of the device</li>
</ul>
<p>A few notes:</p>
<ul>
<li>As long as this module is active and connected, the receiver does not seem to accept additional telnet connections.</li>
<li>Be careful with the volume. 50 % or even 100 % are very loud.</li>
<li>To be able to wake up the receiver, activate the &ldquo;remote&rdquo; setting in the receiver&rsquo;s settings.</li>
</ul>
</article>
</div>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</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>

4
components/media_player.html
View file

@ -110,8 +110,10 @@
<ul>
<li><a href="/components/media_player.cast.html">Chromecasts</a></li>
<li><a href="/components/media_player.mpd.html">Music Player Daemon</a></li>
<li><a href="/components/media_player.denon.html">Denon Network Receivers</a></li>
<li><a href="/components/media_player.kodi.html">Kodi</a></li>
<li><a href="/components/media_player.mpd.html">Music Player Daemon</a></li>
<li><a href="/components/media_player.squeezebox.html">Squeezebox</a></li>
</ul>

14
components/media_player.kodi.html
View file

@ -119,12 +119,20 @@ The kodi platform allows you to control a <a href="http://kodi.tv/">Kodi</a> mul
</pre></td><td class='code'><pre><code class=''><span class='line'># Example configuration.yaml entry
</span><span class='line'>media_player:
</span><span class='line'> platform: kodi
</span><span class='line'> name: Kodi
</span><span class='line'> url: http://192.168.0.123/jsonrpc
</span><span class='line'> user: kodi
</span><span class='line'> password: my_secure_password</span></code></pre></td></tr></table></div></figure>
</span><span class='line'> name: Kodi
</span><span class='line'> user: USERNAME
</span><span class='line'> password: PASSWORD</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>url</strong> <em>Required</em>: The URL of the XBMC/Kodi JSON-RPC API, eg. <a href="http://192.168.0.123/jsonrpc">http://192.168.0.123/jsonrpc</a></li>
<li><strong>name</strong> <em>Optional</em>: The name of the device used in the frontend.</li>
<li><strong>username</strong> <em>Optional</em>: The XBMC/Kodi HTTP username.</li>
<li><strong>password</strong> <em>Optional</em>: The XBMC/Kodi HTTP password.</li>
</ul>

14
components/media_player.mpd.html
View file

@ -115,14 +115,24 @@ The mpd platform allows you to control a <a href="http://www.musicpd.org/">Music
<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'>media_player:
</span><span class='line'> platform: mpd
</span><span class='line'> server: 127.0.0.1
</span><span class='line'> server: IP_ADDRESS
</span><span class='line'> port: 6600
</span><span class='line'> location: bedroom</span></code></pre></td></tr></table></div></figure>
</span><span class='line'> location: bedroom
</span><span class='line'> password: PASSWORD</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>server</strong> <em>Required</em>: IP address of the Music Player Daemon. Example: 192.168.1.32</li>
<li><strong>port</strong> <em>Optional</em>: Port of the Music Player Daemon, defaults to 6600. Example: 6600</li>
<li><strong>location</strong> <em>Optional</em>: Location of your Music Player Daemon.</li>
<li><strong>password</strong> <em>Optional</em>: Password for your Music Player Daemon.</li>
</ul>

12
components/media_player.squeezebox.html
View file

@ -121,10 +121,18 @@ The squeezebox platform allows you to control a <a href="https://en.wikipedia.or
</span><span class='line'> platform: squeezebox
</span><span class='line'> host: 192.168.1.21
</span><span class='line'> port: 9090
</span><span class='line'> username: user
</span><span class='line'> password: password</span></code></pre></td></tr></table></div></figure>
</span><span class='line'> username: USERNAME
</span><span class='line'> password: PASSWORD</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> <em>Required</em>: The host name or address of the Logitech Media Server.</li>
<li><strong>port</strong> <em>Optional</em>: Telnet port to Logitech Media Server, default 9090.</li>
<li><strong>username</strong> <em>Optional</em>: The username, if password protection is enabled.</li>
<li><strong>password</strong> <em>Optional</em>: The password, if password protection is enabled.</li>
</ul>

20
components/mqtt.html
View file

@ -119,19 +119,27 @@ MQTT (aka MQ Telemetry Transport) is a machine-to-machine or &ldquo;Internet of
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
<span class='line-number'>9</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">mqtt</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">broker</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">IP_ADDRESS_BROKER</span>
</span><span class='line'> <span class="c1"># All the other options are optional:</span>
</span><span class='line'> <span class="l-Scalar-Plain">port</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">1883</span>
</span><span class='line'> <span class="l-Scalar-Plain">client_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">home-assistant-1</span>
</span><span class='line'> <span class="l-Scalar-Plain">keepalive</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">60</span>
</span><span class='line'> <span class="l-Scalar-Plain">qos</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">0</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">your_username</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">your_secret_password</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PASSWORD</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>broker</strong> (<em>Required</em>): The IP address of your MQTT broker, e.g. 192.168.1.32.</li>
<li><strong>port</strong> (<em>Optional</em>): The network port to connect to. Default is 1883.</li>
<li><strong>client_id</strong> (<em>Optional</em>): Client ID that Home Assistant will use. Has to be unique on the server. Default is a random generated one.</li>
<li><strong>keepalive</strong> (<em>Optional</em>): The keep alive in seconds for this client. Default is 60.</li>
<li><strong>username</strong> (<em>Optional</em>): The username to use with your MQTT broker.</li>
<li><strong>password</strong> (<em>Optional</em>): The corresponding password for the username to use with your MQTT broker.</li>
</ul>
<p class='note'>
@ -144,7 +152,7 @@ The MQTT component has no TLS support at the moment. This means that only plain-
<ul>
<li><a href="/components/sensor.mqtt.html">MQTT Sensor</a></li>
<li><a href="/components/switch.mqtt.html">MQTT Switch</a></li>
<li><a href="/components/automation.html#mqtt-based-automation">MQTT-automation rule</a>.</li>
<li><a href="/components/automation.html#mqtt-based-automation">MQTT-automation rule</a></li>
<li>Integrating it into a component. See the <a href="https://github.com/balloob/home-assistant/blob/dev/config/custom_components/mqtt_example.py">MQTT example component</a> how to do this.</li>
</ul>

6
components/notify.pushbullet.html
View file

@ -9,7 +9,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Notifications - Home Assistant</title>
<title>PushBullet notification support - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to add user notifications to Home Assistant.">
@ -18,7 +18,7 @@
<link rel="canonical" href="https://home-assistant.io">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Notifications">
<meta property="og:title" content="PushBullet notification support">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/notify.pushbullet.html/">
<meta property="og:type" content="website">
@ -98,7 +98,7 @@
<header>
<h1 class="title indent">
Notifications
PushBullet Notification Support
</h1>
</header>
<hr class="divider">

10
components/scheduler.html
View file

@ -107,7 +107,13 @@
<p>A component that will act as a scheduler and performe actions based
on the events in the schedule.</p>
<p>It will read a json object from <code>schedule.json</code> in the config dir and create a schedule based on it.</p>
<p>Load the component by enabling it in <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>
</pre></td><td class='code'><pre><code class=''><span class='line'>scheduler:</span></code></pre></td></tr></table></div></figure>
<p>It will read a json object from the file <code>schedule.json</code> in the config dir (<code>~/.homeassistant</code>) and create a schedule based on it.</p>
<p>Each schedule is a JSON with the keys <code>id</code>, <code>name</code>, <code>description</code>, <code>entity_ids</code>, <code>events</code>.</p>
@ -121,7 +127,7 @@ on the events in the schedule.</p>
</ul>
<p>Example <code>schedule.json</code></p>
<p>Example <code>schedule.json</code> file</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>

343
components/sensor.arest.html Normal file
View file

@ -0,0 +1,343 @@
<!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>aREST support - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to integrate aREST sensors within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="aREST support">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.arest.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Instructions how to integrate aREST sensors within Home Assistant.">
<meta property="og: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='/images/favicon-192x192.png'> Home Assistant
</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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration.html'>Initial configuration</a></li>
<li><a href='/components/'>Component overview</a></li>
<li><a href='/getting-started/android.html'>Setting up Android</a></li>
</ul>
</li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture.html">Architecture</a></li>
<li><a href="/developers/frontend.html">Frontend development</a></li>
<li><a href="/developers/creating_components.html">
Creating components
</a></li>
<li><a href="/developers/add_new_platform.html">
Adding platform support
</a></li>
<li><a href="/developers/api.html">API</a></li>
<li><a href="/developers/credits.html">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">
aREST Support
</h1>
</header>
<hr class="divider">
<p><img src='/images/supported_brands/arest.png' class='brand pull-right' />
The arest sensor platform allows you to get all data from your devices (like Arduinos with a ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the <a href="http://arest.io/">aREST</a> RESTful framework.</p>
<p>To use your aREST enabled device in your installation, add the following to your <code>configuration.yaml</code> file:</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>
<span class='line-number'>8</span>
<span class='line-number'>9</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">sensor</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">arest</span>
</span><span class='line'> <span class="l-Scalar-Plain">resource</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">http://IP_ADDRESS</span>
</span><span class='line'> <span class="l-Scalar-Plain">monitored_variables</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">temperature</span>
</span><span class='line'> <span class="l-Scalar-Plain">unit</span><span class="p-Indicator">:</span> <span class="s">&#39;°C&#39;</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">humidity</span>
</span><span class='line'> <span class="l-Scalar-Plain">unit</span><span class="p-Indicator">:</span> <span class="s">&#39;%&#39;</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>resource</strong> (<em>Required</em>): IP address and schema of the device that is exposing an aREST API, e.g. <a href="http://192.168.1.10.">http://192.168.1.10.</a></li>
<li><strong>monitored_variables</strong> array:
<ul>
<li><strong>name</strong> (<em>Required</em>): The name of the variable you wish to monitor.</li>
<li><strong>unit</strong> (<em>Optional</em>): Defines the units of measurement of the sensor, if any.</li>
</ul>
</li>
</ul>
<p>The variables in the <code>monitored_variables</code> array must be available in the response of the device. As a starting point you find below a sketch for the Arduino device family. There are two variables (<code>temperature</code> and <code>humidity</code>) which will act as endpoints.</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>
<span class='line-number'>8</span>
<span class='line-number'>9</span>
<span class='line-number'>10</span>
<span class='line-number'>11</span>
<span class='line-number'>12</span>
<span class='line-number'>13</span>
<span class='line-number'>14</span>
<span class='line-number'>15</span>
<span class='line-number'>16</span>
<span class='line-number'>17</span>
<span class='line-number'>18</span>
<span class='line-number'>19</span>
<span class='line-number'>20</span>
<span class='line-number'>21</span>
<span class='line-number'>22</span>
<span class='line-number'>23</span>
<span class='line-number'>24</span>
<span class='line-number'>25</span>
<span class='line-number'>26</span>
<span class='line-number'>27</span>
<span class='line-number'>28</span>
<span class='line-number'>29</span>
<span class='line-number'>30</span>
<span class='line-number'>31</span>
<span class='line-number'>32</span>
<span class='line-number'>33</span>
<span class='line-number'>34</span>
<span class='line-number'>35</span>
<span class='line-number'>36</span>
<span class='line-number'>37</span>
<span class='line-number'>38</span>
<span class='line-number'>39</span>
<span class='line-number'>40</span>
<span class='line-number'>41</span>
<span class='line-number'>42</span>
<span class='line-number'>43</span>
<span class='line-number'>44</span>
<span class='line-number'>45</span>
<span class='line-number'>46</span>
<span class='line-number'>47</span>
<span class='line-number'>48</span>
<span class='line-number'>49</span>
<span class='line-number'>50</span>
<span class='line-number'>51</span>
<span class='line-number'>52</span>
<span class='line-number'>53</span>
<span class='line-number'>54</span>
<span class='line-number'>55</span>
<span class='line-number'>56</span>
<span class='line-number'>57</span>
<span class='line-number'>58</span>
</pre></td><td class='code'><pre><code class='c'><span class='line'><span class="cm">/*</span>
</span><span class='line'><span class="cm"> This modified sketch is based on the Ethernet example of the aREST </span>
</span><span class='line'><span class="cm"> (http://arest.io/) library.</span>
</span><span class='line'><span class="cm">*/</span>
</span><span class='line'>
</span><span class='line'><span class="c1">// Libraries</span>
</span><span class='line'><span class="cp">#include &lt;SPI.h&gt;</span>
</span><span class='line'><span class="cp">#include &lt;Ethernet.h&gt;</span>
</span><span class='line'><span class="cp">#include &lt;aREST.h&gt;</span>
</span><span class='line'><span class="cp">#include &lt;avr/wdt.h&gt;</span>
</span><span class='line'>
</span><span class='line'><span class="c1">// Device settings</span>
</span><span class='line'><span class="kt">char</span><span class="o">*</span> <span class="n">deviceId</span> <span class="o">=</span> <span class="s">&quot;sensor02&quot;</span><span class="p">;</span>
</span><span class='line'><span class="kt">char</span><span class="o">*</span> <span class="n">deviceName</span> <span class="o">=</span> <span class="s">&quot;livingroom&quot;</span><span class="p">;</span>
</span><span class='line'><span class="n">byte</span> <span class="n">deviceMac</span><span class="p">[]</span> <span class="o">=</span> <span class="p">{</span> <span class="mh">0x20</span><span class="p">,</span> <span class="mh">0xD5</span><span class="p">,</span> <span class="mh">0xD3</span><span class="p">,</span> <span class="mh">0x03</span><span class="p">,</span> <span class="mh">0xFE</span><span class="p">,</span> <span class="mh">0x31</span> <span class="p">};</span>
</span><span class='line'><span class="n">IPAddress</span> <span class="nf">deviceIp</span><span class="p">(</span><span class="mi">192</span><span class="p">,</span> <span class="mi">168</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">12</span><span class="p">);</span>
</span><span class='line'>
</span><span class='line'><span class="n">EthernetServer</span> <span class="nf">server</span><span class="p">(</span><span class="mi">80</span><span class="p">);</span>
</span><span class='line'><span class="n">aREST</span> <span class="n">rest</span> <span class="o">=</span> <span class="n">aREST</span><span class="p">();</span>
</span><span class='line'>
</span><span class='line'><span class="c1">// Variables to be exposed to the API</span>
</span><span class='line'><span class="kt">int</span> <span class="n">temperature</span><span class="p">;</span>
</span><span class='line'><span class="kt">int</span> <span class="n">humidity</span><span class="p">;</span>
</span><span class='line'>
</span><span class='line'><span class="kt">void</span> <span class="nf">setup</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span> <span class="p">{</span>
</span><span class='line'> <span class="n">Serial</span><span class="p">.</span><span class="n">begin</span><span class="p">(</span><span class="mi">57600</span><span class="p">);</span>
</span><span class='line'>
</span><span class='line'> <span class="c1">// Init variables and expose them to REST API</span>
</span><span class='line'> <span class="n">temperature</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
</span><span class='line'> <span class="n">humidity</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
</span><span class='line'>
</span><span class='line'> <span class="n">rest</span><span class="p">.</span><span class="n">variable</span><span class="p">(</span><span class="s">&quot;temperature&quot;</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">temperature</span><span class="p">);</span>
</span><span class='line'> <span class="n">rest</span><span class="p">.</span><span class="n">variable</span><span class="p">(</span><span class="s">&quot;humidity&quot;</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">humidity</span><span class="p">);</span>
</span><span class='line'>
</span><span class='line'> <span class="c1">// Give name and ID to device</span>
</span><span class='line'> <span class="n">rest</span><span class="p">.</span><span class="n">set_id</span><span class="p">(</span><span class="n">deviceId</span><span class="p">);</span>
</span><span class='line'> <span class="n">rest</span><span class="p">.</span><span class="n">set_name</span><span class="p">(</span><span class="n">deviceName</span><span class="p">);</span>
</span><span class='line'>
</span><span class='line'> <span class="n">Ethernet</span><span class="p">.</span><span class="n">begin</span><span class="p">(</span><span class="n">deviceMac</span><span class="p">,</span> <span class="n">deviceIp</span><span class="p">);</span>
</span><span class='line'>
</span><span class='line'> <span class="n">server</span><span class="p">.</span><span class="n">begin</span><span class="p">();</span>
</span><span class='line'> <span class="n">Serial</span><span class="p">.</span><span class="n">print</span><span class="p">(</span><span class="s">&quot;Sensor is ready...&quot;</span><span class="p">);</span>
</span><span class='line'>
</span><span class='line'> <span class="c1">// Start watchdog</span>
</span><span class='line'> <span class="n">wdt_enable</span><span class="p">(</span><span class="n">WDTO_4S</span><span class="p">);</span>
</span><span class='line'><span class="p">}</span>
</span><span class='line'>
</span><span class='line'><span class="kt">void</span> <span class="nf">loop</span><span class="p">()</span> <span class="p">{</span>
</span><span class='line'> <span class="n">EthernetClient</span> <span class="n">client</span> <span class="o">=</span> <span class="n">server</span><span class="p">.</span><span class="n">available</span><span class="p">();</span>
</span><span class='line'> <span class="n">rest</span><span class="p">.</span><span class="n">handle</span><span class="p">(</span><span class="n">client</span><span class="p">);</span>
</span><span class='line'> <span class="n">wdt_reset</span><span class="p">();</span>
</span><span class='line'>
</span><span class='line'> <span class="c1">// Replace this with your actual sensor readings, like</span>
</span><span class='line'> <span class="c1">// temperature = (((analogRead(A0) * 5.0) / 1024) - 0.5) * 10;</span>
</span><span class='line'> <span class="n">temperature</span> <span class="o">=</span> <span class="n">random</span><span class="p">(</span><span class="mi">400</span><span class="p">);</span>
</span><span class='line'> <span class="n">humidity</span> <span class="o">=</span> <span class="n">random</span><span class="p">(</span><span class="mi">600</span><span class="p">);</span>
</span><span class='line'> <span class="n">delay</span><span class="p">(</span><span class="mi">500</span><span class="p">);</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<p>Accessing one of the endpoints (eg. <a href="http://192.168.1.10/temperature">http://192.168.1.10/temperature</a>) will give you the value inside a JSON response.</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>
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span><span class="nt">&quot;temperature&quot;</span><span class="p">:</span> <span class="mi">23</span><span class="p">,</span> <span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;sensor01&quot;</span><span class="p">,</span> <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;livingroom&quot;</span><span class="p">,</span> <span class="nt">&quot;connected&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<p>The root will give you a JSON response that contains all variables and their current values along with some device details.</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>
<span class='line-number'>8</span>
<span class='line-number'>9</span>
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;variables&quot;</span> <span class="p">:</span> <span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;temperature&quot;</span> <span class="p">:</span> <span class="mi">23</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;humidity&quot;</span> <span class="p">:</span> <span class="mi">82</span>
</span><span class='line'> <span class="p">},</span>
</span><span class='line'> <span class="nt">&quot;id&quot;</span> <span class="p">:</span> <span class="s2">&quot;sensor01&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;name&quot;</span> <span class="p">:</span> <span class="s2">&quot;livingroom&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;connected&quot;</span> <span class="p">:</span> <span class="kc">true</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
</article>
</div>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</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>

35
components/sensor.bitcoin.html
View file

@ -109,6 +109,8 @@ The bitcoin platform displays various details about the <a href="https://bitcoin
<p>If you have an online wallet from <a href="https://blockchain.info/">Blockchain.info</a> the sensor is capable to show your current balance.</p>
<p>You need to enable the API access for your online wallet to get the balance. To do that log in and move to &lsquo;Account Setting&rsquo;, choose &lsquo;IP Restrictions&rsquo;, and check &lsquo;Enable Api Access&rsquo;. You will get an email message from blockchain.info where you must authorize the API access.</p>
<p>To add the Bitcoin sensor to your installation, add a selection of the available display options to your <code>configuration.yaml</code> file:</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>
@ -170,6 +172,39 @@ The bitcoin platform displays various details about the <a href="https://bitcoin
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>wallet</strong> (<em>Optional</em>): This is your wallet identifier from <a href="https://blockchain.info">https://blockchain.info</a> to access the online wallet.</li>
<li><strong>password</strong> (<em>Optional</em>): Password for your online wallet.</li>
<li><strong>currency</strong> (<em>Optional</em>): The currency to exchange to, eg. CHF, USD, EUR, etc. Default is USD.</li>
<li><strong>display_options</strong> array (<em>Required</em>): Options to display in the frontend.
<ul>
<li><strong>exchangerate</strong>: Exchange rate of 1 BTC</li>
<li><strong>trade_volume_btc</strong>: Trade volume</li>
<li><strong>miners_revenue_usd</strong>: Miners revenue</li>
<li><strong>btc_mined</strong>: BTC mined</li>
<li><strong>trade_volume_usd</strong>: Trade volume in USD</li>
<li><strong>difficulty</strong>: Difficulty</li>
<li><strong>minutes_between_blocks</strong>: Time between blocks in minutes</li>
<li><strong>number_of_transactions</strong>: Number of transactions</li>
<li><strong>hash_rate</strong>: Hash rate in PH/s</li>
<li><strong>timestamp</strong>: Timestamp</li>
<li><strong>mined_blocks</strong>: Minded Blocks</li>
<li><strong>blocks_size</strong>: Block size</li>
<li><strong>total_fees_btc</strong>: Total fees in BTC</li>
<li><strong>total_btc_sent</strong>: Total sent in BTC</li>
<li><strong>estimated_btc_sent</strong>: Estimated sent in BTC</li>
<li><strong>total_btc</strong>: Total of BTC</li>
<li><strong>total_blocks</strong>: Total Blocks</li>
<li><strong>next_retarget</strong>: Next retarget</li>
<li><strong>estimated_transaction_volume_usd</strong>: Estimated transaction volume in BTC</li>
<li><strong>miners_revenue_btc</strong>: Miners revenue in BTC</li>
<li><strong>market_price_usd</strong>: Market price in USD</li>
</ul>
</li>
</ul>

20
components/sensor.dht.html
View file

@ -104,7 +104,8 @@
<hr class="divider">
<p>The dht sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22, or AM2302 device.</p>
<p><img src='/images/supported_brands/dht.png' class='brand pull-right' />
The dht sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22, or AM2302 device.</p>
<p>To use your DHTxx sensor in your installation, add the following to your <code>configuration.yaml</code> file:</p>
@ -127,6 +128,23 @@
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>sensor</strong> (<em>Required</em>): The sensor type, supported devices are DHT11, DHT22, and AM2302</li>
<li><strong>pin</strong> (<em>Required</em>): The pin the sensor is connected to.</li>
<li><strong>monitored_conditions</strong> array: Conditions to monitor.
<ul>
<li><strong>temperature</strong>:</li>
<li><strong>humidity</strong>:</li>
</ul>
</li>
</ul>
<p>Available conditions are only <em>temperature</em> and <em>humidity</em>.</p>
<p>The name of the pin to which the sensor is connected has different names on different platforms. &lsquo;P8_11&rsquo; for Beaglebone, &lsquo;23&rsquo; for Raspberry Pi.</p>
<p class='note warning'>

17
components/sensor.efergy.html
View file

@ -132,6 +132,23 @@ Integrate your <a href="https://efergy.com">Efergy</a> meter information into Ho
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>app_token</strong> (<em>Required</em>): The App Token for your account.</li>
<li><strong>utc_offset</strong> (<em>Required</em>): Some variables (currently only the daily_cost) require that the
negative number of minutes your timezone is ahead/behind UTC time.</li>
<li><strong>monitored_variables</strong> array (<em>Required</em>): Variables to monitor.
<ul>
<li><strong>type</strong> (<em>Required</em>): Name of the variable.</li>
<li><strong>period</strong> (<em>Optional</em>): Some variables take a period argument. Valid options are &ldquo;day&rdquo;, &ldquo;week&rdquo;, &ldquo;month&rdquo;, and &ldquo;year&rdquo;.</li>
<li><strong>currency</strong> (<em>Optional</em>): This is used to display the cost/period as the unit when monitoring the cost. It should correspond to the actual currency used in your dashboard.</li>
</ul>
</li>
</ul>
</article>

28
components/sensor.forecast.html
View file

@ -107,7 +107,7 @@
<p><img src='/images/supported_brands/weather-few-clouds.png' class='brand pull-right' />
The forecast platform uses the <a href="https://forecast.io/">Forecast.io</a> web service as a source for meteorological data for your location.</p>
<p>You need an API key which is free but requires a <a href="https://developer.forecast.io/register">registration</a>.</p>
<p>You need an API key which is free but requires a <a href="https://developer.forecast.io/register">registration</a>. You can make 1000 requests per day. This means that you could create approximately every 1.4 minute one.</p>
<p>To add Forecast.io to your installation, add the following to your <code>configuration.yaml</code> file:</p>
@ -148,7 +148,31 @@ The forecast platform uses the <a href="https://forecast.io/">Forecast.io</a> we
</span></code></pre></td></tr></table></div></figure>
<p>Details about the API are available in the (Forecast.io documentation)[<a href="https://developer.forecast.io/docs/v2">https://developer.forecast.io/docs/v2</a>].</p>
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): Your API key for <a href="http://forecast.io/.">http://forecast.io/.</a></li>
<li><strong>display_conditions</strong> array (<em>Required</em>): Conditions to display in the frontend.
<ul>
<li><strong>summary</strong>: A human-readable text summary.</li>
<li><strong>precip_type</strong>: The type of precipitation occurring.</li>
<li><strong>precip_intensity</strong>: The average expected intensity of precipitation occurring.</li>
<li><strong>temperature</strong>: The current temperature.</li>
<li><strong>dew_point</strong>: The dew point.</li>
<li><strong>wind_speed</strong>: The wind speed.</li>
<li><strong>wind_bearing</strong>: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.</li>
<li><strong>cloud_cover</strong>: The percentage of sky occluded by clouds.</li>
<li><strong>humidity</strong>: The relative humidity.</li>
<li><strong>pressure</strong>: The sea-level air pressure in millibars.</li>
<li><strong>visibility</strong>: The average visibility.</li>
<li><strong>ozone</strong>: The columnar density of total atmospheric ozone in Dobson.</li>
</ul>
</li>
</ul>
<p>Details about the API are available in the <a href="https://developer.forecast.io/docs/v2">Forecast.io documentation</a>.</p>
</article>

16
components/sensor.mqtt.html
View file

@ -116,20 +116,26 @@ last known value. Otherwise, the initial state will be undefined.</p>
<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.yml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">sensor</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">mqtt</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="s">&quot;MQTT</span><span class="nv"> </span><span class="s">Sensor&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">state_topic</span><span class="p-Indicator">:</span> <span class="s">&quot;home/bedroom/temperature&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">unit_of_measurement</span><span class="p-Indicator">:</span> <span class="s">&quot;ºC&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="s">&quot;MQTT</span><span class="nv"> </span><span class="s">Sensor&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">qos</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">0</span>
</span><span class='line'> <span class="l-Scalar-Plain">unit_of_measurement</span><span class="p-Indicator">:</span> <span class="s">&quot;°C&quot;</span>
</span></code></pre></td></tr></table></div></figure>
<p>state_topic: The MQTT topic subscribed to receive sensor values. <em>Required</em></p>
<p>Configuration variables:</p>
<p>name: The name of the sensor. Default is &lsquo;MQTT Sensor&rsquo;. <em>Optional</em></p>
<ul>
<li><strong>state_topic</strong> (<em>Required</em>): The MQTT topic subscribed to receive sensor values.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor. Default is &lsquo;MQTT Sensor&rsquo;.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0.</li>
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the units of measurement of the sensor, if any.</li>
</ul>
<p>unit_of_measurement: Defines the units of measurement of the sensor, if any. <em>Optional</em></p>
</article>

16
components/sensor.mysensors.html
View file

@ -105,7 +105,9 @@
<p><img src='/images/supported_brands/mysensors.png' class='brand pull-right' />
Integrate your <a href="https://www.mysensors.org">MySensors sensors</a> by adding the following to your <code>configuration.yaml</code>:</p>
The <a href="https://www.mysensors.org">MySensors</a> project combines Arduino boards with NRF24L01 radio boards to build sensor networks.</p>
<p>Integrate your Serial MYSensors Gateway by adding the following to your <code>configuration.yaml</code>:</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>
@ -118,6 +120,18 @@ Integrate your <a href="https://www.mysensors.org">MySensors sensors</a> by addi
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>port</strong> (<em>Required</em>): The port where your board is connected to your Home Assistant host. If you are using an original Arduino the port will be named <code>ttyACM*</code>. The exact number can be determined with <code>ls /dev/ttyACM*</code>.</li>
</ul>
<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>
</pre></td><td class='code'><pre><code class='bash'><span class='line'>ls /dev/ttyACM*
</span></code></pre></td></tr></table></div></figure>
</article>

21
components/sensor.openweathermap.html
View file

@ -142,6 +142,27 @@ The openweathermap platform uses <a href="http://openweathermap.org/">OpenWeathe
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): Your API key for <a href="http://openweathermap.org/.">http://openweathermap.org/.</a></li>
<li><strong>forecast</strong> (<em>Optional</em>): Enables the forecast. The default is to display the current conditions.</li>
<li><strong>display_conditions</strong> array (<em>Required</em>): Conditions to display in the frontend.
<ul>
<li><strong>weather</strong>: A human-readable text summary.</li>
<li><strong>temperature</strong>: The current temperature.</li>
<li><strong>wind_speed</strong>: The wind speed.</li>
<li><strong>humidity</strong>: The relative humidity.</li>
<li><strong>pressure</strong>: The sea-level air pressure in millibars.</li>
<li><strong>clouds</strong>: Description about cloud coverage.</li>
<li><strong>rain</strong>: The rain volume.</li>
<li><strong>snow</strong>: The snow volume</li>
</ul>
</li>
</ul>
<p>Details about the API are available in the <a href="http://bugs.openweathermap.org/projects/api/wiki">OpenWeatherMap documentation</a>.</p>

11
components/sensor.rfxtrx.html
View file

@ -114,12 +114,17 @@
<span class='line-number'>4</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">sensor</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">rfxtrx</span>
</span><span class='line'> <span class="l-Scalar-Plain">device</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PATH_TO_DEVICE</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">rfxtrx</span>
</span><span class='line'> <span class="l-Scalar-Plain">device</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PATH_TO_DEVICE</span>
</span></code></pre></td></tr></table></div></figure>
<p>The path to your device, e.g. <code>/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0</code></p>
<p>Configuration variables:</p>
<ul>
<li><strong>device</strong> (<em>Required</em>): The path to your device, e.g. <code>/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0</code></li>
</ul>
</article>

8
components/sensor.swiss_public_transport.html
View file

@ -126,6 +126,14 @@ The swiss public transport sensor will give you the next two departure times fro
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>from</strong> (<em>Required</em>): The ID of the station of the start station.</li>
<li><strong>to</strong> (<em>Required</em>): The ID of the station of the end station.</li>
</ul>
<p>The public timetables are coming from <a href="http://transport.opendata.ch">Swiss public transport</a>.</p>

13
components/sensor.systemmonitor.html
View file

@ -128,6 +128,19 @@ The system monitoring sensor platform to allow you to monitor disk usage, memory
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>resources</strong> array (<em>Required</em>): Contains all entries to display.
<ul>
<li><strong>type</strong> (<em>Required</em>): The type of the information to display, please check the table below for details.</li>
<li><strong>arg</strong> (<em>Optional</em>): Argument to use, please check the table below for details.</li>
</ul>
</li>
</ul>
<p>The table contains types and their argument to use in your <code>configuration.yaml</code> file.</p>
<table>

29
components/sensor.transmission.html
View file

@ -122,22 +122,41 @@ The <a href="http://www.transmissionbt.com/">Transmission</a> platform allows yo
</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">sensor</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">transmission</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Transmission</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">192.168.1.26</span>
</span><span class='line'> <span class="l-Scalar-Plain">port</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">9091</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Transmission</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">monitored_variables</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="s">&#39;current_status&#39;</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="s">&#39;download_speed&#39;</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="s">&#39;upload_speed&#39;</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="s">&#39;current_status&#39;</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="s">&#39;download_speed&#39;</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="s">&#39;upload_speed&#39;</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): This is the IP address of your Transmission daemon, e.g. 192.168.1.32.</li>
<li><strong>port</strong> (<em>Optional</em>): The port your Transmission daemon uses, defaults to 9091.</li>
<li><strong>name</strong> (<em>Optional</em>): The name to use when displaying this Transmission instance.</li>
<li><strong>username</strong> (<em>Optional</em>): Your Transmission username, if you use authentication.</li>
<li><strong>password</strong> (<em>Optional</em>): Your Transmission password, if you use authentication.</li>
<li><strong>display_variables</strong> array: Conditions to display in the frontend.
<ul>
<li><strong>current_status</strong>: The status of your Transmission daemon.</li>
<li><strong>download_speed</strong>: The current download speed.</li>
<li><strong>upload_speed</strong>: The current upload speed.</li>
</ul>
</li>
</ul>
<p>To use the monitoring, your transmission client needs to allow remote access. If you are running the graphical transmission client (transmission-gtk) go to <strong>Edit</strong> -> <strong>Perferences</strong> and choose the tab <strong>Remote</strong>. Check <strong>Allow remote access</strong>, enter your username and your password, and uncheck the network restriction as needed.</p>
<p class='img'>
<img src='/images/screenshots/transmission-perf.png' />
<img src='/images/screenshots/transmission_perf.png' />
</p>

18
components/switch.command_switch.html
View file

@ -125,6 +125,24 @@ A switch platform that issues specific commands when it is turned on and off. Th
</span><span class='line'> offcmd: switch_command off kitchen</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.
<ul>
<li><strong>&lsquo;entry&rsquo;</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>
<li><strong>offcmd</strong> (<em>Required</em>): The action to take for off.</li>
</ul>
</li>
</ul>
</li>
</ul>
</article>

10
components/switch.edimax.html
View file

@ -125,6 +125,16 @@ This edimax switch platform allows you to control the state of your <a href="htt
</span><span class='line'> name: Edimax Smart Plug</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your Edimax switch, eg. 192.168.1.32</li>
<li><strong>username</strong> (<em>Required</em>): Your username for the Edimax switch.</li>
<li><strong>password</strong> (<em>Required</em>): Your password for the Edimax switch.</li>
<li><strong>name</strong> (<em>Optional</em>): The name to use when displaying this switch.</li>
</ul>
</article>

16
components/switch.hikvision.html
View file

@ -119,10 +119,20 @@ This hikvisioncam switch platform allows you to control your motion detection se
</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: hikvisioncam
</span><span class='line'> host: 192.168.1.32
</span><span class='line'> name: Hikvision Cam 1 Motion Detection
</span><span class='line'> host: 192.168.1.26
</span><span class='line'> username: YOUR_USERNAME
</span><span class='line'> password: YOUR_PASSWORD</span></code></pre></td></tr></table></div></figure>
</span><span class='line'> username: USERNAME
</span><span class='line'> password: PASSWORD</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> <em>Required</em>: The IP address of your Hikvision camera, eg. 192.168.1.32</li>
<li><strong>name</strong> <em>Optional</em>: This parameter allows you to override the name of your camera.</li>
<li><strong>username</strong> <em>Required</em>: The username for accessing your Hikvision camera.</li>
<li><strong>password</strong> <em>Required</em>: The password to access your Hikvision camera.</li>
</ul>

24
components/switch.mqtt.html
View file

@ -128,29 +128,37 @@ Try to enable it, if experiencing incorrect switch operation.</p>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
<span class='line-number'>9</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yml entr</span>
<span class='line-number'>10</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yml 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">mqtt</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="s">&quot;Bedroom</span><span class="nv"> </span><span class="s">Switch&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">state_topic</span><span class="p-Indicator">:</span> <span class="s">&quot;home/bedroom/switch1&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">command_topic</span><span class="p-Indicator">:</span> <span class="s">&quot;home/bedroom/switch1/set&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">qos</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">0</span>
</span><span class='line'> <span class="l-Scalar-Plain">payload_on</span><span class="p-Indicator">:</span> <span class="s">&quot;ON&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">payload_off</span><span class="p-Indicator">:</span> <span class="s">&quot;OFF&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">optimistic</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">false</span>
</span></code></pre></td></tr></table></div></figure>
<p>command_topic: The MQTT topic to publish commands to change the switch state. <em>Required</em></p>
<p>Configuration variables:</p>
<p>name: The name of the switch. Default is &lsquo;MQTT Switch&rsquo;. <em>Optional</em></p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): The name of the switch. Default is &lsquo;MQTT Switch&rsquo;.</li>
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates.</li>
<li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the switch state.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.</li>
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents enabled state. Default is &ldquo;ON&rdquo;.</li>
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents disabled state. Default is &ldquo;OFF&rdquo;.</li>
<li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.</li>
</ul>
<p>state_topic: The MQTT topic subscribed to receive state updates. <em>Optional</em></p>
<p>payload_on: The payload that represents enabled state. Default is &ldquo;ON&rdquo;. <em>Optional</em></p>
<p class='note warning'>
Make sure that your topics match exact. <code>some-topic/</code> and <code>some-topic</code> are different topics.
</p>
<p>payload_off: The payload that represents disabled state. Default is &ldquo;OFF&rdquo;. <em>Optional</em></p>
<p>optimistic: Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false. <em>Optional</em></p>
</article>

17
components/switch.transmission.html
View file

@ -120,15 +120,24 @@ The transmission platform allows you to control your <a href="http://www.transmi
</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">transmission</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Transmission</span>
</span><span class='line'> <span class="l-Scalar-Plain">host</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">192.168.1.26</span>
</span><span class='line'> <span class="l-Scalar-Plain">port</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">9091</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Transmission</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PASSWORD</span>
</span></code></pre></td></tr></table></div></figure>
<p><a href="https://github.com/fbradyirl">Finbarr Brady</a> has contributed the transmission switch platform.</p>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): This is the IP address of your Transmission daemon, e.g. 192.168.1.32.</li>
<li><strong>port</strong> (<em>Optional</em>): The port your Transmission daemon uses, defaults to 9091.</li>
<li><strong>name</strong> (<em>Optional</em>): The name to use when displaying this Transmission instance.</li>
<li><strong>username</strong> (<em>Optional</em>): Your Transmission username, if you use authentication.</li>
<li><strong>password</strong> (<em>Optional</em>): Your Transmission password, if you use authentication.</li>
</ul>
</article>

2
components/switch.wemo.html
View file

@ -114,7 +114,7 @@ The wemo platform allows you to control your <a href="http://www.belkin.com/us/p
<span class='line-number'>3</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="p-Indicator">-</span> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">wemo</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">wemo</span>
</span></code></pre></td></tr></table></div></figure>

9
components/tellstick.html
View file

@ -104,7 +104,8 @@
<hr class="divider">
<p>The TellStick Home Assistant integration allows users to add switches and sensors.</p>
<p><img src='/images/supported_brands/telldus_tellstick.png' class='brand pull-right' />
The TellStick Home Assistant integration allows users to add switches and sensors.</p>
<p>To get started, add the following information to your <code>configuration.yaml</code>:</p>
@ -124,7 +125,9 @@
<span class='line-number'>14</span>
<span class='line-number'>15</span>
<span class='line-number'>16</span>
</pre></td><td class='code'><pre><code class='YAML'><span class='line'><span class="l-Scalar-Plain">switch</span><span class="p-Indicator">:</span>
<span class='line-number'>17</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">tellstick</span>
</span><span class='line'>
</span><span class='line'><span class="l-Scalar-Plain">sensor</span><span class="p-Indicator">:</span>
@ -144,6 +147,8 @@
</article>

10
components/thermostat.nest.html
View file

@ -115,10 +115,16 @@ The nest thermostat platform let you control a thermostat from <a href="https://
<span class='line-number'>4</span>
</pre></td><td class='code'><pre><code class=''><span class='line'>thermostat:
</span><span class='line'> platform: nest
</span><span class='line'> username: myemail@mydomain.com
</span><span class='line'> password: mypassword</span></code></pre></td></tr></table></div></figure>
</span><span class='line'> username: USERNAME
</span><span class='line'> password: PASSWORD</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>username</strong> (<em>Required</em>): Your Nest username.</li>
<li><strong>password</strong> (<em>Required</em>): Your Nest password.</li>
</ul>
<p class='img'>

18
components/verisure.html
View file

@ -117,7 +117,7 @@
</ul>
<p>Username and password are required. Other variables are optional and allow you to disable certain devices.</p>
<p>To integrate Verisure with Home Assistant, add the following section to your <code>configuration.yaml</code> file:</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>
@ -129,8 +129,8 @@
<span class='line-number'>8</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">verisure</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">user@example.com</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">password</span>
</span><span class='line'> <span class="l-Scalar-Plain">username</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">PASSWORD</span>
</span><span class='line'> <span class="l-Scalar-Plain">alarm</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">1</span>
</span><span class='line'> <span class="l-Scalar-Plain">hygrometers</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">0</span>
</span><span class='line'> <span class="l-Scalar-Plain">smartplugs</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">1</span>
@ -138,6 +138,18 @@
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>username</strong> (<em>Required</em>): The username to Verisure mypages.</li>
<li><strong>password</strong> (<em>Required</em>): The password to Verisure mypages.</li>
<li><strong>alarm</strong> (<em>Optional</em>): Set to 1 to show alarm, 0 to disable. Default 1.</li>
<li><strong>hygrometers</strong> (<em>Optional</em>): Set to 1 to show hygrometers, 0 to disable. Default 1.</li>
<li><strong>smartplugs</strong> (<em>Optional</em>): Set to 1 to show smartplugs, 0 to disable. Default 1.</li>
<li><strong>thermometers</strong> (<em>Optional</em>): Set to 1 to show thermometers, 0 to disable. Default 1.</li>
</ul>
</article>

7
components/wink.html
View file

@ -126,6 +126,13 @@
</span><span class='line'> access_token: YOUR_ACCESS_TOKEN</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>access_token</strong> (<em>Required</em>): The retrieved access token.</li>
</ul>
<p>This will connect to the Wink hub and automatically set up any lights, switches and sensors that it finds.</p>
<p class='note'>

12
components/zwave.html
View file

@ -131,6 +131,18 @@
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>usb_path</strong> (<em>Required</em>): The port where your device is connected to your Home Assistant host.</li>
</ul>
<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>
</pre></td><td class='code'><pre><code class='bash'><span class='line'>ls /dev/ttyUSB*
</span></code></pre></td></tr></table></div></figure>
</article>