Get raw positions

Use this action to retrieve the raw position response for an Ecovacs vacuum and its charger.

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 get raw positions 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 Ecovacs vacuum.
6. From the actions shown for that target, select Get raw positions.
7. Select Save.

Options in the UI

This action has no additional 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 ecovacs.raw_get_positions. Store the result in a response variable so you can use it in later steps:

action: ecovacs.raw_get_positions
target:
  entity_id: vacuum.deebot_n8_plus
response_variable: ecovacs_positions

This retrieves the raw position response for vacuum.deebot_n8_plus.

Options in YAML

This action has no additional YAML options beyond the target. Optionally, set response_variable to store the response.

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 vacuum entity behind that target.

• Entity: one specific vacuum entity, such as vacuum.living_room.
• Device: every vacuum entity that belongs to a device.
• Area: every vacuum entity in a room or area.
• Floor: every vacuum entity on a floor.
• Label: every vacuum 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.

Response data

The action returns a raw response with the positions of the vacuum and charger. The exact response structure depends on the vacuum model and firmware.

The response includes coordinates under resp -> body -> data like this:

vacuum.deebot_n8_plus:
  ret: ok
  resp:
    header:
      pri: 1
      tzm: 480
      ts: "1717748487712"
      ver: 0.0.1
      fwVer: 1.2.0
      hwVer: 0.1.1
    body:
      code: 0
      msg: ok
      data:
        deebotPos:
          x: 1
          y: 5
          a: 85
          invalid: 0
        chargePos:
          - x: 5
            y: 9
            a: 85
            t: 1
            invalid: 0
        mid: "200465850"
  id: 5o81
  payloadType: j

Good to know

This action is mainly useful when you need the raw position data for troubleshooting or custom processing.

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.