Set device configuration parameter
Use this action to change a configuration parameter on a Z-Wave device, for example to set the LED behavior, motion sensitivity, or the brightness ramp rate of a switch. To change several partial parameters that share one parameter number in a single call, use the Bulk set partial configuration parameters 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 set a configuration parameter from an automation or a script:
- Go to Settings > Automations & scenes.
- Open an existing automation or script, or select Create automation > Create new automation.
- 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.
- In the Then do section, select Add action.
- From the list of actions, search for and select Set device configuration parameter.
- Select the Z-Wave entities, devices, or areas to target, then set the Parameter and Value.
- Select Save.
Options in the UI
The area, or areas, to target. All Z-Wave devices and entities in the area are targeted.
The name or ID of the configuration parameter to change. The name is case sensitive.
Target a specific bitmask for a partial parameter, in hex (0xff) or decimal (255) format. Not needed when you provide the parameter name. Cannot be combined with value size or value format.
The new value for the parameter, as an integer or the state label. The state label is case sensitive.
The size of the value, either 1, 2, or 4. Used with value format when the parameter is not defined in your device’s configuration file. Cannot be combined with bitmask.
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.set_config_parameter.
The following examples use parameter 31 of this device to set the LED 1 Blink Status (bottom) partial parameter in different ways. The values are interchangeable: you can use 1 or Blink for the value in any of them.
action: zwave_js.set_config_parameter
target:
entity_id: switch.fan
data:
parameter: 31
bitmask: 0x01
value: 1
action: zwave_js.set_config_parameter
target:
entity_id: switch.fan
data:
parameter: 31
bitmask: 1
value: "Blink"
action: zwave_js.set_config_parameter
target:
entity_id: switch.fan
data:
parameter: "LED 1 Blink Status (bottom)"
value: "Blink"
Options in YAML
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.
The device ID, or list of device IDs, to target. At least one of entity_id, device_id, or area_id is required.
The entity ID, or list of entity IDs, to target. At least one of entity_id, device_id, or area_id is required.
The name or ID of the configuration parameter to change. The name is case sensitive.
Target a specific bitmask for a partial parameter, in hex (0xff) or decimal (255) format. Not needed when you provide the parameter name. Cannot be combined with value_size or value_format.
The new value for the parameter, as an integer or the state label. The state label is case sensitive.
The size of the value, either 1, 2, or 4. Used with value_format when the parameter is not defined in your device’s configuration file. Cannot be combined with bitmask.
Good to know
- You must target at least one entity, device, or area.
- To find the available parameters and values 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.
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:
- Bulk set partial configuration parameters: Sets multiple partial configuration parameters on a Z-Wave device at once.