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

Site updated at 2016-09-11 01:34:03 UTC

Browse source
This commit is contained in:
Travis CI 2016-09-11 01:34:03 +00:00
parent 99424b497c
commit f143c60d71
311 changed files with 4596 additions and 1607 deletions
Download patch file Download diff file Expand all files Collapse all files

6
components/alarm_control_panel.nx584/index.html
View file

@ -96,14 +96,16 @@
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">alarm_control_panel</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">nx584</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">ADDRESS</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">5007</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Optional</em>): This is the host connection string (host:port) for the nx584 server process. If unset, it is assumed to be <code class="highlighter-rouge">localhost:5007</code>, which will work if the server process is running on the same system as home-assistant.</li>
<li><strong>host</strong> (<em>Optional</em>): The host where the nx584 server process is running. Defaults to localhost.</li>
<li><strong>port</strong> (<em>Optional</em>): The port where the Alarm panel ist listening. Defaults to 5007.</li>
</ul>

3
components/binary_sensor.apcupsd/index.html
View file

@ -193,6 +193,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.arest/index.html
View file

@ -211,6 +211,9 @@ This sensor is not suitable for fast state changes because there is a high possi
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.bloomsky/index.html
View file

@ -208,6 +208,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.command_line/index.html
View file

@ -257,6 +257,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.enocean/index.html
View file

@ -206,6 +206,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.envisalink/index.html
View file

@ -186,6 +186,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.ffmpeg/index.html
View file

@ -263,6 +263,9 @@ You need the <code class="highlighter-rouge">ffmpeg</code> binary in your system
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.homematic/index.html
View file

@ -198,6 +198,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.http/index.html
View file

@ -244,6 +244,9 @@ You should choose a unique device name (DEVICE_NAME) to avoid clashes with other
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.knx/index.html
View file

@ -184,6 +184,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.mqtt/index.html
View file

@ -242,6 +242,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.mysensors/index.html
View file

@ -295,6 +295,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.nest/index.html
View file

@ -224,6 +224,9 @@ You must have the <a href="/components/nest/">Nest component</a> configured to u
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.nx584/index.html
View file

@ -216,6 +216,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

16
components/binary_sensor.octoprint/index.html
View file

@ -89,12 +89,17 @@
<hr class="divider">
<p>The <code class="highlighter-rouge">OctoPrint</code> binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error.</p>
<p>The <code class="highlighter-rouge">octoprint</code> binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error.</p>
<p class="note">
You must have the <a href="/components/octoprint/">OctoPrint component</a> configured to use this sensor.
</p>
<p>To set it up, add the following information to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">binary_sensor</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">octoprint</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">OctoPrint</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">Printing</span>
<span class="pi">-</span> <span class="s">Printing Error</span>
@ -104,15 +109,15 @@
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor. Default is ‘OctoPrint’.</li>
<li><strong>monitored_conditions</strong> array (<em>Required</em>): States to monitor.
<ul>
<li>Printing</li>
<li>Printing Error</li>
<li><strong>Printing</strong>: State of the printer.</li>
<li><strong>Printing Error</strong>: Error while printing.</li>
</ul>
</li>
</ul>
<p class="note">You must have the <a href="/components/octoprint/">OctoPrint component</a> configured to use this sensor.</p>
</article>
@ -201,6 +206,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

5
components/binary_sensor.rest/index.html
View file

@ -113,6 +113,7 @@
<span class="s">name</span><span class="pi">:</span> <span class="s">REST GET binary sensor</span>
<span class="s">sensor_class</span><span class="pi">:</span> <span class="s">opening</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value_json.state</span><span class="nv"> </span><span class="s">}}'</span>
<span class="s">verify_ssl</span><span class="pi">:</span> <span class="s">False</span>
</code></pre>
</div>
@ -139,6 +140,7 @@
<li><strong>sensor_class</strong> (<em>Optional</em>): The <a href="/components/binary_sensor/">type/class</a> of the sensor to set the icon in the frontend.</li>
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the value.</li>
<li><strong>payload</strong> (<em>Optional</em>): The payload to send with a POST request. Usualy formed as a dictionary.</li>
<li><strong>verify_ssl</strong> (<em>Optional</em>): Verify the certification of the endpoint. Default to True.</li>
</ul>
<p class="note warning">
@ -235,6 +237,9 @@ Make sure that the URL matches exactly your endpoint or resource.
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

10
components/binary_sensor.rpi_gpio/index.html
View file

@ -120,13 +120,6 @@
<p>For more details about the GPIO layout, visit the Wikipedia <a href="https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector">article</a> about the Raspberry Pi.</p>
<p class="note warning">
If you are not running Raspbian Jessie, you will need to run Home Assistant as root.
</p>
<p class="note warning">
To avoid having to run Home Assistant as root when using this component, run a Raspbian version released at or after September 29, 2015.
</p>
</article>
@ -218,6 +211,9 @@ To avoid having to run Home Assistant as root when using this component, run a R
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.tcp/index.html
View file

@ -204,6 +204,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.template/index.html
View file

@ -259,6 +259,9 @@
<li>
Template Binary Sensor
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

288
components/binary_sensor.trend/index.html Normal file
View file

@ -0,0 +1,288 @@
<!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>Trend Binary Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Trend binary sensors into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.trend/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Trend Binary Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor.trend/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Trend binary sensors into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Trend Binary Sensor">
<meta name="twitter:description" content="Instructions how to integrate Trend binary sensors into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href='/getting-started/'>Getting started</a></li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook/'>Examples</a></li>
<li><a href="/developers/">Developers</a></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">
Trend Binary Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">trend</code> platform allows you to create sensors which show the trend of numeric <code class="highlighter-rouge">state</code> or<code class="highlighter-rouge">state_attributes</code> from other entities. This sensor requires two updates of the underlying sensor to establish a trend - so it can take some time to show an accurate state. It can be useful as part of automations, where you want to base an action on a trend.</p>
<p>To enable Trend binary sensors in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">binary_sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">trend</span>
<span class="s">sensors</span><span class="pi">:</span>
<span class="s">solar_angle</span><span class="pi">:</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Sun</span><span class="nv"> </span><span class="s">rising'</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">sun.sun</span>
<span class="s">sensor_class</span><span class="pi">:</span> <span class="s">light</span>
<span class="s">attribute</span><span class="pi">:</span> <span class="s">elevation</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>sensors</strong> array (<em>Required</em>): List of your sensors.
<ul>
<li><strong>friendly_name</strong> (<em>Optional</em>): Name to use in the Frontend.</li>
<li><strong>sensor_class</strong> (<em>Optional</em>): The <a href="/components/binary_sensor/">type/class</a> of the sensor to set the icon in the frontend.</li>
<li><strong>entity_id</strong> (<em>Required</em>): The entity that this sensor tracks.</li>
<li><strong>attribute</strong> (<em>Optional</em>): The attribute of the entity that this sensor tracks. If no attribute is specified - the sensor will track the state.</li>
<li><strong>invert</strong> (<em>Optional</em>): Invert the result (so <code class="highlighter-rouge">true</code> means decending rather than ascending)</li>
</ul>
</li>
</ul>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<p>In this section you find some real life examples of how to use this sensor.</p>
<h3><a class="title-link" name="temperature-trend" href="#temperature-trend"></a> Temperature trend</h3>
<p>This example indicates true if the temperture is rising:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">binary_sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">trend</span>
<span class="s">sensors</span><span class="pi">:</span>
<span class="s">temperature_up</span><span class="pi">:</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Temp</span><span class="nv"> </span><span class="s">increasing'</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">sensor.skylight_temperature</span>
<span class="s">sensor_class</span><span class="pi">:</span> <span class="s">heat</span>
</code></pre>
</div>
<p>And this one indicates true if the temperture is falling:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">binary_sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">trend</span>
<span class="s">sensors</span><span class="pi">:</span>
<span class="s">temperature_down</span><span class="pi">:</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Temp</span><span class="nv"> </span><span class="s">decreasing'</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">sensor.skylight_temperature</span>
<span class="s">sensor_class</span><span class="pi">:</span> <span class="s">cold</span>
<span class="s">invert</span><span class="pi">:</span> <span class="s">Yes</span>
</code></pre>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/binary_sensor.trend.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/home-assistant.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Push
</div>
<div class='section'>
Introduced in release: 0.28
</div>
<div class='section'>
<h1 class="title delta">Category Binary Sensor</h1>
<ul class='divided'>
<li>
<a href='/components/binary_sensor.apcupsd/'>APCUPSd Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.bloomsky/'>BloomSky Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.command_line/'>Command line Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.enocean/'>EnOcean Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.http/'>HTTP Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.homematic/'>Homematic Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.knx/'>KNX Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mysensors/'>MySensors Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.nx584/'>NX584 zones</a>
</li>
<li>
<a href='/components/binary_sensor.nest/'>Nest Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.octoprint/'>OctoPrint Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rest/'>RESTful Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.tcp/'>TCP Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
Trend Binary Sensor
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.wink/'>Wink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zwave/'>Z-Wave Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zigbee/'>ZigBee Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.arest/'>aREST Binary Sensor</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<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>

3
components/binary_sensor.vera/index.html
View file

@ -189,6 +189,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
Vera Binary Sensor
</li>

3
components/binary_sensor.wink/index.html
View file

@ -199,6 +199,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.zigbee/index.html
View file

@ -209,6 +209,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

3
components/binary_sensor.zwave/index.html
View file

@ -205,6 +205,9 @@
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>

19
components/binary_sensor/index.html
View file

@ -97,17 +97,19 @@
<ul>
<li><strong>None</strong>: Generic on/off</li>
<li><strong>opening</strong>: Door, window, etc</li>
<li><strong>motion</strong>: Motion sensor</li>
<li><strong>cold</strong>: On means cold (or too cold)</li>
<li><strong>connectivity</strong>: On means connection present, Off means no connection</li>
<li><strong>gas</strong>: CO, CO2, etc</li>
<li><strong>smoke</strong>: Smoke detector</li>
<li><strong>moisture</strong>: Specifically a wetness sensor</li>
<li><strong>heat</strong>: On means hot (or too hot)</li>
<li><strong>light</strong>: Lightness threshold</li>
<li><strong>moisture</strong>: Specifically a wetness sensor</li>
<li><strong>motion</strong>: Motion sensor</li>
<li><strong>moving</strong>: On means moving, Off means stopped</li>
<li><strong>occupancy</strong>: On means occupied, Off means not occupied</li>
<li><strong>opening</strong>: Door, window, etc</li>
<li><strong>power</strong>: Power, over-current, etc</li>
<li><strong>safety</strong>: On means unsafe, Off means safe</li>
<li><strong>heat</strong>: On means hot (or too hot)</li>
<li><strong>cold</strong>: On means cold (or too cold)</li>
<li><strong>moving</strong>: On means moving, Off means stopped</li>
<li><strong>smoke</strong>: Smoke detector</li>
<li><strong>sound</strong>: On means sound detected, Off means no sound</li>
<li><strong>vibration</strong>: On means vibration detected, Off means no vibration</li>
</ul>
@ -188,6 +190,9 @@
<li><a href='/components/binary_sensor.template/'>
Template Binary Sensor
</a></li>
<li><a href='/components/binary_sensor.trend/'>
Trend Binary Sensor
</a></li>
<li><a href='/components/binary_sensor.vera/'>
Vera Binary Sensor
</a></li>

8
components/camera.rpi_camera/index.html
View file

@ -89,7 +89,7 @@
<hr class="divider">
<p>The <code class="highlighter-rouge">rpi</code> platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application <a href="https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md"><code class="highlighter-rouge">raspistill</code></a> to store the image from camera.</p>
<p>The <code class="highlighter-rouge">rpi_camera</code> platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application <a href="https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md"><code class="highlighter-rouge">raspistill</code></a> to store the image from camera.</p>
<p>To enable this camera in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
@ -124,12 +124,6 @@
<p>The given <strong>file_path</strong> must be an existing file because the camera platform setup make a writeable check on it.</p>
<p>Ensure that the user who is running Home Assistant is in the video group. Eg. for the user <code class="highlighter-rouge">hass</code>:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo usermod -a -G video hass
</code></pre>
</div>
</article>

2
components/climate.homematic/index.html
View file

@ -89,7 +89,7 @@
<hr class="divider">
<p>The <code class="highlighter-rouge">homematic</code> cliamte platform lets you control <a href="http://www.homematic.com/">Homematic</a> thermostats through Home Assistant.</p>
<p>The <code class="highlighter-rouge">homematic</code> climate platform lets you control <a href="http://www.homematic.com/">Homematic</a> thermostats through Home Assistant.</p>
<p>Devices will be configured automatically. Please refer to the <a href="/components/homematic/">component</a> configuration on how to setup Homematic.</p>

2
components/climate.honeywell/index.html
View file

@ -89,7 +89,7 @@
<hr class="divider">
<p>The <code class="highlighter-rouge">honeywell</code> cliamte platform let you control <a href="http://getconnected.honeywell.com/en/">Honeywell Connected</a> thermostats from Home Assistant.</p>
<p>The <code class="highlighter-rouge">honeywell</code> climate platform let you control <a href="http://getconnected.honeywell.com/en/">Honeywell Connected</a> thermostats from Home Assistant.</p>
<p>To set it up, add the following information to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>

23
components/cover.command_line/index.html
View file

@ -97,11 +97,11 @@
<span class="s">cover</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">command_line</span>
<span class="s">covers</span><span class="pi">:</span>
<span class="s">Garage door</span><span class="pi">:</span>
<span class="s">opencmd</span><span class="pi">:</span> <span class="s">move_command up kitchen</span>
<span class="s">closecmd</span><span class="pi">:</span> <span class="s">move_command down kitchen</span>
<span class="s">stopcmd</span><span class="pi">:</span> <span class="s">move_command stop kitchen</span>
<span class="s">statecmd</span><span class="pi">:</span> <span class="s">state_command kitchen</span>
<span class="s">garage_door</span><span class="pi">:</span>
<span class="s">command_open</span><span class="pi">:</span> <span class="s">move_command up garage</span>
<span class="s">command_close</span><span class="pi">:</span> <span class="s">move_command down garage</span>
<span class="s">command_stop</span><span class="pi">:</span> <span class="s">move_command stop garage</span>
<span class="s">command_state</span><span class="pi">:</span> <span class="s">state_command garage</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="pi">&gt;</span>
<span class="no">{% if value == 'open' %}</span>
<span class="no">100</span>
@ -117,13 +117,14 @@
<ul>
<li><strong>covers</strong> (<em>Required</em>): The array that contains all command line covers.
<ul>
<li><strong>entry</strong> (<em>Required</em>): Name of the command line cover. Multiple entries are possible.
<li><strong>identifier</strong> (<em>Required</em>): Name of the command line cover as slug. Multiple entries are possible.
<ul>
<li><strong>opencmd</strong> (<em>Required</em>): The command to open the cover.</li>
<li><strong>closecmd</strong> (<em>Required</em>): The action to close the cover.</li>
<li><strong>stopcmd</strong> (<em>Required</em>): The action to stop the cover.</li>
<li><strong>statecmd</strong> (<em>Optional</em>): If given, this will act as a sensor that runs in the background and updates the state of the cover. If the command returns a <code class="highlighter-rouge">0</code> the indicates the cover is fully closed, whereas a 100 indicates the cover is fully open.</li>
<li><strong>value_template</strong> (<em>optional - default: ‘{{ value }}’</em>): if specified, <code class="highlighter-rouge">statecmd</code> will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your <code class="highlighter-rouge">statecmd</code> returns a string “open”, using <code class="highlighter-rouge">value_template</code> as in the example config above will allow you to translate that into the valid state <code class="highlighter-rouge">100</code>.</li>
<li><strong>command_open</strong> (<em>Required</em>): The command to open the cover.</li>
<li><strong>command_close</strong> (<em>Required</em>): The action to close the cover.</li>
<li><strong>command_stop</strong> (<em>Required</em>): The action to stop the cover.</li>
<li><strong>command_state</strong> (<em>Optional</em>): If given, this will act as a sensor that runs in the background and updates the state of the cover. If the command returns a <code class="highlighter-rouge">0</code> the indicates the cover is fully closed, whereas a 100 indicates the cover is fully open.</li>
<li><strong>value_template</strong> (<em>optional - default: ‘{{ value }}’</em>): if specified, <code class="highlighter-rouge">command_state</code> will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your <code class="highlighter-rouge">command_state</code> returns a string “open”, using <code class="highlighter-rouge">value_template</code> as in the example config above will allow you to translate that into the valid state <code class="highlighter-rouge">100</code>.</li>
<li><strong>friendly_name</strong> (<em>Optional</em>): The name used to display the cover in the frontend.</li>
</ul>
</li>
</ul>

3
components/device_tracker.actiontec/index.html
View file

@ -155,6 +155,9 @@ This device tracker needs telnet to be enabled on the router.
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.aruba/index.html
View file

@ -158,6 +158,9 @@ This device tracker needs telnet to be enabled on the router.
<li>
Aruba
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.asuswrt/index.html
View file

@ -156,6 +156,9 @@ You need to enable telnet on your router if you choose to use <code class="highl
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

254
components/device_tracker.automatic/index.html Normal file
View file

@ -0,0 +1,254 @@
<!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>Automatic - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions for how to integrate Automatic ODB readers into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/device_tracker.automatic/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Automatic">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/device_tracker.automatic/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions for how to integrate Automatic ODB readers into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Automatic">
<meta name="twitter:description" content="Instructions for how to integrate Automatic ODB readers into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href='/getting-started/'>Getting started</a></li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook/'>Examples</a></li>
<li><a href="/developers/">Developers</a></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">
Automatic
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">automatic</code> platform offers presence detection by retrieving your car’s information from the <a href="http://automatic.com/">Automatic</a> cloud service.</p>
<p>To use an Automatic ODB reader in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">device_tracker</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">automatic</span>
<span class="s">client_id</span><span class="pi">:</span> <span class="s">1234567</span>
<span class="s">secret</span><span class="pi">:</span> <span class="s">0987654321</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">your@email.com</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">your_password</span>
<span class="s">devices</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">2007 Honda Element</span>
<span class="pi">-</span> <span class="s">2004 Subaru Impreza</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>client_id</strong> (<em>Required</em>): The OAuth client id (get from https://developer.automatic.com/).</li>
<li><strong>secret</strong> (<em>Require</em>): The OAuth client secret (get from https://developer.automatic.com/).</li>
<li><strong>username</strong> (<em>Required</em>): The username associated with your ODB reader.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given ODB reader account.</li>
<li><strong>devices</strong> (<em>Optional</em>): The list of vehicle display names you wish to track. If not provided, all vehicles will be tracked.</li>
</ul>
<p>See the <a href="/components/device_tracker/">device tracker component page</a> for instructions how to configure the people to be tracked.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/device_tracker.automatic.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/automatic.png' />
</div>
<div class='section'>
Introduced in release: 0.28
</div>
<div class='section'>
This is a platform for
<a href='/components/device_tracker/'>the Device Tracker component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Presence Detection</h1>
<ul class='divided'>
<li>
<a href='/components/device_tracker.asuswrt/'>ASUSWRT</a>
</li>
<li>
<a href='/components/device_tracker.actiontec/'>Actiontec</a>
</li>
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
Automatic
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>
<li>
<a href='/components/device_tracker.bluetooth_le_tracker/'>Bluetooth LE Tracker</a>
</li>
<li>
<a href='/components/device_tracker.bluetooth_tracker/'>Bluetooth Tracker</a>
</li>
<li>
<a href='/components/device_tracker.ddwrt/'>DD-WRT</a>
</li>
<li>
<a href='/components/device_tracker.fritz/'>FRITZ!Box</a>
</li>
<li>
<a href='/components/device_tracker.locative/'>Locative</a>
</li>
<li>
<a href='/components/device_tracker.mqtt/'>MQTT Device Tracker</a>
</li>
<li>
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
</li>
<li>
<a href='/components/device_tracker.netgear/'>Netgear</a>
</li>
<li>
<a href='/components/device_tracker.nmap_scanner/'>Nmap</a>
</li>
<li>
<a href='/components/device_tracker.luci/'>OpenWRT (luci)</a>
</li>
<li>
<a href='/components/device_tracker.ubus/'>OpenWRT (ubus)</a>
</li>
<li>
<a href='/components/device_tracker.owntracks/'>Owntracks</a>
</li>
<li>
<a href='/components/device_tracker.snmp/'>SNMP</a>
</li>
<li>
<a href='/components/device_tracker.tplink/'>TP-Link</a>
</li>
<li>
<a href='/components/device_tracker.thomson/'>Thomson</a>
</li>
<li>
<a href='/components/device_tracker.tomato/'>Tomato</a>
</li>
<li>
<a href='/components/device_tracker.unifi/'>Ubiquiti Unifi WAP</a>
</li>
<li>
<a href='/components/device_tracker.icloud/'>iCloud</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<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>

3
components/device_tracker.bluetooth_le_tracker/index.html
View file

@ -148,6 +148,9 @@ Some BTLE devices (e.g. fitness trackers) are only visible to the devices that t
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

7
components/device_tracker.bluetooth_tracker/index.html
View file

@ -92,10 +92,6 @@
<p>This tracker discovers new devices on boot and tracks bluetooth devices periodically based on interval_seconds value. It is not required to pair the devices with each other!
Devices discovered are stored with ‘bt_’ as the prefix for device mac addresses in <code class="highlighter-rouge">known_devices.yaml</code>.</p>
<p class="note">
Requires PyBluez. If you are on Raspbian, make sure you first install <code class="highlighter-rouge">bluetooth</code> and <code class="highlighter-rouge">libbluetooth-dev</code> by running <code class="highlighter-rouge">sudo apt install bluetooth libbluetooth-dev</code>
</p>
<p>To use the Bluetooth tracker in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">device_tracker</span><span class="pi">:</span>
@ -145,6 +141,9 @@ Requires PyBluez. If you are on Raspbian, make sure you first install <code clas
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.bt_home_hub_5/index.html
View file

@ -143,6 +143,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
BT Home Hub 5
</li>

3
components/device_tracker.ddwrt/index.html
View file

@ -147,6 +147,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.fritz/index.html
View file

@ -156,6 +156,9 @@ It seems that it is not necessary to use it in current generation Fritz!Box rout
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.icloud/index.html
View file

@ -158,6 +158,9 @@ If you have two-factor authentication enabled on your iCloud account you will no
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.locative/index.html
View file

@ -148,6 +148,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.luci/index.html
View file

@ -157,6 +157,9 @@ Some installations have <a href="https://github.com/openwrt/luci/issues/576">a s
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.mqtt/index.html
View file

@ -192,6 +192,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.netgear/index.html
View file

@ -152,6 +152,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.nmap_scanner/index.html
View file

@ -144,6 +144,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

16
components/device_tracker.owntracks/index.html
View file

@ -99,6 +99,10 @@
<span class="s">device_tracker</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">owntracks</span>
<span class="s">max_gps_accuracy</span><span class="pi">:</span> <span class="s">200</span>
<span class="s">waypoints</span><span class="pi">:</span> <span class="s">True</span>
<span class="s">waypoint_whitelist</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">jon</span>
<span class="pi">-</span> <span class="s">ram</span>
</code></pre>
</div>
@ -106,6 +110,8 @@
<ul>
<li><strong>max_gps_accuracy</strong> (<em>Optional</em>): Sometimes Owntracks can report GPS location with a very low accuracy (few kilometers). That can trigger false zoning in your Home Assistant installation. With the parameter, you can filter these GPS reports. The number has to be in meter. For example, if you put 200 only GPS report with an accuracy under 200 will be take in account.</li>
<li><strong>waypoints</strong> (<em>Optional</em>): Owntracks users can define <a href="http://owntracks.org/booklet/features/waypoints/">waypoints</a> (a.k.a regions) which are similar in spirit to Home Assistant zones. If this configuration variable is <code class="highlighter-rouge">True</code>, the Owntracks users who are in <code class="highlighter-rouge">waypoint_whitelist</code> can export waypoints from the device and Home Assistant will import them as zone definitions. Defaults to <code class="highlighter-rouge">True</code>.</li>
<li><strong>waypoint_whitelist</strong> (<em>Optional</em>): A list of user names (as defined for <a href="https://home-assistant.io/components/device_tracker.owntracks/">Owntracks</a>) who can export their waypoints from Owntracks to Home Assistant. Defaults to all users who are connected to Home Assistant via Owntracks.</li>
</ul>
<h3><a class="title-link" name="using-owntracks-with-other-device-trackers" href="#using-owntracks-with-other-device-trackers"></a> Using Owntracks with other device trackers</h3>
@ -141,6 +147,13 @@
<h3><a class="title-link" name="using-mobile-and-fixed-ibeacons-together" href="#using-mobile-and-fixed-ibeacons-together"></a> Using mobile and fixed iBeacons together</h3>
<p>You can use iBeacons of both types together, so if you have a Zone <code class="highlighter-rouge">drive</code> with an iBeacon region called <code class="highlighter-rouge">-drive</code> and you arrive home with a mobile iBeacon called <code class="highlighter-rouge">-car</code>, then <code class="highlighter-rouge">device_tracker.beacon_car</code> will be set to a state of <code class="highlighter-rouge">drive</code>.</p>
<h3><a class="title-link" name="importing-owntracks-waypoints-as-zones" href="#importing-owntracks-waypoints-as-zones"></a> Importing Owntracks waypoints as zones</h3>
<p>By default, any Owntracks user connected to Home Assistant can export their waypoint definitions (from the <code class="highlighter-rouge">Export - Export to Endpoint</code> menu item) which will then be translated to zone definitions in Home Assistant. The zones will be named <code class="highlighter-rouge">&lt;user&gt;-&lt;device&gt; - &lt;waypoint name&gt;</code>. This functionality can be controlled in 2 ways:</p>
<ol>
<li>The configuration variable <code class="highlighter-rouge">waypoints</code> can be set to <code class="highlighter-rouge">False</code> which will disable importing waypoints for all users.</li>
<li>The configuration variable <code class="highlighter-rouge">waypoint_whitelist</code> can contain a list of users who are allowed to import waypoints.</li>
</ol>
</article>
@ -177,6 +190,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.snmp/index.html
View file

@ -168,6 +168,9 @@ This device tracker needs SNMP to be enabled on the router.
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.thomson/index.html
View file

@ -146,6 +146,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.tomato/index.html
View file

@ -148,6 +148,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.tplink/index.html
View file

@ -164,6 +164,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.ubus/index.html
View file

@ -185,6 +185,9 @@ file
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker.unifi/index.html
View file

@ -151,6 +151,9 @@
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

3
components/device_tracker/index.html
View file

@ -221,6 +221,9 @@
<li><a href='/components/device_tracker.aruba/'>
Aruba
</a></li>
<li><a href='/components/device_tracker.automatic/'>
Automatic
</a></li>
<li><a href='/components/device_tracker.bt_home_hub_5/'>
BT Home Hub 5
</a></li>

2
components/enocean/index.html
View file

@ -107,6 +107,7 @@
<ul>
<li>Eltako FUD61 dimmer</li>
<li>Eltako FT55 battery-less wall switch</li>
<li>Jung ENOA590WW battery-less wall switch</li>
<li>Permundo PSC234 (switch and power monitor)</li>
</ul>
@ -127,7 +128,6 @@
</ul>
</article>

3
components/foursquare/index.html
View file

@ -177,6 +177,9 @@
<li>
<a href='/components/sensor.twitch/'>Twitch</a>
</li>
<li>
<a href='/components/sensor.xbox_live/'>Xbox Live</a>
</li>
</ul>
</div>
</section>

92
components/index.html
View file

@ -103,7 +103,7 @@ Support for these components is provided by the Home Assistant community.
<div class="grid__item one-sixth lap-one-whole palm-one-whole">
<div class="filter-button-group">
<a href='#all' class="btn">All (399)</a>
<a href='#all' class="btn">All (405)</a>
<a href='#featured' class="btn featured">Featured</a>
@ -126,7 +126,7 @@ Support for these components is provided by the Home Assistant community.
<a href='#binary-sensor' class="btn">
Binary Sensor
(23)
(24)
</a>
@ -196,7 +196,7 @@ Support for these components is provided by the Home Assistant community.
<a href='#finance' class="btn">
Finance
(3)
(4)
</a>
@ -268,7 +268,7 @@ Support for these components is provided by the Home Assistant community.
<a href='#presence-detection' class="btn">
Presence Detection
(22)
(23)
</a>
@ -282,7 +282,7 @@ Support for these components is provided by the Home Assistant community.
<a href='#social' class="btn">
Social
(4)
(5)
</a>
@ -296,7 +296,7 @@ Support for these components is provided by the Home Assistant community.
<a href='#system-monitor' class="btn">
System Monitor
(9)
(11)
</a>
@ -540,6 +540,20 @@ Support for these components is provided by the Home Assistant community.
<a href='/components/device_tracker.automatic/'
class='presence-detection'
style='display: none'>
<div class='img-container'>
<img src='/images/supported_brands/automatic.png'>
</div>
<div class='title'>Automatic</div>
<div class='category'>Presence Detection</div>
</a>
<a href='/components/automation/'
class='automation'
style='display: none'>
@ -754,6 +768,18 @@ Support for these components is provided by the Home Assistant community.
<a href='/components/sensor.coinmarketcap/'
class='finance'
style='display: none'>
<div class='img-container'>
</div>
<div class='title'>CoinMarketCap</div>
<div class='category'>Finance</div>
</a>
<a href='/components/cover.command_line/'
class='cover'
style='display: none'>
@ -2364,6 +2390,18 @@ Support for these components is provided by the Home Assistant community.
<a href='/components/sensor.linux_battery/'
class='system-monitor'
style='display: none'>
<div class='img-container'>
</div>
<div class='title'>Linux Battery</div>
<div class='category'>System Monitor</div>
</a>
<a href='/components/notify.llamalab_automate/'
class='notifications'
style='display: none'>
@ -3436,6 +3474,20 @@ Support for these components is provided by the Home Assistant community.
<a href='/components/sensor.pi_hole/'
class='system-monitor'
style='display: none'>
<div class='img-container'>
<img src='/images/supported_brands/pi_hole.png'>
</div>
<div class='title'>Pi-Hole Sensor</div>
<div class='category'>System Monitor</div>
</a>
<a href='/components/pilight/'
class='hub'
style='display: none'>
@ -4720,6 +4772,20 @@ Support for these components is provided by the Home Assistant community.
<a href='/components/binary_sensor.trend/'
class='binary-sensor'
style='display: none'>
<div class='img-container'>
<img src='/images/supported_brands/home-assistant.png'>
</div>
<div class='title'>Trend Binary Sensor</div>
<div class='category'>Binary Sensor</div>
</a>
<a href='/components/notify.twilio_sms/'
class='notifications'
style='display: none'>
@ -5192,6 +5258,20 @@ Support for these components is provided by the Home Assistant community.
<a href='/components/sensor.xbox_live/'
class='social'
style='display: none'>
<div class='img-container'>
<img src='/images/supported_brands/xbox-live.png'>
</div>
<div class='title'>Xbox Live</div>
<div class='category'>Social</div>
</a>
<a href='/components/sensor.yr/'
class='weather'
style='display: none'>

14
components/light.flux_led/index.html
View file

@ -134,7 +134,7 @@
</code></pre>
</div>
<p>Will add two lights with given name:</p>
<p>Will add two lights with given name and create an automation rule to randomly set color each 45 seconds:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">light</span><span class="pi">:</span>
<span class="c1"># Example configuration.yaml entry</span>
@ -144,11 +144,21 @@
<span class="s">name</span><span class="pi">:</span> <span class="s">flux_lamppost</span>
<span class="s">192.168.0.109</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">flux_living_room_lamp</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="s">random_flux_living_room_lamp</span><span class="pi">:</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">time</span>
<span class="s">seconds</span><span class="pi">:</span> <span class="s1">'</span><span class="s">/45'</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.flux_living_room_lamp</span>
<span class="s">effect</span><span class="pi">:</span> <span class="s">random</span>
</code></pre>
</div>
</article>

10
components/media_player.directv/index.html
View file

@ -97,6 +97,7 @@
<span class="s">media_player</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">directv</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.10</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">8080</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">DirecTV Living Room</span>
</code></pre>
</div>
@ -104,11 +105,13 @@
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> <em>Optional</em>: Use only if you don’t want to scan for devices.</li>
<li><strong>name</strong> <em>Optional</em>: Use to give a specific name to the device.</li>
<li><strong>host</strong> (<em>Optional</em>): Use only if you don’t want to scan for devices.</li>
<li><strong>port</strong> (<em>Optional</em>): The port your receiver is using. Defaults to <code class="highlighter-rouge">8080</code>.</li>
<li><strong>name</strong> (<em>Optional</em>): Use to give a specific name to the device.</li>
</ul>
</article>
@ -124,6 +127,9 @@
<div class='brand-logo-container section'>
<img src='/images/supported_brands/directv.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.25
</div>

19
components/media_player.firetv/index.html
View file

@ -9,7 +9,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>FireTV - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Music Player Daemon into Home Assistant.">
<meta name="description" content="Instructions how to integrate FIre-TV into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/media_player.firetv/">
@ -19,14 +19,14 @@
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/media_player.firetv/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Music Player Daemon into Home Assistant.">
<meta property="og:description" content="Instructions how to integrate FIre-TV into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="FireTV">
<meta name="twitter:description" content="Instructions how to integrate Music Player Daemon into Home Assistant.">
<meta name="twitter:description" content="Instructions how to integrate FIre-TV into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
@ -123,7 +123,8 @@
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">media_player</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">firetv</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">localhost:5556</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">localhost</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">5556</span>
<span class="s">device</span><span class="pi">:</span> <span class="s">livingroom-firetv</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">My Amazon Fire TV</span>
</code></pre>
@ -132,13 +133,14 @@
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Optional</em>): Where <code class="highlighter-rouge">firetv-server</code> is running. Default is <em>localhost:5556</em>.</li>
<li><strong>device</strong> (<em>Optional</em>): The device ID, default is <em>default</em>.</li>
<li><strong>host</strong> (<em>Optional</em>): The host where <code class="highlighter-rouge">firetv-server</code> is running. Default is localhost.</li>
<li><strong>port</strong> (<em>Optional</em>): The port where <code class="highlighter-rouge">firetv-server</code> is running. Default is 5556.</li>
<li><strong>device</strong> (<em>Optional</em>): The device ID. Defaults to <code class="highlighter-rouge">default</code>.</li>
<li><strong>name</strong> (<em>Optional</em>): The friendly name of the device, default is ‘Amazon Fire TV’.</li>
</ul>
<p class="note warning">
Note that python-firetv has support for multiple Amazon Fire TV devices. If you have more than one configured, be sure to specify the device id used. Run <code class="highlighter-rouge">firetv-server -h</code> and/or view the source for complete capabilities.
Note that python-firetv has support for multiple Amazon Fire TV devices. If you have more than one configured, be sure to specify the device ID in <code class="highlighter-rouge">device</code>. Run <code class="highlighter-rouge">firetv-server -h</code> and/or view the source for complete capabilities.
</p>
@ -158,6 +160,9 @@ Note that python-firetv has support for multiple Amazon Fire TV devices. If you
<div class='brand-logo-container section'>
<img src='/images/supported_brands/firetv.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.7.6
</div>

2
components/media_player.kodi/index.html
View file

@ -109,7 +109,7 @@
<ul>
<li><strong>host</strong> (<em>Required</em>): The host name or address of the device that is running XBMC/Kodi</li>
<li><strong>port</strong> (<em>Required</em>): The port number, default 8080</li>
<li><strong>port</strong> (<em>Optional</em>): The port number. Defaults to 8080.</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>

6
components/media_player.mpchc/index.html
View file

@ -117,8 +117,8 @@ The MPC-HC web interface is highly insecure, and allows remote clients full play
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The host name or address of the device that is running MPC-HC</li>
<li><strong>port</strong> (<em>Required</em>): The port number, default 13579</li>
<li><strong>host</strong> (<em>Required</em>): The host name or address of the device that is running MPC-HC.</li>
<li><strong>port</strong> (<em>Optional</em>): The port number. Defaults to 13579.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the device used in the frontend.</li>
</ul>
@ -139,7 +139,7 @@ The MPC-HC web interface is highly insecure, and allows remote clients full play
<img src='/images/supported_brands/mpchc.png' />
</div>
<div class='section'>
Introduced in release: 0.25.0
Introduced in release: 0.25
</div>
<div class='section'>
This is a platform for

8
components/media_player.mpd/index.html
View file

@ -96,7 +96,7 @@
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">media_player</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">mpd</span>
<span class="s">server</span><span class="pi">:</span> <span class="s">IP_ADDRESS</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">6600</span>
<span class="s">location</span><span class="pi">:</span> <span class="s">bedroom</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">PASSWORD</span>
@ -106,9 +106,9 @@
<p>Configuration variables:</p>
<ul>
<li><strong>server</strong> (<em>Required</em>): IP address of the Music Player Daemon, eg. 192.168.1.32</li>
<li><strong>port</strong> (<em>Optional</em>): Port of the Music Player Daemon, defaults to 6600.</li>
<li><strong>location</strong> (<em>Optional</em>): Location of your Music Player Daemon.</li>
<li><strong>host</strong> (<em>Required</em>): IP address of the Host where Music Player Daemon is running.</li>
<li><strong>port</strong> (<em>Optional</em>): Port of the Music Player Daemon. Defaults to 6600.</li>
<li><strong>location</strong> (<em>Optional</em>): Location of your Music Player Daemon. Defaults to “MPD”.</li>
<li><strong>password</strong> (<em>Optional</em>): Password for your Music Player Daemon.</li>
</ul>

2
components/media_player.pandora/index.html
View file

@ -135,8 +135,6 @@ user <span class="o">=</span> you@youraccount.com
<img src="/images/screenshots/pandora_player.png" />
</p>
<p class="note warning">This is a new component and it has some issues. </p>
</article>

4
components/media_player.samsungtv/index.html
View file

@ -99,7 +99,9 @@
<span class="s">media_player</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">samsungtv</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.0.10</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">55000</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Living Room TV</span>
<span class="s">timeout</span><span class="pi">:</span> <span class="s">2</span>
</code></pre>
</div>
@ -107,7 +109,9 @@
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP of the Samsung Smart TV, eg. 192.168.0.10</li>
<li><strong>port</strong> (<em>Optional</em>): The port of the Samsung Smart TV. Defaults to 55000.</li>
<li><strong>name</strong> (<em>Optional</em>): The name you would like to give to the Samsung Smart TV.</li>
<li><strong>timeout</strong> (<em>Optional</em>): The time-out for the communication with the TV. Defaults to 0.</li>
</ul>
<p>Currently known supported models:</p>

17
components/modbus/index.html
View file

@ -137,6 +137,23 @@
<li><strong>parity</strong> (<em>Required</em>): The parity for the serial connection.</li>
</ul>
<h3><a class="title-link" name="services" href="#services"></a> Services</h3>
<table>
<thead>
<tr>
<th>Service</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>write_register</td>
<td>Write register. Requires <code class="highlighter-rouge">unit</code>, <code class="highlighter-rouge">address</code> and <code class="highlighter-rouge">value</code> fields. <code class="highlighter-rouge">value</code> can be either single value or an array</td>
</tr>
</tbody>
</table>
<h2><a class="title-link" name="building-on-top-of-modbus" href="#building-on-top-of-modbus"></a> Building on top of Modbus</h2>
<ul>

4
components/notify.file/index.html
View file

@ -98,7 +98,7 @@
<span class="s">name</span><span class="pi">:</span> <span class="s">NOTIFIER_NAME</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">file</span>
<span class="s">filename</span><span class="pi">:</span> <span class="s">FILENAME</span>
<span class="s">timestamp</span><span class="pi">:</span> <span class="s">1 or 0</span>
<span class="s">timestamp</span><span class="pi">:</span> <span class="s">true or false</span>
</code></pre>
</div>
@ -107,7 +107,7 @@
<ul>
<li><strong>name</strong> (<em>Optional</em>): Setting the optional parameter <code class="highlighter-rouge">name</code> allows multiple notifiers to be created. The default value is <code class="highlighter-rouge">notify</code>. The notifier will bind to the service <code class="highlighter-rouge">notify.NOTIFIER_NAME</code>.</li>
<li><strong>filename</strong> (<em>Required</em>): Name of the file to use. The file will be created if it doesn’t exist and saved in your <code class="highlighter-rouge">config/</code> folder.</li>
<li><strong>timestamp</strong> (<em>Optional</em>): Setting <code class="highlighter-rouge">timestamp</code> to 1 adds a timestamp to every entry.</li>
<li><strong>timestamp</strong> (<em>Optional</em>): Setting <code class="highlighter-rouge">timestamp</code> to True adds a timestamp to every entry.</li>
</ul>
<p>To use notifications, please see the <a href="/getting-started/automation/">getting started with automation page</a>.</p>

5
components/notify.smtp/index.html
View file

@ -100,7 +100,7 @@
<span class="s">server</span><span class="pi">:</span> <span class="s">MAIL_SERVER</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">YOUR_SMTP_PORT</span>
<span class="s">sender</span><span class="pi">:</span> <span class="s">SENDER_EMAIL_ADDRESS</span>
<span class="s">starttls</span><span class="pi">:</span> <span class="s">1 or 0</span>
<span class="s">starttls</span><span class="pi">:</span> <span class="s">true or false</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">YOUR_SMTP_USERNAME</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">YOUR_SMTP_PASSWORD</span>
<span class="s">recipient</span><span class="pi">:</span> <span class="s">YOUR_RECIPIENT</span>
@ -117,7 +117,8 @@
<li><strong>username</strong> (<em>Optional</em>): Username for the SMTP account.</li>
<li><strong>password</strong> (<em>Optional</em>): Password for the SMTP server that belongs to the given username. If the password contains a colon it need to be wrapped in apostrophes.</li>
<li><strong>recipient</strong> (<em>Required</em>): Recipient of the notification.</li>
<li><strong>starttls</strong> (<em>Optional</em>): Enables STARTTLS, eg. 1 or 0. Defaults to 0.</li>
<li><strong>starttls</strong> (<em>Optional</em>): Enables STARTTLS, eg. True or False. Defaults to False.</li>
<li><strong>debug</strong> (<em>Optional</em>): Enables Debug, eg. True or False. Defaults to False.</li>
</ul>
<p>To use the SMTP notification, refer to it in an automation or script like in this example:</p>

2
components/notify/index.html
View file

@ -141,7 +141,7 @@
</tbody>
</table>
<p>The notification component supports specifying <a href="/topics/templating/">templates</a> for both the <code class="highlighter-rouge">message</code> and the <code class="highlighter-rouge">title</code>. This will allow you to use the current state of Home Assistant in your notifications.</p>
<p>The notification component supports specifying <a href="/topics/templating/">templates</a> with <code class="highlighter-rouge">data_template</code>. This will allow you to use the current state of Home Assistant in your notifications.</p>
<p>In an <a href="https://home-assistant.io/getting-started/automation-action/">action</a> of your <a href="/getting-started/automation/">automation setup</a> it could look like this with a customized subject.</p>

6
components/octoprint/index.html
View file

@ -91,10 +91,10 @@
<p><a href="http://octoprint.org/">OctoPrint</a> is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors, you will have to setup sensors and binary sensors separately.</p>
<p>To get started with the OctoPrint API, please follow the directions on their <a href="http://docs.octoprint.org/en/master/api/general.html">site</a>. Once OctoPrint is configured you will need to add your API key and host to your configuration.yaml.</p>
<p>To get started with the OctoPrint API, please follow the directions on their <a href="http://docs.octoprint.org/en/master/api/general.html">site</a>. Once OctoPrint is configured you will need to add your API key and host to your <code class="highlighter-rouge">configuration.yaml</code>.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">octoprint</span><span class="pi">:</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">http://YOUR_OCTOPRINT_HOST</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">YOUR_OCTOPRINT_HOST</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">YOUR_API_KEY</span>
</code></pre>
</div>
@ -102,8 +102,8 @@
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): The retrieved api key.</li>
<li><strong>host</strong> (<em>Required</em>): The octoprint host.</li>
<li><strong>api_key</strong> (<em>Required</em>): The retrieved api key.</li>
</ul>
<p><strong>NOTE</strong> If your 3D printer isn’t connected to the OctoPrint server during the startup of Home Assistant this component will fail to load.</p>

3
components/sensor.bitcoin/index.html
View file

@ -182,6 +182,9 @@
<li>
Bitcoin
</li>
<li>
<a href='/components/sensor.coinmarketcap/'>CoinMarketCap</a>
</li>
<li>
<a href='/components/sensor.fixer/'>Fixer.io</a>
</li>

184
components/sensor.coinmarketcap/index.html Normal file
View file

@ -0,0 +1,184 @@
<!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>CoinMarketCap - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate CoinMarketCap data within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.coinmarketcap/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="CoinMarketCap">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.coinmarketcap/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate CoinMarketCap data within Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="CoinMarketCap">
<meta name="twitter:description" content="Instructions how to integrate CoinMarketCap data within Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href='/getting-started/'>Getting started</a></li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook/'>Examples</a></li>
<li><a href="/developers/">Developers</a></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">
CoinMarketCap
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">coinmarketcap</code> sensor platform displays various details about a crypto currency provided by <a href="http://coinmarketcap.com/">CoinMarketCap</a>.</p>
<p>To add the CoinMarketCap sensor to your installation, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">coinmarketcap</span>
<span class="s">currency</span><span class="pi">:</span> <span class="s">bitcoin</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>currency</strong> (<em>Optional</em>): The currency to display, eg. <code class="highlighter-rouge">bitcoin</code>, <code class="highlighter-rouge">litecoin</code>, <code class="highlighter-rouge">steem</code>, etc. Default is <code class="highlighter-rouge">bitcoin</code>.</li>
</ul>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.coinmarketcap.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Cloud Polling
</div>
<div class='section'>
Introduced in release: 0.28
</div>
<div class='section'>
<h1 class="title delta">Category Finance</h1>
<ul class='divided'>
<li>
<a href='/components/sensor.bitcoin/'>Bitcoin</a>
</li>
<li>
CoinMarketCap
</li>
<li>
<a href='/components/sensor.fixer/'>Fixer.io</a>
</li>
<li>
<a href='/components/sensor.openexchangerates/'>Open Exchange Rates</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<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>

6
components/sensor.cpuspeed/index.html
View file

@ -145,6 +145,12 @@
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>

6
components/sensor.fastdotcom/index.html
View file

@ -160,6 +160,12 @@
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>

3
components/sensor.fixer/index.html
View file

@ -141,6 +141,9 @@
<li>
<a href='/components/sensor.bitcoin/'>Bitcoin</a>
</li>
<li>
<a href='/components/sensor.coinmarketcap/'>CoinMarketCap</a>
</li>
<li>
Fixer.io
</li>

6
components/sensor.fritzbox_callmonitor/index.html
View file

@ -149,6 +149,12 @@ on TCP port 1012. It will assume the values <code class="highlighter-rouge">idle
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>

6
components/sensor.glances/index.html
View file

@ -198,6 +198,12 @@ Glances web server started on http://0.0.0.0:61208/
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>

2
components/sensor.gtfs/index.html
View file

@ -130,9 +130,11 @@
<li><strong>origin</strong> (<em>Required</em>): The stop ID of your origin station.</li>
<li><strong>destination</strong> (<em>Required</em>): The stop ID of your destination station.</li>
<li><strong>data</strong> (<em>Required</em>): The name of the ZIP file or folder containing the GTFS data. It must be located inside the <code class="highlighter-rouge">gtfs</code> folder of your configuration directory.</li>
<li><strong>name</strong> (<em>Optional</em>): Name to use in the frontend.</li>
</ul>
</article>

6
components/sensor.hp_ilo/index.html
View file

@ -189,6 +189,12 @@
<li>
HP ILO
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>

4
components/sensor.imap/index.html
View file

@ -99,7 +99,7 @@
<span class="s">server</span><span class="pi">:</span> <span class="s">imap.gmail.com</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">993</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Emails</span>
<span class="s">user</span><span class="pi">:</span> <span class="s">USERNAME</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">USERNAME</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">PASSWORD</span>
</code></pre>
</div>
@ -110,7 +110,7 @@
<li><strong>server</strong> (<em>Required</em>): The IP address or hostname of the IMAP server.</li>
<li><strong>port</strong> (<em>Required</em>): The port where the server is accessible.</li>
<li><strong>name</strong> (<em>Optional</em>): Name of the IMAP sensor.</li>
<li><strong>user</strong> (<em>Required</em>): Username for the IMAP server.</li>
<li><strong>username</strong> (<em>Required</em>): Username for the IMAP server.</li>
<li><strong>password</strong> (<em>Required</em>): Password for the IMAP server.</li>
</ul>

3
components/sensor.lastfm/index.html
View file

@ -154,6 +154,9 @@
<li>
<a href='/components/sensor.twitch/'>Twitch</a>
</li>
<li>
<a href='/components/sensor.xbox_live/'>Xbox Live</a>
</li>
</ul>
</div>
</section>

207
components/sensor.linux_battery/index.html Normal file
View file

@ -0,0 +1,207 @@
<!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>Linux Battery - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Linux Battery information into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.linux_battery/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Linux Battery">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.linux_battery/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Linux Battery information into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Linux Battery">
<meta name="twitter:description" content="Instructions how to integrate Linux Battery information into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href='/getting-started/'>Getting started</a></li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook/'>Examples</a></li>
<li><a href="/developers/">Developers</a></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">
Linux Battery
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">linux_battery</code> sensor platform is using the information stored in <code class="highlighter-rouge">/sys/class/power_supply/</code> on your local Linux system to display details about the current state of your battery.</p>
<p>To setup a battery sensor to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">linux_battery</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Laptop</span>
<span class="s">battery</span><span class="pi">:</span> <span class="s">1</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): Friendly name to use for the frontend. Default to “Battery”.</li>
<li><strong>battery</strong> (<em>Optional</em>): Number of the battery. Default to <code class="highlighter-rouge">1</code>.</li>
</ul>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.linux_battery.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.28
</div>
<div class='section'>
<h1 class="title delta">Category System Monitor</h1>
<ul class='divided'>
<li>
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
</li>
<li>
<a href='/components/sensor.fritzbox_callmonitor/'>FRITZ!Box</a>
</li>
<li>
<a href='/components/sensor.fastdotcom/'>Fast.com</a>
</li>
<li>
<a href='/components/sensor.glances/'>Glances</a>
</li>
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
Linux Battery
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>
<li>
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
</li>
<li>
<a href='/components/sensor.supervisord/'>Supervisord</a>
</li>
<li>
<a href='/components/sensor.systemmonitor/'>System Monitor</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<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>

8
components/sensor.mfi/index.html
View file

@ -100,8 +100,8 @@
<span class="s">port</span><span class="pi">:</span> <span class="s">PORT</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">USERNAME</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">PASSWORD</span>
<span class="s">use_tls</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">verify_tls</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">ssl</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">verify_ssl</span><span class="pi">:</span> <span class="s">true</span>
</code></pre>
</div>
@ -112,8 +112,8 @@
<li><strong>port</strong> (<em>Optional</em>): The port of your mFi controller. Defaults to 6443 for TLS, otherwise 6080.</li>
<li><strong>username</strong> (<em>Required</em>): The mFi admin username.</li>
<li><strong>password</strong> (<em>Required</em>): The mFi admin user’s password.</li>
<li><strong>use_tls</strong> (<em>Optional</em>): If true, use TLS to contact the mFi controller. Defaults to true.</li>
<li><strong>verify_tls</strong> (<em>Optional</em>): Set this to false if your mFi controller has a self-signed certificate. Defaults to true.</li>
<li><strong>ssl</strong> (<em>Optional</em>): If <code class="highlighter-rouge">True</code>, use SSL/TLS to contact the mFi controller. Defaults to <code class="highlighter-rouge">True</code>.</li>
<li><strong>verify_ssl</strong> (<em>Optional</em>): Set this to <code class="highlighter-rouge">False</code> if your mFi controller has a self-signed certificate. Defaults to <code class="highlighter-rouge">True</code>.</li>
</ul>

3
components/sensor.mqtt_room/index.html
View file

@ -166,6 +166,9 @@ Instead of developing your own application, you can also use any of these alread
<li>
<a href='/components/device_tracker.aruba/'>Aruba</a>
</li>
<li>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</li>
<li>
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
</li>

15
components/sensor.octoprint/index.html
View file

@ -89,12 +89,17 @@
<hr class="divider">
<p>The <code class="highlighter-rouge">OctoPrint</code> sensor platform let you monitor various states of your 3D printer and its print jobs.</p>
<p>The <code class="highlighter-rouge">octoprint</code> sensor platform let you monitor various states of your 3D printer and its print jobs.</p>
<p class="note">
You must have the <a href="/components/octoprint/">OctoPrint component</a> configured to use this sensor.
</p>
<p>To set it up, add the following information to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">sensor</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">octoprint</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">OctoPrint</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">Current State</span>
<span class="pi">-</span> <span class="s">Temperatures</span>
@ -105,16 +110,16 @@
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor. Default is ‘OctoPrint’.</li>
<li><strong>monitored_conditions</strong> array (<em>Required</em>): States to monitor.
<ul>
<li>Current State (Text of current state)</li>
<li>Temperatures (Temperatures of all available tools)(print head, print bed, …) These will be displayed as tool0, tool1, … please refer to your OctoPrint frontend to associate tool number with actual device.</li>
<li>Job Percentage</li>
<li><strong>Current State</strong>: Text of current state)</li>
<li><strong>Temperatures</strong>: Temperatures of all available tools, eg. <code class="highlighter-rouge">print</code>, <code class="highlighter-rouge">head</code>, <code class="highlighter-rouge">print bed</code>, etc. These will be displayed as <code class="highlighter-rouge">tool0</code>, <code class="highlighter-rouge">tool1</code>, or <code class="highlighter-rouge">toolN</code> please refer to your OctoPrint frontend to associate the tool number with an actual device.</li>
<li><strong>Job Percentage</strong>:</li>
</ul>
</li>
</ul>
<p class="note">You must have the <a href="/components/octoprint/">OctoPrint component</a> configured to use this sensor.</p>
</article>

3
components/sensor.openexchangerates/index.html
View file

@ -142,6 +142,9 @@
<li>
<a href='/components/sensor.bitcoin/'>Bitcoin</a>
</li>
<li>
<a href='/components/sensor.coinmarketcap/'>CoinMarketCap</a>
</li>
<li>
<a href='/components/sensor.fixer/'>Fixer.io</a>
</li>

206
components/sensor.pi_hole/index.html Normal file
View file

@ -0,0 +1,206 @@
<!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>Pi-Hole Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate REST sensors into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.pi_hole/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Pi-Hole Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.pi_hole/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate REST sensors into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Pi-Hole Sensor">
<meta name="twitter:description" content="Instructions how to integrate REST sensors into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href='/getting-started/'>Getting started</a></li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook/'>Examples</a></li>
<li><a href="/developers/">Developers</a></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">
Pi-Hole Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">pi_hole</code> sensor platform is displaying the statistical summary of a <a href="https://pi-hole.net/">Pi-Hole</a> system.</p>
<p>To enable this sensor, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code> file for a GET request:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">pi_hole</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.2</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Optional</em>): The IP address of the Pi-Hole system. Defaults to <code class="highlighter-rouge">localhost</code>.</li>
</ul>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.pi_hole.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/pi_hole.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.28
</div>
<div class='section'>
<h1 class="title delta">Category System Monitor</h1>
<ul class='divided'>
<li>
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
</li>
<li>
<a href='/components/sensor.fritzbox_callmonitor/'>FRITZ!Box</a>
</li>
<li>
<a href='/components/sensor.fastdotcom/'>Fast.com</a>
</li>
<li>
<a href='/components/sensor.glances/'>Glances</a>
</li>
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
Pi-Hole Sensor
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>
<li>
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
</li>
<li>
<a href='/components/sensor.supervisord/'>Supervisord</a>
</li>
<li>
<a href='/components/sensor.systemmonitor/'>System Monitor</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<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>

2
components/sensor.rest/index.html
View file

@ -115,6 +115,7 @@
<span class="s">payload</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{</span><span class="nv"> </span><span class="s">"device"</span><span class="nv"> </span><span class="s">:</span><span class="nv"> </span><span class="s">"heater"</span><span class="nv"> </span><span class="s">}'</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">REST POST sensor</span>
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s2">"</span><span class="s">°C"</span>
<span class="s">verify_ssl</span><span class="pi">:</span> <span class="s">False</span>
</code></pre>
</div>
@ -127,6 +128,7 @@
<li><strong>payload</strong> (<em>Optional</em>): The payload to send with a POST request. Depends on the service, but usually formed as JSON.</li>
<li><strong>name</strong> (<em>Optional</em>): Name of the REST sensor.</li>
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the unit of measurement of the sensor, if any.</li>
<li><strong>verify_ssl</strong> (<em>Optional</em>): Verify the certification of the endpoint. Default to True.</li>
</ul>
<p class="note warning">

2
components/sensor.sabnzbd/index.html
View file

@ -100,6 +100,7 @@
<span class="s">api_key</span><span class="pi">:</span> <span class="s">YOUR_API_KEY</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">YOUR_SABNZBD_HOST</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">8080</span>
<span class="s">ssl</span><span class="pi">:</span> <span class="s">True</span>
<span class="s">monitored_variables</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">current_status'</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">speed'</span>
@ -117,6 +118,7 @@
<li><strong>port</strong> (<em>Optional</em>): The port to use whith SABnzbd instance. Defaults to <code class="highlighter-rouge">8080</code>.</li>
<li><strong>api_key</strong> (<em>Required</em>): Name that will be used in the frontend for the pin.</li>
<li><strong>name</strong> (<em>Optional</em>): The name to use when displaying this SABnzbd instance.</li>
<li><strong>ssl</strong> (<em>Optional</em>): Use <code class="highlighter-rouge">https</code> instead of <code class="highlighter-rouge">http</code> to connect. Defaults to False.</li>
<li><strong>monitored_variables</strong> array (<em>Required</em>): List of the monitored variables.
<ul>
<li><strong>current_status</strong>: current status of the SABnzbd instance</li>

6
components/sensor.snmp/index.html
View file

@ -180,6 +180,12 @@ laLoad.1 <span class="o">=</span> STRING: 0.19
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
SNMP
</li>

10
components/sensor.speedtest/index.html
View file

@ -91,7 +91,7 @@
<p>The <code class="highlighter-rouge">speedtest</code> sensor component uses the <a href="https://speedtest.net/">Speedtest.net</a> web service to measure network bandwidth performance.</p>
<p>By default, it will run every hour. The user can change the update frequency in the config by defining the minute, hour, and day for a speedtest to run.</p>
<p>By default, it will run every hour. The user can change the update frequency in the configuration by defining the minute, hour, and day for a speedtest to run. For the <code class="highlighter-rouge">server_id</code> check the list of <a href="https://www.speedtest.net/speedtest-servers.php">available servers</a>.</p>
<p>To add a Speedtest.net sensor to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
@ -99,6 +99,7 @@
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">sensor</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">speedtest</span>
<span class="s">server_id</span><span class="pi">:</span> <span class="s">1234</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">ping</span>
<span class="pi">-</span> <span class="s">download</span>
@ -149,6 +150,7 @@
<li><strong>upload</strong>: Upload speed in Mbps.</li>
</ul>
</li>
<li><strong>server_id</strong> (<em>Optional</em>): Specify the speedtest server to perform test against.</li>
<li><strong>minute</strong> (<em>Optional</em>): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.</li>
<li><strong>hour</strong> (<em>Optional</em>): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.</li>
<li><strong>day</strong> (<em>Optional</em>): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.</li>
@ -195,6 +197,12 @@
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>

3
components/sensor.steam_online/index.html
View file

@ -167,6 +167,9 @@
<li>
<a href='/components/sensor.twitch/'>Twitch</a>
</li>
<li>
<a href='/components/sensor.xbox_live/'>Xbox Live</a>
</li>
</ul>
</div>
</section>

6
components/sensor.supervisord/index.html
View file

@ -143,6 +143,12 @@
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>

6
components/sensor.systemmonitor/index.html
View file

@ -244,6 +244,12 @@
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>

14
components/sensor.temper/index.html
View file

@ -96,9 +96,23 @@
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">temper</span>
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">My</span><span class="nv"> </span><span class="s">TEMPer'</span>
<span class="s">scale</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">offset</span><span class="pi">:</span> <span class="s">0</span>
</code></pre>
</div>
<p>Since some of these sensors consistently show higher temperatures the scale and offset values can be used to fine-tune your sensor.
The calculation follows the formula <code class="highlighter-rouge">scale * sensor value + offset</code>.</p>
<p>The TEMPer sensors can only be accessed as root by default. To fix the USB permissions on your system create the file <code class="highlighter-rouge">/etc/udev/rules.d/99-tempsensor.rules</code> and add the following line to it:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>SUBSYSTEMS=="usb", ACTION=="add", ATTRS{idVendor}=="0c45", ATTRS{idProduct}=="7401", MODE="666"
</code></pre>
</div>
<p>After that re-plug the device and restart Home Assistant.</p>
</article>

3
components/sensor.twitch/index.html
View file

@ -147,6 +147,9 @@
<li>
Twitch
</li>
<li>
<a href='/components/sensor.xbox_live/'>Xbox Live</a>
</li>
</ul>
</div>
</section>

16
components/sensor.wunderground/index.html
View file

@ -89,10 +89,10 @@
<hr class="divider">
<p>The <code class="highlighter-rouge">wunderground</code> platform uses <a href="http://www.wunderground.com">Weather Underground</a> as an source for current weather information.</p>
<p>The <code class="highlighter-rouge">wunderground</code> platform uses <a href="http://www.wunderground.com">Weather Underground</a> as a source for current weather information.</p>
<p class="note warning">
Obtain WUnderground API <a href="https://www.wunderground.com/weather/api">here</a>. Free account allows 500 requests per day or 10 per minute.
Obtain a WUnderground API key <a href="https://www.wunderground.com/weather/api">here</a>. A free account allows 500 requests per day or 10 per minute.
</p>
<p>To add Wunderground to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
@ -137,21 +137,21 @@ Obtain WUnderground API <a href="https://www.wunderground.com/weather/api">here<
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (Required): See above</li>
<li><strong>pws_id</strong> (Optional): You can enter your PWS id. Current list of Wunderground PWS stations is available <a href="https://www.wunderground.com/weatherstation/ListStations.asp">here</a>. If you do not enter the PWS ID, the current location information (latitude and longitude) from your <code class="highlighter-rouge">configuration.yaml</code> will be used to display weather conditions.</li>
<li><strong>pws_id</strong> (Optional): You can enter a Personal Weather Station id. The current list of Wunderground PWS stations is available <a href="https://www.wunderground.com/weatherstation/ListStations.asp">here</a>. If you do not enter a PWS ID, the current location information (latitude and longitude) from your <code class="highlighter-rouge">configuration.yaml</code> will be used to display weather conditions.</li>
<li><strong>monitored_conditions</strong> array (<em>Required</em>): Conditions to display in the frontend. The following conditions can be monitored.
<ul>
<li><strong>weather</strong>: A human-readable text summary with picture from Wunderground.</li>
<li><strong>temp_f</strong>: Current temperature in Fahrenheit</li>
<li><strong>temp_c</strong>: Current temperature in Celsius</li>
<li><strong>station_id</strong>: Your personal weather station (PWS) ID</li>
<li><strong>feelslike_c</strong>: Feels like (or apparent) temperature in celsius</li>
<li><strong>feelslike_c</strong>: Feels like (or apparent) temperature in Celsius</li>
<li><strong>feelslike_f</strong>: Feels like (or apparent) temperature in Fahrenheit</li>
<li><strong>feelslike_string</strong>: Text summary of how the current teperature feels like</li>
<li><strong>feelslike_string</strong>: Text summary of how the current temperature feels like</li>
<li><strong>heat_index_c</strong>: Heat index (combined effects of the temperature and humidity of the air) in Celsius</li>
<li><strong>heat_index_f</strong>: Heat index (combined effects of the temperature and humidity of the air) in Fahrenheit</li>
<li><strong>heat_index_string</strong>: Text summary of current heat index</li>
<li><strong>dewpoint_c</strong>: Temperature in celsius below which water droplets begin to condense and dew can form</li>
<li><strong>dewpoint_f</strong>: Temperature in fahrenheit below which water droplets begin to condense and dew can form</li>
<li><strong>dewpoint_c</strong>: Temperature in Celsius below which water droplets begin to condense and dew can form</li>
<li><strong>dewpoint_f</strong>: Temperature in Fahrenheit below which water droplets begin to condense and dew can form</li>
<li><strong>dewpoint_string</strong>: Text summary of dew point</li>
<li><strong>wind_kph</strong>: Current wind speed in kph</li>
<li><strong>wind_mph</strong>: Current wind speed in mph</li>
@ -160,7 +160,7 @@ Obtain WUnderground API <a href="https://www.wunderground.com/weather/api">here<
<li><strong>pressure_mb</strong>: Atmospheric air pressure in millibars</li>
<li><strong>wind_dir</strong>: Wind direction</li>
<li><strong>wind_string</strong>: Text summary of current wind conditions</li>
<li><strong>relative_humidity</strong>: Reltive humidity</li>
<li><strong>relative_humidity</strong>: Relative humidity</li>
<li><strong>visibility_mi</strong>: Average visibility in miles</li>
<li><strong>visibility_km</strong>: Average visibility in km</li>
<li><strong>precip_today_in</strong>: Total precipitation in inches</li>

197
components/sensor.xbox_live/index.html Normal file
View file

@ -0,0 +1,197 @@
<!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>Xbox Live - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to set up Xbox Live sensors in Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.xbox_live/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Xbox Live">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.xbox_live/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to set up Xbox Live sensors in Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Xbox Live">
<meta name="twitter:description" content="Instructions on how to set up Xbox Live sensors in Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href='/getting-started/'>Getting started</a></li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook/'>Examples</a></li>
<li><a href="/developers/">Developers</a></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">
Xbox Live
</h1>
</header>
<hr class="divider">
<p>The Xbox Live component is able to track <a href="http://xbox.com/">Xbox</a> profiles.</p>
<p>To use this sensor you need a free API key from <a href="http://xboxapi.com">XboxAPI.com</a>.
Please also make sure to connect your Xbox account on that site.</p>
<p>The configuration requires you to specify XUIDs which are the unique identifiers for profiles.
These can be determined on <a href="http://xboxapi.com">XboxAPI.com</a> by either looking at your own profile page or using their interactive documentation to search for gamertags.</p>
<p>To use the Xbox Live sensor in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">xbox_live</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">YOUR_API_KEY</span>
<span class="s">xuid</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">account1</span>
<span class="pi">-</span> <span class="s">account2</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): Your API key from <a href="http://xboxapi.com">XboxAPI.com</a>.</li>
<li><strong>xuid</strong> (<em>Required</em>): Array of profile XUIDs to be tracked.</li>
</ul>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.xbox_live.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/xbox-live.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Cloud Polling
</div>
<div class='section'>
Introduced in release: 0.28
</div>
<div class='section'>
<h1 class="title delta">Category Social</h1>
<ul class='divided'>
<li>
<a href='/components/foursquare/'>Foursquare</a>
</li>
<li>
<a href='/components/sensor.lastfm/'>Last.fm</a>
</li>
<li>
<a href='/components/sensor.steam_online/'>Steam</a>
</li>
<li>
<a href='/components/sensor.twitch/'>Twitch</a>
</li>
<li>
Xbox Live
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<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>

12
components/sensor/index.html
View file

@ -126,6 +126,9 @@
<li><a href='/components/sensor.cpuspeed/'>
CPU speed
</a></li>
<li><a href='/components/sensor.coinmarketcap/'>
CoinMarketCap
</a></li>
<li><a href='/components/sensor.command_line/'>
Command line Sensor
</a></li>
@ -192,6 +195,9 @@
<li><a href='/components/sensor.lastfm/'>
Last.fm
</a></li>
<li><a href='/components/sensor.linux_battery/'>
Linux Battery
</a></li>
<li><a href='/components/sensor.loop_energy/'>
Loop Energy
</a></li>
@ -246,6 +252,9 @@
<li><a href='/components/sensor.serial_pm/'>
Particulate matter Sensor
</a></li>
<li><a href='/components/sensor.pi_hole/'>
Pi-Hole Sensor
</a></li>
<li><a href='/components/sensor.plex/'>
Plex Activity Monitor
</a></li>
@ -330,6 +339,9 @@
<li><a href='/components/sensor.worldclock/'>
Worldclock
</a></li>
<li><a href='/components/sensor.xbox_live/'>
Xbox Live
</a></li>
<li><a href='/components/sensor.yr/'>
YR
</a></li>

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

@ -98,10 +98,11 @@
<span class="s">platform</span><span class="pi">:</span> <span class="s">command_line</span>
<span class="s">switches</span><span class="pi">:</span>
<span class="s">kitchen_light</span><span class="pi">:</span>
<span class="s">oncmd</span><span class="pi">:</span> <span class="s">switch_command on kitchen</span>
<span class="s">offcmd</span><span class="pi">:</span> <span class="s">switch_command off kitchen</span>
<span class="s">statecmd</span><span class="pi">:</span> <span class="s">query_command kitchen</span>
<span class="s">command_on</span><span class="pi">:</span> <span class="s">switch_command on kitchen</span>
<span class="s">command_off</span><span class="pi">:</span> <span class="s">switch_command off kitchen</span>
<span class="s">command_state</span><span class="pi">:</span> <span class="s">query_command kitchen</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value</span><span class="nv"> </span><span class="s">==</span><span class="nv"> </span><span class="s">"online"</span><span class="nv"> </span><span class="s">}}'</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Kitchen switch</span>
</code></pre>
</div>
@ -110,12 +111,13 @@
<ul>
<li><strong>switches</strong> (<em>Required</em>): The array that contains all command switches.
<ul>
<li><strong>entry</strong> (<em>Required</em>): Name of the command switch. Multiple entries are possible.
<li><strong>identifier</strong> (<em>Required</em>): Name of the command switch as slug. 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>
<li><strong>statecmd</strong> (<em>Optional</em>): If given, this command will be run. Returning a result code <code class="highlighter-rouge">0</code> will indicate that the switch is on.</li>
<li><strong>value_template</strong> (<em>Optional</em>): If specified, statecmd will ignore the result code of the command but the template evaluating to <code class="highlighter-rouge">true</code> will indicate the switch is on.</li>
<li><strong>command_on</strong> (<em>Required</em>): The action to take for on.</li>
<li><strong>command_off</strong> (<em>Required</em>): The action to take for off.</li>
<li><strong>command_state</strong> (<em>Optional</em>): If given, this command will be run. Returning a result code <code class="highlighter-rouge">0</code> will indicate that the switch is on.</li>
<li><strong>value_template</strong> (<em>Optional</em>): If specified, <code class="highlighter-rouge">command_state</code> will ignore the result code of the command but the template evaluating to <code class="highlighter-rouge">true</code> will indicate the switch is on.</li>
<li><strong>friendly_name</strong> (<em>Optional</em>): The name used to display the switch in the frontend.</li>
</ul>
</li>
</ul>
@ -135,8 +137,8 @@
<span class="s">platform</span><span class="pi">:</span> <span class="s">command_line</span>
<span class="s">switches</span><span class="pi">:</span>
<span class="s">arest_pin4</span><span class="pi">:</span>
<span class="s">oncmd</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/usr/bin/curl</span><span class="nv"> </span><span class="s">-X</span><span class="nv"> </span><span class="s">GET</span><span class="nv"> </span><span class="s">http://192.168.1.10/digital/4/1"</span>
<span class="s">offcmd</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/usr/bin/curl</span><span class="nv"> </span><span class="s">-X</span><span class="nv"> </span><span class="s">GET</span><span class="nv"> </span><span class="s">http://192.168.1.10/digital/4/0"</span>
<span class="s">command_on</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/usr/bin/curl</span><span class="nv"> </span><span class="s">-X</span><span class="nv"> </span><span class="s">GET</span><span class="nv"> </span><span class="s">http://192.168.1.10/digital/4/1"</span>
<span class="s">command_off</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/usr/bin/curl</span><span class="nv"> </span><span class="s">-X</span><span class="nv"> </span><span class="s">GET</span><span class="nv"> </span><span class="s">http://192.168.1.10/digital/4/0"</span>
</code></pre>
</div>
@ -153,7 +155,7 @@ This switch will shutdown your host immediately, there will be no confirmation.
<span class="s">platform</span><span class="pi">:</span> <span class="s">command_line</span>
<span class="s">switches</span><span class="pi">:</span>
<span class="s">Home Assistant system shutdown</span><span class="pi">:</span>
<span class="s">offcmd</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/usr/sbin/poweroff"</span>
<span class="s">command_off</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/usr/sbin/poweroff"</span>
</code></pre>
</div>
@ -166,8 +168,8 @@ This switch will shutdown your host immediately, there will be no confirmation.
<span class="s">platform</span><span class="pi">:</span> <span class="s">command_line</span>
<span class="s">switches</span><span class="pi">:</span>
<span class="s">VLC</span><span class="pi">:</span>
<span class="s">oncmd</span><span class="pi">:</span> <span class="s2">"</span><span class="s">cvlc</span><span class="nv"> </span><span class="s">1.mp3</span><span class="nv"> </span><span class="s">vlc://quit</span><span class="nv"> </span><span class="s">&amp;"</span>
<span class="s">offcmd</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pkill</span><span class="nv"> </span><span class="s">vlc"</span>
<span class="s">command_on</span><span class="pi">:</span> <span class="s2">"</span><span class="s">cvlc</span><span class="nv"> </span><span class="s">1.mp3</span><span class="nv"> </span><span class="s">vlc://quit</span><span class="nv"> </span><span class="s">&amp;"</span>
<span class="s">command_off</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pkill</span><span class="nv"> </span><span class="s">vlc"</span>
</code></pre>
</div>
@ -180,9 +182,9 @@ This switch will shutdown your host immediately, there will be no confirmation.
<span class="s">platform</span><span class="pi">:</span> <span class="s">command_line</span>
<span class="s">switches</span><span class="pi">:</span>
<span class="s">foscam_motion</span><span class="pi">:</span>
<span class="s">oncmd</span><span class="pi">:</span> <span class="s1">'</span><span class="s">curl</span><span class="nv"> </span><span class="s">-k</span><span class="nv"> </span><span class="s">"https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&amp;isEnable=1&amp;usr=admin&amp;pwd=password"'</span>
<span class="s">offcmd</span><span class="pi">:</span> <span class="s1">'</span><span class="s">curl</span><span class="nv"> </span><span class="s">-k</span><span class="nv"> </span><span class="s">"https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&amp;isEnable=0&amp;usr=admin&amp;pwd=password"'</span>
<span class="s">statecmd</span><span class="pi">:</span> <span class="s1">'</span><span class="s">curl</span><span class="nv"> </span><span class="s">-k</span><span class="nv"> </span><span class="s">--silent</span><span class="nv"> </span><span class="s">"https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=getMotionDetectConfig&amp;usr=admin&amp;pwd=password"</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">grep</span><span class="nv"> </span><span class="s">-oP</span><span class="nv"> </span><span class="s">"(?&lt;=isEnable&gt;).*?(?=&lt;/isEnable&gt;)"'</span>
<span class="s">command_on</span><span class="pi">:</span> <span class="s1">'</span><span class="s">curl</span><span class="nv"> </span><span class="s">-k</span><span class="nv"> </span><span class="s">"https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&amp;isEnable=1&amp;usr=admin&amp;pwd=password"'</span>
<span class="s">command_off</span><span class="pi">:</span> <span class="s1">'</span><span class="s">curl</span><span class="nv"> </span><span class="s">-k</span><span class="nv"> </span><span class="s">"https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&amp;isEnable=0&amp;usr=admin&amp;pwd=password"'</span>
<span class="s">command_state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">curl</span><span class="nv"> </span><span class="s">-k</span><span class="nv"> </span><span class="s">--silent</span><span class="nv"> </span><span class="s">"https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=getMotionDetectConfig&amp;usr=admin&amp;pwd=password"</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">grep</span><span class="nv"> </span><span class="s">-oP</span><span class="nv"> </span><span class="s">"(?&lt;=isEnable&gt;).*?(?=&lt;/isEnable&gt;)"'</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value</span><span class="nv"> </span><span class="s">==</span><span class="nv"> </span><span class="s">"1"</span><span class="nv"> </span><span class="s">}}'</span>
</code></pre>
</div>

2
components/switch.dlink/index.html
View file

@ -107,6 +107,7 @@
<span class="s">name</span><span class="pi">:</span> <span class="s">D-Link plug</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">YOUR_USERNAME</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">YOUR_PASSWORD</span>
<span class="s">use_legacy_protocol</span><span class="pi">:</span> <span class="s">False</span>
</code></pre>
</div>
@ -117,6 +118,7 @@
<li><strong>name</strong> (<em>Optional</em>): The name to use when displaying this switch.</li>
<li><strong>username</strong> (<em>Required</em>): The username for your plug. Defaults to <code class="highlighter-rouge">admin</code>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your plug. Default password is the <code class="highlighter-rouge">PIN</code> inlcuded on the configuration card.</li>
<li><strong>use_legacy_protocol</strong> (<em>Optional</em>): Enable limited support for legacy firmware protocols (Tested with v1.24).</li>
</ul>

Some files were not shown because too many files have changed in this diff Show more