Add headings to make it easier to point to section and update markup

This commit is contained in:
Fabian Affolter 2016-06-20 17:14:42 +02:00
parent 81d475f55e
commit 92e7af39c8

View File

@ -17,7 +17,9 @@ The only requirement is that you have a Raspberry Pi with a fresh installation o
```bash ```bash
$ wget -Nnv https://raw.githubusercontent.com/home-assistant/fabric-home-assistant/master/hass_rpi_installer.sh && bash hass_rpi_installer.sh $ wget -Nnv https://raw.githubusercontent.com/home-assistant/fabric-home-assistant/master/hass_rpi_installer.sh && bash hass_rpi_installer.sh
``` ```
*Note this command is one line and not run as sudo* <p class='note warning'>
Note this command is one-line and not run as sudo.
</p>
Installation will take approx. 1-2 hours depending on the Raspberry Pi model the installer is being run against. The installer will identitfy what Raspberry PI hardware revision you are using and adjust commands accordingly. A complete log of the install is located at: `/home/pi/fabric-home-assistant/installation_report.txt` The installer has been updated to simply log any errors encountered, but resume installing. Please consult the "installation report" if your install encountered issues. Installation will take approx. 1-2 hours depending on the Raspberry Pi model the installer is being run against. The installer will identitfy what Raspberry PI hardware revision you are using and adjust commands accordingly. A complete log of the install is located at: `/home/pi/fabric-home-assistant/installation_report.txt` The installer has been updated to simply log any errors encountered, but resume installing. Please consult the "installation report" if your install encountered issues.
@ -25,8 +27,11 @@ Installation will take approx. 1-2 hours depending on the Raspberry Pi model the
Once rebooted, your Raspberry Pi will be up and running with Home Assistant. You can access it at [http://your_raspberry_pi_ip:8123](http://your_raspberry_pi_ip:8123). Once rebooted, your Raspberry Pi will be up and running with Home Assistant. You can access it at [http://your_raspberry_pi_ip:8123](http://your_raspberry_pi_ip:8123).
The Home Assistant configuration is located at `/home/hass/.homeassistant`. The virtualenv with the Home Assistant installation is located at `/srv/hass/hass_venv`. As part of the secure installation, a new user is added to your Raspberry Pi to run Home Assistant as named, **hass**. This is a system account and does not have login or other abilities by design. When editing your configuration.yaml files, you will need to run the commands with "sudo" or by switching user. The Home Assistant configuration is located at `/home/hass/.homeassistant`. The [virtualenv](https://virtualenv.pypa.io/en/latest/) with the Home Assistant installation is located at `/srv/hass/hass_venv`. As part of the secure installation, a new user (**hass**) is added to your Raspberry Pi to run Home Assistant. This is a system account and does not have login or other abilities by design. When editing your `configuration.yaml` files, you will need to run the commands with `sudo` or by switching user.
*Windows users* - Setting up WinSCP to allow this seemlessly is detailed below.
<p class='note note'>
*Windows users*: Setting up WinSCP to allow this seemlessly is at the end of this page.
</p>
By default, installation makes use of a Python Virtualenv. If you wish to not follow this recommendation, you may add the flag `-n` to the end of the install command specified above. By default, installation makes use of a Python Virtualenv. If you wish to not follow this recommendation, you may add the flag `-n` to the end of the install command specified above.
@ -43,29 +48,35 @@ The All-In-One Installer script will do the following automatically:
* Build openzwave-control-panel in `/srv/hass/src/open-zwave-control-panel` * Build openzwave-control-panel in `/srv/hass/src/open-zwave-control-panel`
* Add both Home Assistant and Mosquitto to systemd services to start at boot * Add both Home Assistant and Mosquitto to systemd services to start at boot
### {% linkable_title Upgrading %}
To upgrade the All-In-One setup manually: To upgrade the All-In-One setup manually:
* Login to Raspberry Pi ```ssh pi@your_raspberry_pi_ip``` * Login to Raspberry Pi `ssh pi@your_raspberry_pi_ip`
* Change to hass user `sudo su -s /bin/bash hass` * Change to hass user `sudo su -s /bin/bash hass`
* Change to virtual enviroment `source /srv/hass/hass_venv/bin/activate` * Change to virtual enviroment `source /srv/hass/hass_venv/bin/activate`
* Update HA `pip3 install --upgrade homeassistant` * Update HA `pip3 install --upgrade homeassistant`
To upgrade with fabric: To upgrade with fabric:
* Login to Raspberry Pi ```ssh pi@your_raspberry_pi_ip``` * Login to Raspberry Pi `ssh pi@your_raspberry_pi_ip`
* Change to `cd ~/fabric-home-assistant` * Change to `cd ~/fabric-home-assistant`
* Run `fab upgrade_homeassistant` * Run `fab upgrade_homeassistant`
To launch the OZWCP webapp: ### {% linkable_title Using the OZWCP web application %}
To launch the OZWCP web application:
* Login to Raspberry Pi `ssh pi@your_raspberry_pi_ip` * Login to Raspberry Pi `ssh pi@your_raspberry_pi_ip`
* Change to the ozwcp directory `cd /srv/hass/src/open-zwave-control-panel/` * Change to the ozwcp directory `cd /srv/hass/src/open-zwave-control-panel/`
* Launch the control panel `sudo ./ozwcp -p 8888` * Launch the control panel `sudo ./ozwcp -p 8888`
* Open a web browser to `http://your_pi_ip:8888` * Open a web browser to `http://your_pi_ip:8888`
* Specify your zwave controller, for example `/dev/ttyACM0` and hit initialize * Specify your zwave controller, for example `/dev/ttyACM0` and hit initialize
*don't check the USB box regardless of using a USB based device*
<p class='note warning'>
Don't check the USB box regardless of using a USB based device.
</p>
*Windows Users* - Please note that after running the installer, you will need to modify settings allowing you to "switch users" to edit your configuration files. The needed change within WinSCP is: Environment -> SCP/Shell -> Shell and set it to `sudo su -`. ### {% linkable_title WinSCP %}
If you are Windows users who is using [WinSCP](https://winscp.net/), please note that after running the installer, you will need to modify settings allowing you to "switch users" to edit your configuration files. The needed change within WinSCP is: **Environment** -> **SCP/Shell** -> **Shell** and set it to `sudo su -`.