jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge branch 'current' into rc

Browse source
This commit is contained in:
Paulus Schoutsen 2018-04-13 17:01:21 -04:00
commit bd9e7179e6
25 changed files with 220 additions and 125 deletions
Download patch file Download diff file Expand all files Collapse all files

7
source/_docs/automation/action.markdown
View file

@ -22,13 +22,12 @@ automation:
event: sunset
action:
service: light.turn_on
entity_id:
- light.kitchen
- light.living_room
data:
brightness: 150
rgb_color: [255, 0, 0]
entity_id:
- light.kitchen
- light.living_room
automation 2:
# Notify me on my mobile phone of an event
trigger:

7
source/_docs/ecosystem/ios.markdown
View file

@ -8,7 +8,6 @@ comments: false
sharing: true
footer: true
redirect_from: /ecosystem/ios/
redirect_from: /components/ios/
---
The Home Assistant for iOS app offers a companion app for iOS which is deeply integrated into both Home Assistant and iOS. Its basic features include:
@ -22,7 +21,7 @@ The app is available on the iOS App Store in every country that Apple supports.
<p style="text-align: center;"><a target="_blank" href="https://itunes.apple.com/us/app/home-assistant-open-source-home-automation/id1099568401?mt=8" style="display:inline-block;overflow:hidden;background:url(//linkmaker.itunes.apple.com/assets/shared/badges/en-us/appstore-lrg.svg) no-repeat;width:135px;height:40px;background-size:contain;"></a></p>
## Basic requirements
## {% linkable_title Basic requirements %}
* iOS device running at least iOS 9, but iOS 10 is greatly preferred.
* Home Assistant 0.42.4 or higher for push notification support.
@ -34,7 +33,7 @@ Loading the `ios` component will also load the [`device_tracker`][device-tracker
## {% linkable_title Setup %}
### Automated Setup
### {% linkable_title Automated Setup %}
The `ios` component will automatically be loaded under the following circumstances:
@ -45,7 +44,7 @@ Automated discovery and component loading only happens at first install of the a
After the first automated setup you need to add `ios:` to your configuration so that the component loads by default even after restarting Home Assistant.
### Manual Setup
### {% linkable_title Manual Setup %}
You may also manually load the `ios` component by adding the following to your configuration:

53
source/_docs/installation/docker.markdown
View file

@ -10,7 +10,7 @@ footer: true
redirect_from: /getting-started/installation-docker/
---
Installation with Docker is straightforward. Adjust the following command so that `/path/to/your/config/` points at the folder where you want to store your config and run it:
Installation with Docker is straightforward. Adjust the following command so that `/path/to/your/config/` points at the folder where you want to store your configuration and run it:
### {% linkable_title Linux %}
@ -20,7 +20,7 @@ $ docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/
### {% linkable_title macOS %}
When using `docker-ce` (or `boot2docker`) on macOS, you are unable to map the local timezone to your Docker container ([Docker issue](https://github.com/docker/for-mac/issues/44)). Instead of `-v /etc/localtime:/etc/localtime:ro`, just pass in the timezone environment variable when you launch the container, ex: `-e "TZ=America/Los_Angeles"`. Replace "America/Los_Angeles" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
When using `docker-ce` (or `boot2docker`) on macOS, you are unable to map the local timezone to your Docker container ([Docker issue](https://github.com/docker/for-mac/issues/44)). Instead of `-v /etc/localtime:/etc/localtime:ro`, just pass in the timezone environment variable when you launch the container, e.g, `-e "TZ=America/Los_Angeles"`. Replace "America/Los_Angeles" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
If you wish to browse directly to `http://localhost:8123` from your macOS host, meaning forward ports directly to the container, replace the `--net=host` switch with `-p 8123:8123`. More detail can be found in [the docker forums](https://forums.docker.com/t/should-docker-run-net-host-work/14215/10).
@ -28,7 +28,7 @@ If you wish to browse directly to `http://localhost:8123` from your macOS host,
$ docker run -d --name="home-assistant" -v /path/to/your/config:/config -e "TZ=America/Los_Angeles" -p 8123:8123 homeassistant/home-assistant
```
Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs] (https://docs.docker.com/engine/userguide/networking/#default-networks). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates.
Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs](https://docs.docker.com/engine/userguide/networking/#default-networks). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates.
### {% linkable_title Windows %}
@ -84,31 +84,24 @@ As QNAP within QTS now supports Docker (with a neat UI), you can simply install
The steps would be:
- Install “Container Station” package on your Qnap NAS
- Launch Container Station and move to “Create Container”-section
- Search image “homeassistant/home-assistant” with
docker hub and click on “Install”
- Install "Container Station" package on your Qnap NAS
- Launch Container Station and move to "Create Container"-section
- Search image "homeassistant/home-assistant" with Docker hub and click on "Install"
- Choose "latest" version and click next
- Choose a container-name you want (e.g.
“homeassistant”)
- Click on “Advanced Settings”
- Within “Shared Folders” click on "Volume from host" > "Add" and
choose either an existing folder or add a new folder. The “mount
point” has to be “/config”, so that Home Assistant will use it for
the configs and logs.
- Within “Network” and select Network Mode to “Host”
- To ensure that Home Assistant displays the correct
timezone go to the “Environment” tab and click the plus sign then add
`variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
- Click on “Create”
- Choose a container-name you want (e.g., "homeassistant")
- Click on "Advanced Settings"
- Within "Shared Folders" click on "Volume from host" > "Add" and choose either an existing folder or add a new folder. The "mount point has to be `/config`, so that Home Assistant will use it for the configuration and logs.
- Within "Network" and select Network Mode to "Host"
- To ensure that Home Assistant displays the correct timezone go to the "Environment" tab and click the plus sign then add `variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
- Click on "Create"
- Wait for some time until your NAS has created the container
- Your Home Assistant within Docker should now run and will serve the web interface from port 8123 on your Docker host (this will be your Qnap NAS IP address - for example `http://192.xxx.xxx.xxx:8123`)
Remark: to update your Home Assistant on your Docker within Qnap NAS, you just remove container and image and do steps again (Don't remove "config" folder)
Remark: To update your Home Assistant on your Docker within Qnap NAS, you just remove container and image and do steps again (Don't remove "config" folder).
If you want to use a USB Bluetooth adapter or Z-Wave USB Stick with Home Assistant on Qnap Docker, Fallow this step:
If you want to use a USB Bluetooth adapter or Z-Wave USB stick with Home Assistant on Qnap Docker, follow those steps:
**Z-wave:**
#### {% linkable_title Z-Wave %}
- Connect to your NAS over SSH
- Load cdc-acm kernel module(when nas restart need to run this command)
@ -123,16 +116,16 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB Stick with Home Assista
`-v` is your config path
`-e` is set timezone
- Edit configuration.yaml
- Edit `configuration.yaml`
```
```yaml
zwave:
usb_path: /dev/ttyACM0
```
That will tell Home Assistant where to look for our Z-wave radio.
**Bluetooth:**
#### {% linkable_title Bluetooth %}
- Connect to your NAS over SSH
- Run Docker command:
@ -141,9 +134,9 @@ That will tell Home Assistant where to look for our Z-wave radio.
First `-v` is your config path
`-e` is set timezone
- Edit configuration.yaml
- Edit the `configuration.yaml` file
```
```yaml
device_tracker:
- platform: bluetooth_tracker
```
@ -180,10 +173,12 @@ $ docker-compose up -d
### {% linkable_title Exposing Devices %}
In order to use z-wave, zigbee or other components that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your docker command:
In order to use Z-Wave, ZigBbee or other components that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your docker command:
```bash
$ docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/localtime:/etc/localtime:ro --device /dev/ttyUSB0:/dev/ttyUSB0 --net=host homeassistant/home-assistant
$ docker run -d --name="home-assistant" -v /path/to/your/config:/config \
-v /etc/localtime:/etc/localtime:ro --device /dev/ttyUSB0:/dev/ttyUSB0 \
--net=host homeassistant/home-assistant
```
or in a `docker-compose.yml` file:

10
source/_docs/installation/hassbian/integrations.markdown
View file

@ -26,11 +26,11 @@ For more details about the GPIO layout, visit the [documentation](https://www.ra
Permission have been given to the `homeassistant` user to use the GPIO pins and all of the following components should require no underlying changes to work.
Just follow the component pages for each on how to add them to your Home Assistant installation.
- [DHT Sensor](/components/sensor.dht/).
- [Raspberry Pi Cover](/components/cover.rpi_gpio/).
- [Raspberry Pi GPIO Binary Sensor](/components/binary_sensor.rpi_gpio/).
- [Raspberry Pi GPIO Switch](/components/switch.rpi_gpio/).
- [Raspberry Pi RF Switch](/components/switch.rpi_rf/).
- [DHT Sensor](/components/sensor.dht/)
- [Raspberry Pi Cover](/components/cover.rpi_gpio/)
- [Raspberry Pi GPIO Binary Sensor](/components/binary_sensor.rpi_gpio/)
- [Raspberry Pi GPIO Switch](/components/switch.rpi_gpio/)
- [Raspberry Pi RF Switch](/components/switch.rpi_rf/)
### {% linkable_title Raspberry Pi Camera %}

14
source/_docs/installation/synology.markdown
View file

@ -10,6 +10,10 @@ footer: true
redirect_from: /getting-started/installation-synology/
---
<p class='note warning'>
Synology only provide Python 3.5.1, which is not compatible with Home Assistant 0.65.0 or later. Until Synology offer an updated version of Python, Home Assistant 0.64 is the most recent version that will be able to be installed. You can manually specify the version of Home Assistant to install, for example to install version 0.64.3 you would do `./python3 -m pip install homeassistant==0.64.3`
</p>
There are 2 alternatives, when using Home Assistant on Synology NAS:
1. using Docker
2. directly running on DSM
@ -26,7 +30,7 @@ Running these commands will:
Using the Synology webadmin:
- Install python3 using the Synology Package Center (be aware, this provides 3.5.1, which is not compatible with Home Assistant 0.65.0 or later)
- Install python3 using the Synology Package Center
- Create homeassistant user and add to the "users" group
SSH onto your synology & login as admin or root
@ -51,16 +55,12 @@ Install PIP (Python's package management system)
# ./python3 -m ensurepip
```
Use PIP to install Homeassistant package
Use PIP to install Homeassistant package 0.64.3
```bash
# ./python3 -m pip install homeassistant
# ./python3 -m pip install homeassistant==0.64.3
```
<p class='note'>
Until Synology offer an updated version of Python, Home Assistant 0.64 is the most recent version that will be able to be installed. You can manually specify the version of Home Assistant to install, for example to install version 0.64.3 you would do `./python3 -m pip install homeassistant==0.64.3`
</p>
Create homeassistant config directory & switch to it
```bash

10
source/_docs/installation/updating.markdown
View file

@ -14,7 +14,7 @@ redirect_from: /getting-started/updating/
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), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant).
</p>
Check what's new in the latest version and potentially impacts your system in [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). It is good practice to review these release notes and pay close attention to the **Breaking Changes** that are listed there. If you haven't done an update for a while, you should also check previous release notes as they can also contain relevant **Breaking Changes**. **Breaking Changes** may require configuration updates for your components. If you missed this and Home Assistant refuses to start, check `<config-dir>/home-assistant.log` for details about broken components.
Check what's new in the latest version and potentially impacts your system in [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). It is good practice to review these release notes and pay close attention to the **Breaking Changes** that are listed there. If you haven't done an update for a while, you should also check previous release notes as they can also contain relevant **Breaking Changes**. **Breaking Changes** may require configuration updates for your components. If you missed this and Home Assistant refuses to start, check the log file in the [configuration](/docs/configuration/) directory, e.g., `.homeassistant/home-assistant.log`, for details about broken components.
The default way to update Home Assistant to the latest release, when available, is:
@ -22,7 +22,13 @@ The default way to update Home Assistant to the latest release, when available,
$ 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](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well.
For a Docker container, simply pull the latest one:
```bash
$ sudo docker pull homeassistant/home-assistant:latest
```
After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well.
<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 [Hass.io](/hassio/), [Hassbian](/docs/hassbian/installation/), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv).

4
source/_docs/mqtt/discovery.markdown
View file

@ -43,8 +43,8 @@ The discovery topic need to follow a specific format:
```
- `<component>`: One of the supported components, eg. `binary_sensor`.
- `<node_id>`: (*Optional*) id of the node providing the topic.
- `<object_id>`: "The ID of the device. This is only to allow for separate topics for each device and is not used for the `entity_id`."
- `<node_id>` (*Optional*): ID of the node providing the topic.
- `<object_id>`: The ID of the device. This is only to allow for separate topics for each device and is not used for the `entity_id`.
- `<>`: The topic `config` or `state` which defines the current action.
The payload will be checked like an entry in your `configuration.yaml` file if a new device is added. This means that missing variables will be filled with the platform's default values. All configuration variables which are *required* must be present in the initial payload send to `/config`.

14
source/_docs/z-wave/installation.markdown
View file

@ -205,7 +205,7 @@ The first run after adding a device is when the `zwave` component will take time
### {% linkable_title Component could not be set up %}
Sometimes the device may not be accessible and you'll get an error message upon startup about not being able to set up Z-Wave. Run the following command for your device path:
Sometimes the device may not be accessible and you'll get an error message upon startup about not being able to set up Z-Wave. Run the following command for your device path (here we're using `/dev/ttyAMA0` for our Razberry board):
```bash
$ ls -l /dev/ttyAMA0
@ -224,6 +224,18 @@ $ sudo chgrp dialout /dev/ttyAMA0
$ sudo chmod g+rw /dev/ttyAMA0
```
Check too that the account you're running Home Assistant as is in the `dialout` group. For instance, if you're using `homeassistant`:
```bash
$ groups homeassistant
```
That should include `dialout`, if it doesn't then:
```bash
$ sudo usermod -G dialout homeassistant
```
### {% linkable_title Device path changes %}
If your device path changes when you restart, see [this guide](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/) on fixing it.