Z-Wave JS for Home Assistant (app)

About

Z-Wave JS is an app that controls a Z-Wave network from Home Assistant. It runs on Home Assistant OS on amd64 and aarch64 systems and opens its own page in the sidebar. The app is pointed at the Z-Wave controller stick through a device option, which takes a path such as a by-id serial path. It also holds separate security keys for S0 and the S2 security classes, and generates any key that is missing at startup. Keys from an older network key setting are migrated to the S0 legacy key on first start. The app can talk to the Supervisor, and the Z-Wave JS integration is added to Home Assistant afterwards.

Automatic summary of the docs and configuration of home-assistant/apps. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Opens in the sidebar Its own page opens inside Home Assistant.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Setting it up

Install it under Settings, Apps, then start it.

Permissions

Supervisor APICan talk to the Supervisor, which manages apps and the system.

Configuration

DeviceThe Z-Wave controller device.
SocketInstead of using a physical device, you can connect to a Z-Wave adapter via a socket.
Log LevelThis option sets the log level of Z-Wave JS.
Log to File?When this option is enabled, logs will be written to the /addon_configs/core_zwave_js folder with the .log file extension.
Max number of log files to keepWhen log_to_file is true, Z-Wave JS will create a log file for each day. This option allows you to control the maximum number of files that Z-Wave JS will keep.
Network KeyIn previous versions of the app, this was the only key that was needed. With the introduction of S2 security inclusion in zwave-js, this option has been deprecated.
Radio Frequency RegionThe radio frequency region that the controller should use.
S0 Legacy KeyS0 Security Z-Wave devices require a network key before being added to the network.
S2 Access Control KeyThis must be provided in order to include devices with the S2 Access Control security class.
S2 Authenticated KeyThis must be provided in order to include devices with the S2 Authenticated security class.
S2 Unauthenticated KeyThis must be provided in order to include devices with the S2 Unauthenticated security class.
Z-Wave Long Range S2 Access Control KeyThis must be provided in order to include devices using Z-Wave Long Range with the S2 Access Control security class.
Z-Wave Long Range S2 Authenticated KeyThis must be provided in order to include devices using Z-Wave Long Range with the S2 Authenticated security class.
500 series controller soft-resetThis setting tells the app how to handle soft-resets for 500 series controllers. The default setting, Automatic, instructs the app to automatically detect whether or not this needs to be enabled. The default setting should work for most users, so only change this setting if you know what you are doing and/or you are asked to.
Disable automatic controller recoveryThis setting will disable Z-Wave JS's automatic recovery process when the controller appears to be unresponsive and will instead let the controller recover on its own if it's capable of doing so. While the controller is unresponsive, commands will start to fail and nodes may randomly get marked as dead. If a controller is not able to recover on its own, you will need to restart the app to attempt recovery. In most cases, users will never need to use this feature, so only change this setting if you know what you are doing and/or you are asked to.