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

Site updated at 2015-09-01 08:42:54 UTC

Browse source
This commit is contained in:
Paulus Schoutsen 2015-09-01 01:42:54 -07:00
parent 2e727a5332
commit 5a20d28e54
77 changed files with 4485 additions and 1421 deletions
Download patch file Download diff file Expand all files Collapse all files

45
getting-started/configuration.html
View file

@ -104,16 +104,20 @@
<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>By default, Home Assistant will create a configuration folder. 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>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>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 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>
<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>
@ -152,7 +156,7 @@
</span></code></pre></td></tr></table></div></figure>
<h3>Password protecting the web interface</h3>
<h3><a class='title-link' name='password-protecting-the-web-interface' href='#password-protecting-the-web-interface'></a> 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>
@ -165,7 +169,9 @@
<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>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>
@ -183,6 +189,25 @@
<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
@ -190,8 +215,8 @@ 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
<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>
@ -208,15 +233,17 @@ your front page.</p>
</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">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>
<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>