Z-Wave JS configuration parameter
The Z-Wave JS configuration parameter condition passes when a configuration parameter on the selected Z-Wave nodes has the value you specify. Configuration parameters are the device’s own settings, such as an LED indicator mode or a motion sensitivity level, and most of them are not exposed as Home Assistant entities.
This condition is useful when:
- You want to branch on a device setting that has no entity, such as a beeper or LED mode.
- You want to confirm a parameter was actually applied before continuing.
- You want to check a partial parameter that is packed into a bitmask.
Using this condition from the user interface
If you prefer building automations visually, Home Assistant walks you through this condition step by step. You pick what to check, tweak a few options, and save. No YAML knowledge required.
To use Z-Wave JS configuration parameter in an automation:
- Go to Settings > Automations & scenes.
- Open an existing automation, or select Create automation > Create new automation.
- In the And if section, select Add condition.
- Search for Z-Wave JS configuration parameter and select it.
- Under Devices (see Selecting nodes), pick the Z-Wave devices whose nodes you want to check.
- Under Parameter, enter the parameter number.
- Under Value, enter the value to compare with.
- Optionally set Bitmask and Endpoint.
- Under Condition passes if (see Behavior with multiple nodes), choose how multiple nodes should combine. The default is Any.
- Select Save.
Options in the UI
Bitmask of a partial parameter, as a number or a hexadecimal string such as 0x1, if the parameter is split into parts.
Using this condition 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 condition as zwave_js.config_parameter. A basic example looks like this:
condition: zwave_js.config_parameter
options:
device_id: 45d7d3230dbb7441473ec883dab294d4
parameter: 3
value: 255
This passes when parameter 3 on that node is 255.
Parameters that expose named values can be compared by label instead of by number, and a partial parameter is selected with a bitmask:
condition: zwave_js.config_parameter
options:
device_id: 45d7d3230dbb7441473ec883dab294d4
parameter: 3
value: "Enable Beeper"
condition: zwave_js.config_parameter
options:
device_id: 8f4219cfa57e23f6f669c4616c2205e2
parameter: 101
bitmask: "0x1"
value: 1
Options in YAML
The value to compare with, either the raw value or its state label.
Bitmask of a partial parameter, as a number or a hexadecimal string such as 0x1, if the parameter is split into parts.
Selecting nodes
A Z-Wave node is represented in Home Assistant as a device, so this condition selects nodes with a device picker rather than a target. Pick one or more Z-Wave devices, and the condition tests the node behind each one.
Behavior with multiple nodes
When you select more than one device, the Condition passes if option controls how the results combine:
- Any (default): the condition passes if at least one node’s parameter matches.
- All: the condition passes only when every node’s parameter matches.
Good to know
- Parameter numbers, their allowed values, and any bitmasks are specific to the device. Look them up in the device manual or on Z-Wave JS Config DB.
- A parameter with named values can be compared either by its raw number or by its label, for example
1or"Enable". The raw value written as a string, such as"1", also matches. - The condition is rejected when it is saved if none of the selected nodes has the parameter at all, so a typo in the parameter number surfaces immediately rather than silently never passing.
- A node that does have the parameter but with a different value simply does not match.
- The condition does not pass when none of the selected devices resolve to a Z-Wave node. A device that no longer resolves counts as unresolved and makes All fail.
- To change a parameter rather than test it, use the
zwave_js.set_config_parameteraction.
Try it yourself
Ready to test this? Go to Settings > Automations & scenes, open an automation, and add this condition. Trigger the automation with and without the condition met, and watch whether it continues or stops.
More examples
Real scenarios where this condition gates an automation. Copy any example and adapt it to your setup.
You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.
Automation: only run the nightly routine while the lock beeper is on
- Trigger: Time: 23:00
-
Condition: Z-Wave JS configuration parameter
- Devices: Front door lock
- Parameter: 3
- Value: Enable Beeper
- Action: Send a notification message
YAML example for checking a configuration parameter
alias: "Warn at night while the lock beeper is enabled"
triggers:
- trigger: time
at: "23:00:00"
conditions:
- condition: zwave_js.config_parameter
options:
device_id: 45d7d3230dbb7441473ec883dab294d4
parameter: 3
value: "Enable Beeper"
actions:
- action: notify.send_message
target:
entity_id: notify.my_device
data:
message: "The front door lock will beep tonight."
Still stuck?
The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the condition you’re using and what you expected to happen, or share on our subreddit /r/homeassistant.
AI assistants like ChatGPT or Claude can also explain conditions or suggest the right one when you describe what you want in plain language.
Related conditions
Explore related conditions:
-
Z-Wave JS value: Tests if a Z-Wave value on one or more nodes equals the given value.
-
Z-Wave JS node status: Tests if one or more Z-Wave JS nodes have the given status.