2026.6.3
Home ▸ Actions

Remove device

The Remove device action removes a specific device from a Xiaomi Aqara Gateway. Removing a device is required before you can pair it with another gateway.

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 remove a device 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): Remove device.
  6. Enter the Gateway MAC and the Device ID of the device to remove.
  7. Select Save.

This action does not support targets. In the UI, use the Gateway MAC field to choose which gateway the device is removed from.

Options in the UI

Gateway MAC (Required)

The MAC address of the Xiaomi Aqara Gateway.
Device ID (Required)

The hardware address of the device to remove.

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.remove_device. 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: xiaomi_aqara.remove_device
data:
  gw_mac: xxxxxxxxxxxx
  device_id: "158d0000000000"

This removes the device with the given hardware address from the gateway.

Options in YAML

gw_mac string Required

The MAC address of the Xiaomi Aqara Gateway.

device_id string Required

The hardware address of the device to remove.

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.

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:

  • Add device: Enables pairing mode on a Xiaomi Aqara Gateway to add a new device.