Streamline getting started installation (#1968)
This commit is contained in:
Paulus Schoutsen
GitHub
parent
b8d1ec99fc
commit
de374b280d
17 changed files with 824 additions and 400 deletions
29
source/getting-started/getting-started-alternatives.markdown
Normal file
29
source/getting-started/getting-started-alternatives.markdown
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
layout: page
|
||||
title: "HASSbian image for Raspberry Pi"
|
||||
description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
---
|
||||
layout: page
|
||||
title: "Installing Home Assistant"
|
||||
description: "Instructions to get started using Home Assistant."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Installing Home Assistant is bla bla. Choose options:
|
||||
|
||||
- [Raspberry Pi][rpi]
|
||||
- [Python]
|
||||
|
||||
[rpi]: /getting-started/installation-raspberry-pi-image/
|
||||
[Python]: /getting-started/installation-python/
|
||||
129
source/getting-started/hassbian-common-tasks.markdown
Normal file
129
source/getting-started/hassbian-common-tasks.markdown
Normal file
|
|
@ -0,0 +1,129 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Common tasks on Hassbian"
|
||||
description: "Instructions how to do common tasks on Hassbian."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
### {% linkable_title Login to the Raspberry Pi %}
|
||||
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 [Putty][ssh-putty].
|
||||
|
||||
Connect to the Raspberry Pi over ssh. Default user name is `pi` and password is `raspberry`.
|
||||
Linux and Mac OS users execute the following command in a terminal.
|
||||
|
||||
```bash
|
||||
$ ssh pi@ip-address-of-pi
|
||||
```
|
||||
|
||||
Windows users start [Putty][ssh-putty], enter the IP address of the Raspberry Pi in the *Host name* field and port 22 in the *Port* field. Then click *Open* and a terminal window will open. Enter the credentials. Default user name is `pi` and password is `raspberry`.
|
||||
|
||||
Optionally, starting with Windows 10 anniversary update, you can use the built-in '[Bash on Windows][bash-windows]' to use SSH if you have enabled Developer mode and have installed the "Windows Subsystem for Linux (beta)" feature.
|
||||
|
||||
### {% linkable_title Start/Stop/Restart Home Assistant %}
|
||||
Log in as the `pi` account account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo systemctl stop home-assistant@homeassistant.service
|
||||
```
|
||||
|
||||
Replace `stop` with `start` or `restart` to get the desired functionality.
|
||||
To get the current state of the `homeassistant.service` replace `stop` with `status`.
|
||||
|
||||
### {% linkable_title Update Home Assistant %}
|
||||
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo systemctl stop home-assistant@homeassistant.service
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ source /srv/homeassistant/bin/activate
|
||||
$ pip3 install --upgrade homeassistant
|
||||
$ exit
|
||||
$ sudo systemctl start home-assistant@homeassistant.service
|
||||
```
|
||||
|
||||
This will in order do the following:
|
||||
|
||||
- Stop the Home Assistant service running on HASSbian
|
||||
- Open a shell as the `homeassistant` user running the Homeassistant service and that has ownership over the Home Assistant installation.
|
||||
- Change into the virtual Python environment at `/srv/homeassistant/` containing the Home Assistant installation.
|
||||
- Upgrade the Home Assistant installation to the latest release.
|
||||
- Exit the shell and return to the `pi` user.
|
||||
- Restart the Home Assistant service.
|
||||
|
||||
### {% linkable_title Manually launch Home Assistant %}
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ source /srv/homeassistant/bin/activate
|
||||
$ hass
|
||||
```
|
||||
|
||||
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 don't forget to [stop][stop-homeassistant] it first.
|
||||
|
||||
### {% linkable_title Check your configuration %}
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ source /srv/homeassistant/bin/activate
|
||||
$ hass --script check_config
|
||||
```
|
||||
|
||||
This will output any errors in your configuration files to console.
|
||||
|
||||
### {% linkable_title Read the Home Assistant log file %}
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ cd /home/homeassistant/.homeassistant
|
||||
$ nano homeassistant.log
|
||||
```
|
||||
|
||||
This will in order do the following:
|
||||
|
||||
- Open a shell as the `homeassistant` user.
|
||||
- Change directory to the Home Assistant configuration directory.
|
||||
- Open the log file in the nano editor.
|
||||
|
||||
Optionaly, you can also view the log with `journalctl`.
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo journalctl -fu home-assistant@homeassistant.service
|
||||
```
|
||||
|
||||
### {% linkable_title Edit the Home Assistant configuration %}
|
||||
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ cd /home/homeassistant/.homeassistant
|
||||
$ nano configuration.yaml
|
||||
```
|
||||
|
||||
This will in order do the following:
|
||||
|
||||
- Open a shell as the `homeassistant` user.
|
||||
- Change directory to the Home Assistant configuration directory.
|
||||
- Open the configuration file in the nano editor.
|
||||
|
||||
It's generally recommended that you read the [Getting started][configuring-homeassistant] guide for how to configure Home Assistant.
|
||||
|
||||
### {% linkable_title Change locale, timezone and keyboard layout %}
|
||||
|
||||
```bash
|
||||
$ sudo raspi-config
|
||||
```
|
||||
|
||||
[configuring-homeassistant]: /getting-started/configuration/
|
||||
[ssh-putty]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
|
||||
[stop-homeassistant]: /getting-started/installation-raspberry-pi-image/#startstoprestart-home-assistant-on-hassbian
|
||||
[bash-windows]: https://msdn.microsoft.com/en-us/commandline/wsl/about
|
||||
22
source/getting-started/hassbian-customization.markdown
Normal file
22
source/getting-started/hassbian-customization.markdown
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Customization"
|
||||
description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
To allow you to customize your installation further, we have included a set of Hassbian scripts.
|
||||
|
||||
- Install Samba. Allows anyone on your network to edit your configuration from any computer. This share is unsecured and it's usage is not recommended if you share your network with others.
|
||||
- Install Libcec. Adds local [HDMI CEC support][cec].
|
||||
- Install Mossquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects offical repository. Now includes websocket support.
|
||||
- Install Open Z-Wave. Installs Open Z-Wave and prepares for using a USB or GPIO ZWave controller.
|
||||
|
||||
All of these scripts are available in the directory `/home/pi/hassbian-scripts/`. For more information about these scripts have a look at the [hassbian-scripts repository][hassbian-repo].
|
||||
|
||||
[hassbian-repo]: https://github.com/home-assistant/hassbian-scripts#the-included-scripts
|
||||
[cec]: /components/hdmi_cec/
|
||||
50
source/getting-started/hassbian-installation.markdown
Normal file
50
source/getting-started/hassbian-installation.markdown
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Installing Hassbian"
|
||||
description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
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 (~10 minutes).
|
||||
|
||||
1. [Download the Hassbian 1.1 image][image-download] (359MB)
|
||||
2. Use [Etcher][etcher] to flash the image to your SD card
|
||||
3. Ensure your Raspberry Pi has access to the internet.
|
||||
4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes.
|
||||
|
||||
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk).
|
||||
|
||||
After initial boot, you can reach Home Assistant in your browser at [http://hassbian.local:8123]. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`.
|
||||
|
||||
The following extras are included on the image:
|
||||
|
||||
- GPIO pins are ready to use.
|
||||
- Bluetooth is ready to use (supported models only, no Bluetooth LE).
|
||||
|
||||
### {% linkable_title Technical Details %}
|
||||
|
||||
- Home Assistant is installed in a virtual Python environment at `/srv/homeassistant/`
|
||||
- Home Assistant will be started as a service run by the user `homeassistant`
|
||||
- The configuration is located at `/home/homeassistant/.homeassistant`
|
||||
|
||||
|
||||
### {% linkable_title Troubleshooting %}
|
||||
|
||||
If you run into any issues, please see [the troubleshooting page](/getting-started/troubleshooting/). It contains solutions to many of the more commonly encountered issues.
|
||||
|
||||
In addition to this site, check out these sources for additional help:
|
||||
|
||||
- [Forum](https://community.home-assistant.io) for Home Assistant discussions and questions.
|
||||
- [Gitter Chat Room](https://gitter.im/home-assistant/home-assistant) for real-time chat about Home Assistant.
|
||||
- [GitHub Page](https://github.com/home-assistant/home-assistant/issues) for issue reporting.
|
||||
|
||||
### [Learn how to configure Home Assistant »](/getting-started/configuration/)
|
||||
### [Learn common tasks in Hassbian »](/getting-started/hassbian-common-tasks/)
|
||||
|
||||
[image-download]: https://github.com/home-assistant/pi-gen/releases/download/v1.1/image_2017-02-03-HASSbian.zip
|
||||
[etcher]: https://etcher.io/
|
||||
[http://hassbian.local:8123]: http://hassbian.local:8123
|
||||
100
source/getting-started/hassbian-integrations.markdown
Normal file
100
source/getting-started/hassbian-integrations.markdown
Normal file
|
|
@ -0,0 +1,100 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Raspberry Pi integrations"
|
||||
description: "Home Assistant integrations specific to the Raspberry Pi."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Some components that are specific for the Raspberry Pi can require some further configuration outside of Home Assistant. All commands below are assumed to be executed with the `pi` account. For full documentation of these components refer to the [components](/components) page.
|
||||
|
||||
### {% linkable_title Bluetooth Tracker %}
|
||||
|
||||
The Bluetooth tracker will work on a Raspberry Pi 3 with the built-in Bluetooth module or with a USB Bluetooth device on any of the other Raspberry Pi's.
|
||||
|
||||
Install the following external dependencies.
|
||||
```bash
|
||||
$ sudo apt-get install bluetooth libbluetooth-dev
|
||||
```
|
||||
After this follow the [Bluetooth Tracker component](/components/device_tracker.bluetooth_tracker/) and [Device Tracker page](/components/device_tracker/) pages.
|
||||
|
||||
### {% linkable_title Raspberry Pi Camera %}
|
||||
|
||||
The Raspberry Pi Camera is a specific camera for the Raspberry Pi boards. For more information about the camera I suggest reading the [documentation](https://www.raspberrypi.org/documentation/usage/camera/) from the Raspberry Pi foundation.
|
||||
|
||||
To use the camera it needs to be enabled with the `raspi-config` utility.
|
||||
|
||||
```bash
|
||||
$ sudo raspi-config
|
||||
```
|
||||
|
||||
Select `Enable camera` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
|
||||
|
||||
After reboot add your `homeassistant` account to the `video` group.
|
||||
|
||||
```bash
|
||||
$ sudo adduser homeassistant video
|
||||
```
|
||||
|
||||
After this follow the [Raspberry Pi Camera component](/components/camera.rpi_camera/) page.
|
||||
|
||||
### {% linkable_title Raspberry Pi GPIO %}
|
||||
|
||||
Each of the following devices are connected to the GPIO pins on the Raspberry Pi.
|
||||
For more details about the GPIO layout, visit the [documentation](https://www.raspberrypi.org/documentation/usage/gpio/) from the Raspberry Pi foundation.
|
||||
|
||||
Since these are not normally used some extra permission will need to be added.
|
||||
In general the permission that is needed is granted by adding the `homeassistant` account to the `gpio` group.
|
||||
|
||||
### {% linkable_title Raspberry Pi Cover %}
|
||||
|
||||
Add your `homeassistant` account to the `gpio` group
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [Raspberry Pi Cover component](/components/cover.rpi_gpio/) page.
|
||||
|
||||
### {% linkable_title DHT Sensor %}
|
||||
|
||||
Add your `homeassistant` account to the `gpio` group
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [DHT Sensor component](/components/sensor.dht/) page.
|
||||
|
||||
|
||||
### {% linkable_title Raspberry PI GPIO Binary Sensor %}
|
||||
|
||||
Add your `homeassistant` account to the `gpio` group
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [Raspberry PI GPIO Binary Sensor component](/components/binary_sensor.rpi_gpio/) page.
|
||||
|
||||
### {% linkable_title Raspberry PI GPIO Switch %}
|
||||
|
||||
Add your `homeassistant` account to the `gpio` group.
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [Raspberry PI GPIO Switch component](/components/switch.rpi_gpio/) page.
|
||||
|
||||
### {% linkable_title Raspberry Pi RF Switch %}
|
||||
|
||||
Add your `homeassistant` account to the `gpio` group
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [Raspberry Pi RF Switch component](/components/switch.rpi_rf/) page.
|
||||
|
||||
### {% linkable_title One wire Sensor %}
|
||||
|
||||
The One wire sensor requires that support for it is enabled on the Raspberry Pi and that the One Wire device is connected to GPIO pin 4.
|
||||
To enable One Wire support add the following line to the end of `/boot/config.txt`
|
||||
```yaml
|
||||
dtoverlay=w1-gpio
|
||||
```
|
||||
After this follow the [One Wire Sensor component](/components/sensor.onewire/) page.
|
||||
29
source/getting-started/hassbian-upgrading.markdown
Normal file
29
source/getting-started/hassbian-upgrading.markdown
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Upgrading Hassbian"
|
||||
description: "Instructions how to upgrade Hasbian to the latest version."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
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 `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo apt-get update
|
||||
$ sudo apt-get upgrade
|
||||
```
|
||||
|
||||
Press `Y` to confirm that you would like to continue.
|
||||
|
||||
#### {% linkable_title Upgrading the hassbian-scripts %}
|
||||
|
||||
To update the hassbian-scripts directory execute the following command as the `pi` user.
|
||||
|
||||
```bash
|
||||
$ cd hassbian-scripts
|
||||
$ git pull
|
||||
```
|
||||
22
source/getting-started/hassbian.markdown
Normal file
22
source/getting-started/hassbian.markdown
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Hassbian"
|
||||
description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Hassbian is our customized operating system for the Raspberry Pi 3. It is the easiest way of installing Home Assistant.
|
||||
|
||||
- [Install Hassbian][install]
|
||||
- [Customize your installation][customize]
|
||||
- [Pi specific integrations][integrations]
|
||||
- [Learn how to perform common tasks][common]
|
||||
|
||||
[install]: /getting-started/hassbian-installatino/
|
||||
[customize]: /getting-started/hassbian-customization/
|
||||
[common]: /getting-started/hassbian-common-tasks/
|
||||
[integrations]: /getting-started/hassbian-integrations/
|
||||
|
|
@ -1,52 +1,41 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Getting Started"
|
||||
description: "Step by step guide to get started with Home Assistant."
|
||||
date: 2014-12-18 22:57
|
||||
title: "Installing Home Assistant"
|
||||
description: "Instructions to get started using Home Assistant."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Below you can find the standard instructions. See the sidebar for installation instructions for specific platforms. If you're running a Linux-based platform, we suggest you follow the [VirtualEnv Linux instructions] to avoid using root.
|
||||
You will need to install Home Assistant before we can get started. You can install Home Assistant on your computer or you can turn a Raspberry Pi into a dedicated Home Assistant hub.
|
||||
|
||||
[Virtualenv Linux instructions]: /getting-started/installation-virtualenv/
|
||||
<div class="text-center hass-option-cards" markdown="0">
|
||||
<a class='option-card' href='/getting-started/hassbian-installation/'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/raspberry-pi.png' />
|
||||
</div>
|
||||
<div class='title'>Install Hassbian on your Raspberry Pi 3</div>
|
||||
</a>
|
||||
<a class='option-card' href='/getting-started/installation-python/'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/python.svg' />
|
||||
</div>
|
||||
<div class='title'>Install Home Assistant on your computer</div>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
Installing and running Home Assistant on your local machine is easy. The only requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows we require at least Python 3.5 and for other operating systems at least Python 3.4.2. Once installed, execute the following code in a console:
|
||||
### {% linkable_title Alternative methods %}
|
||||
|
||||
```bash
|
||||
$ pip3 install homeassistant
|
||||
$ hass --open-ui
|
||||
```
|
||||
For advanced users we have several alternative guides for installing Home Assistant.
|
||||
|
||||
Running these commands will:
|
||||
- [Docker](/getting-started/installation-docker/)
|
||||
- [Manual Raspberry Pi installtion](/getting-started/installation-raspberry-pi/) (requires existing Raspbian installation)
|
||||
- [Raspberry Pi All-In-One Installer Script](/getting-started/installation-raspberry-pi-all-in-one/) (requires existing Raspbian installation)
|
||||
- [Vagrant](/getting-started/installation-vagrant/)
|
||||
- [Synology NAS](/getting-started/installation-synology/)
|
||||
- [Virtualenv Linux](/getting-started/installation-virtualenv/)
|
||||
|
||||
- Install Home Assistant
|
||||
- Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123)
|
||||
|
||||
If you prefer to watch a video tutorial, [tktino](https://github.com/tktino) has made some great ones:
|
||||
|
||||
- [Windows 10](https://www.youtube.com/watch?v=X27eVvuqwnY)
|
||||
- [Mac OS X](https://www.youtube.com/watch?v=hej6ipN86ls)
|
||||
- [Ubuntu 14.04](https://www.youtube.com/watch?v=SXaAG1lGNH0)
|
||||
|
||||
### {% linkable_title Updating %}
|
||||
|
||||
To update Home Assistant to the latest release check the [Updating section](/getting-started/updating/).
|
||||
|
||||
### {% linkable_title Troubleshooting %}
|
||||
|
||||
If you run into any issues, please see [the troubleshooting page](/getting-started/troubleshooting/). It contains solutions to many commonly encountered issues.
|
||||
|
||||
In addition to this site, check out these sources for additional help:
|
||||
|
||||
- [Forum](https://community.home-assistant.io) for Home Assistant discussions and questions
|
||||
- [Gitter Chat Room](https://gitter.im/home-assistant/home-assistant) for real-time chat about Home Assistant
|
||||
- [GitHub Page](https://github.com/home-assistant/home-assistant/issues) for issue reporting
|
||||
|
||||
### {% linkable_title What's next? %}
|
||||
|
||||
To see what Home Assistant can do, launch demo mode: `hass --demo-mode` or visit the [demo page](/demo).
|
||||
|
||||
### [Next step: Configuring Home Assistant »](/getting-started/configuration/)
|
||||
[rpi]: /getting-started/installation-raspberry-pi-image/
|
||||
[python]: /getting-started/installation-python/
|
||||
|
|
|
|||
54
source/getting-started/installation-python.markdown
Normal file
54
source/getting-started/installation-python.markdown
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Installation on your computer"
|
||||
description: "Step by step guide to install Home Assistant on your computer."
|
||||
date: 2014-12-18 22:57
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Installing and running Home Assistant on your local machine is easy. The only requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows we require at least Python 3.5 and for other operating systems at least Python 3.4.2.
|
||||
|
||||
Once installed, execute the following code in a console:
|
||||
|
||||
```bash
|
||||
$ pip3 install homeassistant
|
||||
$ hass --open-ui
|
||||
```
|
||||
|
||||
Running these commands will:
|
||||
|
||||
- Install Home Assistant
|
||||
- Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123)
|
||||
|
||||
If you're running a Linux-based platform, we suggest you follow the [VirtualEnv Linux instructions][virtualenv] to avoid using root.
|
||||
|
||||
Video tutorials of this process for various operating systems are available here:
|
||||
|
||||
- [Windows 10](https://www.youtube.com/watch?v=X27eVvuqwnY)
|
||||
- [Mac OS X](https://www.youtube.com/watch?v=hej6ipN86ls)
|
||||
- [Ubuntu 14.04](https://www.youtube.com/watch?v=SXaAG1lGNH0)
|
||||
|
||||
### {% linkable_title Updating %}
|
||||
|
||||
To update Home Assistant to the latest release check the [Updating section](/getting-started/updating/).
|
||||
|
||||
### {% linkable_title Troubleshooting %}
|
||||
|
||||
If you run into any issues, please see [the troubleshooting page](/getting-started/troubleshooting/). It contains solutions to many commonly encountered issues.
|
||||
|
||||
In addition to this site, check out these sources for additional help:
|
||||
|
||||
- [Forum](https://community.home-assistant.io) for Home Assistant discussions and questions
|
||||
- [Gitter Chat Room](https://gitter.im/home-assistant/home-assistant) for real-time chat about Home Assistant
|
||||
- [GitHub Page](https://github.com/home-assistant/home-assistant/issues) for issue reporting
|
||||
|
||||
### {% linkable_title What's next? %}
|
||||
|
||||
To see what Home Assistant can do, launch demo mode: `hass --demo-mode` or visit the [demo page](/demo).
|
||||
|
||||
### [Next step: Configuring Home Assistant »](/getting-started/configuration/)
|
||||
|
||||
[virtualenv]: /getting-started/installation-virtualenv/
|
||||
|
|
@ -1,197 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "HASSbian image for Raspberry Pi"
|
||||
description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
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 (~10 minutes).
|
||||
|
||||
1. [Download the latest image][image-download]
|
||||
2. Flash the image to an SD card:
|
||||
- [Windows][flash-windows]
|
||||
- [Linux][flash-linux]
|
||||
- [Mac OS][flash-macos]
|
||||
3. Ensure your Raspberry Pi has access to the internet.
|
||||
4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes.
|
||||
|
||||
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk).
|
||||
|
||||
Home Assistant will now be available by navigating with a browser to `http://ip-address-of-pi:8123`. The default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`.
|
||||
|
||||
The following extras are included on the image:
|
||||
|
||||
- GPIO pins are ready to use.
|
||||
- Bluetooth is ready to use (supported models only, no Bluetooth LE).
|
||||
- Hassbian-scripts. A set of script written to add extra functionality to your Raspberry Pi installation.
|
||||
Currently includes:
|
||||
- Install Libcec. Adds local [HDMI CEC support][cec].
|
||||
- Install Mossquitto. Installs the latest Mosquitto package and client tools from the Mosquitto projects offical repository. Now includes websocket support.
|
||||
- Install OpenZWave. Installs OpenZWave and prepares for using a USB or GPIO ZWave controller.
|
||||
- Install Samba. Installs the Samba packages and shares you configuration over smb to be available to edit on any computer without the need for separate file transfer software. This share is unsecured and it's usage is not recommended if your installation is publicly available.
|
||||
|
||||
All of these scripts are available in the directory `/home/pi/hassbian-scripts/`. This directory is actually a cloned git repository that's clone on first boot and can be updated to the latest release with ease after.
|
||||
To update the hassbian-scripts directory execute the following command as the `pi` user.
|
||||
```bash
|
||||
$ cd hassbian-scripts
|
||||
$ git pull
|
||||
```
|
||||
For more information about these scripts have a look at the [hassbian-scripts repository][hassbian-repo].
|
||||
|
||||
Some extra tips:
|
||||
|
||||
- Check out the list of [Raspberry Pi hardware specific components][pi-components].
|
||||
- Run `sudo raspi-config` to change the locale, timezone and keyboard layout.
|
||||
|
||||
### {% linkable_title Technical Details %}
|
||||
|
||||
- Home Assistant is installed in a virtual Python environment at `/srv/homeassistant/`
|
||||
- Home Assistant will be started as a service run by the user `homeassistant`
|
||||
- The configuration is located at `/home/homeassistant/.homeassistant`
|
||||
|
||||
### {% linkable_title Managing your HASSbian installation %}
|
||||
#### {% linkable_title Login to HASSbian on the Raspberry Pi %}
|
||||
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 [Putty][ssh-putty].
|
||||
|
||||
Connect to the Raspberry Pi over ssh. Default user name is `pi` and password is `raspberry`.
|
||||
Linux and Mac OS users execute the following command in a terminal.
|
||||
|
||||
```bash
|
||||
$ ssh pi@ip-address-of-pi
|
||||
```
|
||||
|
||||
Windows users start [Putty][ssh-putty], enter the IP address of the Raspberry Pi in the *Host name* field and port 22 in the *Port* field. Then click *Open* and a terminal window will open. Enter the credentials. Default user name is `pi` and password is `raspberry`.
|
||||
|
||||
Optionally, starting with Windows 10 anniversary update, you can use the built-in '[Bash on Windows][bash-windows]' to use SSH if you have enabled Developer mode and have installed the "Windows Subsystem for Linux (beta)" feature.
|
||||
|
||||
#### {% linkable_title Start/Stop/Restart Home Assistant on HaSSbian %}
|
||||
Log in as the `pi` account account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo systemctl stop home-assistant@homeassistant.service
|
||||
```
|
||||
|
||||
Replace `stop` with `start` or `restart` to get the desired functionality.
|
||||
To get the current state of the `homeassistant.service` replace `stop` with `status`.
|
||||
|
||||
#### {% linkable_title Update Home Assistant on HASSbian %}
|
||||
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo systemctl stop home-assistant@homeassistant.service
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ source /srv/homeassistant/bin/activate
|
||||
$ pip3 install --upgrade homeassistant
|
||||
$ exit
|
||||
$ sudo systemctl start home-assistant@homeassistant.service
|
||||
```
|
||||
|
||||
This will in order do the following:
|
||||
|
||||
- Stop the Home Assistant service running on HASSbian
|
||||
- Open a shell as the `homeassistant` user running the Homeassistant service and that has ownership over the Home Assistant installation.
|
||||
- Change into the virtual Python environment at `/srv/homeassistant/` containing the Home Assistant installation.
|
||||
- Upgrade the Home Assistant installation to the latest release.
|
||||
- Exit the shell and return to the `pi` user.
|
||||
- Restart the Home Assistant service.
|
||||
|
||||
#### {% linkable_title Manually launch Home Assistant on HASSbian %}
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ source /srv/homeassistant/bin/activate
|
||||
$ hass
|
||||
```
|
||||
|
||||
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 don't forget to [stop][stop-homeassistant] it first.
|
||||
|
||||
#### {% linkable_title Check your configuration on HASSbian %}
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ source /srv/homeassistant/bin/activate
|
||||
$ hass --script check_config
|
||||
```
|
||||
|
||||
This will output any errors in your configuration files to console.
|
||||
|
||||
#### {% linkable_title Read the Home Assistant log file on HASSbian %}
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ cd /home/homeassistant/.homeassistant
|
||||
$ nano homeassistant.log
|
||||
```
|
||||
|
||||
This will in order do the following:
|
||||
|
||||
- Open a shell as the `homeassistant` user.
|
||||
- Change directory to the Home Assistant configuration directory.
|
||||
- Open the log file in the nano editor.
|
||||
|
||||
Optionaly, you can also view the log with `journalctl`.
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo journalctl -fu home-assistant@homeassistant.service
|
||||
```
|
||||
|
||||
#### {% linkable_title Edit the Home Assistant configuration on HASSbian %}
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ cd /home/homeassistant/.homeassistant
|
||||
$ nano configuration.yaml
|
||||
```
|
||||
|
||||
This will in order do the following:
|
||||
|
||||
- Open a shell as the `homeassistant` user.
|
||||
- Change directory to the Home Assistant configuration directory.
|
||||
- Open the configuration file in the nano editor.
|
||||
|
||||
It's generally recommended that you read the [Getting started][configuring-homeassistant] guide for how to configure Home Assistant.
|
||||
|
||||
#### {% linkable_title Upgrade and update HASSbian %}
|
||||
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 `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
$ sudo apt-get update
|
||||
$ sudo apt-get upgrade
|
||||
```
|
||||
|
||||
Press `Y` to confirm that you would like to continue.
|
||||
|
||||
### {% linkable_title Troubleshooting %}
|
||||
|
||||
If you run into any issues, please see [the troubleshooting page](/getting-started/troubleshooting/). It contains solutions to many of the more commonly encountered issues.
|
||||
|
||||
In addition to this site, check out these sources for additional help:
|
||||
|
||||
- [Forum](https://community.home-assistant.io) for Home Assistant discussions and questions.
|
||||
- [Gitter Chat Room](https://gitter.im/home-assistant/home-assistant) for real-time chat about Home Assistant.
|
||||
- [GitHub Page](https://github.com/home-assistant/home-assistant/issues) for issue reporting.
|
||||
|
||||
### [Next step: Configuring Home Assistant »](/getting-started/configuration/)
|
||||
[image-download]: https://github.com/home-assistant/pi-gen/releases
|
||||
[flash-linux]: https://www.raspberrypi.org/documentation/installation/installing-images/linux.md
|
||||
[flash-macos]: https://www.raspberrypi.org/documentation/installation/installing-images/mac.md
|
||||
[flash-windows]: https://www.raspberrypi.org/documentation/installation/installing-images/windows.md
|
||||
[cec]: /components/hdmi_cec/
|
||||
[pi-components]: /getting-started/installation-raspberry-pi/#raspberry-pi-hardware-specific-components
|
||||
[hassbian-repo]: https://github.com/home-assistant/hassbian-scripts
|
||||
[ssh-putty]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
|
||||
[stop-homeassistant]: /getting-started/installation-raspberry-pi-image/#startstoprestart-home-assistant-on-hassbian
|
||||
[configuring-homeassistant]: /getting-started/configuration/
|
||||
[bash-windows]: https://msdn.microsoft.com/en-us/commandline/wsl/about
|
||||
|
||||
|
|
@ -63,7 +63,7 @@ $ sudo chown homeassistant:homeassistant homeassistant
|
|||
|
||||
Next up is to create and change to a virtual environment for Home Assistant. This will be done as the `homeassistant` account.
|
||||
```bash
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ sudo su -s /bin/bash homeassistant
|
||||
$ cd /srv/homeassistant
|
||||
$ python3 -m venv homeassistant_venv
|
||||
$ source /srv/homeassistant/homeassistant_venv/bin/activate
|
||||
|
|
@ -78,89 +78,10 @@ Start Home Assistant for the first time. This will complete the installation, cr
|
|||
(homeassistant_venv) $ hass
|
||||
```
|
||||
|
||||
You can now reach your installation on your raspberry pi over the web interface on [http://ipaddress:8123](http://ipaddress:8123).
|
||||
You can now reach your installation on your raspberry pi over the web interface on [http://ipaddress:8123](http://ipaddress:8123).
|
||||
|
||||
For instruction on how to configure Home Assistant continue on with [Configuring Home Assistant](/getting-started/configuration/).
|
||||
|
||||
### {% linkable_title Raspberry Pi Hardware Specific Components %}
|
||||
|
||||
Some components that are specific for the Raspberry Pi can require some further configuration outside of Home Assistant. All commands below are assumed to be executed with the `pi` account. For full documentation of these components refer to the [components](/components) page.
|
||||
|
||||
### {% linkable_title Bluetooth Tracker %}
|
||||
The Bluetooth tracker will work on a Raspberry Pi 3 with the built-in Bluetooth module or with a USB Bluetooth device on any of the other Raspberry Pi's.
|
||||
|
||||
Install the following external dependencies.
|
||||
```bash
|
||||
$ sudo apt-get install bluetooth libbluetooth-dev
|
||||
```
|
||||
After this follow the [Bluetooth Tracker component](/components/device_tracker.bluetooth_tracker/) and [Device Tracker page](/components/device_tracker/) pages.
|
||||
|
||||
|
||||
### {% linkable_title Raspberry Pi Camera %}
|
||||
The Raspberry Pi Camera is a specific camera for the Raspberry Pi boards. For more information about the camera I suggest reading the [documentation](https://www.raspberrypi.org/documentation/usage/camera/) from the Raspberry Pi foundation.
|
||||
|
||||
To use the camera it needs to be enabled with the `raspi-config` utility.
|
||||
```bash
|
||||
$ sudo raspi-config
|
||||
```
|
||||
Select `Enable camera` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
|
||||
After reboot add your `homeassistant` account to the `video` group.
|
||||
```bash
|
||||
$ sudo adduser homeassistant video
|
||||
```
|
||||
After this follow the [Raspberry Pi Camera component](/components/camera.rpi_camera/) page.
|
||||
|
||||
### {% linkable_title Raspberry Pi GPIO %}
|
||||
Each of the following devices are connected to the GPIO pins on the Raspberry Pi.
|
||||
For more details about the GPIO layout, visit the [documentation](https://www.raspberrypi.org/documentation/usage/gpio/) from the Raspberry
|
||||
Pi foundation.
|
||||
Since these are not normally used some extra permission will need to be added.
|
||||
In general the permission that is needed is granted by adding the `homeassistant` account to the `gpio` group.
|
||||
|
||||
|
||||
#### {% linkable_title Raspberry Pi Cover %}
|
||||
Add your `homeassistant` account to the `gpio` group
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [Raspberry Pi Cover component](/components/cover.rpi_gpio/) page.
|
||||
|
||||
#### {% linkable_title DHT Sensor %}
|
||||
Add your `homeassistant` account to the `gpio` group
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [DHT Sensor component](/components/sensor.dht/) page.
|
||||
|
||||
|
||||
#### {% linkable_title Raspberry PI GPIO Binary Sensor %}
|
||||
Add your `homeassistant` account to the `gpio` group
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [Raspberry PI GPIO Binary Sensor component](/components/binary_sensor.rpi_gpio/) page.
|
||||
|
||||
#### {% linkable_title Raspberry PI GPIO Switch %}
|
||||
Add your `homeassistant` account to the `gpio` group.
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [Raspberry PI GPIO Switch component](/components/switch.rpi_gpio/) page.
|
||||
|
||||
#### {% linkable_title Raspberry Pi RF Switch %}
|
||||
Add your `homeassistant` account to the `gpio` group
|
||||
```bash
|
||||
$ sudo adduser homeassistant gpio
|
||||
```
|
||||
After this follow the [Raspberry Pi RF Switch component](/components/switch.rpi_rf/) page.
|
||||
|
||||
#### {% linkable_title One wire Sensor %}
|
||||
The One wire sensor requires that support for it is enabled on the Raspberry Pi and that the One Wire device is connected to GPIO pin 4.
|
||||
To enable One Wire support add the following line to the end of `/boot/config.txt`
|
||||
```yaml
|
||||
dtoverlay=w1-gpio
|
||||
```
|
||||
After this follow the [One Wire Sensor component](/components/sensor.onewire/) page.
|
||||
|
||||
### {% linkable_title Troubleshooting %}
|
||||
|
||||
If you run into any issues, please see [the troubleshooting page](/getting-started/troubleshooting/). It contains solutions to many of the more commonly encountered issues.
|
||||
|
|
|
|||
|
|
@ -15,11 +15,11 @@ The default way to update Home Assistant to the latest release, when available,
|
|||
|
||||
```bash
|
||||
$ pip3 install --upgrade homeassistant
|
||||
```
|
||||
```
|
||||
|
||||
After updating, you must restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/getting-started/autostart/) daemon (if applicable)
|
||||
|
||||
<p class='note note'>
|
||||
<p class='note'>
|
||||
To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [HASSbian](/getting-started/installation-raspberry-pi-image/), [Raspberry Pi All-In-One Installer](/getting-started/installation-raspberry-pi-all-in-one/), [Vagrant](/getting-started/installation-vagrant/), or [Virtualenv](/getting-started/installation-virtualenv)t.
|
||||
</p>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue