This guide describes how to add Z-Wave to your Home Assistant using the Z-Wave JS Integration.
To support the integration, we will be using the Z-Wave JS to MQTT add-on, available from the Home Assistant community add-on store. This add-on includes the Z-Wave JS Server as part of the Z-Wave JS to MQTT application and despite the name, MQTT is not required to run it.
The Z-Wave network can be configured via the Z-Wave JS Control Panel built into Home Assistant but the benefit of using the Z-Wave JS to MQTT add-on is that it also exposes an additional, more advanced control panel, which offers wider network configuration options and diagnostic tools.
Requirements
Software Versions Used in this Guide
To support the integration, we will be using the Z-Wave JS to MQTT add-on, available from the Home Assistant community add-on store. This add-on includes the Z-Wave JS Server as part of the Z-Wave JS to MQTT application and despite the name, MQTT is not required to run it.
The Z-Wave network can be configured via the Z-Wave JS Control Panel built into Home Assistant but the benefit of using the Z-Wave JS to MQTT add-on is that it also exposes an additional, more advanced control panel, which offers wider network configuration options and diagnostic tools.
Requirements
- Home Assistant OS running on a Raspberry Pi (3 and above) or similar
- You will also need an Aeotec Z-Stick Gen5+, Z-Wave.me UZB1 or other compatible Z-Wave stick or module installed.
Software Versions Used in this Guide
- Home Assistant OS version 2021.7.3
- Z-Wave JS to MQTT version 0.22.1
- Supervisor version 2021.06.8 (stable)
STEP 1: Install the Z-Wave JS to MQTT Add-on
Log into Home Assistant and navigate to Supervisor > Add-on store and search for Z-Wave JS to MQTT. Select the add-on and click INSTALL:
STEP 2: Start the Z-Wave JS to MQTT Add-on
Once installed, enable start on boot and click START:
Wait a few seconds, then click OPEN WEB UI:
STEP 3: Configure your Z-Wave Network
In the Z-Wave JS to MQTT Control Panel, select Settings > Zwave from the left menu, select your Z-Wave Serial Port (/dev/ttyACM0 for USB Z-Wave sticks) and generate a new Network Key then click SAVE:
NOTE: Remember to copy your network key and store it in a safe place in case you ever need to retrieve it again in the future!
Select Control Panel from the left menu and you should soon see your Z-Wave controller appear in the list (node #1):
Select Control Panel from the left menu and you should soon see your Z-Wave controller appear in the list (node #1):
STEP 4: Setup the Z-Wave JS Integration in Home Assistant
In Home Assistant, navigate to Configuration > Integrations and click the ADD INTEGRATION button on the bottom right of the screen, search for Z-Wave JS and select it:
On the Select connection method dialog box, UNCHECK the option to use the Z-Wave JS Supervisor add-on and click SUBMIT:
Next, replace the default URL of ws://localhost:3000 with ws://a0d7b954-zwavejs2mqtt:3000 and click SUBMIT:
A "Success" confirmation box will then appear and you can optionally set an Area for your new Z-Wave controller. Click FINISH and you're done!
Click CONFIGURE on the newly added Z-Wave JS Integration card to view the Home Assistant Z-Wave Network Management Console:
RSS Feed
