Set chime paired doorbells

With this action, you can choose which doorbells ring a UniFi Protect smart chime. Select the chime, then select the doorbells you want to pair with it.

The list of doorbells replaces whatever was paired before. If you leave the doorbells empty, all doorbells are unpaired from the chime.

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 use this action in an automation or script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create to start a new one.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger.
4. In the Then do section, select Add action.
5. From the search box, search for and select UniFi Protect: Set chime paired doorbells.
6. In the Chime field, select the chime device.
7. In the Doorbells field, select the doorbells to pair with the chime. Leave it empty to unpair all doorbells.
8. Select Save.

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

action: unifiprotect.set_chime_paired_doorbells
data:
  device_id: 1234567890abcdef1234567890abcdef
  doorbells:
    entity_id: binary_sensor.front_doorbell_doorbell

This pairs the front doorbell with the selected chime.

Options in YAML

Good to know

• The doorbells you select replace the current pairing. Doorbells you leave out are unpaired.
• Leaving the doorbells empty unpairs every doorbell from the chime.

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.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: silence a chime at night

Unpair all doorbells from a bedroom chime at night, then pair them again in the morning.

• Trigger: A scheduled time
• Action: UniFi Protect: Set chime paired doorbells

alias: "Unpair the bedroom chime at night"
triggers:
  - trigger: time
    at: "22:00:00"
actions:
  - action: unifiprotect.set_chime_paired_doorbells
    data:
      device_id: 1234567890abcdef1234567890abcdef

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.