Play ringtone

The Play ringtone action plays a specific ringtone on a Xiaomi Aqara Gateway.

This is useful for turning the gateway into a doorbell or an alarm sound, for example playing a chime when someone presses a button or an alert when a door opens.

The gateway firmware must be at least version 1.4.1_145.

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 play a ringtone 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 Xiaomi Gateway (Aqara): Play ringtone.
6. Enter the Gateway MAC and the Ringtone ID, and optionally a Ringtone volume.
7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

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

action: xiaomi_aqara.play_ringtone
data:
  gw_mac: aa:bb:cc:dd:ee:ff
  ringtone_id: 8
  ringtone_vol: 8

Options in YAML

Available ringtone IDs

• Alarms
  • 0: Police car 1
  • 1: Police car 2
  • 2: Accident
  • 3: Countdown
  • 4: Ghost
  • 5: Sniper rifle
  • 6: Battle
  • 7: Air raid
  • 8: Bark
• Doorbells
  • 10: Doorbell
  • 11: Knock at a door
  • 12: Amuse
  • 13: Alarm clock
• Alarm clock
  • 20: MiMix
  • 21: Enthusiastic
  • 22: GuitarClassic
  • 23: IceWorldPiano
  • 24: LeisureTime
  • 25: ChildHood
  • 26: MorningStreamLiet
  • 27: MusicBox
  • 28: Orange
  • 29: Thinker
• Custom ringtones uploaded through the Mi Home app, starting from 10001

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.

Play a ringtone when a button is held

This example plays a barking sound when a first-generation round button is held down.

triggers:
  - trigger: event
    event_type: xiaomi_aqara.click
    event_data:
      entity_id: binary_sensor.switch_158d000xxxxxc2
      click_type: long_click_press
actions:
  - action: xiaomi_aqara.play_ringtone
    data:
      gw_mac: aa:bb:cc:dd:ee:ff
      ringtone_id: 8
      ringtone_vol: 8

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.

Related actions

These actions work well alongside this one:

• Stop ringtone: Stops a ringtone that is playing on a Xiaomi Aqara Gateway.

• Add device: Opens the Xiaomi Aqara Gateway for pairing a new device.

• Remove device: Removes a paired device from a Xiaomi Aqara Gateway.