Skip to content

Obstacle Photos ​

Map obstacle photos be displayed via Current Map entity camera proxy.

Selected ObstacleSelected ObstacleSelected Obstacle
Panel Selected ObstaclePanel Selected Obstacle

Previews are provided by Dreame Vacuum Card

/api/camera_map_obstacle_proxy/{entity_id}?token={access_token}&index={obstacle_index}&crop={is_cropped}&file={download_file}

  • entity_id: Id of the current map entity (camera.{vacuum_name}_map)
  • access_token: Camera entity access token (Can be acquired from camera.{vacuum_name}_map entity attributes)
  • obstacle_index (optional, default = 1): Index of the obstacle (Can be acquired from camera.{vacuum_name}_map entity attributes)
  • is_cropped (optional, default = 1): App renders the obstacle photos as cropped to prevent displaying the borders on some devices. This parameter can be set to 0 for rendering the original obstacle image.
  • download_file (optional, default = 0): Can be set to 1 for downloading the obstacle picture

TIP

Returns 404 if the requested obstacle does not exists.

Example:

text
http://local.homeassistant/api/camera_map_obstacle_proxy/camera.vacuum_map?token=5df93cfcf8ecc23fa17b233ca938cc52f41e2b17a46ca291865be3f9ba64d89b&index=2&crop=1

Dashboard Example

To see an example of how this endpoint can be used, refer to the Obstacles Card on the Custom Card Templates page.

Obstacle Photos from History Maps ​

Map obstacle photos for history maps be displayed via Current Map entity camera proxy.

/api/camera_map_obstacle_history_proxy/{entity_id}?token={access_token}&history_index={history_index}&cruising={is_cruising_history}&index={obstacle_index}&crop={is_cropped}&file={download_file}

  • entity_id: Id of the current map entity (camera.{vacuum_name}_map)
  • access_token: Camera entity access token (Can be acquired from camera.{vacuum_name}_map entity attributes)
  • history_index (optional, default = 1): Index of the history entry from 1 to 25 (Can be acquired from sensor.{vacuum_name}_cleaning_history entity attributes)
  • is_cruising_history (optional, default = 0): Can be set to 1 for getting the cruising history instead of the cleaning history (Only on devices with the cruising capability)
  • obstacle_index (optional, default = 1): Index of the obstacle (Can be acquired from camera.{vacuum_name}_map entity attributes)
  • is_cropped (optional, default = 1): App renders the obstacle photos as cropped to prevent displaying the borders on some devices. This parameter can be set to 0 for rendering the original obstacle image.
  • download_file (optional, default = 0): Can be set to 1 for downloading the obstacle picture

TIP

Returns 404 if the requested history map or obstacle does not exists.

Example:

text
http://local.homeassistant/api/camera_map_obstacle_history_proxy/camera.vacuum_map?token=5df93cfcf8ecc23fa17b233ca938cc52f41e2b17a46ca291865be3f9ba64d89b&history_index=2&index=3