jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/faq/index.html
Travis CI 13155e8ee8 Site updated at 2018-01-27 13:16:56 UTC
2018-01-27 13:16:56 +00:00

235 lines
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>FAQ - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Home Assistant's FAQ">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/faq/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="FAQ">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/faq/">
<meta property="og:type" content="website">
<meta property="og:description" content="Home Assistant's FAQ">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="FAQ">
<meta name="twitter:description" content="Home Assistant's FAQ">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" 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 class='site-header'>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</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">
FAQ
</h1>
</header>
<hr class="divider">
<p>This is a community curated list of frequently asked questions (FAQ) about the installation, setup, and usage of Home Assistant.</p>
<h2><a class="title-link" name="common" href="#common"></a> Common</h2>
<h3><a class="title-link" name="python-2" href="#python-2"></a> Python 2</h3>
<p>There will be no support for Python 2.x. Python 2 will be EOL in <a href="https://www.python.org/dev/peps/pep-0373/#id2">2020</a> and it doesn’t make any sense to support a release which was planned to be retired in 2015.</p>
<h3><a class="title-link" name="releases" href="#releases"></a> Releases</h3>
<p>The usual release cycle is two weeks. Every other weekend will a new release of Home Assistant be available. There is no fix day or time when the release will happen because that depends on the person who is finishing the release. It can already be Monday at your location. If there was no announcement made in the previous release notes or on another communication channel then the release will happen.</p>
<h2><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h2>
<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 class="highlighter-rouge">home-assistant.log</code> file and see if there are any errors related to your component you are trying to set up.</p>
<p>If you have incorrect entries in your configuration files you can use the <code class="highlighter-rouge">check_config</code> script to assist in identifying them: <code class="highlighter-rouge">hass --script check_config</code>.</p>
<h3><a class="title-link" name="why-are-you-using-yaml-for-the-configuration-file" href="#why-are-you-using-yaml-for-the-configuration-file"></a> Why are you using YAML for the configuration file?</h3>
<p>And not JSON or XML for the <a href="/docs/configuration/">configuration file</a>? Because <a href="/docs/configuration/yaml/">YAML</a> can be written by hand, you don’t have to care about commas or tag and it’s a superset of JSON.</p>
<h2><a class="title-link" name="documentation" href="#documentation"></a> Documentation</h2>
<h3><a class="title-link" name="documentation-tools" href="#documentation-tools"></a> Documentation tools</h3>
<p>Why are you not using tools X for the documentation? Because the current solution works for us and we see no additional value in using a separate publishing platform.</p>
<h3><a class="title-link" name="missing-documentation" href="#missing-documentation"></a> Missing Documentation</h3>
<p>Home Assistant is a FAST moving open source project. This means occasionally the official documentation will not be 100% current or complete. Since this is an open source volunteer project, we would encourage anyone who finds gaps in the documentation to click the <code class="highlighter-rouge">edit this page on Github</code> link in the top right and submit any corrections/enhancements they may find useful.</p>
<p>In the absence of information, many users find it beneficial to look at other people’s configurations to find examples of what they want to accomplish in their own configurations. The easiest way to find these configurations is through this <a href="https://github.com/search?q=topic%3Ahome-assistant-config&amp;type=Repositories">Github search</a>.</p>
<h2><a class="title-link" name="installation" href="#installation"></a> Installation</h2>
<h3><a class="title-link" name="no-module-named-pip" href="#no-module-named-pip"></a> No module named pip</h3>
<p><a href="https://pip.pypa.io/en/stable/">Pip</a> should come bundled with the latest Python 3 but is omitted by some distributions. If you are unable to run <code class="highlighter-rouge">python3 -m pip --version</code> you can install <code class="highlighter-rouge">pip</code> by <a href="https://bootstrap.pypa.io/get-pip.py">downloading the installer</a> and running it with Python 3:</p>
<div class="language-bash highlighter-rouge">
<pre class="highlight"><code><span class="gp">$ </span>python3 get-pip.py
</code></pre>
</div>
<h3><a class="title-link" name="distutilserrorsdistutilsoptionerror" href="#distutilserrorsdistutilsoptionerror"></a> distutils.errors.DistutilsOptionError</h3>
<p>The problem which leads to <code class="highlighter-rouge">distutils.errors.DistutilsOptionError: must supply either home or prefix/exec-prefix -- not both</code> is a known issue if you’re on a Mac using Homebrew to install Python. Please follow <a href="https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md#note-on-pip-install---user">these instructions</a> to resolve it.</p>
<h3><a class="title-link" name="libyaml-is-not-found-or-a-compiler-error" href="#libyaml-is-not-found-or-a-compiler-error"></a> libyaml is not found or a compiler error</h3>
<p>On a Debian system, install the Python 3 YAML library by <code class="highlighter-rouge">sudo apt-get install python3-yaml</code>.</p>
<h3><a class="title-link" name="pip3-command-not-found" href="#pip3-command-not-found"></a> pip3: command not found</h3>
<p>This utility should have been installed as part of the Python 3.4 installation. Check if Python 3.4 is installed by running <code class="highlighter-rouge">python3 --version</code>. If it is not installed, <a href="https://www.python.org/getit/">download it here</a>.</p>
<p>If you are able to successfully run <code class="highlighter-rouge">python3 --version</code> but not <code class="highlighter-rouge">pip3</code>, install Home Assistant by running the following command instead:</p>
<div class="language-bash highlighter-rouge">
<pre class="highlight"><code><span class="gp">$ </span>python3 -m pip install homeassistant
</code></pre>
</div>
<p>On a Debian system, you can also install python3 by <code class="highlighter-rouge">sudo apt-get install python3</code>d and pip3 by <code class="highlighter-rouge">sudo apt-get install python3-pip</code>.</p>
<h2><a class="title-link" name="usage" href="#usage"></a> Usage</h2>
<h3><a class="title-link" name="after-upgrading-your-browser-login-gets-stuck" href="#after-upgrading-your-browser-login-gets-stuck"></a> After upgrading, your browser login gets stuck</h3>
<p>After upgrading to a new version, you may notice your browser gets stuck at the “loading data” login screen. Close the window/tab and go into your browser settings and delete all the cookies for your URL. You can then log back in and it should work.</p>
<p>Android Chrome</p>
<p>chrome -&gt; settings -&gt; site settings -&gt; storage -&gt; search for your URL for Home Assistant-&gt; “clear &amp; reset”</p>
<h3><a class="title-link" name="connection-error" href="#connection-error"></a> Connection error</h3>
<p>It can happen that you get a traceback that notify you about connection issues while running Home Assistant. Eg.</p>
<div class="language-bash highlighter-rouge">
<pre class="highlight"><code>ConnectionRefusedError: <span class="o">[</span>Errno 111] Connection refused
</code></pre>
</div>
<p>The chance is very high that this is not a bug but an issue with the service/daemon itself. Check your network (DNS, DHCP, uplink, etc.) first and make sure that Home Assistant and the service are poperly configured. Keep in mind that webservices can be down.</p>
<h3><a class="title-link" name="dependencies" href="#dependencies"></a> Dependencies</h3>
<p>The dependencies which are used by Home Assistant are stored in the folder <code class="highlighter-rouge">deps</code> of the <a href="/docs/configuration/">configuration folder</a> directory. After an <a href="/docs/installation/updating/">upgrade</a> the dependences will be upgraded as well.</p>
<h3><a class="title-link" name="frontend-is-acting-weird" href="#frontend-is-acting-weird"></a> Frontend is acting weird</h3>
<p>Close the windows or tab and clear the cache. The frontend is aggressively caching and clearing the cache ensures that the frontend is reloaded when you access it the next time.</p>
<h3><a class="title-link" name="problems-with-dependencies" href="#problems-with-dependencies"></a> Problems with dependencies</h3>
<p>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 class="highlighter-rouge">home-assistant.log</code>.</p>
<p>The first step is trying to restart Home Assistant and see if the problem persists. If it does, look at the log to see what the error is. If you can’t figure it out, please <a href="https://github.com/home-assistant/home-assistant/issues">report it</a> so we can investigate what is going on.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='section'>
<h1 class="title delta">Entries</h1>
<ul class='divided sidebar-menu'>
<li>
<b>Common</b>
<ul>
<li><a href='/faq#python-2'>Python 2</a></li>
<li><a href='/faq#releases'>Releases</a></li>
</ul>
</li>
<li>
<b>Configuration</b>
<ul>
<li><a href='/faq#my-component-does-not-show-up'>My component does not show up</a></li>
<li><a href='/faq#why-are-you-using-yaml-for-the-configuration-file'>Why are you using YAML for the configuration file?</a></li>
</ul>
</li>
<li>
<b>Documentation</b>
<ul>
<li><a href='/faq#documentation-tools'>Documentation tools</a></li>
<li><a href='/faq#missing-documentation'>Missing Documentation</a></li>
</ul>
</li>
<li>
<b>Installation</b>
<ul>
<li><a href='/faq#no-module-named-pip'>No module named pip</a></li>
<li><a href='/faq#distutils-errors-distutilsoptionerror'>distutils.errors.DistutilsOptionError</a></li>
<li><a href='/faq#libyaml-is-not-found-or-a-compiler-error'>libyaml is not found or a compiler error</a></li>
<li><a href='/faq#pip3-command-not-found'>pip3: command not found</a></li>
</ul>
</li>
<li>
<b>Usage</b>
<ul>
<li><a href='/faq#after-upgrading-your-browser-login-gets-stuck'>After upgrading, your browser login gets stuck</a></li>
<li><a href='/faq#connection-error'>Connection error</a></li>
<li><a href='/faq#dependencies'>Dependencies</a></li>
<li><a href='/faq#frontend-is-acting-weird'>Frontend is acting weird</a></li>
<li><a href='/faq#problems-with-dependencies'>Problems with dependencies</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink