jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify ozw requirements and update names (#13450)

Browse Source
This commit is contained in:
Martin Hjelmare 2020-05-15 20:14:15 +02:00 committed by GitHub
parent 9536a683fc
commit fa61874e47
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
source/_integrations/ozw.markdown
View File

@ -13,13 +13,14 @@ ha_codeowners:
ha_domain: ozw ha_domain: ozw
--- ---
This integration allows you to utilize OpenZWave's qt-openzwave daemon to control a Z-Wave network over MQTT. This integration allows you to utilize OpenZWave's ozwdaemon to control a Z-Wave network over MQTT.
## Requirements ## Requirements
- MQTT server and the [MQTT integration](/integrations/mqtt/) set up in Home Assistant. - MQTT server and the [MQTT integration](/integrations/mqtt/) set up in Home Assistant.
- [qt-openzwave daemon](https://github.com/OpenZWave/qt-openzwave). - The [ozwdaemon](https://github.com/OpenZWave/qt-openzwave) installed and running in your network.
- Supported Z-Wave dongle compatible with OpenZWave 1.6. See this [list](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules) of controllers. For Home Assistant Supervisor there's a [custom add-on](https://github.com/marcelveldt/hassio-addons-repo/tree/master/ozwdaemon).
- Supported Z-Wave dongle compatible with OpenZWave 1.6. See this [list](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules) of controllers. The Z-Wave controller dongle should be connected to the same host as where the ozwdaemon is running.
## Configuration ## Configuration
@ -34,31 +35,31 @@ available.
### Secure network key ### Secure network key
The secure network key is set in the settings for the qt-openzwave daemon and The secure network key is set in the settings for the ozwdaemon and
not in the integration configuration. not in the integration configuration.
## Services ## Services
### Service `zwave_mqtt.add_node` ### Service `ozw.add_node`
This service will set the controller into inclusion mode and should be used to This service will set the controller into inclusion mode and should be used to
add a device (node) to the Z-Wave network. Call the service and then perform add a device (node) to the Z-Wave network. Call the service and then perform
the device-specific procedure, according to the device manual, to add your the device-specific procedure, according to the device manual, to add your
device to the network. Make sure the controller is connected to the host where device to the network. Make sure the controller is connected to the host where
the QT-OpenZwave daemon is running, when performing this operation. the ozwdaemon is running, when performing this operation.
| Service Data Attribute | Required | Description | | Service Data Attribute | Required | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `secure` | no | Add the new node with secure communications. [Secure network key must be set](#secure-network-key). This process will fallback to add_node (unsecure) for unsupported devices. Note that insecure devices can't directly talk to secure devices. | | `secure` | no | Add the new node with secure communications. [Secure network key must be set](#secure-network-key). This process will fallback to add_node (unsecure) for unsupported devices. Note that insecure devices can't directly talk to secure devices. |
| `instance_id` | no | The OZW Instance/Controller to use, defaults to 1. | | `instance_id` | no | The OZW Instance/Controller to use, defaults to 1. |
### Service `zwave_mqtt.remove_node` ### Service `ozw.remove_node`
This service will set the controller into exclusion mode and should be used to This service will set the controller into exclusion mode and should be used to
remove a device (node) from the Z-Wave network. Call the service and then remove a device (node) from the Z-Wave network. Call the service and then
perform the device-specific procedure, according to the device manual, perform the device-specific procedure, according to the device manual,
to remove your device from the network. Make sure the controller is connected to remove your device from the network. Make sure the controller is connected
to the host where the QT-OpenZwave daemon is running, when performing to the host where the ozwdaemon is running, when performing
this operation. this operation.
| Service Data Attribute | Required | Description | | Service Data Attribute | Required | Description |