While this is a beta integration, please consider the following from the 0.110 release blog
It is still early days for this integration, though; not all platforms and devices are supported yet and the setup process has prerequisites that raise the accessibility bar. See our documentation for the current requirements and instructions.
If you want to give it a shot, you should be comfortable with setting up custom add-ons and MQTT. There is no migration from the current Z-Wave integration yet, this is still to come.
The plan is to add more platforms in the future, making it super simple to set up the integration. Stay tuned.
There is currently no plan to deprecate the existing Z-Wave integration. But the hope is that the new integration, in the future, will offer a simpler, more stable and more feature-rich experience than the current Z-Wave integration.
In total, there are three parts to using the new OpenZWave (beta)
ozwdaemon – This is either an add-on or it could be in a docker container ( Even a “bare-metal” install ). This just needs to be running somewhere on your network.
2 - A mqtt broker ( I use mosquitto ) running somewhere – This could be an add-on, a docker container, a “bare-metal” install or even in the cloud.
3 - Open ZWave (beta) - This is the new Z-Wave integration for Home Assistant – Install this from the integrations page in Home Assistant – Note: This is the same component as the HACS pre-release . The name has been changed as it moved from pre-release to beta. This name change was to avoid confusion with the unrelated
Here’s what I did to get OpenZWave functionality working on Home Assistant Supervised (should also work for full Home Assistant):
- Install Mosquitto Broker from Supervisor-Addon Store-Official Addons (no config needed)
- Install MQTT integration from Configuration-Integrations (no config needed)
- Install the Openzwave addon from Supervisor-Addon Store-Official Addons
Its configuration looked like this in my case, I chose to go with no network security key, as I have no locks and had issues getting it to work with the key:
device: /dev/serial/by-id/usb-0658_0200-if00 network_key: ''
To find out your own device ID, in your host terminal/SSH type “ls /dev/serial/by-id/”
- Installed the OpenZWave (beta) integration from Configuration-Integrations (no config needed)
At this point, if you already had a stick with devices saved to it, they should start being created in HA and visible in Configuration-Devices.
If you started with a new stick, there’s this step as well:
- Go to Developer Tools-Services, select ozw.add_node and hit Call Service. This will take your controller into inclusion mode and enable pairing of new devices. So, you can hit Call Service and press whatever pairing button is needed on your device. There is no feedback at all in the UI, except for the hopeful appearance of your new device in Configuration-Devices.
Optionally, you can also download OZWAdmin, which is a GUI made by the OpenZWave developer to handle certain aspects of the node configuration and monitoring: https://github.com/OpenZWave/ozw-admin/releases (I also needed to go to File-Preferences-Network in OZWAdmin and increase the cache from the default 1000) - in order to use this, go to Supervisor-OpenZwave-Configuration and put 1983 in the Host field. Afterwards, download OZWAdmin on any PC with a GUI and connect to your instance via your IP & port 1983. I’d like to point out that this is an excellent tool for checking and/or modifying all the node parameters, with clear explanations of what each parameter does.
Thanks to everyone that helped get me up and running!