Prerequisite: MQTT Broker (Server) and Integration
Test Migration for Supervised installs:
- Install the addon, but leave it off/disabled
- Open the zwave control panel and hit “Stop Network”
- Config/Activate the OZW Addon
- Activate the OZW (Beta) Integration from
Integrations -> +
You are now using the OZW Beta integration!
Don’t like it and want to switch back? Easy.
- Remove the OZW Integration from
Integrations -> Remove
- Stop/Disable the OZW Addon
- Open zwave control panel and hit “Start Network”
Congrats! You’ve switched back to the 1.4 built-in integration.
Core/Container Installs:
-
docker pull
(see below for full command) the ozwd container, do not start it. - Open the zwave control panel and hit “Stop Network”
- Configure and start the ozwd container. (see below)
- Activate the OZW (Beta) Integration from
Integrations -> +
You are now using the OZW Beta integration!
Don’t like it and want to switch back? Easy.
- Remove the OZW Integration from
Integrations -> Remove
- Stop the ozwd container.
- Open zwave control panel and hit “Start Network”
Congrats! You’ve switched back to the 1.4 built-in integration.
Reminder, if you restart Home Assistant before switching back you’re going to have a bad time.
Make sure you switch back, or remove the zwave
configuration from your configuration before restarting.
Full docker pull command: docker pull openzwave/ozwdaemon:allinone-latest
Config/Start the ozwd conatiner (runs interactive mode or foreground):
docker run -it --security-opt seccomp=unconfined \
--device=/dev/serial/by-id/usb-0658_0200-if00:/dev/zwave \
-v /opt/ozw:/opt/ozw/config \
-p 1983:1983 \
-p 5901:5901 \
-p 7800:7800 \
-e MQTT_SERVER="<MQTT SERVER IP/HOST>" \
-e MQTT_USERNAME="<MQTT SERVER USER>" \
-e MQTT_PASSWORD="<MQTT PWD>" \
-e OZW_NETWORK_KEY="<YOUR ZWAVE NETWORK KEY>" \
-e USB_PATH=/dev/zwave openzwave/ozwdaemon:allinone-build-150
Daemon mode (background mode):
docker run -d --security-opt seccomp=unconfined \
--device=/dev/serial/by-id/usb-0658_0200-if00:/dev/zwave \
-v /opt/ozw:/opt/ozw/config \
-p 1983:1983 \
-p 5901:5901 \
-p 7800:7800 \
-e MQTT_SERVER="<MQTT SERVER IP/HOST>" \
-e MQTT_USERNAME="<MQTT SERVER USER>" \
-e MQTT_PASSWORD="<MQTT PWD>" \
-e OZW_NETWORK_KEY="<YOUR ZWAVE NETWORK KEY>" \
-e USB_PATH=/dev/zwave openzwave/ozwdaemon:allinone-build-150
Modify as needed for your USB stick and other variables.
Docker Compose version:
version: '2'
services:
mqtt:
container_name: mqtt
restart: unless-stopped
image: eclipse-mosquitto
privileged: true
volumes:
- /home/docker/mosquitto/config/:/mosquitto/config/
- /home/docker/mosquitto/log:/mosquitto/log
- /home/docker/mosquitto/data:/mosquitto/data
- /etc/localtime:/etc/localtime:ro
ports:
- "1883:1883"
- "9001:9001"
qt-openzwave:
image: openzwave/ozwdaemon:allinone-build-150
container_name: "qt-openzwave"
security_opt:
- seccomp:unconfined
depends_on:
- "mqtt"
devices:
- "/dev/serial/by-id/usb-0658_0200-if00:/dev/zwave"
volumes:
- /opt/ozw:/opt/ozw/config
ports:
- "1983:1983"
- "5901:5901"
- "7800:7800"
environment:
TZ: "America/Phoenix"
MQTT_SERVER: "[redacted]"
MQTT_USERNAME: "[redacted]"
MQTT_PASSWORD: "[redacted]"
USB_PATH: "/dev/zwave"
OZW_NETWORK_KEY: "[redacted key]"
restart: unless-stopped
How to obtain your network key
If your key is not in your configuration.yaml
check core.config_entries
.
Go into .storage/core.config_entries
and search for network_key
.
Troubleshooting OZW Beta
“All my devices are showing as unavailable!”
If topic: OpenZWave/1/status/
does not contain: "Status": "driverAllNodesQueried"
all your devices will say unavailable
. This can be caused by battery devices not reporting, try waking battery powered devices per the device manual.
Additional help can be found on the Home Assistant Discord in #zwave
Like what you see with the new integration and want to full switch?
See this guide for the steps to complete the switch.