jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/getting-started/configuration.html
Paulus Schoutsen a699ae115d Site updated at 2015-07-01 05:58:00 UTC
2015-06-30 22:58:00 -07:00

281 lines
No EOL
13 KiB
HTML
Raw Blame History

<!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>Configuring Home Assistant - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Configuring 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="Configuring Home Assistant">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/getting-started/configuration.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Configuring Home Assistant.">
<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/help.html">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">
Configuring Home Assistant
</h1>
</header>
<hr class="divider">
<p>The configuration for Home Assistant lives by default in the <code>config</code> folder. The file <code>configuration.yaml</code> 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>config/configuration.yaml.example</code></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 class='note'>
You will have to restart Home Assistant for changes in <code>configuration.yaml</code> to take effect.
</p>
<h3>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>
<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>
</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 class="c1"># Omitted values in this section will be auto detected using freegeoip.net</span>
</span><span class='line'>
</span><span class='line'> <span class="c1"># Location required to calculate the time the sun rises and sets</span>
</span><span class='line'> <span class="l-Scalar-Plain">latitude</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">32.87336</span>
</span><span class='line'> <span class="l-Scalar-Plain">longitude</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">117.22743</span>
</span><span class='line'>
</span><span class='line'> <span class="c1"># C for Celsius, F for Fahrenheit</span>
</span><span class='line'> <span class="l-Scalar-Plain">temperature_unit</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">C</span>
</span><span class='line'>
</span><span class='line'> <span class="c1"># Pick yours from here:</span>
</span><span class='line'> <span class="c1"># http://en.wikipedia.org/wiki/List_of_tz_database_time_zones</span>
</span><span class='line'> <span class="l-Scalar-Plain">time_zone</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">America/Los_Angeles</span>
</span><span class='line'>
</span><span class='line'> <span class="c1"># Name of the location where Home Assistant is running</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Home</span>
</span></code></pre></td></tr></table></div></figure>
<h3>Password protecting the web interface</h3>
<p>The first thing you want to add is a password for the web interface. Use your favourite text editor to open the file <code>/config/configuration.yaml</code> and add the following to the bottom:</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>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="l-Scalar-Plain">http</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">api_password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_PASSWORD</span>
</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, 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='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 <em>homeassistant</em> section of your
<em>configuration.yaml</em> file, 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>Entity IDs can be retrieved from the web interface by using the Set State page
in the Developer Tools.</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>
</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>
Reference in a new issue View git blame Copy permalink