Get current position

Use this action to retrieve the current position of a Roborock vacuum as X and Y coordinates.

This action returns its result in a response variable, which you can use in later steps of the same automation or script. It does not move the vacuum.

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 a vacuum’s current position 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 Roborock vacuum whose position you want to retrieve.
  6. From the actions shown for that target, select Get current position.
  7. Select Save.

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 roborock.get_vacuum_current_position. 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: roborock.get_vacuum_current_position
target:
  entity_id: vacuum.roborock_s7
response_variable: vacuum_position

This action has no additional options in YAML.

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 the X and Y coordinates of the vacuum, keyed by entity ID:

vacuum.roborock_s7:
  x: 28081
  y: 25168

Good to know

  • This is a cloud call meant for diagnostics, not for automations. Frequent requests can lead to rate limiting.

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:

  • Go to position: Sends a Roborock vacuum to a specific position.

  • Get maps: Retrieves the map and room information of a Roborock vacuum.