From 3a3e721848f061161da14a571af3d67fddde86d3 Mon Sep 17 00:00:00 2001 From: Martin Hjelmare Date: Tue, 5 May 2020 10:28:39 +0200 Subject: [PATCH] Add zwave_mqtt base (#13255) * Add zwave_mqtt base * Fix Z-Wave casing * Mention network key * :pencil2: Tweaks Co-authored-by: Franck Nijhof --- source/_integrations/zwave_mqtt.markdown | 56 ++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 source/_integrations/zwave_mqtt.markdown diff --git a/source/_integrations/zwave_mqtt.markdown b/source/_integrations/zwave_mqtt.markdown new file mode 100644 index 00000000000..46565a0ec35 --- /dev/null +++ b/source/_integrations/zwave_mqtt.markdown @@ -0,0 +1,56 @@ +--- +title: Z-Wave over MQTT +description: Instructions on how to integrate Z-Wave over MQTT with Home Assistant. +ha_category: + - Switch +ha_release: "0.110" +ha_iot_class: Local Push +ha_config_flow: true +ha_codeowners: + - '@cgarwood' + - '@marcelveldt' + - '@MartinHjelmare' +ha_domain: zwave_mqtt +--- + +This integration allows you to utilize OpenZWave's qt-openzwave daemon to control a Z-Wave network over MQTT. + +## Requirements + +- MQTT server and the [MQTT integration](/integrations/mqtt/) set up in Home Assistant +- [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. + +## Configuration + +This integration can be configured using the integrations in the +Home Assistant frontend. + +Menu: **Configuration** -> **Integrations**. + +Click on the `+` sign to add an integration and click on **Z-Wave over MQTT**. +After completing the configuration flow, the Z-Wave over MQTT +integration will be available. + +### Secure network key + +The secure network key is set in the settings for the qt-openzwave daemon and not in the integration configuration. + +## Services + +### 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. + +| 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. | +| `instance_id` | no | The OZW Instance/Controller to use, defaults to 1. | + +### 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. + +| Service Data Attribute | Required | Description | +| ---------------------- | -------- | -------------------------------------------------- | +| `instance_id` | no | The OZW Instance/Controller to use, defaults to 1. |