Rename zwave_mqtt to ozw (#13446)

This commit is contained in:
Franck Nijhof 2020-05-14 22:56:25 +02:00 committed by GitHub
parent 526322243a
commit 9536a683fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,6 @@
--- ---
title: Z-Wave over MQTT title: OpenZWave (beta)
description: Instructions on how to integrate Z-Wave over MQTT with Home Assistant. description: Instructions on how to integrate OpenZWave with Home Assistant.
ha_category: ha_category:
- Switch - Switch
ha_release: "0.110" ha_release: "0.110"
@ -10,15 +10,15 @@ ha_codeowners:
- '@cgarwood' - '@cgarwood'
- '@marcelveldt' - '@marcelveldt'
- '@MartinHjelmare' - '@MartinHjelmare'
ha_domain: zwave_mqtt 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 qt-openzwave daemon 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) - [qt-openzwave daemon](https://github.com/OpenZWave/qt-openzwave).
- 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. - 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.
## Configuration ## Configuration
@ -28,28 +28,38 @@ Home Assistant frontend.
Menu: **Configuration** -> **Integrations**. Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **Z-Wave over MQTT**. Click on the `+` sign to add an integration and click on **OpenZWave (beta)**.
After completing the configuration flow, the Z-Wave over MQTT After completing the configuration flow, the OpenZWave integration will be
integration will be available. available.
### Secure network key ### Secure network key
The secure network key is set in the settings for the qt-openzwave daemon and not in the integration configuration. The secure network key is set in the settings for the qt-openzwave daemon and
not in the integration configuration.
## Services ## Services
### Service `zwave_mqtt.add_node` ### Service `zwave_mqtt.add_node`
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 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 the QT-OpenZwave daemon is running, when performing this operation. 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
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
the QT-OpenZwave daemon 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 unsecure 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 `zwave_mqtt.remove_node`
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 perform the device-specific procedure, according to the device manual, 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 this operation. 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
perform the device-specific procedure, according to the device manual,
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
this operation.
| Service Data Attribute | Required | Description | | Service Data Attribute | Required | Description |
| ---------------------- | -------- | -------------------------------------------------- | | ---------------------- | -------- | -------------------------------------------------- |