Bulk set partial configuration parameters

Use this action to set several partial configuration parameters that share one parameter number on a Z-Wave device in a single call. This is useful when a device packs multiple settings into one parameter and you want to change more than one of them at the same time.

Correctly using this action requires advanced knowledge of Z-Wave. For a single parameter, use the Set device configuration parameter action instead.

You can target the action at one or more entities, devices, or areas. At least one of those must be provided.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To bulk set partial configuration parameters from an automation or a script:

  1. Go to Settings > Automations & scenes.
  2. Open an existing automation or script, or select Create automation > Create new automation.
  3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
  4. In the Then do section, select Add action.
  5. From the list of actions, search for and select Bulk set partial configuration parameters.
  6. Select the Z-Wave entities, devices, or areas to target, then set the Parameter and Value.
  7. Select Save.

Options in the UI

Area ID(s) (Optional)

The area, or areas, to target. All Z-Wave devices and entities in the area are targeted.

Device ID(s) (Optional)

The device, or devices, to target.

Entity ID(s) (Optional)

The entity, or entities, to target.

Endpoint (Optional)

The configuration parameter’s endpoint. Defaults to 0.

Parameter (Required)

The ID of the configuration parameter to change.

Value (Required)

Either a raw integer for the whole parameter, or a mapping where each key is the bitmask (hex or integer) or partial parameter name, and each value is the value to set for that partial.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as zwave_js.bulk_set_partial_config_parameters.

The following examples use parameter 21 of this device. They set 0xff to 127, 0x7f00 to 10, and 0x8000 to 1 (or the raw value 4735).

Note

When you use the mapping format, the cached values of any partial parameters you leave out are kept. So in the second, third, fourth, and fifth examples, the cached values for 0xff0000, 0x3f000000, and 0x40000000 are used. When you send the raw integer value, it is assumed you calculated the full value, so in the first example those partials are all set to 0.

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: zwave_js.bulk_set_partial_config_parameters
target:
  entity_id: switch.fan
data:
  parameter: 21
  value: 4735
ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: zwave_js.bulk_set_partial_config_parameters
target:
  entity_id: switch.fan
data:
  parameter: 21
  value:
    0xff: 127
    0x7f00: 10
    0x8000: 1
ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: zwave_js.bulk_set_partial_config_parameters
target:
  entity_id: switch.fan
data:
  parameter: 21
  value:
    255: 127
    32512: 10
    32768: 1
ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: zwave_js.bulk_set_partial_config_parameters
target:
  entity_id: switch.fan
data:
  parameter: 21
  value:
    255: 127
    32512: 10
    32768: "Fine"
ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: zwave_js.bulk_set_partial_config_parameters
target:
  entity_id: switch.fan
data:
  parameter: 21
  value:
    "Quick Strip Effect: Hue Color Wheel / Color Temp": 127
    "Quick Strip Effect Intensity": 10
    "Quick Strip Effect Intensity Scale": "Fine"

Options in YAML

area_id string | list

The area ID, or list of area IDs, to target. All Z-Wave devices and entities in the area are targeted. At least one of entity_id, device_id, or area_id is required.

device_id string | list

The device ID, or list of device IDs, to target. At least one of entity_id, device_id, or area_id is required.

entity_id string | list

The entity ID, or list of entity IDs, to target. At least one of entity_id, device_id, or area_id is required.

endpoint integer

The configuration parameter’s endpoint.

parameter integer Required

The ID of the configuration parameter to change.

value integer | map Required

Either a raw integer for the whole parameter, or a mapping where each key is the bitmask (hex or integer) or partial parameter name, and each value is the value to set for that partial. Missing partials keep their cached values.

Good to know

  • You must target at least one entity, device, or area.
  • To find the available parameters and bitmasks for your device, look it up in the Z-Wave JS device database.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one: