mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 23:36:51 +00:00
Removal of Hassbian from documentation (#10934)
* R.I.P Hassbian * Restore device tracker to glosssay * Remove space
This commit is contained in:
Fredrik Lindqvist
Franck Nijhof
parent
f985d738e8
commit
2937ca5308
@ -97,12 +97,12 @@ This is because we only allow an IP address as a client ID when your IP address
|
||||
If you don't have a valid domain name for your Home Assistant instance, you can modify the `hosts` file on your computer to fake one. On Windows, edit the `C:\Windows\System32\Drivers\etc\hosts` file with administrator privilege, or on Linux the `/etc/hosts` file, and add following entry:
|
||||
|
||||
```text
|
||||
12.34.56.78 hassbian.home
|
||||
12.34.56.78 homeassistant.home
|
||||
```
|
||||
|
||||
Replace `12.34.56.78` with your Home Assistant's public IP address.
|
||||
|
||||
This will allow you to open Home Assistant at `http://hassbian.home:8123/`
|
||||
This will allow you to open Home Assistant at `http://homeassistant.home:8123/`
|
||||
|
||||
### Stuck on Loading data
|
||||
|
||||
|
||||
@ -101,4 +101,4 @@ Of course, if I wanted to make this App or its predecessor reusable, I would hav
|
||||
|
||||
In addition, Apps can write to `AppDaemon`'s log files, and there is a system of constraints that allows you to control when and under what circumstances Apps and callbacks are active to keep the logic clean and simple.
|
||||
|
||||
For full installation instructions, see the [AppDaemon Project Documentation pages](http://appdaemon.readthedocs.io/en/stable/). If you're using Hassbian, then the [Hassbian scripts](https://github.com/home-assistant/hassbian-scripts/blob/dev/docs/suites/appdaemon.md) make it easy to install.
|
||||
For full installation instructions, see the [AppDaemon Project Documentation pages](http://appdaemon.readthedocs.io/en/stable/).
|
||||
|
||||
@ -5,7 +5,7 @@ description: "A guide to remotely accessing Home Assistant and securing the conn
|
||||
|
||||
<div class='note'>
|
||||
|
||||
If you are using Hass.io or Hassbian, do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) for Hass.io or the [DuckDNS suite](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/duckdns.md) for Hassbian to automatically maintain a subdomain including HTTPS certificates via Let's Encrypt.
|
||||
If you are using Hass.io do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) for Hass.io.
|
||||
|
||||
</div>
|
||||
|
||||
@ -17,7 +17,7 @@ This guide was added by mf_social on 16/03/2017 and was valid at the time of wri
|
||||
* You want to access your Home Assistant instance when you are away from home (ie, not connected to your local network) and secure it with a TLS/SSL certificate.
|
||||
* You have a basic understanding of the phrases I have used so far.
|
||||
* You are not currently running anything on port 80 on your network (you'd know if you were).
|
||||
* If you are not using Home Assistant on a Debian/Raspian/Hassbian system you will be able to convert any of the terminology I use in to the correct syntax for your system.
|
||||
* If you are not using Home Assistant on a Debian/Raspian system you will be able to convert any of the terminology I use in to the correct syntax for your system.
|
||||
* You understand that this is a 'guide' covering the general application of these things to the general masses and there are things outside of the scope of it, and it does not cover every eventuality (although I have made some notes where people may stumble). Also, I have used some turns of phrase to make it easier to understand for the novice reader which people of advanced knowledge may say is inaccurate. My goal here is to get you through this guide with a satisfactory outcome and have a decent understanding of what you are doing and why, not to teach you advanced internet communication protocols.
|
||||
* Each step presumes you have fully completed the previous step successfully, so if you did an earlier step following a different guide, please ensure that you have not missed anything out that may affect the step you have jumped to, and ensure that you adapt any commands to take in to account different file placements from other guides.
|
||||
|
||||
@ -266,7 +266,7 @@ wget https://dl.eff.org/certbot-auto
|
||||
chmod a+x certbot-auto
|
||||
```
|
||||
|
||||
You might need to stop Home Assistant before continuing with the next step. You can do this via the Web-UI or use the following command if you are running on Hassbian:
|
||||
You might need to stop Home Assistant before continuing with the next step. You can do this via the Web-UI or use the following command if you are running on Raspbian:
|
||||
|
||||
```text
|
||||
sudo systemctl stop home-assistant@homeassistant.service
|
||||
|
||||
@ -63,4 +63,4 @@ http:
|
||||
ssl_key: /etc/letsencrypt/live/mydomain.com/privkey.pem
|
||||
```
|
||||
|
||||
Make sure the files are accessible by the user that runs Home Assistant, eg. `homeassistant` for a HASSbian setup.
|
||||
Make sure the files are accessible by the user that runs Home Assistant.
|
||||
|
||||
@ -31,4 +31,4 @@ HADashboard is a modular, skinnable dashboard for [Home Assistant](/) that is in
|
||||
Glassic Theme
|
||||
</p>
|
||||
|
||||
For full installation instructions see the HADashboard section in the [AppDaemon Project Documentation](http://appdaemon.readthedocs.io/en/stable/DASHBOARD_INSTALL.html). If you're using Hassbian, then the [Hassbian scripts](https://github.com/home-assistant/hassbian-scripts/blob/dev/docs/suites/appdaemon.md) make it easy to install AppDaemon.
|
||||
For full installation instructions see the HADashboard section in the [AppDaemon Project Documentation](http://appdaemon.readthedocs.io/en/stable/DASHBOARD_INSTALL.html).
|
||||
@ -49,7 +49,6 @@ These install options are fully supported by Home Assistant's documentation. For
|
||||
:-----|:-----|:-----
|
||||
[Hass.io](/hassio/installation/)|Raspberry Pi<br>VM|Anybody
|
||||
[Docker](/docs/installation/docker/)|Docker|Anybody already running Docker
|
||||
[Hassbian](/docs/hassbian/installation/)|Raspberry Pi|Those who want a more traditional Linux experience and either have experience with Linux, or intend to learn
|
||||
|
||||
## Alternative installs
|
||||
|
||||
|
||||
@ -1,21 +1,12 @@
|
||||
---
|
||||
title: "Hassbian"
|
||||
description: "Instructions to flash the Home Assistant Hassbian image on a Raspberry Pi."
|
||||
description: "Hassbian image for a Raspberry Pi."
|
||||
redirect_from: /getting-started/hassbian/
|
||||
---
|
||||
|
||||
Hassbian is our customized operating system for the Raspberry Pi Zero, 2,3 and 3B+. It is one of the easiest ways of installing Home Assistant.
|
||||
|
||||
- [Install Hassbian](/docs/hassbian/installation/)
|
||||
- [Customize your installation](/docs/hassbian/customization/)
|
||||
- [Pi specific integrations](/docs/hassbian/integrations/)
|
||||
- [Learn how to perform common tasks](/docs/hassbian/common-tasks/)
|
||||
<div class='note warning'>
|
||||
|
||||
### Activating the virtual environment
|
||||
The Hassbian image is deprecated as of October 2019. Please move to another [installation method](/getting-started/).
|
||||
|
||||
When instructions tell you to activate the virtual environment to install a Python library, or perform some tasks, the following commands will do this:
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
source /srv/homeassistant/bin/activate
|
||||
```
|
||||
</div>
|
||||
@ -1,135 +0,0 @@
|
||||
---
|
||||
title: "Common tasks on Hassbian"
|
||||
description: "Instructions on how to do common tasks on Hassbian."
|
||||
redirect_from: /docs/hassbian/common-tasks/
|
||||
---
|
||||
|
||||
### Login to the Raspberry Pi
|
||||
|
||||
To login to your Raspberry Pi running Hassbian you're going to be using a ssh client. Depending on your platform there are several alternatives for doing this. Linux and Mac 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.
|
||||
|
||||
### Start/Stop/Restart Home Assistant
|
||||
|
||||
Log in as the `pi` 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`.
|
||||
|
||||
### Update Home Assistant
|
||||
|
||||
<div class='note'>
|
||||
|
||||
You can use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade homeassistant`
|
||||
|
||||
</div>
|
||||
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
sudo systemctl stop home-assistant@homeassistant.service
|
||||
sudo -u homeassistant -H -s
|
||||
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.
|
||||
- Start the Home Assistant service.
|
||||
|
||||
### Manually launch Home Assistant
|
||||
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
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. If you want the log output to be colored, execute `hass --script check_config` first. This will install the `colorlog` module.
|
||||
|
||||
### Check your configuration
|
||||
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
source /srv/homeassistant/bin/activate
|
||||
hass --script check_config
|
||||
```
|
||||
|
||||
This will output any errors in your configuration files to console.
|
||||
|
||||
### Read the Home Assistant log file
|
||||
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
cd /home/homeassistant/.homeassistant
|
||||
nano home-assistant.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.
|
||||
|
||||
Optionally, 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
|
||||
```
|
||||
|
||||
### Edit the Home Assistant configuration
|
||||
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
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.
|
||||
|
||||
### 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]: /docs/installation/hassbian/common-tasks/#startstoprestart-home-assistant
|
||||
[bash-windows]: https://msdn.microsoft.com/en-us/commandline/wsl/about
|
||||
@ -1,55 +0,0 @@
|
||||
---
|
||||
title: "Customization"
|
||||
description: "Instructions to flash the Home Assistant Hassbian image on a Raspberry Pi."
|
||||
redirect_from: /docs/hassbian/customization/
|
||||
---
|
||||
|
||||
To allow you to customize your installation further, we have included a tool called `hassbian-config`. This tool comes with a set of suites that can easily be installed or upgraded for easier customization of your Home Assistant installation.
|
||||
The tool is available by running `hassbian-config`.
|
||||
|
||||
### Install scripts
|
||||
|
||||
To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo].
|
||||
These are some of the available suites:
|
||||
|
||||
- [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md)
|
||||
- [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md)
|
||||
- [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md)
|
||||
- [Fail2Ban](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/fail2ban.md) **This suite can't be installed on Raspberry Pi Zero**
|
||||
- [Duck DNS](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/duckdns.md) _This can also be configured to generate Let's Encrypt SSL certificates_
|
||||
- [Hue](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hue.md)
|
||||
- [Hassbian Manager](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/manager.md) is a web UI tool that can help you manage your suites.
|
||||
- [Mosquitto](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mosquitto.md)
|
||||
- [Pi-hole](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/pihole.md)
|
||||
- [Razberry](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/razberry.md)
|
||||
- [Samba](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/samba.md)
|
||||
- [Trådfri](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/tradfri.md)
|
||||
- [Webterminal](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/webterminal.md)
|
||||
- [Zigbee2mqtt](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/zigbee2mqtt.md)
|
||||
- Various database engines.
|
||||
- [MariaDB](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mariadb.md)
|
||||
- [PostgreSQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/postgresql.md)
|
||||
- [MS SQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mssql.md)
|
||||
|
||||
To install any of them simply run `sudo hassbian-config install SUITE`.
|
||||
|
||||
### Upgrade scripts
|
||||
|
||||
To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo].
|
||||
These are some of the available suites:
|
||||
|
||||
- [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md)
|
||||
- [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md)
|
||||
- [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md)
|
||||
- [Hassbian](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hassbian.md)
|
||||
- [Hassbian Manager](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/manager.md)
|
||||
- [Home Assistant](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/homeassistant.md)
|
||||
- [hassbian-config (hassbian-scripts)](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hassbian_config.md)
|
||||
- [Python](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/python.md)
|
||||
|
||||
To upgrade any of them simply run `sudo hassbian-config upgrade SUITE`.
|
||||
|
||||
For more information about this tool have a look at the [hassbian-scripts repository][hassbian-repo].
|
||||
|
||||
[hassbian-repo]: https://github.com/home-assistant/hassbian-scripts
|
||||
[cec]: /integrations/hdmi_cec/
|
||||
@ -1,126 +0,0 @@
|
||||
---
|
||||
title: "Installing Hassbian"
|
||||
description: "Instructions to flash the Home Assistant Hassbian image on a Raspberry Pi."
|
||||
redirect_from: /docs/hassbian/installation/
|
||||
---
|
||||
|
||||
One of the easiest ways to install Home Assistant on your Raspberry Pi Zero, 2, 3 and 3B+ 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 image][image-download]
|
||||
2. Use [balenaEtcher][balenaEtcher] to flash the image to your SD card. We recommend at least a 32 GB SD card to avoid running out of space.
|
||||
3. Ensure your Raspberry Pi has wired access to the internet for the entire process or configure your [wireless network settings](#wireless-network) **before proceeding to step 4**.
|
||||
4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 10 minutes.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/documentation/faqs/#pi-power) with your Pi. Mobile chargers may not be suitable since some were only designed to provide just enough power to the device it was designed for by the manufacturer. **Do not** try to power the Pi from the USB port on a TV, computer, or similar.
|
||||
|
||||
</div>
|
||||
|
||||
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk).
|
||||
Additional information is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc).
|
||||
|
||||
After initial boot an installer will run in the background, this will download and install the newest version of [hassbian-config](https://github.com/home-assistant/hassbian-scripts) and Home-Assistant, this takes around 10 minutes to complete, after it has finished, you will be prompted to login: `hassbian login:`. Installation is complete at this point. The default username is `pi` and the password is `raspberry`.
|
||||
|
||||
Open a browser on a device that's connected to the same network as your Raspberry Pi and point it to Home Assistant 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/`.
|
||||
|
||||
If you find that the web page is not reachable after 30 minutes or so, check that you have files in `/home/homeassistant/.homeassistant/`, if there are no files in this location then run the installer manually using this command: `sudo systemctl start install_homeassistant.service`.
|
||||
|
||||
|
||||
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).
|
||||
- SSH server is enabled.
|
||||
- A tool called [`hassbian-config`](https://github.com/home-assistant/hassbian-scripts#hassbian-scripts).
|
||||
|
||||
### Wireless Network
|
||||
|
||||
After flashing the image to your SD Card open the partition `boot` and create a new file `wpa_supplicant.conf`. Edit the file and enter your network credentials. For more information visit [Setting up WiFi for Raspbian][wifi-setup]. During start the file will automatically be copied in the right folder and the network connection will be established. The file could look like this:
|
||||
|
||||
```conf
|
||||
country=SE
|
||||
ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
|
||||
update_config=1
|
||||
|
||||
network={
|
||||
ssid="YOUR_SSID"
|
||||
psk="YOUR_PASSWORD"
|
||||
}
|
||||
```
|
||||
|
||||
You may need to adjust the country code depending upon where you are. A list of codes can be found [here](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
|
||||
|
||||
If you are using a [hidden SSID](https://en.wikipedia.org/wiki/Network_cloaking) for your WiFi network , you must add `scan_ssid=1` to the `network` section to be able to connect.
|
||||
|
||||
If you are running in trouble with your WiFi connection (for [further details](https://www.raspberrypi.org/forums/viewtopic.php?t=207882)), check the output of the following command:
|
||||
|
||||
```bash
|
||||
$ sudo rfkill list
|
||||
0: phy0: Wireless LAN
|
||||
Soft blocked: yes
|
||||
Hard blocked: no
|
||||
```
|
||||
|
||||
To unblock it, execute `$ sudo rfkill unblock wifi`.
|
||||
|
||||
### 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`
|
||||
|
||||
[image-download]: https://github.com/home-assistant/pi-gen/releases/latest
|
||||
[balenaEtcher]: https://www.balena.io/etcher
|
||||
[http://hassbian.local:8123]: http://hassbian.local:8123
|
||||
[wifi-setup]: https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md
|
||||
|
||||
## Updating
|
||||
|
||||
The [Hassbian Scripts](https://github.com/home-assistant/hassbian-scripts) are the easiest way of updating both the host operating system, and Home Assistant.
|
||||
|
||||
### Updating Home Assistant
|
||||
|
||||
SSH to your system as the user `pi` and run:
|
||||
|
||||
```bash
|
||||
$ sudo hassbian-config upgrade homeassistant
|
||||
```
|
||||
|
||||
### Updating the host operating system
|
||||
|
||||
SSH to your system as the user `pi` and run:
|
||||
|
||||
```bash
|
||||
$ sudo hassbian-config upgrade hassbian
|
||||
```
|
||||
|
||||
## Run a specific version
|
||||
|
||||
In the event that a Home Assistant version doesn't play well with your hardware setup, you can downgrade to a previous release. For example:
|
||||
|
||||
```bash
|
||||
$ sudo hassbian-config upgrade homeassistant=0.XX.X
|
||||
```
|
||||
|
||||
#### Run the beta version
|
||||
|
||||
If you would like to test next release before anyone else, you can install the beta version released every two weeks, for example:
|
||||
|
||||
```bash
|
||||
$ sudo hassbian-config upgrade homeassistant --beta
|
||||
```
|
||||
|
||||
## Run the development version
|
||||
|
||||
If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`.
|
||||
|
||||
<div class='note warning'>
|
||||
The "dev" branch is likely to be unstable. Potential consequences include loss of data and instance corruption.
|
||||
</div>
|
||||
|
||||
For example:
|
||||
|
||||
```bash
|
||||
$ sudo hassbian-config upgrade homeassistant --dev
|
||||
```
|
||||
@ -1,50 +0,0 @@
|
||||
---
|
||||
title: "Raspberry Pi integrations"
|
||||
description: "Home Assistant integrations specific to the Raspberry Pi."
|
||||
redirect_from: /docs/hassbian/integrations/
|
||||
---
|
||||
|
||||
Some integrations 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 integrations refer to the [integrations](/components) page.
|
||||
|
||||
### 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.
|
||||
|
||||
Software needed for the tracker is pre-installed so just follow the [Bluetooth Tracker integration](/integrations/bluetooth_tracker/) and [Device Tracker page](/integrations/device_tracker/) pages.
|
||||
|
||||
### 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.
|
||||
|
||||
Permission have been given to the `homeassistant` user to use the GPIO pins and all of the following integrations should require no underlying changes to work.
|
||||
Just follow the integration pages for each on how to add them to your Home Assistant installation.
|
||||
|
||||
- [DHT Sensor](/integrations/dht/)
|
||||
- [Raspberry Pi Cover](/integrations/rpi_gpio/#cover)
|
||||
- [Raspberry Pi GPIO Binary Sensor](/integrations/rpi_gpio/#binary-sensor)
|
||||
- [Raspberry Pi GPIO Switch](/integrations/rpi_gpio/#switch)
|
||||
- [Raspberry Pi RF Switch](/integrations/rpi_rf/)
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
Go to `Interfacing Options`, select `Enable camera` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
|
||||
|
||||
After this follow the [Raspberry Pi Camera integration](/integrations/rpi_camera/) page.
|
||||
|
||||
### 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 integration](/integrations/onewire/) page.
|
||||
@ -1,32 +0,0 @@
|
||||
---
|
||||
title: "Upgrading Hassbian"
|
||||
description: "Instructions on how to upgrade Hassbian to the latest version."
|
||||
redirect_from: /docs/hassbian/upgrading/
|
||||
---
|
||||
|
||||
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 -y upgrade
|
||||
```
|
||||
|
||||
#### Updating Home Assistant
|
||||
|
||||
<div class='note'>
|
||||
|
||||
You can use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade homeassistant`
|
||||
|
||||
</div>
|
||||
|
||||
To update the Home Assistant installation execute the following command as the `pi` user.
|
||||
|
||||
```bash
|
||||
sudo systemctl stop home-assistant@homeassistant.service
|
||||
sudo -u homeassistant -H -s
|
||||
source /srv/homeassistant/bin/activate
|
||||
pip3 install --upgrade homeassistant
|
||||
exit
|
||||
sudo systemctl start home-assistant@homeassistant.service
|
||||
```
|
||||
@ -6,7 +6,7 @@ redirect_from: /getting-started/updating/
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Hass.io](/hassio/), [Hassbian](/docs/installation/hassbian/common-tasks/#update-home-assistant), or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant).
|
||||
The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Hass.io](/hassio/) or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant).
|
||||
|
||||
</div>
|
||||
|
||||
@ -14,7 +14,7 @@ Check what's new in the latest version and potentially impacts your system in [H
|
||||
|
||||
<div 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 [Hass.io](/hassio/), [Hassbian](/docs/hassbian/installation/), or [Virtualenv](/docs/installation/virtualenv).
|
||||
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 [Hass.io](/hassio/) or [Virtualenv](/docs/installation/virtualenv).
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -78,8 +78,6 @@ at this point simply add your user (homeassistant) to the dialout group:
|
||||
$ sudo usermod -a -G dialout homeassistant
|
||||
```
|
||||
|
||||
Finally, reboot again to make those changes active. It's has been tested on hassbian and has been reported that this is also required on the Pi2.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
If you've installed the Z-Way software, you'll need to ensure you disable it before you install Home Assistant or you won't be able to access the board. Do this with `sudo /etc/init.d/z-way-server stop; sudo update-rc.d z-way-server disable`.
|
||||
|
||||
@ -142,23 +142,13 @@ ls -1tr /dev/tty*|tail -n 1
|
||||
|
||||
The `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled. Failure to do so will result in random failures of those components. For example you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager`
|
||||
|
||||
### Hassbian
|
||||
|
||||
You do not need to install any software to use Z-Wave.
|
||||
|
||||
To find the path of your Z-Wave USB stick, disconnect it and then reconnect it to your system and run:
|
||||
|
||||
```bash
|
||||
ls -1tr /dev/tty*|tail -n 1
|
||||
```
|
||||
|
||||
### Community install methods
|
||||
|
||||
#### Raspberry Pi specific
|
||||
|
||||
On the Raspberry Pi you will need to enable the serial interface in the `raspi-config` tool before you can add Z-Wave to Home Assistant. Make sure to reboot the Raspberry Pi for the setting to take effect.
|
||||
|
||||
#### Linux (except Hassbian)
|
||||
#### Linux
|
||||
|
||||
On Debian Linux platforms there are dependencies you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems):
|
||||
|
||||
@ -276,7 +266,7 @@ If you're getting errors like:
|
||||
|
||||
openzwave-embed/open-zwave-master/libopenzwave.a: No such file or directory
|
||||
|
||||
Then the problem is that you're missing `libudev-dev` (or the equivalent for your distribution), please [install it](/docs/z-wave/installation/#linux-except-hassbian).
|
||||
Then the problem is that you're missing `libudev-dev` (or the equivalent for your distribution), please [install it](/docs/z-wave/installation/#linux).
|
||||
|
||||
### Random failures
|
||||
|
||||
|
||||
@ -10,7 +10,6 @@
|
||||
<b>{% active_link /docs/installation/ Installation %}</b>
|
||||
<ul>
|
||||
<li>{% active_link /hassio/ Hass.io %}</li>
|
||||
<li>{% active_link /docs/installation/hassbian/ Hassbian %}</li>
|
||||
<li>{% active_link /docs/installation/updating/ Updating %}</li>
|
||||
<li>{% active_link /docs/installation/troubleshooting/ Troubleshooting %}</li>
|
||||
</ul>
|
||||
|
||||
@ -121,18 +121,6 @@ or
|
||||
2001:raw:600:/dev/ttyUSB0:9600 EVEN 1STOPBIT 7DATABITS XONXOFF LOCAL -RTSCTS
|
||||
```
|
||||
|
||||
[HASSbian](/docs/installation/hassbian/installation/) users have to give dialout permission to the user `homeassistant`:
|
||||
|
||||
```bash
|
||||
$ sudo usermod -a -G dialout homeassistant
|
||||
```
|
||||
|
||||
and after that you need to reboot!
|
||||
|
||||
```bash
|
||||
$ sudo reboot
|
||||
```
|
||||
|
||||
Docker users have to allow Docker access to the device by adding `--device /dev/ttyUSB21:/dev/ttyUSB21` to the run command:
|
||||
|
||||
```hass
|
||||
|
||||
@ -14,13 +14,15 @@ The `environment_canada` weather platforms provide meteorological data for Canad
|
||||
|
||||
The following device types and data are supported:
|
||||
|
||||
- [Weather](#weather) - Current conditions and forecasts
|
||||
- [Sensor](#sensor) - Current conditions and alerts
|
||||
- [Camera](#camera) - Radar imagery
|
||||
- [Location Selection](#location-selection)
|
||||
- [Weather](#weather)
|
||||
- [Sensor](#sensor)
|
||||
- [Alert TTS Script](#alert-tts-script)
|
||||
- [Camera](#camera)
|
||||
|
||||
<p class='note'>
|
||||
|
||||
On Raspbian or Hassbian, you may need to manually install additional prerequisites with the following command:
|
||||
On Raspbian you may need to manually install additional prerequisites with the following command:
|
||||
`sudo apt-get install libatlas-base-dev libopenjp2-7`
|
||||
|
||||
</p>
|
||||
@ -172,7 +174,7 @@ camera:
|
||||
```
|
||||
|
||||
<p class='note'>
|
||||
On Raspbian or Hassbian, you may need to manually install additional prerequisites with the following command:
|
||||
On Raspbian you may need to manually install additional prerequisites with the following command:
|
||||
`sudo apt-get install libatlas-base-dev libopenjp2-7`
|
||||
</p>
|
||||
|
||||
|
||||
@ -11,8 +11,7 @@ The `ffmpeg` integration allows other Home Assistant integrations to process vid
|
||||
|
||||
<div class='note'>
|
||||
|
||||
You need the `ffmpeg` binary in your system path. On Hassbian you will need to login as the `pi` user and `sudo apt install ffmpeg`. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](https://www.ffmpeg.org/) website.
|
||||
|
||||
You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website.
|
||||
</div>
|
||||
|
||||
<div class='note'>
|
||||
|
||||
@ -38,7 +38,7 @@ ln -s /path/to/your/installation/of/_cec.so /path/to/your/venv/lib/python*/site-
|
||||
|
||||
##### Symlinking examples:
|
||||
|
||||
For the default virtual environment of a [HASSbian Image for Raspberry Pi](/docs/installation/raspberry-pi/) the command would be as follows.
|
||||
For the default virtual environment of a [Manual install for Raspberry Pi](/docs/installation/raspberry-pi/) the command would be as follows.
|
||||
|
||||
```bash
|
||||
ln -s /usr/local/lib/python*/dist-packages/cec.py /srv/homeassistant/lib/python*/site-packages
|
||||
|
||||
@ -121,12 +121,6 @@ The log information are stored in the
|
||||
and you can read it with the command-line tool `cat` or follow it dynamically
|
||||
with `tail -f`.
|
||||
|
||||
If you are a Hassbian user you can use the example below:
|
||||
|
||||
```bash
|
||||
$ tail -f /home/homeassistant/.homeassistant/home-assistant.log
|
||||
```
|
||||
|
||||
If you are a Hass.io user, you can use the example below, when logged in through
|
||||
the [SSH add-on](/addons/ssh/):
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ ha_release: "0.40"
|
||||
ha_iot_class: Local Polling
|
||||
---
|
||||
|
||||
The `modem_callerid` sensor platform uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1).
|
||||
The `modem_callerid` integration uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1).
|
||||
|
||||
When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number.
|
||||
|
||||
@ -19,7 +19,7 @@ To find the path of your USB modem, run:
|
||||
ls /dev/ttyACM*
|
||||
```
|
||||
|
||||
If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hassbian) give access to the stick with:
|
||||
If Home Assistant (`hass`) runs with another user (e.g., `homeassistant`) give access to the stick with:
|
||||
|
||||
```bash
|
||||
sudo usermod -a -G dialout homeassistant
|
||||
@ -54,7 +54,7 @@ To find the path of your USB modem, run:
|
||||
|
||||
`$ ls /dev/ttyACM*`
|
||||
|
||||
If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hassbian) give access to the stick with:
|
||||
If Home Assistant (`hass`) runs with another user (e.g., `homeassistant`) give access to the stick with:
|
||||
|
||||
`$ sudo usermod -a -G dialout homeassistant`
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ As an alternative to the router-based device tracking, it is possible to directl
|
||||
Please keep in mind that modern smart phones will usually turn off WiFi when they are idle. Simple trackers like this may not be reliable on their own.
|
||||
</div>
|
||||
|
||||
You might have to install the packages for `arp` and `nmap`. On Debian based hosts (for example Hassbian and Raspbian) do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`.
|
||||
You might have to install the packages for `arp` and `nmap`. On Debian based hosts (for example Raspbian) do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
|
||||
@ -50,7 +50,6 @@ There are varying methods to perform this, dependent on your OS that is running
|
||||
Home Assistant installed on a Debian-type OS may require configuration. This section is applicable but not limited to the following operating systems:
|
||||
|
||||
- Debian
|
||||
- Hassbian
|
||||
- Rassbian
|
||||
- Armbian
|
||||
- Ubuntu
|
||||
|
||||
@ -144,15 +144,6 @@ No additional actions are required
|
||||
|
||||
No additional actions are required
|
||||
|
||||
### Hassbian
|
||||
|
||||
You will need to activate the venv and install the websocket library:
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
source /srv/homeassistant/bin/activate
|
||||
pip3 install websocket-client
|
||||
```
|
||||
### Other install methods
|
||||
|
||||
You will need to install the `websocket-client` Python package in your Home Assistant install. This will probably be done with:
|
||||
|
||||
@ -141,7 +141,7 @@ group:
|
||||
- group.sense_hat
|
||||
```
|
||||
|
||||
### Directions for installing on Raspberry Pi All-In-One installer and HASSbian:
|
||||
### Directions for installing on Raspberry Pi Raspbian Based installation:
|
||||
|
||||
Here are the steps to make the _SenseHAT_ sensor work _successfully_ with the virtual environment versions.
|
||||
|
||||
@ -182,7 +182,7 @@ sudo reboot
|
||||
```
|
||||
|
||||
Unfortunately enabling the SenseHAT Sensor integration for a Virtual Environment install of Home Assistant fails with errors.
|
||||
_(The Raspberry Pi All-In-One installer and HASSbian both run Home Assistant in an virtual environment)._
|
||||
_(The Raspberry Pi All-In-One installer run Home Assistant in an virtual environment)._
|
||||
These issues have been discussed in the repository issue [#5093](https://github.com/home-assistant/home-assistant/issues/5093)
|
||||
|
||||
This fix has been tested with a clean install of:
|
||||
|
||||
@ -12,7 +12,7 @@ The `tensorflow` image processing platform allows you to detect and recognize ob
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
The following packages must be installed on Hassbian/Raspbian before following the setup for the integration to work:
|
||||
The following packages must be installed on Raspbian before following the setup for the integration to work:
|
||||
`sudo apt-get install libatlas-base-dev libopenjp2-7 libtiff5`
|
||||
|
||||
</div>
|
||||
|
||||
@ -16,7 +16,7 @@ The `triggered` state also provides a state attribute called `triggered_source`
|
||||
- `Fire/Smoke` is when fire or smoke is detected, or a person pushed the Fire button
|
||||
- `Carbon Monoxide` is when carbon monoxide is detected
|
||||
|
||||
If you have issues running this component, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Hassbian, run the command `apt install libxml2-dev libxmlsec1-dev` with sudo.
|
||||
If you have issues running this component, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Raspbian, run the command `apt install libxml2-dev libxmlsec1-dev` with sudo.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -30,7 +30,7 @@ Currently, version 0.1.4-beta2 of the custom firmware is the highest supported.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
Hassbian users: Don't forget to install `ffmpeg` support on your platform, otherwise, you'll not see video.
|
||||
Raspbian users: Don't forget to install `ffmpeg` support on your platform, otherwise, you'll not see video.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ If you use a version higher than 0.1.4-beta2, you can simply solve the FTP issue
|
||||
</div>
|
||||
|
||||
<div class='note warning'>
|
||||
Hassbian users: don't forget to install ffmpeg support on your platform, otherwise, you'll not see video.
|
||||
Raspbian users: don't forget to install ffmpeg support on your platform, otherwise, you'll not see video.
|
||||
</div>
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user