Merge branch 'current' into next
This commit is contained in:
commit
cc025a6a72
107 changed files with 293 additions and 181 deletions
|
@ -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