map

Get the current position of the cleaning robot

Returns the current position and orientation of the cleaning robot together with the map it is currently located on.

As long as the robot has not found its location, mapId can be null or omitted and isValid is false.

get/homeappliances/{haId}/map/robot/position

Request

  • Base URL: https://api.home-connect.com/api
  • URL: https://api.home-connect.com/api/homeappliances/{haId}/map/robot/position
  • Auth: OAuth 2 (authorization code, authorization URL https://api.home-connect.com/security/oauth/authorize, token URL https://api.home-connect.com/security/oauth/token, scopes: CleaningRobot-Map)

Response

Current position of the cleaning robot

mapIdinteger

Map ID the robot is currently on. Can be null or omitted if the robot has not yet found its location.

isValidboolean

True if the position and map id are up to date. False if the robot needs to re-localize.

Changes

No recorded changes to this operation across all 1 revision of this API.