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

Site updated at 2015-09-20 04:36:32 UTC

Browse source
This commit is contained in:
Paulus Schoutsen 2015-09-19 21:36:32 -07:00
parent 5ccad30d25
commit a922794802
27 changed files with 1241 additions and 752 deletions
Download patch file Download diff file Expand all files Collapse all files

2
getting-started/android.html
View file

@ -120,8 +120,6 @@
</p>
<p>Some internet service providers will only offer dynamic IPs. This can cause you to be unable to access Home Assistant while being remote. You can solve this by using a free Dynamic DNS service like <a href="https://www.duckdns.org/">DuckDNS</a>.</p>
</article>

396
getting-started/automation.html Normal file
View file

@ -0,0 +1,396 @@
<!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>Automating Home Assistant - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Steps to help you get automation setup in Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Automating Home Assistant">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/getting-started/automation.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Steps to help you get automation setup in Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/images/favicon-192x192.png'> Home Assistant
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li>
<a href="/getting-started/">Getting started</a>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration.html'>Initial configuration</a></li>
<li><a href='/components/'>Component overview</a></li>
<li><a href='/getting-started/android.html'>Setting up Android</a></li>
</ul>
</li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture.html">Architecture</a></li>
<li><a href="/developers/frontend.html">Frontend development</a></li>
<li><a href="/developers/creating_components.html">
Creating components
</a></li>
<li><a href="/developers/add_new_platform.html">
Adding platform support
</a></li>
<li><a href="/developers/api.html">API</a></li>
<li><a href="/developers/credits.html">Credits</a></li>
</ul>
</li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
Automating Home Assistant
</h1>
</header>
<hr class="divider">
<p>When all your devices are set up it&rsquo;s time to put the cherry on the pie: automation. Home Assistant
offers <a href="/components/#automation">a few built-in automations</a> but mainly you&rsquo;ll be using
<a href="/components/automation.html">the automation component</a> to set up your own rules.</p>
<h3><a class='title-link' name='the-basics-of-automation' href='#the-basics-of-automation'></a> The basics of automation</h3>
<p>Every automation rule consists of triggers, an action to be performed and optional conditions.</p>
<p>Triggers can be any event observed in Home Assistant. For example, it can be a certain point in time
or a person coming home, which can be observed by the state changing from <code>not_home</code> to <code>home</code>.</p>
<p>Actions will call services within Home Assistant. For example, turn a light on, set the temperature
on your thermostat or activate a scene.</p>
<p>Conditions are used to prevent actions from firing unless certain conditions are met. For example,
it is possible to only turn on the light if someone comes home and it is after a certain point in
time.</p>
<p>The difference between a condition and a trigger can be confusing. The difference is that the trigger
looks at the event that is happening, ie a car engine turning on. Conditions looks at the current state
of the system, ie is the car engine on.</p>
<h3><a class='title-link' name='exploring-the-internal-state' href='#exploring-the-internal-state'></a> Exploring the internal state</h3>
<p>Automation rules are based on the internal state of Home Assistant. This is available for exploring
in the app using the developer tools. The first icon will show you the available services and the
second icon will show you the current devices.</p>
<p>Each device is represented in Home Assistant as an entity consisting of the following parts:</p>
<table>
<thead>
<tr>
<th> Name </th>
<th> Description </th>
<th> Example </th>
</tr>
</thead>
<tbody>
<tr>
<td> Entity ID </td>
<td> Unique identifier for the entity. </td>
<td> <code>light.kitchen</code></td>
</tr>
<tr>
<td> State </td>
<td> The current state of the device. </td>
<td> <code>home</code></td>
</tr>
<tr>
<td> Attributes </td>
<td> Extra data related to the device and/or current state. </td>
<td> <code>brightness</code></td>
</tr>
</tbody>
</table>
<p>A service can be called to have Home Assistant perform an action. Turn on a light, run a script or
enable a scene. Each service has a domain and a name. For example the service <code>light.turn_on</code> is
capable of turning on any light device in your system. Services can be passed parameters to for
example tell which device to turn on or what color to use.</p>
<h2><a class='title-link' name='creating-your-first-automation-rule' href='#creating-your-first-automation-rule'></a> Creating your first automation rule</h2>
<p>Before we dive deeper into what every piece of automation <em>can</em> do, let&rsquo;s loot at a simple automation
rule: <strong>Turn on the lights when the sun sets</strong></p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">automation</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">alias</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Turn on light when sun sets</span>
</span><span class='line'> <span class="l-Scalar-Plain">trigger</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">sun</span>
</span><span class='line'> <span class="l-Scalar-Plain">event</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">sunset</span>
</span><span class='line'> <span class="l-Scalar-Plain">action</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">service</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">light.turn_on</span>
</span></code></pre></td></tr></table></div></figure>
<p>In this example, we are defining a trigger to track the sunset and tell it to fire one hour before
the sun is setting. When this event is triggered, the service <code>light.turn_on</code> is called without any
parameters. Because we specify no parameters, it will turn on all the lights.</p>
<p>After a few days of running this automation rule you come to realize that this automation rule is not
good enough. It was already dark when the lights went on and the one day you weren&rsquo;t home, the lights
turned on anyway. Time for some tweaking. Let&rsquo;s add an offset to the sunset trigger and a condition
to only turn on the lights if anyone is home.</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
<span class='line-number'>9</span>
<span class='line-number'>10</span>
<span class='line-number'>11</span>
<span class='line-number'>12</span>
<span class='line-number'>13</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">automation</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">alias</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Turn on light when sun sets</span>
</span><span class='line'> <span class="l-Scalar-Plain">trigger</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">sun</span>
</span><span class='line'> <span class="l-Scalar-Plain">event</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">sunset</span>
</span><span class='line'> <span class="l-Scalar-Plain">offset</span><span class="p-Indicator">:</span> <span class="s">&quot;-01:00:00&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">condition</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">state</span>
</span><span class='line'> <span class="l-Scalar-Plain">entity_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">group.all_devices</span>
</span><span class='line'> <span class="l-Scalar-Plain">state</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">home</span>
</span><span class='line'> <span class="l-Scalar-Plain">action</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">service</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">light.turn_on</span>
</span></code></pre></td></tr></table></div></figure>
<p>Now you&rsquo;re happy and all is good. You start to like this automation business and buy some more lights,
this time you put them in the bedroom. But what you now realize is that when the sun is setting, the
lights in the bedroom are also being turned on! Time to tweak the automation to only turn on the living
room lights.</p>
<p>The first thing you do is to look at the entities in the developer tools (second icon) in the app.
You see the names of your lights and you write them down: <code>light.table_lamp</code>, <code>light.bedroom</code>,
<code>light.ceiling</code>.</p>
<p>Instead of hard coding the entity ids of the lights in the automation rule, we will set up a group.
This will allow us to see the living room separate in the app and be able to address it from
automation rules.</p>
<p>So we tweak the config to add the group and have the automation rule only turn on the group.</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
<span class='line-number'>9</span>
<span class='line-number'>10</span>
<span class='line-number'>11</span>
<span class='line-number'>12</span>
<span class='line-number'>13</span>
<span class='line-number'>14</span>
<span class='line-number'>15</span>
<span class='line-number'>16</span>
<span class='line-number'>17</span>
<span class='line-number'>18</span>
<span class='line-number'>19</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">group</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">living_room</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">light.table_lamp</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">light.ceiling</span>
</span><span class='line'>
</span><span class='line'><span class="l-Scalar-Plain">automation</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">alias</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Turn on light when sun sets</span>
</span><span class='line'> <span class="l-Scalar-Plain">trigger</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">sun</span>
</span><span class='line'> <span class="l-Scalar-Plain">event</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">sunset</span>
</span><span class='line'> <span class="l-Scalar-Plain">offset</span><span class="p-Indicator">:</span> <span class="s">&quot;-01:00:00&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">condition</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">state</span>
</span><span class='line'> <span class="l-Scalar-Plain">entity_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">group.all_devices</span>
</span><span class='line'> <span class="l-Scalar-Plain">state</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">home</span>
</span><span class='line'> <span class="l-Scalar-Plain">action</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">service</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">light.turn_on</span>
</span><span class='line'> <span class="l-Scalar-Plain">entity_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">group.living_room</span>
</span></code></pre></td></tr></table></div></figure>
<p>Christmas is coming along and you decide to buy a remote switch to control the christmas lights from
Home Assistant. You can&rsquo;t claim to live in the house of the future if you&rsquo;re still manually turn on
your christmas lights!</p>
<p>We hook the switch up to Home Assistant and grab the entity id from the developer tools:
<code>switch.christmas_lights</code>. We will update the group to include the switch and will change our action.
We are no longer able to call <code>light.turn_on</code> because we also want to turn on a switch. This is
where <code>homeassistant.turn_on</code> comes to the rescue. This service is capable of turning any entity on.</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
<span class='line-number'>9</span>
<span class='line-number'>10</span>
<span class='line-number'>11</span>
<span class='line-number'>12</span>
<span class='line-number'>13</span>
<span class='line-number'>14</span>
<span class='line-number'>15</span>
<span class='line-number'>16</span>
<span class='line-number'>17</span>
<span class='line-number'>18</span>
<span class='line-number'>19</span>
<span class='line-number'>20</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">group</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">living_room</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">light.table_lamp</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">light.ceiling</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">switch.christmas_lights</span>
</span><span class='line'>
</span><span class='line'><span class="l-Scalar-Plain">automation</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">alias</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Turn on light when sun sets</span>
</span><span class='line'> <span class="l-Scalar-Plain">trigger</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">sun</span>
</span><span class='line'> <span class="l-Scalar-Plain">event</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">sunset</span>
</span><span class='line'> <span class="l-Scalar-Plain">offset</span><span class="p-Indicator">:</span> <span class="s">&quot;-01:00:00&quot;</span>
</span><span class='line'> <span class="l-Scalar-Plain">condition</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">state</span>
</span><span class='line'> <span class="l-Scalar-Plain">entity_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">group.all_devices</span>
</span><span class='line'> <span class="l-Scalar-Plain">state</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">home</span>
</span><span class='line'> <span class="l-Scalar-Plain">action</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">service</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">homeassistant.turn_on</span>
</span><span class='line'> <span class="l-Scalar-Plain">entity_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">group.living_room</span>
</span></code></pre></td></tr></table></div></figure>
<h3><a class='title-link' name='further-reading' href='#further-reading'></a> Further reading</h3>
<p>We went over the basics of creating a home automation rule. From here no longer any hand holding,
go automate!</p>
<ul>
<li>Learn about the available <a href="/components/automation.html#triggers">automation triggers</a></li>
<li>Learn about the available <a href="/components/automation.html#conditions">automation conditions</a></li>
<li>Learn about <a href="/components/script.html">scripts</a> to help you trigger multiple actions and delays</li>
<li>Learn about <a href="/components/scene.html">scenes</a> to help you set many entities at once to your liking</li>
</ul>
</article>
</div>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</div>
</div>
</div>
</footer>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
<![endif]-->
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>

18
getting-started/advanced.html → getting-started/autostart.html
View file

@ -9,20 +9,20 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Advanced Installation - Home Assistant</title>
<title>Launch Home Assistant on boot - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Brief advanced installation tutorials.">
<meta name="description" content="Instructions how to setup Home Assistant to launch on boot on various platforms..">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Advanced Installation">
<meta property="og:title" content="Launch Home Assistant on boot">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/getting-started/advanced.html/">
<meta property="og:url" content="https://home-assistant.io/getting-started/autostart.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Brief advanced installation tutorials.">
<meta property="og:description" content="Instructions how to setup Home Assistant to launch on boot on various platforms..">
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
@ -98,15 +98,13 @@
<header>
<h1 class="title indent">
Advanced Installation
Launch Home Assistant on Boot
</h1>
</header>
<hr class="divider">
<p>Here are some general tutorials on how to setup some of the more advanced deployments that are frequently requested.</p>
<p><div class='advanced-installs-container'>
<p><div class='advanced-installs-container'>
<input name='advanced-installs' type='radio' id='upstart-install' checked>
<input name='advanced-installs' type='radio' id='systemd-install'>
<input name='advanced-installs' type='radio' id='osx-install'>
@ -123,7 +121,7 @@ Many linux distributions use the Upstart system (or similar) for managing daemon
<p>If the preceding command returns the string <code>init</code>, you are likely using Upstart.</p>
<p>Upstart will launch init scripts that are located in the directory <code>/etc/init.d/</code>. A sample init script for systems using Upstart is <a href="https://raw.githubusercontent.com/balloob/home-assistant/dev/scripts/hass-daemon">maintained by this project</a>.</p>
<p>Upstart will launch init scripts that are located in the directory <code>/etc/init.d/</code>. A sample init script for systems using Upstart is <a href="https://raw.githubusercontent.com/balloob/home-assistant/dev/script/hass-daemon">maintained by this project</a>.</p>
<p>To install this script, download it, tweak it to you liking, and install it by following the directions in the header. This script will setup Home Assistant to run when the system boots. To start/stop Home Assistant manually, issue the following commands:
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>

121
getting-started/configuration.html
View file

@ -104,13 +104,20 @@
<hr class="divider">
<p>Home Assistant will create a configuration folder when it is run for the first time. Depending on your operating system this is <code>~/.homeassistant</code> (OS X/Linux) or <code>%APPDATA%/.homeassistant</code> (Windows). If you want to use a different folder for configuration, run <code>hass --config path/to/config</code>.</p></p>
<p>Home Assistant will create a configuration folder when it is run for the first time. Location depends
on operating system: on OS X/Linux it is <code>~/.homeassistant</code> and on Windows it is <code>%APPDATA%/.homeassistant</code>.
If you want to use a different folder for configuration, run <code>hass --config path/to/config</code>.</p>
<p>Inside your configuration folder is the file <code>configuration.yaml</code>. This is the main file that contains which components will be loaded and what their configuration is. An example configuration file is located at <a href="https://github.com/balloob/home-assistant/blob/master/config/configuration.yaml.example"><code>here</code></a>.</p>
<p>Inside your configuration folder is the file <code>configuration.yaml</code>. This is the main file that contains
which components will be loaded and what their configuration is. An example configuration file is
located <a href="https://github.com/balloob/home-assistant/blob/master/config/configuration.yaml.example">here</a>.</p>
<p>When launched for the first time, Home Assistant will write a default configuration enabling the web interface and device discovery. It can take up to a minute for your devices to be discovered and show up in the interface.</p>
<p>When launched for the first time, Home Assistant will write a default configuration enabling the web
interface and device discovery. It can take up to a minute for your devices to be discovered and
show up in the interface.</p>
<p>If you are running into troubles while configuring Home Assistant, have a look at <a href="/getting-started/troubleshooting-configuration.html">the configuration troubleshoot page</a>.</p>
<p>If you are running into troubles while configuring Home Assistant, have a look at
<a href="/getting-started/troubleshooting-configuration.html">the configuration troubleshoot page</a>.</p>
<p class='note'>
You will have to restart Home Assistant for changes in <code>configuration.yaml</code> to take effect.
@ -119,7 +126,9 @@
<h3><a class='title-link' name='setting-up-the-basic-info' href='#setting-up-the-basic-info'></a> Setting up the basic info</h3>
<p>By default Home Assistant will try to detect your location and will automatically select a temperature unit and time zone based on your location. You can overwrite this by adding the following information to your <code>configuration.yaml</code>:</p>
<p>By default Home Assistant will try to detect your location and will automatically select a
temperature unit and time zone based on your location. You can overwrite this by adding the
following information to your <code>configuration.yaml</code>:</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
@ -167,100 +176,22 @@
</span></code></pre></td></tr></table></div></figure>
<h3><a class='title-link' name='adding-devices-and-services' href='#adding-devices-and-services'></a> Adding devices and services</h3>
<p>Home Assistant will be able to automatically discover and configure any Google Chromecasts, Netgear routers,
Belkin WeMo switches and Philips Hue bridges in your network if you have
<a href="/components/discovery.html">the discovery component</a> enabled (which is by default).</p>
<p>Not all devices can be discovered, so if you have any of the following devices or services, please see their respective pages for installation instructions:</p>
<ul>
<li><a href="/components/device_tracker.html">Device tracking</a></li>
<li><a href="/components/isy994.html">ISY994 controller</a></li>
<li><a href="/components/thermostat.html">Nest thermostat</a></li>
<li><a href="/components/notify.html">Notifications</a></li>
<li><a href="/blog/2015/03/22/release-notes/#sabnzbd">SABnzbd</a></li>
<li><a href="/components/tellstick.html">TellStick</a></li>
<li><a href="/components/wink.html">Wink hub</a></li>
<li><a href="/developers/add_new_platform.html">Add support for your own device or service</a></li>
</ul>
<p>See the <a href="/components/">components overview page</a> for a complete list of supported devices.</p>
<h3><a class='title-link' name='grouping-devices' href='#grouping-devices'></a> Grouping devices</h3>
<p>Once you get a bunch of devices set up, it is time to organize them. This can be done using groups.
Each group exists of a name and a list of entity IDs. Entity IDs can be retrieved from the web interface
by using the Set State page in the Developer Tools (one in the middle).</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="l-Scalar-Plain">group</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">living_room</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">light.table_lamp, switch.ac</span>
</span><span class='line'> <span class="l-Scalar-Plain">bedroom</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">light.bedroom</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">media_player.nexus_player</span>
</span></code></pre></td></tr></table></div></figure>
<h3><a class='title-link' name='customizing-devices-and-services' href='#customizing-devices-and-services'></a> Customizing devices and services</h3>
<p>By default, most of your devices will be visible on the Home Assistant States
page and have a default icon determined by their domain. You may find it
desireable to customize the look and feel of your front page by altering some
of these parameters.</p>
<p>By adding the following parameters to the <code>homeassistant:</code> section of your
<code>configuration.yaml</code>, you can customize the attributes of any state on
your front page.</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
<span class='line-number'>9</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="l-Scalar-Plain">homeassistant</span><span class="p-Indicator">:</span>
</span><span class='line'>
</span><span class='line'> <span class="c1"># Add this to your existing configuration</span>
</span><span class='line'>
</span><span class='line'> <span class="l-Scalar-Plain">customize</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">some.entity_id</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">hidden</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">true</span>
</span><span class='line'> <span class="l-Scalar-Plain">entity_picture</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">http://URL.TO/PICTURE</span>
</span><span class='line'> <span class="l-Scalar-Plain">friendly_name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">SOME CUSTOM NAME</span>
</span></code></pre></td></tr></table></div></figure>
<p class='note'>Customizations are currently unavailable for device tracker entities.</p>
<h3><a class='title-link' name='setting-up-home-automation' href='#setting-up-home-automation'></a> Setting up Home Automation</h3>
<p>When all your devices are set up it&rsquo;s time to put the cherry on the pie: automation. There are many ways to automate your home with Home Assistant so we have divided it into a couple of topics:</p>
<ul>
<li><a href="/components/device_sun_light_trigger.html">Automatic light control based on the sun and if people are home</a> (built-in component)</li>
<li><a href="/components/simple_alarm.html">Intruder alerts</a> (built-in component)</li>
<li><a href="/components/automation.html">Setup your own automation rules</a> (using configuration file)</li>
<li><a href="/developers/creating_components.html">Create your own automation component</a> (writing Python code)</li>
</ul>
<h3><a class='title-link' name='setting-up-your-phone-or-tablet' href='#setting-up-your-phone-or-tablet'></a> Setting up your phone or tablet</h3>
<p>Home Assistant runs as a self hosted web application. Home Assistant contains support to be added to your homescreen. If you&rsquo;re on Android you can follow <a href="/getting-started/android.html">the visual guide</a>. For other devices, open Home Assistant on your mobile browser and click on the add to homescreen option.</p>
<h3><a class='title-link' name='remote-access' href='#remote-access'></a> Remote access</h3>
<p>To make Home Assistant accessible while away from home, you will have to setup port forwarding from
your router to port 8123 on the computer that is hosting Home Assistant. Instructions how to do this
can be found by searching <code>&lt;Router model&gt; port forwarding instructions</code>.</p>
<p>Some internet service providers will only offer dynamic IPs. This can cause you to be unable to
access Home Assistant while being remote. You can solve this by using a free Dynamic DNS service
like <a href="https://www.duckdns.org/">DuckDNS</a>.</p>
<h3><a href="/getting-started/devices.html">Next step: Setting up devices &raquo;</a></h3>
</article>

218
getting-started/devices.html Normal file
View file

@ -0,0 +1,218 @@
<!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>Adding devices to Home Assistant - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Steps to help you get your devices in Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Adding devices to Home Assistant">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/getting-started/devices.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Steps to help you get your devices in Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/images/favicon-192x192.png'> Home Assistant
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li>
<a href="/getting-started/">Getting started</a>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration.html'>Initial configuration</a></li>
<li><a href='/components/'>Component overview</a></li>
<li><a href='/getting-started/android.html'>Setting up Android</a></li>
</ul>
</li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture.html">Architecture</a></li>
<li><a href="/developers/frontend.html">Frontend development</a></li>
<li><a href="/developers/creating_components.html">
Creating components
</a></li>
<li><a href="/developers/add_new_platform.html">
Adding platform support
</a></li>
<li><a href="/developers/api.html">API</a></li>
<li><a href="/developers/credits.html">Credits</a></li>
</ul>
</li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
Adding Devices to Home Assistant
</h1>
</header>
<hr class="divider">
<p>Home Assistant will be able to automatically discover and configure any Google Chromecasts, Netgear
routers, Belkin WeMo switches, Philips Hue bridges and Sonos speakers in your network if you have
<a href="/components/discovery.html">the discovery component</a> enabled (which is by default).</p>
<p>See the <a href="/components/">components overview page</a> to find installation instructions for your devices
and services.</p>
<p>To get the most out of automation, it is useful to setup the following things:</p>
<ul>
<li><a href="/components/#presence">Presence Detection</a></li>
<li><a href="/components/#notify-service">Notification service</a></li>
</ul>
<p>If you can&rsquo;t find support for your favorite device or service,
<a href="/developers/add_new_platform.html">consider adding support</a></p>
<h3><a class='title-link' name='grouping-devices' href='#grouping-devices'></a> Grouping devices</h3>
<p>Once you get a bunch of devices set up, it is time to organize them. This can be done using groups.
Each group exists of a name and a list of entity IDs. Entity IDs can be retrieved from the web interface
by using the Set State page in the Developer Tools (icon in the middle).</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">group</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">living_room</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">light.table_lamp, switch.ac</span>
</span><span class='line'> <span class="l-Scalar-Plain">bedroom</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">light.bedroom</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">media_player.nexus_player</span>
</span></code></pre></td></tr></table></div></figure>
<h3><a class='title-link' name='customizing-devices-and-services' href='#customizing-devices-and-services'></a> Customizing devices and services</h3>
<p>By default, all of your devices will be visible and have a default icon determined by their domain.
You may find it desireable to customize the look and feel of your front page by altering some
of these parameters. This can be done by adding the following config to the <code>homeassistant:</code> section.</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
<span class='line-number'>9</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">homeassistant</span><span class="p-Indicator">:</span>
</span><span class='line'>
</span><span class='line'> <span class="c1"># Add this to your existing configuration</span>
</span><span class='line'> <span class="l-Scalar-Plain">customize</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">some.entity_id</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">hidden</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">true</span>
</span><span class='line'> <span class="l-Scalar-Plain">entity_picture</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">http://placehold.it/200x200</span>
</span><span class='line'> <span class="l-Scalar-Plain">friendly_name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">My better name</span>
</span></code></pre></td></tr></table></div></figure>
<h3><a href="/getting-started/automation.html">Next step: Setting up automation &raquo;</a></h3>
</article>
</div>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</div>
</div>
</div>
</footer>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
<![endif]-->
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>

37
getting-started/index.html
View file

@ -146,7 +146,7 @@ When using boot2docker on OS X you are unable to map the local time to your Dock
</div> <!-- INSTALL-INSTRUCTIONS DOCKER --></p>
<p><div class='install-instructions raspberry'>
<p>Home Assistant uses Python 3.4 which is not shipped with the current Raspbian distibution for the Raspberry Pi. Before installing Home Assistant, you will have to <a href="http://depado.markdownblog.com/2015-03-12-short-tutorial-raspbian-python3-4-rpi-gpio" target="_blank">install Python 3.4</a>.</p>
<p>Home Assistant uses Python 3.4 which is not shipped with the current Raspbian distibution for the Raspberry Pi. Before installing Home Assistant, you will have to <a href="https://www.raspberrypi.org/forums/viewtopic.php?f=32&t=113961#p779265" target="_blank">install Python 3.4</a>.</p>
<p>Once that is complete, installing and running Home Assistant on your local machine is easy. Make sure you have <a href='https://www.python.org/downloads/' target="_blank">Python 3.4</a> installed and execute the following code in a console:</p>
@ -164,31 +164,32 @@ When using boot2docker on OS X you are unable to map the local time to your Dock
</ol>
</div> <!-- INSTALL-INSTRUCTIONS RASPBERRY --></p>
<p><h3>Troubleshooting</h3></p>
<h3><a class='title-link' name='troubleshooting' href='#troubleshooting'></a> Troubleshooting</h3>
<p><p>If you run into any issues, please see the <a href='/getting-started/troubleshooting.html'>troubleshooting page</a>. It contains solutions to many of the more commonly encountered issues.</p></p>
<p>If you run into any issues, please see <a href="/getting-started/troubleshooting.html">the troubleshooting page</a>. It contains solutions to many of the more commonly encountered issues.</p>
<p>For additional help, in addition to this site, there are three sources:</p>
<p><p>For additional help, in addition to this site, there are three sources:
<ul>
<li><a href="https://gitter.im/balloob/home-assistant" target="_blank">Gitter Chatroom</a> for general Home Assistant discussions and questions.</li>
<li><a href="https://groups.google.com/forum/#!forum/home-assistant-dev" target="_blank">Development Mailing List</a> for development related questions and discussing new features.</li>
<li><a href="https://github.com/balloob/home-assistant" target="_blank">GitHub Page</a> for issue reporting.</li>
<li><a href="https://gitter.im/balloob/home-assistant">Gitter Chatroom</a> for general Home Assistant discussions and questions.</li>
<li><a href="https://groups.google.com/forum/#!forum/home-assistant-dev">Development Mailing List</a> for development related questions and discussing new features.</li>
<li><a href="https://github.com/balloob/home-assistant">GitHub Page</a> for issue reporting.</li>
</ul>
</p></p>
<p><h3>Staying Up to Date</h3>
<p>In order to update Home Assistant to the latest stable release, simply type the following into a console:</p>
<h3><a class='title-link' name='whats-next' href='#whats-next'></a> What&rsquo;s next</h3>
<p>If you want to have Home Assistant start on boot, <a href="/getting-started/autostart.html">autostart instructions</a> can be found here.</p>
<p>To see what Home Assistant can do, launch demo mode:
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
</pre></td><td class='code'><pre><code class='bash'><span class='line'>pip3 install <span class="se">--</span>upgrade homeassistant
</span></code></pre></td></tr></table></div></figure>
<p>If you would like to stay up to date with the newest unstable builds (alphas, betas, and release candidates), use this command:</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
</pre></td><td class='code'><pre><code class='bash'><span class='line'>pip3 install <span class="se">--</span>upgrade <span class="se">--</span>pre homeassistant
</pre></td><td class='code'><pre><code class='bash'><span class='line'>hass <span class="se">--</span>demo-mode
</span></code></pre></td></tr></table></div></figure></p>
<p><h3>What&rsquo;s Next</h3>
<p>If you want to see what Home Assistant can do, you can start the demo mode by running <code>hass --demo-mode</code>. Home Assistant has a few other command line flags that can be displayed by running <code>hass --help</code>.</p>
<p>From here you may now start configuring Home Assistant to your liking. For more advanced users, the <a href='/getting-started/advanced.html'>advanced configuration page</a> contains brief tutorials on creating more advanced installations.</p></p>
<p>To update Home Assistant to the latest release:
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
</pre></td><td class='code'><pre><code class='bash'><span class='line'>pip3 install <span class="se">--</span>upgrade homeassistant
</span></code></pre></td></tr></table></div></figure></p>
<h3><a href="/getting-started/configuration.html">Next step: Configuring Home Assistant &raquo;</a></h3>