Dec 16, 2020 When the network key field is empty, and you click the generate key button, it doesn't work. If you manually put in a key, save, and then try to regenerate the key, it works. To Reproduce Steps to reproduce the behavior: Have empty network key field, also in settings.json; Click on generate key button; No key is being put in the field; Expected. 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.

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 userinterface, by using this My button:

If the above My button doesn’t work, you can also perform the following stepsmanually:

Browse to your Home Assistant instance.
In the sidebar click on Configuration.
From the configuration menu select: Integrations.
In the bottom right, click on theAdd Integration button.
From the list, search and select “Z-Wave JS”.
Follow the instruction on screen to complete the set up.

Services

Service zwave_js.set_config_parameter

This service will update a configuration parameter. To update multiple partial parameters in a single call, use the zwave_js.bulk_set_partial_config_parameters service.

Service Data Attribute	Required	Description
`entity_id`	no	Entity (or list of entities) to set the configuration parameter on. At least one `entity_id` or `device_id` must be provided.
`device_id`	no	ID of device to set the configuration parameter on. At least one `entity_id` or `device_id` must be provided.
`parameter`	yes	The parameter number or the name of the property. The name of the property is case sensitive.
`bitmask`	no	The bitmask for a partial parameter in hex (0xff) or decimal (255) format. If the name of the parameter is provided, this is not needed.
`value`	yes	The target value for the parameter as the integer value or the state label. The state label is case sensitive.

Examples of setting a single parameter value

Let’s use parameter 31 for this device as an example to show examples of different ways that the LED 1 Blink Status (bottom) partial parameter can be set. Note that in places where we are using different values for the same key, the different values are interchangeable across the examples. We can, for instance, use 1 or Blink interchangeably for the value in all of the examples.

Example 1:

Example 2:

Example 3:

Service zwave_js.bulk_set_partial_config_parameters

This service will bulk set multiple partial configuration parameters. Be warned that correctly using this service requires advanced knowledge of Z-Wave to use correctly.

Service Data Attribute	Required	Description
`entity_id`	no	Entity (or list of entities) to set the configuration parameter on. At least one `entity_id` or `device_id` must be provided.
`device_id`	no	ID of device to set the configuration parameter on. At least one `entity_id` or `device_id` must be provided.
`parameter`	yes	The parameter number of the property. The name of the property is case sensitive.
`value`	yes	Either the raw integer value that you want to set for the entire parameter, or a dictionary where the keys are either the bitmasks (in integer or hex form) or the partial parameter name and the values are the value you want to set on each partial (either the integer value or a named state when applicable). Note that when using a dictionary, and bitmasks that are not provided will be set to their currently cached values.

Examples of bulk setting partial parameter values

Let’s use parameter 21 for this device as an example to show how partial parameters can be bulk set. In this case, we want to set 0xff to 127, 0x7f00 to 10, and 0x8000 to 1 (or the raw value of 4735).

When using the dictionary format to map the partial parameter to values, the cached values for the missing partial parameters will be used. So in examples 2, 3, 4, and 5, the service would use the cached value for partial parameters 0xff0000, 0x3f000000, and 0x40000000 because new values haven’t been specified. If you send the raw integer value, it is assumed that you have calculated the full value, so in example 1, partial parameters 0xff0000, 0x3f000000, and 0x40000000 would all be set to 0.

Example 1:

Example 2:

Example 3:

Example 4:

Example 5:

Service zwave_js.refresh_value

This service will refresh the value(s) for an entity. This service will generate extra traffic on your Z-Wave network and should be used sparingly. Updates from devices on battery may take some time to be received.

Service Data Attribute	Required	Description
`entity_id`	yes	Entity or list of entities to refresh values for.
`refresh_all_values`	no	Whether all values should be refreshed. If `false`, only the primary value will be refreshed. If `true`, all watched values will be refreshed.

Service zwave_js.set_value

This service will set

Generate Zwave Network Key Random