Notice - Repository Archived

This component has been merged into the Home Assistant Core as the OpenZWave/ozw component. Please submit bug reports to the Home Assistant Core repository.

Home Assistant Z-Wave over MQTT Integration (Pre-Release)

This integration allows you to utilize OpenZWave's qt-openzwave to control a Z-Wave network over MQTT. It is currently available as a custom component through HACS and will be submitted as an official Home Assistant component once it has matured a bit.

Some info about differences between previous current Z-Wave implementation, zwave2mqtt etc. can be found here: https://community.home-assistant.io/t/update-on-the-z-wave-integration-home-assistant-dev-docs/169045/41

This is an early beta/pre-release and there are still significant limitations

Requirements

• MQTT server and the MQTT integration set up in Home Assistant
• QT-OpenZwave daemon (https://github.com/OpenZWave/qt-openzwave)
• Supported Z-wave dongle compatible with OpenZWave 1.6 (list)

Quick start

1. Remove the current/previous Z-Wave integration from your setup (if present). --> If you had the current/previous Z-Wave integration runninhg, please restart Home Assistant after you remove it.
2. Install the Mosquittto broker addon and configure MQTT in HomeAssistant integrations page.
3. Make sure you have HACS set-up (https://github.com/custom-components/hacs).
4. Install Z-Wave over MQTT (Pre-Release) from HACS Integrations Page.
5. Install custom Home Assistant add-on repository to get the OpenZWave daemon: https://github.com/marcelveldt/hassio-addons-repo
6. Install the OpenZWave Daemon from add-on repository, configure and start.
7. Carefully check the logs of the daemon if it started successfully!
8. Go to the HomeAssistant integrations page, add Zwave MQTT integration.

Features and Limitations

• Currently already supports binary_sensor, cover, fan, sensor, and switch platforms
• Scenes support for both Central scenes and node/network scenes: Will fire HomeAssistant event zwave_mqtt.scene_activated.
• Light support is currently limited to dimmers only, RGB bulbs are not yet implemented.
• Other platforms will be added soon!
• There is no migration path from the normal/current Z-Wave integration, you will have to reconfigure Home Assistant entities. Your Z-Wave mesh is stored on your stick and will stay intact though, no need to re-add devices.

Contributing

Contributions are welcome! If you'd like to contribute, feel free to pick up anything on the current GitHub issues list!

Code Formatting

We try to follow the core Home Assistant style guidelines. Code should be formatted with black and imports sorted with isort. We have pre-commit hooks to help automate this process. Run pip install pre-commit and then pre-commit install to install the pre-commit hooks for code formatting.

Upstream Resources Used

• python-openzwave-mqtt - Converts qt-openzwave MQTT messages to Python objects and events
• qt-openzwave - OpenZWave MQTT Daemon