Set a value on multiple devices via multicast

Use this action to change the same value on several Z-Wave devices at once using multicast, so all targeted devices receive the message simultaneously. This is handy for keeping a group of devices in sync, for example setting the same level on multiple dimmers at the exact same moment.

Correctly using this action requires advanced knowledge of Z-Wave. It performs minimal validation and passes your input straight to the Z-Wave JS API. For a single device, use the Set a value action instead.

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 value via multicast 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 Set a value on multiple devices via multicast.
  6. Select the Z-Wave entities, devices, or areas to target, then set the Command class, Property, 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.

Broadcast (Optional)

When on, the command is broadcast to all nodes on the network. Defaults to off.

Command class (Required)

The ID of the command class for the value.

Endpoint (Optional)

The endpoint for the value.

Property (Required)

The ID of the property for the value.

Property key (Optional)

The ID of the property key for the value.

Value (Required)

The new value to set.

Options (Optional)

A map of set value options. Refer to the Z-Wave JS documentation for the available options.

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.multicast_set_value. A basic example looks like this:

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.multicast_set_value
target:
  entity_id:
    - light.living_room
    - light.kitchen
data:
  command_class: 38
  property: targetValue
  value: 50

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.

device_id string | list

The device ID, or list of device IDs, to target. At least two entities or devices must resolve when not broadcasting.

entity_id string | list

The entity ID, or list of entity IDs, to target. At least two entities or devices must resolve when not broadcasting.

broadcast boolean

Whether the command is broadcast to all nodes on the network. When you have only one Z-Wave network, you do not need to provide a device or entity when this is true. With multiple networks, provide at least one device or entity so the action knows which network to target.

command_class integer Required

The ID of the command class for the value.

property string | integer Required

The ID of the property for the value.

property_key string | integer

The ID of the property key for the value.

endpoint integer

The endpoint for the value.

value any Required

The new value to set.

options map

A map of set value options. Refer to the Z-Wave JS documentation for the available options.

Good to know

  • When not broadcasting, target at least two entities or devices on the same Z-Wave network.
  • Multicast only works for devices on the same Z-Wave network.

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:

  • Set a value: Changes any value that Z-Wave recognizes on a Z-Wave device.