Address comments for #14643 (#14655)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Alexei Chetroi 2020-09-29 17:38:00 -04:00 committed by GitHub
parent ce6ebd36f8
commit 497d0b20b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -146,29 +146,42 @@ To add new devices to the network, call the `permit` service on the `zha` domain
## Services ## Services
### Service `permit`
This service opens network for joining new devices ### Service `zha.permit`
This service opens network for joining new devices.
| Data | Optional | Description | | Data | Optional | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| `duration` | yes | For how long to allow new devices to join, default 60s | `duration` | yes | For how long to allow new devices to join, default 60s
| `ieee` | yes | allow new devices to join via an existing device | `ieee` | yes | allow new devices to join via an existing device
| `src_ieee` | | The IEEE address of the joining ZB3 device. Use with `install_code`
| `install_code` | | Install Code of the joining device. Use with `src_ieee`
| `qr_code` | | QR code containing IEEE and Install Code of the joining ZB3 device
* currently `qr_cde` supports QR Install Codes from: To join a new device using an install code (ZB3 devices) use the following data attributes (must use parameters only
- Aqara from the same group:
- Consciot
- Embrighten
### Service `remove` | Data | Parameter Group | Description |
This service remove an existing device from the network | ---- | ---- | ----------- |
| `src_ieee` | install_code | The IEEE address of the joining ZB3 device. Use with `install_code`
| `install_code` | install_code | Install Code of the joining device. Use with `src_ieee`
| `qr_code` | qr_code | QR code containing IEEE and Install Code of the joining ZB3 device
<div class='note'>
Currently `qr_code` supports QR Install Codes from:
- Aqara
- Consciot
- Embrighten
</div>
### Service `zha.remove`
This service remove an existing device from the network.
| Data | Optional | Description | | Data | Optional | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| `ieee` | no | What device to remove | `ieee` | no | IEEE address of the device to remove
### OTA firmware updates ### OTA firmware updates