Z-Wave JS


This integration allows you to control a Z-Wave network via the Z-Wave JS driver. This is our recommended Z-Wave integration for Home Assistant.

Please review the limitations below before you get started as a few devices still may not work or only work partially.

Quick start (Home Assistant including Supervisor)

To add Z-Wave JS to your installation, plug the Z-Wave stick into the device that runs Home Assistant. Then Go to Configuration >> Integrations in the UI. Click the “Add integration” button in the bottom right and from the list of integrations, select “Z-Wave JS” and follow the instructions shown.

Note: A new network key is automatically generated for you. If this Z-Wave stick has already paired with secure devices, you need to enter the previously used network key. Make sure that you keep a backup of this key in a safe place in case you need to move your Z-Wave stick to another device.

If you do not run Home Assistant OS (the default installation type) or Home Assistant Supervised, please see the advanced installation instructions.

Using Z-Wave

When the Z-Wave integration starts up, it will interview your entire Z-Wave network. Depending on the number of devices paired with the Z-Wave stick, this can take a while. Information about your devices is stored in cache files by Z-Wave JS. Be aware that (re)starting the Z-Wave server will cause your network to be (partially) unresponsive until the interview process is done.

While your Z-Wave mesh is permanently stored on your stick, the additional metadata is not. When you lose the cache files (for example by switching between any of the below-mentioned ways to run the server) all your nodes will have to be re-interviewed again before they can be properly controlled. You can speed up this process by manually waking up your battery-powered devices. Most of the time this is a press on the button on those devices (see their manual). It is not needed to exclude/re-include devices from the mesh. Just be patient and the devices will appear.

Advanced users: Make sure that the server started successfully by inspecting the logs. Give the Z-Wave controller some time to start.

Configuration

Adding Z-Wave JS to your Home Assistant instance can be done via the user interface, by taking the following steps:

  • Browse to your Home Assistant instance.

  • In the sidebar click on Configuration.

  • From the configuration menu select: Integrations.

  • In the bottom right, click on the Add Integration button.

  • From the list, search and select “Z-Wave JS”.

  • Follow the instruction on screen to complete the set up.

After completing, the Z-Wave JS integration will be immediately available for use.

Services

Service zwave_js.set_lock_usercode

This service will set the usercode of a lock to X at code slot Y. Valid usercodes are at least 4 digits.

Service Data Attribute Required Description
entity_id no Lock entity or list of entities to set the usercode.
code_slot yes The code slot to set the usercode into.
usercode yes The code to set in the slot.

Service zwave_js.clear_lock_usercode

This service will clear the usercode of a lock in code slot X. Valid code slots are between 1-254.

Service Data Attribute Required Description
entity_id no Lock entity or list of entities to clear the usercode.
code_slot yes The code slot to clear the usercode from.

Events

Events are fired when you press a button on a remote (aka Central Scene support) or when a stateless value is being signalled by a device. You can test what events come in using the event developer tools in Home Assistant and subscribe to zwave_js_event. Once you know what the event data looks like, you can use this to create automations.

Node events (Notification)

These are events fired by the device using the notification command class. The parameters attribute in the example below is optional, and when it is included, the keys in the attribute will vary depending on the event.

{
    "type": "notification",
    "domain": "zwave_js",
    "node_id": 1,
    "home_id": "974823419",
    "device_id": "ad8098fe80980974",
    "label": "Keypad lock operation",
    "parameters": {"userId": 1}
}

Scene events (Value Notification)

Value Notifications are used for stateless values, like Central Scenes and Scene Activation.

Value Notification example:

{
    "type": "value_notification",
    "domain": "zwave_js",
    "node_id": 1,
    "home_id": "974823419",
    "endpoint": 0,
    "device_id": "ad8098fe80980974",
    "command_class": 32,
    "command_class_name": "Basic",
    "label": "Event value",
    "property_name": "event",
    "property_key_name": "some value",
    "value": 255,
}

Current Limitations

As this integration is still in the early stages there are some important limitations to be aware of.

  • While support for the most common devices is working, some command classes are not yet (fully) implemented in Z-Wave JS. You can track the status here. For example the Barrier Operator CommandClass (in plain English: garage door controllers) are not added yet (but almost finished!).
  • Configuration of Z-Wave nodes and/or configuration with the Home Assistant UI is currently not yet implemented. You will need to use another tool, such as zwavejs2mqtt, to manage device configuration.
  • Polling is currently not supported in the integration but will be added soon as a service.
  • Support for setting configuration parameters through service calls is currently not supported but may be added in a later release.
  • There currently is no migration path available from any of the other Z-Wave implementations in Home Assistant. Your Z-Wave network is however stored on your stick so migrating will only require you to redo your device and entity naming.

You can keep track of the Roadmap for the Z-Wave JS integration here.

Migrating from previous Z-Wave implementations

If you are currently running on the zwave or ozw Z-Wave integration and it works fine, there is no need to switch over at this time to Z-Wave JS. It is important to know is that most development focus currently goes to Z-Wave JS. The previous implementations are still provided as-is. They will NOT be removed without proper notice but in time there might come technical dependencies that render one or both of those integrations unusable.

If you’re new to Home Assistant, use Z-Wave JS.

The zwave integration has been marked as deprecated and will no longer receive any updates like new device files. The ozw integration will receive new device files if they are provided by upstream.

It is perfectly doable to switch over from one of the above mentioned previous integrations to the new Z-Wave JS integration. The good news is that your entire Z-Wave network is stored on your stick so you will not have to run through your house to recreate your network. That said, we currently do not provide a full-fledged, worry-free, click-a-button, migration from old to new. We’re exploring options to provide this in the future. This means that if you want to switch over now, you will be the migration wizard.

In a nutshell this is what the migration path looks like

  1. Make a backup of your Home Assistant configuration. If you’re running the supervisor this is very easy to do by creating a snapshot. You should do this so you’ll be able to quickly revert if you may run into unexpected problems.

    Write down/copy your Z-Wave network key somewhere, you are going to need it later.
    Make a list of what node ID belongs to each device. Your network (Nodes and their config etc) is stored on the stick but the names you gave your devices and entities are not. This step is optional but will save you a lot of time later.
  2. Remove the Z-Wave integration from Home Assistant: Configuration –> Integrations –> Z-Wave (or OpenZWave) –> Press the three dots and click Remove.

  3. If you were running the OpenZWave beta, make sure to stop (or even remove) the OpenZWave add-on, also make sure it doesn’t start automatically at startup.

  4. Restart your Home Assistant host. This step is important to make sure that your Z-Wave stick is released by the operating system.

  5. Install the Z-Wave JS Server of your choice. If you run the supervisor and you’d like to run the standard add-on, you can skip this step if you want. The add-on is installed automatically for you when you choose so in the integration set-up. Remember to fill in the network key you’ve saved before.

  6. Set up the Z-Wave JS integration and connect it to the server. You should see your nodes being detected by Home Assistant. Carefully watch if the status of the node is “ready”. This means it’s been fully interviewed (and those details cached) by the Z-Wave JS driver. Battery-powered nodes will only be interviewed when they wake up (at scheduled intervals) which can take from a few hours to a few days. To speed that up, you might want to consider waking the device up once. The manual of your device will tell you how to do a manual wake.

  7. Once a node hits the ready state, the entities will be created (so not before). Only at this point, is it safe to rename the device (and so its entities). You will thank yourself at this point for having that list noted down of nodes and their names. This is actually the only real hard part of the migration as you will need to name all your devices again.

  8. Enjoy your super fast up-to-date Z-Wave network in Home Assistant with support for all modern devices!

Need more help with your migration to Z-Wave JS?

There are a few topics created on the forums that might be of your interest:

You can also visit the #zwave channel on our discord.

Advanced installation instructions

The above instructions won’t work if you are using Home Assistant Container, Home Assistant Core, or you don’t want to use the built-in Z-Wave JS Server add-on. Below you’ll find the more detailed set-up instructions that covers all use cases.

Requirements

Controlling your Z-Wave network using the Z-Wave JS integration has the following requirements:

  1. Run Z-Wave JS Server. This application provides the connection between your Z-Wave USB stick and Home Assistant. This server runs separately from Home Assistant so your Z-Wave mesh will keep running if you restart or stop Home Assistant. The Home Assistant Z-Wave JS integration connects to this server via a websocket connection. You need to run this Z-Wave server before you can use the integration.

  2. Supported Z-Wave dongle. The Z-Wave controller dongle should be connected to the same host as where the Z-Wave JS server is running. In the configuration for the Z-Wave server you need to provide the path to this stick. It’s recommended to use the /dev/serial-by-id/yourdevice version of the path to your stick, to make sure the path doesn’t change over reboots. The most common known path is /dev/serial/by-id/usb-0658_0200-if00.

  3. A network key. This key is used in order to connect securely to compatible devices. The network key consists of 32 hexadecimal characters, for example 2232666D100F795E5BB17F0A1BB7A146 (do not use this one, pick a random one). Without a network key security enabled devices cannot be added securely and will not function correctly. You must provide this network key in the configuration part of the Z-Wave JS Server. For new installations, a unique default key will be auto generated for you. TIP: You could use a site like random.org to create your own random network key. Make sure that you keep a backup of this key in a safe place. You will need to enter the same key to be able to access the securely paired devices.

  4. The Z-Wave JS integration in Home Assistant. This integration connects to the Z-Wave JS Server to retrieve the info from your Z-Wave network and turns it into Home Assistant devices and entities.

Running the Z-Wave JS Server

As stated in the above requirements, you need to run the Z-Wave JS Server somewhere in your network. There are multiple ways to run this server, we’ll explain the most common ways below:

1. The official Z-Wave JS add-on, available from the add-on store

This option is only available for Home Assistant OS (the recommended installation type) and Home Assistant Supervised installations.

This add-on runs the Z-Wave JS server. It can be automatically installed and configured by Home Assistant as part of setting up the integration. You can also set it up manually.

The Z-Wave network can be configured via the built-in Z-Wave JS control panel in Home Assistant.

2. The Z-Wave JS to MQTT add-on installed available from the community add-on store

This option is only available for Home Assistant OS (the recommended installation type) and Home Assistant Supervised installations.

This add-on includes the Z-Wave JS Server as part of the Z-Wave JS 2 MQTT application. Despite the name, MQTT is not required to run this add-on.

The Z-Wave network can be configured via the built-in Z-Wave JS control panel in Home Assistant and via the Z-Wave JS control panel built into Z-Wave JS 2 MQTT.

Despite what the name suggests, you can actually run this add-on without MQTT enabled. In that case, it will provide you with a full-fledged, attractive and feature-complete UI to manage your Z-Wave nodes and settings.

3. The Z-Wave JS to MQTT Docker container

This is the recommended approach if you’re running Home Assistant Container. See the zwavejs2mqtt documentation for instructions.

After installing the Docker image, make sure you enable the Z-Wave JS Server in the configuration.

4. Run the Z-Wave server yourself

This is considered a very advanced use case. In this case you run the Z-Wave JS Server or zwavejs2mqtt NodeJS application directly. Installation and maintaining this is out of scope for this document. See the Z-Wave JS server or zwavejs2mqtt GitHub repository for information.

Installing and configuring the Z-Wave JS integration in Home Assistant

Once you have the Z-Wave server up and running, it’s time to configure the integration in Home Assistant. This integration can be configured using the integrations in the Home Assistant frontend:

  1. Click on the + sign to add an integration and click on Z-Wave JS.

  2. If you’re running full Home Assistant with supervisor, you will be presented with a dialog that asks if you want to use the Z-Wave JS Supervisor add-on. Check the box if you prefer this option. If you run the server yourself, or prefer the alternative zwavejs2mqtt addon, uncheck this box. After completing the configuration flow, the Z-Wave JS integration will be available.

  3. If you’re not running the supervisor or you’ve unchecked the above mentioned box, you will be asked to enter a websocket URL (defaults to ws://localhost:3000). It is very important that you fill in the correct (docker) IP/hostname here. For example for the Z-Wave JS to MQTT add-on this is ws://a0d7b954-zwavejs2mqtt:3000.

Frequently Asked Questions

What Z-Wave devices are currently supported?

See the Z-Wave JS device database.

Can I switch between the Official Z-Wave JS add-on and Z-Wave JS to MQTT?

You can, but you cannot run them at the same time. Only one of them can be active at the same time.

When you switch add-ons, re-add the Z-Wave integration to Home Assistant with the new/updated WebSocket URL. There will be a popup raised that this Z-Wave network is already configured but “under the hood” the WebSocket URL is adjusted.

I do not see any entities created for my device in Home Assistant

Entities will be created only after the node hits the ready state (interview is completed). Also, note that some devices (like button remotes) do not create any entities but will only provide events when a button is pressed. See the events section on how to handle those events in your automations. If you are certain that your device should have entities and you do not see them (even after a restart of Home Assistant Core), that will be the time to create an issue about your problem on the GitHub issue tracker, see below section of troubleshooting issues.

Is there a way to easily export a dump of all my current Z-Wave nodes before I migrate?

You can run the script below in the Developer Tools to get a full oversight of your nodes and their entities.

{%- for node, zstates in states | selectattr('attributes.node_id', 'in', range(1000)) | groupby('attributes.node_id') %}

{%- for s in zstates %}
Node {{ node }};{{ s.name }};{{ s.entity_id }}{% endfor %}

{%- endfor %}

How can I add (include) a new device to my Z-Wave network?

  1. In Home Assistant: open Configuration -> Integrations -> Z-Wave JS -> Configure.
  2. Press Add node.
  3. Press Start Inclusion. The Z-Wave controller is now in inclusion mode and will not respond to other commands.
  4. Put the device you want to add in inclusion mode. Refer to its manual how this is done.
  5. The UI should confirm that the node was added and it will be immediately visible in Home Assistant. After a short while (seconds to minutes) the entities should also be created.
  6. If the controller fails to add/find your device, cancel the inclusion process (to unblock your network again). In some cases it might help to first remove a node (exclusion) before you add it, even when the device has not been added to this Z-Wave network yet. Another approach would be to factory reset the device. Info about that is in the manual of your device.
While adding devices, you have the option to use `secure inclusion`, this means that the traffic between the controller and the device will be encrypted. This adds additional overhead to the Z-Wave network so use this option with care. As a general rule of thumb it is advised to only securely include devices that actually NEED this kind of protection. A good example is a Z-Wave door lock.

How can I remove (exclude) a device from my Z-Wave network?

  1. In Home Assistant: open Configuration -> Integrations -> Z-Wave JS -> Configure.
  2. Press Remove node.
  3. Press Start Exclusion. The Z-Wave controller is now in exclusion mode and will not respond to other commands.
  4. Put the device you want to remove in exclusion mode. Refer to its manual how this is done.
  5. The UI should confirm that the node was removed and the device and entities will be removed from Home Assistant.

Where do I need to enter the network key?

  • You enter the network key during integration setup if you do not have the add-on installed.
  • Official Z-Wave JS add-on: In the add-on configuration, directly in the supervisor.
  • Z-Wave JS 2 MQTT: In the web UI, go to Settings -> Z-Wave -> Network Key.

How can I use my OZW network key in zwavejs2mqtt?

You can use your existing network key in zwavejs2mqtt but you need to slightly adjust it. The OZW looks like this: 0x01, 0x02, 0x03 etc. while the network key format accepted in zwavejs2mqtt looks like this 0102030405 etc.. You can simply edit your existing key and remove the "0x" part and the ", " part so it becomes one large string of numbers.

What’s the benefit of using Z-Wave JS to MQTT over the official Add-On?

The official add-on provides the Z-Wave Server in it’s bare minimum variant, just enough to serve the Home Assistant integration. The Z-Wave JS to MQTT project includes the Z-Wave JS Server for convenience but also provides a Z-Wave Control panel and the ability (hence its name) to serve your Z-Wave network to MQTT. You can leave the MQTT Gateway disabled and only use the Control panel but you can even have the MQTT features enabled at the same time. For example to interact with Z-Wave from other devices, while the Home Assistant integration still works (as long as you keep the WS Server enabled in zwavejs2mqtt).

Z-Wave JS to MQTT seems to provide Home Assistant integration on its own too, now I’m confused

Correct, the Z-Wave (JS) to MQTT project existed before Home Assistant even had plans to move to the Z-Wave JS Driver. The Home Assistant integration that exists in zwavejs2mqtt is based on MQTT discovery. The official Z-Wave JS integration is not based on MQTT and is talking directly to the Z-Wave JS Driver (using the WS Server). This gives a better experience.

Can I run Z-Wave JS to MQTT only for the control panel and nothing else?

Sure, in the settings of zwavejs2mqtt, make sure to enable “WS Server” and disable “Gateway”.

My device does not automatically update its status in HA if I control it manually

Your device might not send send automatic status updates to the controller. While the best advice would be to update to recent Z-Wave Plus devices, there is a workaround with active polling (request the status) at some interval. See the section below for more info about this.

What about polling of devices?

Some legacy devices don’t report all their values automatically and require polling to get updated values when controlled manually. Z-Wave JS does not automatically poll devices on a regular basis without user interaction. Polling can quickly lead to network congestion and should be used very sparingly and only where necessary.

  • In an upcoming release of Home Assistant we will provide a service to allow you to manually poll a value, for example from an automation that only polls a device when there is motion in that same room. If you really need polling, you can enable this in zwavejs2mqtt but not in the official add-on.

  • zwavejs2mqtt allows you to configure scheduled polling on a per-value basis, which you can use to keep certain values updated. It also allows you to poll individual values on-demand from your automations, which should be preferred over blindly polling all the time if possible.

Polling is considered bad practice and should only be used as a last resort when you use it with care and accept the negative impact on your network. Z-Wave is a very low speed network and poll requests can easily flood your network and slow down your commands.

My device is recognized as Unknown Manufacturer and/or some of its functionalities do not work in Z-Wave JS

When your device is not yet fully interviewed, this info will not yet be present. So make sure your device is interviewed at least once. Is the state of your device reported as ready and you still see Unknown Manufacturer, read on.

Z-Wave JS keeps a database of all devices it supports, including any special treatments they need. These are called the device configuration files and they are contributed mainly by the community. Is your device not fully supported, consider contributing the device configuration file.

I get a lot of sensor entities for my device that I’m probably never going to use

The integration will add as many useable entities for you as possible from the information it retrieves from your Z-Wave devices. Entities that you don’t want/like, can be disabled within the Home Assistant interface.

I renamed my devices in Z-Wave JS 2 MQTT but those names are not visible in Home Assistant

Correct. Only a few devices actually support having their name stored in the hardware. In case your device supports it, you can rename it from the control panel and it will be stored on your device (and Home Assistant will prefer that name). Most devices don’t support that feature. Zwavejs2mqtt changes are only available within the application and not stored/synced with the actual Z-Wave network and thus not populated to Home Assistant.

Troubleshooting Issues

Get a dump of the current network state

When trying to determine why something isn’t working as you expect, or when reporting an issue with the integration, it is helpful to know what Z-Wave JS sees as the current state of your Z-Wave network. To get a dump of your current network state, follow the menu:

Configuration -> Integrations -> Z-Wave JS -> Configure -> Download a dump of your network to help diagnose issues