map

Get the occupancy grid of a map

Returns the grid based raw layout of the map identified by mapId.

The grid is packed as array in row-major-order starting on the bottom left grid cell. Depending on the home appliance, the grid is either delivered as plain integer array in gridMap or zstd compressed and base64url encoded in gridMapCompressedZstd.

get/homeappliances/{haId}/map/maps/{mapId}/occupancyGrid

Request

  • Base URL: https://api.home-connect.com/api
  • URL: https://api.home-connect.com/api/homeappliances/{haId}/map/maps/{mapId}/occupancyGrid
  • 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

Occupancy grid of the requested map

mapIdinteger required

The map's identifier

gridMapinteger[]

Grid based low level map layout. Packed as array in row-major-order starting on the bottom left grid cell. Integer values are interpreted as follows: 0=unknown, 1=unoccupied/free, 2=obstacle/wall.

gridMapCompressedZstdstring

Based on gridMap, this is the zstd [RFC8878] compressed and base64url [RFC4648] encoded version.

resolutionnumber required

Size of a grid cell in centimeter

widthinteger required

Number of grid cells in horizontal direction

heightinteger required

Number of grid cells in vertical direction

Changes

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