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>

65
getting-started/index.html
View file

@ -125,20 +125,20 @@
<!-- ###### Preparation instructions Generic ######################## -->
<div class='prep-instructions generic'>
Installing and running Home Assistant on your local machine is easy. Make sure you have <a href='https://www.python.org/downloads/'>Python 3.4</a> and <a href='http://git-scm.com/downloads'>git</a> installed and execute the following code in a console:
Installing and running Home Assistant on your local machine is easy. Make sure you have <a href='https://www.python.org/downloads/'>Python 3.4</a> installed and execute the following code in a console:
</div>
<!-- ###### Preparation instructions Fedora ######################## -->
<div class='prep-instructions fedora'>
<p>The preparation of a <a href='https://fedoraproject.org'>Fedora</a> 22 host will only take a couple of minutes. First install Python 3.4, <code>git</code> and the other needed packages out of the <a href='https://admin.fedoraproject.org/pkgdb'>Fedora Package Collection</a>. This ensure that you receive updates in the future.</p>
<p>The preparation of a <a href='https://fedoraproject.org'>Fedora</a> 22 host will only take a couple of minutes. First install Python 3.4 and the other needed packages out of the <a href='https://admin.fedoraproject.org/pkgdb'>Fedora Package Collection</a>. This ensure that you receive updates in the future.</p>
<p class='note'>
It&#8217;s assumed that your user has an entry in the sudoers file. Otherwise, run the commands which needs more privileges as root.
</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'>sudo dnf -y install python3 python3-devel git gcc
</pre></td><td class='code'><pre><code class='bash'><span class='line'>sudo dnf -y install python3 python3-devel gcc
</span></code></pre></td></tr></table></div></figure>
</div>
@ -183,22 +183,13 @@ It&#8217;s assumed that your user has an entry in the sudoers file. Otherwise, r
<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='bash'><span class='line'>git clone --recursive https://github.com/balloob/home-assistant.git
</span><span class='line'>python3 -m venv home-assistant
</span><span class='line'><span class="nb">cd </span>home-assistant
</span><span class='line'><span class="nb">source </span>bin/activate
</span><span class='line'>python3 -m homeassistant --open-ui
</pre></td><td class='code'><pre><code class='bash'><span class='line'>pip3 install homeassistant
</span><span class='line'>hass --open-ui
</span></code></pre></td></tr></table></div></figure>
</p>
<p>Running these commands will:</p>
<ol>
<li>Download Home Assistant</li>
<li>Setup an isolated environment</li>
<li>Navigate to downloaded files</li>
<li>Activate the isolated environment (on Windows, run <code>Scripts/activate.bat</code>)</li>
<li>Install Home Assistant</li>
<li>Launch Home Assistant and serve web interface on <a href='http://localhost:8123'>http://localhost:8123</a></li>
</ol>
<br />
@ -212,20 +203,15 @@ It&#8217;s assumed that your user has an entry in the sudoers file. Otherwise, r
<input name='post-instructions' type='radio' id='debian-post'>
<label class='menu-selector generic-post' for='generic-post'>Generic</label>
<label class='menu-selector fedora-post' for='fedora-post'>Fedora/CentOS</label>
<label class='menu-selector debian-post' for='debian-post'>Debian</label>
<!-- <label class='menu-selector debian-post' for='debian-post'>Debian</label> &#8211;>
<!-- ###### Post-installation instructions Generic ######################## -->
<div class='post-instructions generic-post'>
<p>There is nothing else to do. If you run into any issues, please see the <a href='/getting-started/troubleshooting.html'>troubleshooting page</a>.</p>
<p class='note'>
You can run Home Assistant in demo mode by appending <code>--demo-mode</code> to line 5.
</p>
<p class='note'>
If you want to update to the latest version in the future, run: <code>scripts/update</code>.
</p>
<p>If you want to see what Home Assistant can do, you can start the demo mode by running <code>hass --demo-mode</code>.</p>
<p>In the future, if you want to update to the latest version, run <code>pip3 install --upgrade home-assistant</code>.</p>
</div>
<!-- ###### Post-installation instructions Fedora/CentOS ######################## -->
@ -239,7 +225,11 @@ It&#8217;s assumed that your user has an entry in the sudoers file. Otherwise, r
</span></code></pre></td></tr></table></div></figure>
<p>Home Assistant will serve its web interface on <a href='http://[IP address of the host]:8123'>http://[IP address of the host]:8123</a>.</p>
<p>If you want that Home Assistant is lauched automatically, an extra step is needed to setup <code>systemd</code>. You need a service file to control Home Assistant with <code>systemd</code>. The <code>WorkingDirectory</code> and the <code>PYTHONPATH</code> must point to your clone git repository.</p>
<p>If you want that Home Assistant is lauched automatically, an extra step is needed to setup <code>systemd</code>. You need a service file to control Home Assistant with <code>systemd</code>. <!-- The <code>WorkingDirectory</code> and the <code>PYTHONPATH</code> must point to your clone git repository. &#8211;></p>
<!-- WorkingDirectory=/home/fab/home-assistant/
Environment="PYTHONPATH=/home/fab/home-assistant/" -->
<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>
@ -253,8 +243,6 @@ It&#8217;s assumed that your user has an entry in the sudoers file. Otherwise, r
<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>
</pre></td><td class='code'><pre><code class='bash'><span class='line'>su -c <span class="s1">&#39;cat &lt;&lt;EOF &gt;&gt; /lib/systemd/system/home-assistant.service</span>
</span><span class='line'><span class="s1">[Unit]</span>
</span><span class='line'><span class="s1">Description=Home Assistant</span>
@ -262,8 +250,6 @@ It&#8217;s assumed that your user has an entry in the sudoers file. Otherwise, r
</span><span class='line'>
</span><span class='line'><span class="s1">[Service]</span>
</span><span class='line'><span class="s1">Type=simple</span>
</span><span class='line'><span class="s1">WorkingDirectory=/home/fab/home-assistant/</span>
</span><span class='line'><span class="s1">Environment=&quot;PYTHONPATH=/home/fab/home-assistant/&quot;</span>
</span><span class='line'><span class="s1">ExecStart=/usr/bin/python3.4 -m homeassistant</span>
</span><span class='line'>
</span><span class='line'><span class="s1">[Install]</span>
@ -307,10 +293,7 @@ It&#8217;s assumed that your user has an entry in the sudoers file. Otherwise, r
</pre></td><td class='code'><pre><code class='bash'><span class='line'>sudo journalctl -f -u home-assistant
</span></code></pre></td></tr></table></div></figure>
<p class='note'>
If you want to update to the latest version in the future, run: <code>scripts/update</code> and restart Home Assistant.
</p>
<p>In the future, if you want to update to the latest version, run <code>pip3 install --upgrade home-assistant</code>.</p>
<p class='note'>
Those instructions were written for Fedora 22 Server and Workstation. They may work for Cloud flavor as well but this was not tested.
@ -401,28 +384,26 @@ NOTE: the rest of the commands are not being run as sudo and will install python
</pre></td><td class='code'><pre><code class='bash'><span class='line'>pyenv virtualenv 3.4.2 homeassistant
</span></code></pre></td></tr></table></div></figure>
<p><b>Step 5. Clone the source</b></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'>git clone --recursive https://github.com/balloob/home-assistant.git
</span></code></pre></td></tr></table></div></figure>
<p><b>Step 6. Set the virtual environment</b></p>
<p><b>Step 5. Set the virtual environment</b></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='bash'><span class='line'><span class="nb">cd </span>home-assistant
</span><span class='line'>pyenv <span class="nb">local </span>homeassistant
</span></code></pre></td></tr></table></div></figure>
<p><b>Step 6. Install Home Assistant</b></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 homeassistant
</span></code></pre></td></tr></table></div></figure>
<p><b>Step 7. Start it up</b></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'>python3 -m homeassistant
</pre></td><td class='code'><pre><code class='bash'><span class='line'>hass
</span></code></pre></td></tr></table></div></figure>
<p>It will be up and running on port 8123</p>
<p class='note'>
If you want to update to the latest version in the future, run: <code>scripts/update</code>.
</p>
<p>In the future, if you want to update to the latest version, run <code>pip3 install --upgrade home-assistant</code>.</p>
</div>

212
getting-started/troubleshooting-configuration.html Normal file
View file

@ -0,0 +1,212 @@
<!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>Troubleshooting your configuration - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Common problems with tweaking your configuration and their solutions.">
<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="Troubleshooting your configuration">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/getting-started/troubleshooting-configuration.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Common problems with tweaking your configuration and their solutions.">
<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">
Troubleshooting Your Configuration
</h1>
</header>
<hr class="divider">
<p>It can happen that you run into trouble while configuring Home Assistant. A component is not
showing up or is acting weird. This page will discuss a few of the most common problems.</p>
<p>Before we dive into common issues, make sure you know where your configuration directory is.
Home Assistant will print out the configuration directory it is using when starting up.</p>
<p>Whenever a component or configuration option results in a warning, it will be stored in
<code>home-assistant.log</code>. This file is reset on start of Home Assistant.</p>
<h3><a class='title-link' name='my-component-does-not-show-up' href='#my-component-does-not-show-up'></a> My component does not show up</h3>
<p>When a component does not show up, many different things can be the case. Before you try any of
these steps, make sure to look at the <code>home-assistant.log</code> file and see if there are any errors
related to your component you are trying to set up.</p>
<p><strong>Problems with the configuration<br></strong></p>
<p><code>configuration.yaml</code> does not allow multiple sections to have the same name. If you want a
specific component to be loaded twice, append a number to the name.</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>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="l-Scalar-Plain">sensor</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">mqtt</span>
</span><span class='line'> <span class="p-Indicator">[</span><span class="nv">…</span><span class="p-Indicator">]</span>
</span><span class='line'>
</span><span class='line'><span class="l-Scalar-Plain">sensor 2</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">bitcoin</span>
</span><span class='line'> <span class="p-Indicator">[</span><span class="nv">…</span><span class="p-Indicator">]</span>
</span></code></pre></td></tr></table></div></figure>
<p>Another common problem is that a required configuration setting is missing. If this is the
case, the component will report this to <code>home-assistant.log</code>. You can have a look at
<a href="/components/">the component page</a> for instructions how to setup the components. If you find any
errors or want to expand the documentation, please
<a href="https://github.com/balloob/home-assistant.io/issues">let us know</a>.</p>
<p><strong>Problems with dependencies<br></strong>
Almost all components have external dependencies to communicate with your devices and services.
Sometimes Home Assistant is unable to install the necessary dependencies. If this is the case, it
should show up in <code>home-assistant.log</code>.</p>
<p>First step is trying to restart Home Assistant and see if the problem persists. If it does, please
<a href="https://github.com/balloob/home-assistant/issues">report it</a> so we can investigate what is going on.</p>
<p><strong>Problems with components<br></strong>
It can happen that some components either do not work right away or stop working after Home
Assistant has been running for a while. If this happens to you, please
<a href="https://github.com/balloob/home-assistant/issues">report it</a> so that we can have a look.</p>
<p class='note'>
Whenever you report an issue, be aware that we are a group of volunteers that do not have access to
every single device in the world nor unlimited time to fix every problem out there.
</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>

68
getting-started/troubleshooting.html
View file

@ -9,20 +9,20 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Troubleshooting - Home Assistant</title>
<title>Troubleshooting installation problems - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Common problems and their solutions.">
<meta name="description" content="Common installation problems and their solutions.">
<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="Troubleshooting">
<meta property="og:title" content="Troubleshooting installation problems">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/getting-started/troubleshooting.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Common problems and their solutions.">
<meta property="og:description" content="Common installation problems and their solutions.">
<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,58 +98,34 @@
<header>
<h1 class="title indent">
Troubleshooting
Troubleshooting Installation Problems
</h1>
</header>
<hr class="divider">
<p>It can happen that you run into trouble while installing Home Assistant. This page is here to help you figure out the most common problems.</p>
<p>It can happen that you run into trouble while installing Home Assistant. This page is here to help
you figure out the most common problems.</p>
<p><strong>python3: command not found</strong><br>
Check if Python 3.4 is installed by running <code>python3 --version</code>. If it is not installed, <a href="https://www.python.org/getit/">download it here</a>.</p>
<p><strong>pip3: command not found</strong><br>
This utility should have been installed as part of the Python 3.4 installation. Check if Python 3.4
is installed by running <code>python3 --version</code>. If it is not installed,
<a href="https://www.python.org/getit/">download it here</a>.</p>
<p>If you are to succesfully run <code>python3 --version</code> but not <code>pip3</code>, run the following command instead
to install Home Assistant: <code>python3 -m pip install homeassistant</code>.</p>
<p><strong>No module named pip</strong><br>
<a href="https://pip.pypa.io/en/stable/">Pip</a> should come bundled with the latest Python 3 but is ommitted by some distributions. If you are unable to run <code>python3 -m pip --version</code> you can install <code>pip</code> by <a href="https://bootstrap.pypa.io/get-pip.py">downloading the installer</a> and run it with Python 3: <code>python3 get-pip.py</code>.</p>
<p><strong>git: command not found</strong><br>
Check if Git is installed by running <code>git --version</code>. If you are unable to run this command you can install it by following <a href="http://git-scm.com/downloads">these instructions</a>.</p>
<p><strong>No module named &lsquo;pytz&rsquo;</strong><br>
There is a problem with installing dependencies on the fly. Install the dependencies manually in advance.</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='bash'><span class='line'>python3 -m pip install --upgrade pip
</span><span class='line'>python3 -m pip install --upgrade -r requirements.txt
</span></code></pre></td></tr></table></div></figure>
<p><strong>Ubuntu 14.04: &hellip; returned non-zero exit status</strong><br>
There is a known issue with installing on Ubuntu 14.04 and possibly many other newer Debian based distributions. The <code>venv</code> Python 3.4 package that has been bundled in the apt-get repository are known to be broken. This has been documented <a href="https://bugs.launchpad.net/ubuntu/+source/python3.4/+bug/1290847">in this bug report</a>. If you are encountering an error that looks like the following while creating the virtual environment, you are experiencing this bug.</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'>Error: Command <span class="s1">&#39;[&#39;</span>home-assistant/bin/python3.4<span class="s1">&#39;, &#39;</span>-Im<span class="s1">&#39;, &#39;</span>ensurepip<span class="s1">&#39;, &#39;</span>--upgrade<span class="s1">&#39;, &#39;</span>--default-pip<span class="s1">&#39;]&#39;</span> returned non-zero <span class="nb">exit </span>status
</span></code></pre></td></tr></table></div></figure>
<p>This error can be fixed permanently by running the following commands.</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>
</pre></td><td class='code'><pre><code class='bash'><span class='line'><span class="nb">cd</span> ~/Downloads
</span><span class='line'>wget https://gist.githubusercontent.com/rmkraus/c3972492a9de875203c6/raw/46629b63857537deedc85ec4a11cd8284816e2a0/install_ensurepip.py
</span><span class='line'>sudo python3 install_ensurepip.py
</span><span class='line'>rm install_ensurepip.py
</span></code></pre></td></tr></table></div></figure>
<p>After these commands have been successfully executed, the <code>venv</code> package will be fixed system-wide.</p>
<a href="https://pip.pypa.io/en/stable/">Pip</a> should come bundled with the latest Python 3 but is ommitted
by some distributions. If you are unable to run <code>python3 -m pip --version</code> you can install <code>pip</code> by
<a href="https://bootstrap.pypa.io/get-pip.py">downloading the installer</a> and run it with Python 3:
<code>python3 get-pip.py</code>.</p>
<p><strong>No access to the frontend</strong><br>
In newer Linux distributions (at least Fedora 22/CentOS 7) the access to a host are very limited. This means that you can&rsquo;t access the Home Assistant Frontend that is running on a host in your network. Check the Post-installation section on the <a href="/getting-started/index.html">Getting started</a> page and follow the instruction that match your distribution to allow access to port 8123.</p>
In newer Linux distributions (at least Fedora 22/CentOS 7) the access to a host are very limited.
This means that you can&rsquo;t access the Home Assistant Frontend that is running on a host in your
network. Check the Post-installation section on the <a href="/getting-started/">Getting started</a> page and
follow the instruction that match your distribution to allow access to port 8123.</p>
</article>