Merge branch 'current' into next
This commit is contained in:
Paulus Schoutsen
commit
cc025a6a72
107 changed files with 293 additions and 181 deletions
|
|
@ -43,6 +43,13 @@ Don't forget to save your new automation rule. In order for your saved automatio
|
|||
|
||||
## {% linkable_title Updating your configuration to use the editor %}
|
||||
|
||||
First check that you have activated the configuration editor.
|
||||
|
||||
```yaml
|
||||
# Activate the configuration editor
|
||||
config:
|
||||
```
|
||||
|
||||
The automation editor reads and writes to the file `automations.yaml` in your [configuration](/docs/configuration/) folder. Make sure that you have set up the automation component to read from it:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Home Assistant can run as a daemon within init.d with the script below.
|
|||
|
||||
### {% linkable_title 1. Copy script %}
|
||||
|
||||
Copy either the deamon script or the Python environment scrip at the end of this page to `/etc/init.d/hass-daemon` depending on your installation.
|
||||
Copy either the daemon script or the Python environment scrip at the end of this page to `/etc/init.d/hass-daemon` depending on your installation.
|
||||
|
||||
After that, set the script to be executable:
|
||||
|
||||
|
|
@ -85,7 +85,8 @@ PRE_EXEC=""
|
|||
# Typically /usr/bin/hass
|
||||
HASS_BIN="hass"
|
||||
RUN_AS="USER"
|
||||
PID_FILE="/var/run/hass.pid"
|
||||
PID_DIR="/var/run"
|
||||
PID_FILE="$PID_DIR/hass.pid"
|
||||
CONFIG_DIR="/var/opt/homeassistant"
|
||||
LOG_DIR="/var/log/homeassistant"
|
||||
LOG_FILE="$LOG_DIR/home-assistant.log"
|
||||
|
|
@ -93,11 +94,7 @@ FLAGS="-v --config $CONFIG_DIR --pid-file $PID_FILE --log-file $LOG_FILE --daemo
|
|||
|
||||
|
||||
start() {
|
||||
if [ ! -d "$PID_DIR" ]; then
|
||||
echo "It seems you did not run"
|
||||
echo -e "\tservice hass-daemon install"
|
||||
return 1
|
||||
fi
|
||||
create_piddir
|
||||
if [ -f $PID_FILE ] && kill -0 $(cat $PID_FILE) 2> /dev/null; then
|
||||
echo 'Service already running' >&2
|
||||
return 1
|
||||
|
|
@ -217,11 +214,7 @@ LOG_FILE="$LOG_DIR/home-assistant.log"
|
|||
FLAGS="-v --config $CONFIG_DIR --pid-file $PID_FILE --log-file $LOG_FILE --daemon"
|
||||
|
||||
start() {
|
||||
if [ ! -d "$PID_DIR" ]; then
|
||||
echo "It seems you did not run"
|
||||
echo -e "\tservice hass-daemon install"
|
||||
return 1
|
||||
fi
|
||||
create_piddir
|
||||
if [ -f $PID_FILE ] && kill -0 $(cat $PID_FILE) 2> /dev/null; then
|
||||
echo 'Service already running' >&2
|
||||
return 1
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ Configuration variables:
|
|||
|
||||
### {% linkable_title Password protecting the web interface %}
|
||||
|
||||
First, you'll want to add a password for the Home Assistant web interface. Use your favourite text editor to open `configuration.yaml` and edit the `http` section:
|
||||
First, you'll want to add a password for the Home Assistant web interface. Use your favorite text editor to open `configuration.yaml` and edit the `http` section:
|
||||
|
||||
```yaml
|
||||
http:
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ After filling Home Assistant with all your precious home automation devices, you
|
|||
|
||||
## {% linkable_title Changing visibility of a group %}
|
||||
|
||||
To change visibility of a group, use the service `group.set_visibility`, pass the group name as `entity_id` and use `visible` to decide wheter the group should be shown or hidden.
|
||||
To change visibility of a group, use the service `group.set_visibility`, pass the group name as `entity_id` and use `visible` to decide whether the group should be shown or hidden.
|
||||
|
||||
```yaml
|
||||
service: group.set_visibility
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ Components inside packages can only specify platform entries using configuration
|
|||
|
||||
### {% linkable_title Create a packages folder %}
|
||||
|
||||
One way to organise packages would be to create a folder named "packages" in your Home Assistant configuration directory. In the packages directory you can store any number of packages in a YAML file. This entry in your `configuration.yaml` will load all packages:
|
||||
One way to organize packages would be to create a folder named "packages" in your Home Assistant configuration directory. In the packages directory you can store any number of packages in a YAML file. This entry in your `configuration.yaml` will load all packages:
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ There are several circumstances under which `initialize()` might be called:
|
|||
- Following a change in the status of Daylight Savings Time
|
||||
- Following a restart of Home Assistant
|
||||
|
||||
In every case, the App is responsible for recreating any state it might need as if it were the first time it was ever started. If `initialize()` is called, the app can safely assume that it is either being loaded for the first time, or that all callbacks and timers have been cancelled. In either case, the APP will need to recreate them. Depending upon the application it may be desirable for the App to establish state such as whether or not a particular light is on, within the `initialize()` function to ensure that everything is as expected or to make immediate remedial action (e.g. turn off a light that might have been left on by mistake when the app was restarted).
|
||||
In every case, the App is responsible for recreating any state it might need as if it were the first time it was ever started. If `initialize()` is called, the app can safely assume that it is either being loaded for the first time, or that all callbacks and timers have been canceled. In either case, the APP will need to recreate them. Depending upon the application it may be desirable for the App to establish state such as whether or not a particular light is on, within the `initialize()` function to ensure that everything is as expected or to make immediate remedial action (e.g. turn off a light that might have been left on by mistake when the app was restarted).
|
||||
|
||||
After the `initialize()` function is in place, the rest of the app consists of functions that are called by the various callback mechanisms, and any additional functions the user wants to add as part of the program logic. Apps are able to subscribe to 2 main classes of events:
|
||||
|
||||
|
|
@ -539,7 +539,7 @@ self.handle = self.listen_state(self.my_callback, "light.office_1", new = "on",
|
|||
|
||||
### {% linkable_title cancel_listen_state() %}
|
||||
|
||||
Cancel a `listen_state()` callback. This will mean that the App will no longer be notified for the specific state change that has been cancelled. Other state changes will continue to be monitored.
|
||||
Cancel a `listen_state()` callback. This will mean that the App will no longer be notified for the specific state change that has been canceled. Other state changes will continue to be monitored.
|
||||
|
||||
#### {% linkable_title Synopsis %}
|
||||
|
||||
|
|
@ -1317,7 +1317,7 @@ self.select_option("input_select.mode", "Day")
|
|||
|
||||
### {% linkable_title notify() %}
|
||||
|
||||
This is a convenience function for the `notify.notify` service. It will send a notification to your defualt notification service. If you have more than one, use `call_service()` to call the specific notification service you require instead.
|
||||
This is a convenience function for the `notify.notify` service. It will send a notification to your default notification service. If you have more than one, use `call_service()` to call the specific notification service you require instead.
|
||||
|
||||
#### {% linkable_title Synopsis %}
|
||||
|
||||
|
|
@ -1534,7 +1534,7 @@ The name of the event that caused the callback, e.g. `"MODE_CHANGE"` or `call_se
|
|||
|
||||
A dictionary containing any additional information associated with the event.
|
||||
|
||||
### {% linkable_title Use of Events for Signalling between Home Assistant and AppDaemon %}
|
||||
### {% linkable_title Use of Events for Signaling between Home Assistant and AppDaemon %}
|
||||
|
||||
Home Assistant allows for the creation of custom events and existing components can send and receive them. This provides a useful mechanism for signaling back and forth between Home Assistant and AppDaemon. For instance, if you would like to create a UI Element to fire off some code in Home Assistant, all that is necessary is to create a script to fire a custom event, then subscribe to that event in AppDaemon. The script would look something like this:
|
||||
|
||||
|
|
@ -1701,7 +1701,7 @@ time()
|
|||
|
||||
#### {% linkable_title Returns %}
|
||||
|
||||
A localised Python time object representing the current AppDaemon time.
|
||||
A localized Python time object representing the current AppDaemon time.
|
||||
|
||||
#### {% linkable_title Parameters %}
|
||||
|
||||
|
|
@ -1725,7 +1725,7 @@ date()
|
|||
|
||||
#### {% linkable_title Returns %}
|
||||
|
||||
A localised Python time object representing the current AppDaemon date.
|
||||
A localized Python time object representing the current AppDaemon date.
|
||||
|
||||
#### {% linkable_title Parameters %}
|
||||
|
||||
|
|
@ -1749,7 +1749,7 @@ datetime()
|
|||
|
||||
#### {% linkable_title Returns %}
|
||||
|
||||
A localised Python datetime object representing the current AppDaemon date and time.
|
||||
A localized Python datetime object representing the current AppDaemon date and time.
|
||||
|
||||
#### {% linkable_title Parameters %}
|
||||
|
||||
|
|
@ -1764,7 +1764,7 @@ now = self.datetime()
|
|||
|
||||
### {% linkable_title convert_utc() %}
|
||||
|
||||
Home Assistant provides timestamps of several different sorts that may be used to gain additional insight into state changes. These timestamps are in UTC and are coded as ISO 8601 Combined date and time strings. `convert_utc()` will accept one of these strings and convert it to a localised Python datetime object representing the timestamp
|
||||
Home Assistant provides timestamps of several different sorts that may be used to gain additional insight into state changes. These timestamps are in UTC and are coded as ISO 8601 Combined date and time strings. `convert_utc()` will accept one of these strings and convert it to a localized Python datetime object representing the timestamp
|
||||
|
||||
#### {% linkable_title Synopsis %}
|
||||
|
||||
|
|
@ -1774,7 +1774,7 @@ convert_utc(utc_string)
|
|||
|
||||
#### {% linkable_title Returns %}
|
||||
|
||||
`convert_utc(utc_string)` returns a localised Python datetime object representing the timestamp.
|
||||
`convert_utc(utc_string)` returns a localized Python datetime object representing the timestamp.
|
||||
|
||||
#### {% linkable_title Parameters %}
|
||||
|
||||
|
|
@ -2072,7 +2072,7 @@ Note the timestamps in the log - AppDaemon believes it is now just before sunset
|
|||
|
||||
### {% linkable_title Speeding things up %}
|
||||
|
||||
Some Apps need to run for periods of a day or two for you to test all aspects. This can be time consuming, but Time Travel can also help here in two ways. The first is by speeding up time. To do this, simply use the `-t` option on the command line. This specifies the amount of time a second lasts while time travelling. The default of course is 1 second, but if you change it to `0.1` for instance, AppDaemon will work 10x faster. If you set it to `0`, AppDaemon will work as fast as possible and, depending in your hardware, may be able to get through an entire day in a matter of minutes. Bear in mind however, due to the threaded nature of AppDaemon, when you are running with `-t 0` you may see actual events firing a little later than expected as the rest of the system tries to keep up with the timer. To set the tick time, start AppDaemon as follows:
|
||||
Some Apps need to run for periods of a day or two for you to test all aspects. This can be time consuming, but Time Travel can also help here in two ways. The first is by speeding up time. To do this, simply use the `-t` option on the command line. This specifies the amount of time a second lasts while time traveling. The default of course is 1 second, but if you change it to `0.1` for instance, AppDaemon will work 10x faster. If you set it to `0`, AppDaemon will work as fast as possible and, depending in your hardware, may be able to get through an entire day in a matter of minutes. Bear in mind however, due to the threaded nature of AppDaemon, when you are running with `-t 0` you may see actual events firing a little later than expected as the rest of the system tries to keep up with the timer. To set the tick time, start AppDaemon as follows:
|
||||
|
||||
```bash
|
||||
$ appdaemon -t 0.1
|
||||
|
|
@ -2105,4 +2105,4 @@ $ appdaemon -s "2016-06-06 19:16:00" -s "2016-06-06 20:16:00" -t 0
|
|||
|
||||
### {% linkable_title A Note on Times %}
|
||||
|
||||
Some Apps you write may depend on checking times of events relative to the current time. If you are time travelling this will not work if you use standard python library calls to get the current time and date etc. For this reason, always use the AppDamon supplied `time()`, `date()` and `datetime()` calls, documented earlier. These calls will consult with AppDaemon's internal time rather than the actual time and give you the correct values.
|
||||
Some Apps you write may depend on checking times of events relative to the current time. If you are time traveling this will not work if you use standard python library calls to get the current time and date etc. For this reason, always use the AppDamon supplied `time()`, `date()` and `datetime()` calls, documented earlier. These calls will consult with AppDaemon's internal time rather than the actual time and give you the correct values.
|
||||
|
|
|
|||
|
|
@ -133,7 +133,7 @@ Every time you run this script, you will be prompted for a comment to describe t
|
|||
|
||||
[Travis CI](https://travis-ci.org) is a continuous integration testing system that runs every time the code in your repository is updated and allows you to validate that your code works on a fresh install.
|
||||
|
||||
- [Authorise Travis CI](https://travis-ci.org/auth) to have access to your github repos.
|
||||
- [Authorize Travis CI](https://travis-ci.org/auth) to have access to your github repos.
|
||||
- Create the build script that travis will run to test your repo.
|
||||
- Create a dummy secrets.yaml for Travis.
|
||||
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ Type the following command to list your network interfaces:
|
|||
$ ifconfig
|
||||
```
|
||||
|
||||
You will receive an ouput similar to the image below:
|
||||
You will receive an output similar to the image below:
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/ip-set.jpg' />
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ In advance of sending a notification:
|
|||
|
||||
When sending a notification:
|
||||
|
||||
1. Send a notification with `data.push.category` set to a pre-defined notification category identifer.
|
||||
1. Send a notification with `data.push.category` set to a pre-defined notification category identifier.
|
||||
2. Push notification delivered to device
|
||||
3. User opens notification.
|
||||
3. Action tapped
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ redirect_from: /getting-started/browsers/
|
|||
|
||||
Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don't test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works. The "Release" column contains the release number which were tested. This doen't mean that older or newer releases not work.
|
||||
|
||||
If a browser is listed as working but you are still having problems, it is possible that some add-on or extension may be the problem. Some add-ons or extenstion are known to cause issue with the frontend, but it's not possible to test them all. If you are having issues with the frontend displaying correctly, you should disable all your add-ons or extensions and enable them one at a time.
|
||||
If a browser is listed as working but you are still having problems, it is possible that some add-on or extension may be the problem. Some add-ons or extension are known to cause issue with the frontend, but it's not possible to test them all. If you are having issues with the frontend displaying correctly, you should disable all your add-ons or extensions and enable them one at a time.
|
||||
|
||||
We would appreciate if you help to keep this page up-to-date and add feedback.
|
||||
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ This will let you access your Home Assistant portal from http://localhost:8123,
|
|||
|
||||
### {% linkable_title Synology NAS %}
|
||||
|
||||
As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatability-information, if your NAS is supported), see https://www.synology.com/en-us/dsm/app_packages/Docker
|
||||
As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see https://www.synology.com/en-us/dsm/app_packages/Docker
|
||||
|
||||
The steps would be:
|
||||
* Install "Docker" package on your Synology NAS
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ The tool is available by running `hassbian-config`.
|
|||
|
||||
### Install scripts
|
||||
To view the available packages run `hassbian-config show` and `sudo hassbian-config install PACKAGENAME`.
|
||||
- Install Hue. Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component thats used with Amazon Echo, Google Home and Mycroft.ai.
|
||||
- Install Hue. Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component that's used with Amazon Echo, Google Home and Mycroft.ai.
|
||||
- Install MariaDB. This script installs MariaDB and it's dependencies for use with the recorder component in Home Assistant. No database or database user is created during this setup and will need to be created manually.
|
||||
- Install Mosquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects official repository. Now includes websocket support.
|
||||
- Install Libcec. Adds local [HDMI CEC support][cec]. *This scipt is currently brooken upstream since it currently doesn't build properly for Python >3.4*
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ $ cd home-assistant/virtualization/vagrant
|
|||
```
|
||||
|
||||
<p class='note'>
|
||||
The following instructions will assume you changed your working directory to be `home-assistant/virtualization/vagrant`. This is mandatory because Vagrant will look for informations about the running VM inside that folder and won't work otherwise
|
||||
The following instructions will assume you changed your working directory to be `home-assistant/virtualization/vagrant`. This is mandatory because Vagrant will look for information about the running VM inside that folder and won't work otherwise
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ _(If you're on a Debian based system, you will need to install Python virtual en
|
|||
### {% linkable_title Notes %}
|
||||
|
||||
- In the future, if you want to start Home Assistant manually again, follow step 2, 3 and 5.
|
||||
- It's recommanded to run Home Assistant as a dedicated user.
|
||||
- It's recommended to run Home Assistant as a dedicated user.
|
||||
|
||||
<p class='info'>
|
||||
Looking for more advanced guides? Check our [Rasbian guide](/docs/installation/raspberry-pi/) or the [other installation guides](/docs/installation/).
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Script Syntax"
|
||||
description: "Documention for the Home Assistant Script Syntax."
|
||||
description: "Documentation for the Home Assistant Script Syntax."
|
||||
date: 2016-04-24 08:30 +0100
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
|
@ -124,16 +124,51 @@ event_data:
|
|||
entity_id: device_tracker.paulus
|
||||
domain: light
|
||||
```
|
||||
|
||||
You can also use event_data_template to fire an event with custom data. This could be used to pass data to another script awaiting
|
||||
an event trigger.
|
||||
```
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
event: MY_EVENT
|
||||
event_data_template:
|
||||
name: myEvent
|
||||
customData: "{{ myCustomVariable }}"
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Raise and Consume Custom Events %}
|
||||
|
||||
The following automation shows how to raise a custom event called `event_light_turned_on` with `entity_id` as the event data. The action part could be inside a script or an automation.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
- alias: Fire Event
|
||||
trigger:
|
||||
platform: state
|
||||
entity_id: switch.kitchen
|
||||
to: 'on'
|
||||
action:
|
||||
event: event_light_state_changed
|
||||
event_data:
|
||||
state: "on"
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The following automation shows how to capture the custom event `event_light_turned_on`, and retrieve corresponsing `entity_id` that was passed as the event data.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
- alias: Capture Event
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: event_light_state_changed
|
||||
action:
|
||||
- service: notify.notify
|
||||
data_template:
|
||||
message: "kitchen light is turned {{ trigger.event.data.state }}"
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
[Script component]: /components/script/
|
||||
[automations]: /getting-started/automation-action/
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ To add (include) a non-secure Z-Wave [device](/docs/z-wave/devices/) to your sys
|
|||
1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend
|
||||
2. Click the **Add Node** button in the *Z-Wave Network Management* card - this will place the controller in inclusion mode
|
||||
3. Activate your device to be included by following the instructions provided with the device
|
||||
4. With the device in its final location, run a *Heal*
|
||||
4. With the device in its final location, run a *Heal Network*
|
||||
|
||||
Don't use this for [secure devices](https://home-assistant.io/docs/z-wave/adding/#adding-secure-devices), since this is likely to limit the features the device supports.
|
||||
|
||||
|
|
@ -63,6 +63,7 @@ After defining your network key, follow these steps to add (include) a secure Z-
|
|||
1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend
|
||||
2. Click the **Add Node Secure** button in the *Z-Wave Network Management* card - this will place the controller in inclusion mode
|
||||
3. Activate your device to be included by following the instructions provided with the device
|
||||
4. With the device in its final location, run a *Heal Network*
|
||||
|
||||
## {% linkable_title Removing Devices %}
|
||||
|
||||
|
|
@ -71,4 +72,4 @@ To remove (exclude) a Z-Wave device from your system:
|
|||
1. Go to the Z-Wave control panel in the Home Assistant frontend
|
||||
2. Click the **Remove Node** button in the *Z-Wave Network Management* card - this will place the controller in exclusion mode
|
||||
3. Activate your device to be excluded by following the instructions provided with the device
|
||||
4. With the device in its final location, run a *Heal*
|
||||
4. Run a *Heal Network* so all the other nodes learn about its removal
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ Here is where you [include and exclude](/docs/z-wave/adding/) Z-Wave devices fro
|
|||
|
||||
* **Rename Node** sets a node's name - this won't happen immediately, and requires you to restart Home Assistant (not reboot) to set the new name
|
||||
|
||||
* **Heal Node** starts healing of the node.(Update neighbour list and update return routes)
|
||||
* **Heal Node** starts healing of the node.(Update neighbor list and update return routes)
|
||||
|
||||
* **Test Node** sends no_op test messages to the node. This could in theory bring back a dead node.
|
||||
|
||||
|
|
@ -114,7 +114,7 @@ Underneath that you can select any supported configuration parameter to see the
|
|||
|
||||
## {% linkable_title Node user codes %}
|
||||
|
||||
If your node has user codes, you can set and delete them. The format is raw hex Ascii code. Bellow the input you will see your actual code. For normal nodes this is as follows:
|
||||
If your node has user codes, you can set and delete them. The format is raw hex Ascii code. Below the input you will see your actual code. For normal nodes this is as follows:
|
||||
```yaml
|
||||
\x30 = 0
|
||||
\x31 = 1
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Home Assistant stores logs from Z-Wave in `OZW_log.txt` in the Home Assistant co
|
|||
|
||||
### {% linkable_title Aeotec Z-Stick %}
|
||||
|
||||
It's totally normal for your Z-Wave stick to cycle through its LEDs (Yellow, Blue and Red) while plugged into your system. If you don't like this behaviour it can be turned off.
|
||||
It's totally normal for your Z-Wave stick to cycle through its LEDs (Yellow, Blue and Red) while plugged into your system. If you don't like this behavior it can be turned off.
|
||||
|
||||
Use the following example commands from a terminal session on your Pi where your Z-Wave stick is connected.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,14 @@ footer: true
|
|||
redirect_from: /getting-started/z-wave-installation/
|
||||
---
|
||||
|
||||
The first time you enable the Z-Wave component it will install the Z-Wave drivers (python-openzwave). This can take up to half an hour on slow machines like Raspberry Pi.
|
||||
|
||||
Installing the drivers might require some extra packages to be installed. Check your platform below.
|
||||
|
||||
## {% linkable_title Platform specific installation instructions %}
|
||||
|
||||
### {% linkable_title Linux (except Hass.io) %}
|
||||
|
||||
On Linux platforms (other than Hass.io) there is one dependency you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems):
|
||||
|
||||
```bash
|
||||
|
|
@ -18,19 +26,17 @@ $ sudo apt-get install libudev-dev
|
|||
|
||||
On Python 3.6 you may also have to install libpython3.6-dev, and possibly python3.6-dev.
|
||||
|
||||
When installing on macOS you may have to also run the command below ahead of time, replace "x.x" with the version of Python (`$ python3 --version`) you have installed.
|
||||
### {% linkable_title macOS %}
|
||||
|
||||
When installing on macOS you may have to also run the command below ahead of time, replace "x.x" with the version of Python (`$ python3 --version`) you have installed.
|
||||
|
||||
```bash
|
||||
$ sudo /Applications/Python\ x.x/Install\ Certificates.command
|
||||
```
|
||||
|
||||
<p class='note'>
|
||||
The installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi.
|
||||
</p>
|
||||
### {% linkable_title Raspberry Pi %}
|
||||
|
||||
<p class='note'>
|
||||
On Raspberry Pi you will need to enable the serial interface in the raspbi-config tool before you can add Z-Wave to Home Assistant.
|
||||
</p>
|
||||
On Raspberry Pi you will need to enable the serial interface in the `raspbi-config` tool before you can add Z-Wave to Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
|
|
@ -41,7 +47,7 @@ zwave:
|
|||
```
|
||||
|
||||
{% configuration zwave %}
|
||||
usb_path:
|
||||
usb_path:
|
||||
description: The port where your device is connected to your Home Assistant host.
|
||||
required: false
|
||||
type: string
|
||||
|
|
@ -51,7 +57,7 @@ network_key:
|
|||
required: false
|
||||
type: string
|
||||
default: None
|
||||
config_path:
|
||||
config_path:
|
||||
description: The path to the Python OpenZWave configuration files.
|
||||
required: false
|
||||
type: string
|
||||
|
|
@ -76,11 +82,11 @@ new_entity_ids:
|
|||
required: false
|
||||
type: boolean
|
||||
default: True
|
||||
device_config:
|
||||
device_config:
|
||||
description: This attribute contains node-specific override values. (For releases prior to 0.39 this variable is called **customize**) See [Customizing devices and services](/docs/configuration/customizing-devices/) for the format.
|
||||
required: false
|
||||
type: string, list
|
||||
keys:
|
||||
keys:
|
||||
ignored:
|
||||
description: Ignore this entity completely. It won't be shown in the Web Interface and no events are generated for it.
|
||||
required: false
|
||||
|
|
@ -163,16 +169,10 @@ To enable Z-Wave, plug your Z-Wave USB stick into your Raspberry Pi 3 and add th
|
|||
|
||||
```yaml
|
||||
zwave:
|
||||
usb_path: /dev/ttyAMA0
|
||||
usb_path: /dev/ttyACM0
|
||||
```
|
||||
|
||||
For some devices the `/dev/ttyAMA0` device is not detected by udev and is therefore not mapped by Docker. To explicitly set this device for mapping to Home-Assistant, execute the following command using the ssh add-on:
|
||||
|
||||
```bash
|
||||
$ curl -d '{"devices": ["ttyAMA0"]}' http://hassio/homeassistant/options
|
||||
```
|
||||
|
||||
After that, you need to change `usb_path` to `/dev/ttyAMA0`.
|
||||
Depending on your Z-Wave device it may instead be `/dev/ttyAMA0` (eg Razberry board) or `/dev/ttyUSB0` (eg HUBUZB-1).
|
||||
|
||||
### {% linkable_title RancherOS %}
|
||||
|
||||
|
|
@ -202,7 +202,7 @@ Ensure you keep a backup of this key. If you have to rebuild your system and don
|
|||
|
||||
## {% linkable_title First Run %}
|
||||
|
||||
The (compilation and) installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspbery Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed.
|
||||
The (compilation and) installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed.
|
||||
|
||||
The first run after adding a device is when the `zwave` component will take time to initialize the entities, some entities may appear with incomplete names. Running a network heal may speed up this process.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue