Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for new ZHA config entry flow #13279

Merged
merged 2 commits into from
May 8, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 21 additions & 31 deletions source/_integrations/zha.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -79,32 +79,36 @@ Use the plus button in the bottom right to add a new integration called **ZHA**.

In the popup:

- USB Device Path - on a Linux system will be something like `/dev/ttyUSB0` or `/dev/ttyACM0`
- Radio type - select device type `ezsp`, `deconz`, `ti_cc`, `xbee` or `zigate`
- Serial Device Path - List of detected serial ports on the system. You need to pick one to which your
radio is connected
- Submit

Press `Submit` and the integration will try to detect radio type automatically. If unsuccessful, you will get
a new pop-up asking for a radio type. In the pop-up:

- Radio Type

| Radio Type | Zigbee Radio Hardware |
| ------------- | ------------- |
| `ezsp` | EmberZNet based radios, Telegesis ETRX357USB*** (using EmberZNet firmware) |
| `deconz` | ConBee, ConBee II |
| `deconz` | ConBee, ConBee II, RaspBi |
| `ezsp` | EmberZNet based radios, HUSBZB-1, Telegesis ETRX357USB*** (using EmberZNet firmware) |
| `ti_cc` | Texas Instruments ZNB based radios: CC2531, CC2530 |
| `xbee` | Digi XBee Series 2, 2C, 3 |
| `zigate` | ZiGate based radio |

- Press `Submit` to save changes.

The success dialog will appear or an error will be displayed in the popup. An error is likely if Home Assistant can't access the USB device or your device is not up to date. Refer to [Troubleshooting](#troubleshooting) below for more information.

## Configuration - Manual
- Submit

To configure the component, select ZHA on the Integrations page and provide the path to your Zigbee USB stick.
Press `Submit` to save radio type and you will get a new form asking for port settings specific for this
radio type. In the pop-up:
- Serial device path
- port speed (not applicable for all radios)
- data flow control (not applicable for all radios)

Or, you can manually configure `zha` section in `configuration.yaml`. The path to the database which will persist your network data is required.
Most devices need at very least the serial device path, like `/dev/ttyUSB0`, but it is recommended to use
device path from `/dev/serial/by-id` folder,
eg `/dev/serial/by-id/usb-Silicon_Labs_HubZ_Smart_Home_Controller_C0F003D3-if01-port0`

```yaml
# Example configuration.yaml entry
zha:
usb_path: /dev/ttyUSB2
database_path: /home/homeassistant/.homeassistant/zigbee.db
```
Press `Submit` The success dialog will appear or an error will be displayed in the popup. An error is likely if Home Assistant can't access the USB device or your device is not up to date. Refer to [Troubleshooting](#troubleshooting) below for more information.

If you are use ZiGate, you have to use some special usb_path configuration:

Expand All @@ -113,20 +117,6 @@ If you are use ZiGate, you have to use some special usb_path configuration:
- Wifi Zigate : `socket://[IP]:[PORT]` for example `socket://192.168.1.10:9999`

{% configuration %}
radio_type:
description: One of `deconz`, `ezsp`, `ti_cc`, `xbee` or `zigate`.
required: false
type: string
default: ezsp
usb_path:
description: Path to the serial device for the radio.
required: true
type: string
baudrate:
description: Baud rate of the serial device.
required: false
type: integer
default: 57600
database_path:
description: _Full_ path to the database which will keep persistent network data.
required: true
Expand Down