home-assistant.github.io/getting-started/installation-raspberry-pi-image/index.html
2017-01-23 01:04:27 +00:00

404 lines
No EOL
22 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>HASSbian image for Raspberry Pi - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/getting-started/installation-raspberry-pi-image/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="HASSbian image for Raspberry Pi">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/getting-started/installation-raspberry-pi-image/">
<meta property="og:type" content="website">
<meta property="og:description" content="Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi.">
<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="HASSbian image for Raspberry Pi">
<meta name="twitter:description" content="Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.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='/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="/ecosystem/">Ecosystem</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>
</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">
HASSbian Image for Raspberry Pi
</h1>
</header>
<hr class="divider">
<p>The easiest way to install Home Assistant on your Raspberry Pi is by using HASSbian: a Raspberry Pi image with Home Assistant built-in. The image will install the latest version of Home Assistant on initial boot (~5 minutes).</p>
<ol>
<li><a href="https://github.com/home-assistant/pi-gen/releases">Download the latest image</a></li>
<li>Flash the image to an SD card:
<ul>
<li><a href="https://www.raspberrypi.org/documentation/installation/installing-images/windows.md">Windows</a></li>
<li><a href="https://www.raspberrypi.org/documentation/installation/installing-images/linux.md">Linux</a></li>
<li><a href="https://www.raspberrypi.org/documentation/installation/installing-images/mac.md">Mac OS</a></li>
</ul>
</li>
<li>Ensure your Raspberry Pi has access to the internet.</li>
<li>Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes.</li>
</ol>
<p>These instructions are also available as a <a href="https://www.youtube.com/watch?v=iIz6XqDwHEk">video</a>.</p>
<p>Home Assistant will now be available by navigating with a browser to <code class="highlighter-rouge">http://ip-address-of-pi:8123</code>. The default username is <code class="highlighter-rouge">pi</code> and password is <code class="highlighter-rouge">raspberry</code> (please change this by running <code class="highlighter-rouge">passwd</code>). The Home Assistant configuration is located at <code class="highlighter-rouge">/home/homeassistant/.homeassistant/</code>.</p>
<p>The following extras are included on the image:</p>
<ul>
<li>GPIO pins are ready to use.</li>
<li>Mosquitto MQTT broker is installed (not activated by default).</li>
<li>Bluetooth is ready to use (supported models only, no Bluetooth LE).</li>
</ul>
<p>Some extra tips:</p>
<ul>
<li>Check out the list of <a href="/getting-started/installation-raspberry-pi/#raspberry-pi-hardware-specific-components">Raspberry Pi hardware specific components</a>.</li>
<li>Z-Wave support can be installed by following the <a href="/getting-started/z-wave/">Getting started instructions for Z-Wave</a>.</li>
<li>Run <code class="highlighter-rouge">sudo raspi-config</code> to change the locale, timezone and keyboard layout.</li>
</ul>
<h3><a class="title-link" name="technical-details" href="#technical-details"></a> Technical Details</h3>
<ul>
<li>Home Assistant is installed in a virtual Python environment at <code class="highlighter-rouge">/srv/homeassistant/</code></li>
<li>Home Assistant will be started as a service run by the user <code class="highlighter-rouge">homeassistant</code></li>
<li>The configuration is located at <code class="highlighter-rouge">/home/homeassistant/.homeassistant</code></li>
</ul>
<h3><a class="title-link" name="managing-your-hassbian-installation" href="#managing-your-hassbian-installation"></a> Managing your HASSbian installation</h3>
<h4><a class="title-link" name="login-to-hassbian-on-the-raspberry-pi" href="#login-to-hassbian-on-the-raspberry-pi"></a> Login to HASSbian on the Raspberry Pi</h4>
<p>To login to your Raspberry Pi running HASSbian your going to be using a ssh client. Depending on your platform there are several alternatives for doing this. Linux and Max OS generally have a ssh client installed. Windows users are recommended to download and install the ssh client <a href="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html">Putty</a>.</p>
<p>Connect to the Raspberry Pi over ssh. Default user name is <code class="highlighter-rouge">pi</code> and password is <code class="highlighter-rouge">raspberry</code>.<br />
Linux and Mac OS users execute the following command in a terminal.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ssh pi@ip-address-of-pi
</code></pre>
</div>
<p>Windows users start <a href="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html">Putty</a>, enter the IP address of the Raspberry Pi in the <em>Host name</em> field and port 22 in the <em>Port</em> field. Then click <em>Open</em> and a terminal window will open. Enter the credentials. Default user name is <code class="highlighter-rouge">pi</code> and password is <code class="highlighter-rouge">raspberry</code>.</p>
<p>Optionally, starting with Windows 10 anniversary update, you can use the built-in <a href="https://msdn.microsoft.com/en-us/commandline/wsl/about">Bash on Windows</a> to use SSH if you have enabled Developer mode and have installed the “Windows Subsystem for Linux (beta)” feature.</p>
<h4><a class="title-link" name="startstoprestart-home-assistant-on-hassbian" href="#startstoprestart-home-assistant-on-hassbian"></a> Start/Stop/Restart Home Assistant on HaSSbian</h4>
<p>Log in as the <code class="highlighter-rouge">pi</code> account account and execute the following commands:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo systemctl stop home-assistant@homeassistant.service
</code></pre>
</div>
<p>Replace <code class="highlighter-rouge">stop</code> with <code class="highlighter-rouge">start</code> or <code class="highlighter-rouge">restart</code> to get the desired functionality.
To get the current state of the <code class="highlighter-rouge">homeassistant.service</code> replace <code class="highlighter-rouge">stop</code> with <code class="highlighter-rouge">status</code>.</p>
<h4><a class="title-link" name="update-home-assistant-on-hassbian" href="#update-home-assistant-on-hassbian"></a> Update Home Assistant on HASSbian</h4>
<p>Log in as the <code class="highlighter-rouge">pi</code> account and execute the following commands:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo systemctl stop home-assistant@homeassistant.service
<span class="gp">$ </span>sudo su -s /bin/bash homeassistant
<span class="gp">$ </span><span class="nb">source</span> /srv/homeassistant/bin/activate
<span class="gp">$ </span>pip3 install --upgrade homeassistant
<span class="gp">$ </span><span class="nb">exit</span>
<span class="gp">$ </span>sudo systemctl start home-assistant@homeassistant.service
</code></pre>
</div>
<p>This will in order do the following:</p>
<ul>
<li>Stop the Home Assistant service running on HASSbian</li>
<li>Open a shell as the <code class="highlighter-rouge">homeassistant</code> user running the Homeassistant service and that has ownership over the Home Assistant installation.</li>
<li>Change into the virtual Python environment at <code class="highlighter-rouge">/srv/homeassistant/</code> containing the Home Assistant installation.</li>
<li>Upgrade the Home Assistant installation to the latest release.</li>
<li>Exit the shell and return to the <code class="highlighter-rouge">pi</code> user.</li>
<li>Restart the Home Assistant service.</li>
</ul>
<h4><a class="title-link" name="manually-launch-home-assistant-on-hassbian" href="#manually-launch-home-assistant-on-hassbian"></a> Manually launch Home Assistant on HASSbian</h4>
<p>Log in as the <code class="highlighter-rouge">pi</code> account and execute the following commands:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo su -s /bin/bash homeassistant
<span class="gp">$ </span><span class="nb">source</span> /srv/homeassistant/bin/activate
<span class="gp">$ </span>hass
</code></pre>
</div>
<p>This will start Home Assistant in your shell and output anything that ends up in the log and more into the console. This will fail if the Home Assistant service is already running so dont forget to <a href="/getting-started/installation-raspberry-pi-image/#startstoprestart-home-assistant-on-hassbian">stop</a> it first.</p>
<h4><a class="title-link" name="check-your-configuration-on-hassbian" href="#check-your-configuration-on-hassbian"></a> Check your configuration on HASSbian</h4>
<p>Log in as the <code class="highlighter-rouge">pi</code> account and execute the following commands:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo su -s /bin/bash homeassistant
<span class="gp">$ </span><span class="nb">source</span> /srv/homeassistant/bin/activate
<span class="gp">$ </span>hass --script check_config
</code></pre>
</div>
<p>This will output any errors in your configuration files to console.</p>
<h4><a class="title-link" name="read-the-home-assistant-log-file-on-hassbian" href="#read-the-home-assistant-log-file-on-hassbian"></a> Read the Home Assistant log file on HASSbian</h4>
<p>Log in as the <code class="highlighter-rouge">pi</code> account and execute the following commands:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo su -s /bin/bash homeassistant
<span class="gp">$ </span><span class="nb">cd</span> /home/homeassistant/.homeassistant
<span class="gp">$ </span>nano homeassistant.log
</code></pre>
</div>
<p>This will in order do the following:</p>
<ul>
<li>Open a shell as the <code class="highlighter-rouge">homeassistant</code> user.</li>
<li>Change directory to the Home Assistant configuration directory.</li>
<li>Open the log file in the nano editor.</li>
</ul>
<p>Optionaly, you can also view the log with <code class="highlighter-rouge">journalctl</code>.
Log in as the <code class="highlighter-rouge">pi</code> account and execute the following commands:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo journalctl -fu home-assistant@homeassistant.service
</code></pre>
</div>
<h4><a class="title-link" name="edit-the-home-assistant-configuration-on-hassbian" href="#edit-the-home-assistant-configuration-on-hassbian"></a> Edit the Home Assistant configuration on HASSbian</h4>
<p>Log in as the <code class="highlighter-rouge">pi</code> account and execute the following commands:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo su -s /bin/bash homeassistant
<span class="gp">$ </span><span class="nb">cd</span> /home/homeassistant/.homeassistant
<span class="gp">$ </span>nano configuration.yaml
</code></pre>
</div>
<p>This will in order do the following:</p>
<ul>
<li>Open a shell as the <code class="highlighter-rouge">homeassistant</code> user.</li>
<li>Change directory to the Home Assistant configuration directory.</li>
<li>Open the configuration file in the nano editor.</li>
</ul>
<p>Its generally recommended that you read the <a href="/getting-started/configuration/">Getting started</a> guide for how to configure Home Assistant.</p>
<h4><a class="title-link" name="upgrade-and-update-hassbian" href="#upgrade-and-update-hassbian"></a> Upgrade and update HASSbian</h4>
<p>HASSbian is based on Raspbian and uses the same repositories. Any changes to Raspbian will be reflected in HASSbian. To update and upgrade system packages and installed software (excluding Home Assistant) do the following.
Log in as the <code class="highlighter-rouge">pi</code> account and execute the following commands:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo apt-get update
<span class="gp">$ </span>sudo apt-get upgrade
</code></pre>
</div>
<p>Press <code class="highlighter-rouge">Y</code> to confirm that you would like to continue.</p>
<h3><a class="title-link" name="usb-device-permissions" href="#usb-device-permissions"></a> USB device permissions</h3>
<p>When using some USB devices users have to give dialout permission to the user <code class="highlighter-rouge">homeassistant</code> and restart.</p>
<div class="language-shell highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo usermod -a -G dialout homeassistant
<span class="gp">$ </span>sudo reboot
</code></pre>
</div>
<h3><a class="title-link" name="troubleshooting" href="#troubleshooting"></a> Troubleshooting</h3>
<p>If you run into any issues, please see <a href="/getting-started/troubleshooting/">the troubleshooting page</a>. It contains solutions to many of the more commonly encountered issues.</p>
<p>In addition to this site, check out these sources for additional help:</p>
<ul>
<li><a href="https://community.home-assistant.io">Forum</a> for Home Assistant discussions and questions.</li>
<li><a href="https://gitter.im/home-assistant/home-assistant">Gitter Chat Room</a> for real-time chat about Home Assistant.</li>
<li><a href="https://github.com/home-assistant/home-assistant/issues">GitHub Page</a> for issue reporting.</li>
</ul>
<h3><a href="/getting-started/configuration/">Next step: Configuring Home Assistant »</a></h3>
</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='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/getting-started/installation-raspberry-pi-image.markdown'>Edit this page on GitHub</a></div>
<div class='section'>
<h1 class="title delta">Getting Started Guide</h1>
<ul class='divided sidebar-menu'>
<li>
<a href='/getting-started/'>Installation </a>
<ul>
<li><a href='/getting-started/installation-raspberry-pi/'>Raspberry Pi </a></li>
<li><a href='/getting-started/installation-raspberry-pi-all-in-one/'>Raspberry Pi All-In-One Installer </a></li>
<li><a class='active' href='/getting-started/installation-raspberry-pi-image/'>Raspberry Pi Image </a></li>
<li><a href='/getting-started/installation-docker/'>Docker </a></li>
<li><a href='/getting-started/installation-vagrant/'>Vagrant </a></li>
<li><a href='/getting-started/installation-synology/'>Synology NAS </a></li>
<li><a href='/getting-started/installation-virtualenv/'>Virtualenv Linux </a></li>
<li><a href='/getting-started/updating/'>Updating </a></li>
<li><a href='/getting-started/troubleshooting/'>Troubleshooting </a></li>
</ul>
</li>
<li>
<a href='/getting-started/configuration/'>Configuration </a>
<ul>
<li><a href='/getting-started/yaml/'>YAML </a></li>
<li><a href='/getting-started/basic/'>Basic information </a></li>
<li><a href='/getting-started/devices/'>Setting up devices </a></li>
<li><a href='/getting-started/customizing-devices/'>Customizing devices and services </a></li>
<li><a href='/getting-started/presence-detection/'>Presence Detection </a></li>
<li><a href='/getting-started/troubleshooting-configuration/'>Troubleshooting </a></li>
<li><a href='/getting-started/securing/'>Security Check Points </a></li>
</ul>
</li>
<li>
<a href='/getting-started/automation/'>Automation </a>
<ul>
<li><a href='/getting-started/automation-create-first/'>Tutorial </a></li>
<li><a href='/getting-started/automation-trigger/'>Triggers </a></li>
<li><a href='/getting-started/automation-condition/'>Conditions </a></li>
<li><a href='/getting-started/automation-action/'>Actions </a></li>
<li><a href='/getting-started/automation-templating/'>Templates </a></li>
</ul>
</li>
<li>
<a href='/getting-started/scripts/'>Scripts </a>
<ul>
<li><a href='/getting-started/scripts-service-calls/'>Service Calls </a></li>
<li><a href='/getting-started/scripts-conditions/'>Conditions </a></li>
</ul>
</li>
<li>
<a href='/getting-started/z-wave/'>Z-Wave </a>
<ul>
<li><a href='/getting-started/z-wave-controllers/'>Controllers </a></li>
<li><a href='/getting-started/z-wave-settings/'>Modifying Settings </a></li>
<li><a href='/getting-started/z-wave-device-specific/'>Device Specific </a></li>
</ul>
</li>
<li>
<a href='/getting-started/autostart/'>Autostart </a>
<ul>
<li><a href='/getting-started/autostart-systemd/'>Linux - systemd </a></li>
<li><a href='/getting-started/autostart-upstart/'>Linux - Upstart </a></li>
<li><a href='/getting-started/autostart-init.d/'>Linux - init.d </a></li>
<li><a href='/getting-started/autostart-macos/'>macOS </a></li>
<li><a href='/getting-started/autostart-synology/'>Synology NAS </a></li>
</ul>
</li>
<li><a href='/topics/'>Advanced Topics </a></li>
<li><a href='/details/'>Details </a></li>
<li><a href='/getting-started/android/'>Add to Android Homescreen </a></li>
<li><a href='/getting-started/browsers/'>Browser Compatibility List </a></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>.<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>
</body>
</html>