2026.6.3
Home ▸ Actions

Set lock configuration

Use this action to set the configuration of a Z-Wave lock, such as the operation type, auto-relock time, and twist assist. This is handy when you want a lock to relock itself automatically after a set time, or to fine-tune how the motor behaves.

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 the lock configuration 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. Select what you want to control. Under By target (see Targets), select the locks to configure.
  6. From the actions shown for that target, select Set lock configuration.
  7. Set the Operation type and any other options you want to use.
  8. Select Save.

Options in the UI

Operation type (Required)

The operation type of the lock, either timed or constant.
Lock timeout (Optional)

Seconds until lock mode times out. Only use this with the timed operation type.
Autorelock time (Optional)

Seconds until the lock returns to the locked state. Only enforced with the constant operation type.
Hold and release time (Optional)

Seconds the latch stays retracted.
Twist Assist (Optional)

Whether the motor should help in locking and unlocking.
Block to Block (Optional)

Whether the lock should run the motor until it hits resistance.

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_lock_configuration. 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.set_lock_configuration
target:
  entity_id: lock.front_door
data:
  operation_type: constant
  auto_relock_time: 30

Options in YAML

operation_type string Required

The operation type of the lock, either timed or constant.

lock_timeout integer

Seconds until lock mode times out. Only use this with the timed operation type.

auto_relock_time integer

Seconds until the lock returns to the locked state. Only enforced with the constant operation type.

hold_and_release_time integer

Seconds the latch stays retracted.

twist_assist boolean

Whether the motor should help in locking and unlocking.

block_to_block boolean

Whether the lock should run the motor until it hits resistance.

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching lock entity behind that target.

  • Entity: one specific lock entity, such as lock.living_room.
  • Device: every lock entity that belongs to a device.
  • Area: every lock entity in a room or area.
  • Floor: every lock entity on a floor.
  • Label: every lock entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

  • Use the lock timeout with the timed operation type, and the autorelock time with the constant operation type.
  • Not every lock supports every option.

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: