Set lock rule

Use this action to apply a temporary lock rule to a specific UniFi Access door from an automation or a script. It complements the Door Lock Rule select entity and adds support for setting how long the rule stays active.

This action is available for controllers that support temporary lock rules.

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 lock rule 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 search box, search for and select UniFi Access: Set lock rule.
6. Select the Device for the UniFi Access door you want to update.
7. Select the Rule you want to apply.
8. Optionally, set the Interval to control how long a custom rule stays active.
9. Select Save.

This action does not support targets. In the UI, you select the door through the Device field instead of choosing an area, device, entity, or label as a target.

Options in the UI

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

action: unifi_access.set_lock_rule
data:
  device_id: 0123456789abcdef0123456789abcdef
  rule: keep_lock

This keeps the door locked.

Options in YAML

Automation: keep a door unlocked for half an hour

Apply a custom rule that keeps a door unlocked for 30 minutes when an automation runs.

• Trigger: State
  • Entity: Delivery mode (input_boolean.delivery_mode)
  • To: On
• Action: Set lock rule
  • Device: Front door
  • Rule: Custom
  • Interval: 00:30:00

alias: "Unlock front door for deliveries"
triggers:
  - trigger: state
    entity_id: input_boolean.delivery_mode
    to: "on"
actions:
  - action: unifi_access.set_lock_rule
    data:
      device_id: 0123456789abcdef0123456789abcdef
      rule: custom
      interval:
        hours: 0
        minutes: 30

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn 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] without writing a line of YAML.

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.