homeassistant.components.roborock.image.RoborockMap Class Reference

Inheritance diagram for homeassistant.components.roborock.image.RoborockMap:

Collaboration diagram for homeassistant.components.roborock.image.RoborockMap:

Public Member Functions
None	__init__ (self, str unique_id, RoborockDataUpdateCoordinator coordinator, int map_flag, bytes starting_map, str map_name, list[Drawable] drawables)
bytes|None	async_image (self)
bool	available (self)
bool	is_map_valid (self)
bool	is_selected (self)
Public Member Functions inherited from homeassistant.components.roborock.entity.RoborockCoordinatedEntityV1
None	__init__ (self, str unique_id, RoborockDataUpdateCoordinator coordinator, list[RoborockDataProtocol]|RoborockDataProtocol|None listener_request=None)
None	async_added_to_hass (self)
None	async_will_remove_from_hass (self)
RoborockMqttClientV1	cloud_api (self)
dict	send (self, RoborockCommand|str command, dict[str, Any]|list[Any]|int|None params=None)
Public Member Functions inherited from homeassistant.components.roborock.entity.RoborockEntityV1
None	__init__ (self, str unique_id, DeviceInfo device_info, RoborockClientV1 api)
RoborockClientV1	api (self)
AttributeCache	get_cache (self, CacheableAttribute attribute)
Public Member Functions inherited from homeassistant.components.roborock.entity.RoborockEntity
None	__init__ (self, str unique_id, DeviceInfo device_info, RoborockClient api)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_write_ha_state (self)
str|None	attribution (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
Public Member Functions inherited from homeassistant.components.roborock.coordinator.RoborockDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, HomeDataDevice device, NetworkInfo device_networking, HomeDataProduct product_info, RoborockMqttClientV1 cloud_api, list[HomeDataRoom] home_data_rooms)
str	duid (self)
str	duid_slug (self)
None	get_maps (self)
None	get_rooms (self)
None	release (self)
None	verify_api (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_config_entry_first_refresh (self)
Generator[Any]	async_contexts (self)
None	async_refresh (self)
None	async_register_shutdown (self)
None	async_request_refresh (self)
None	async_set_update_error (self, Exception err)
None	async_set_updated_data (self, _DataT data)
None	async_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)
Public Member Functions inherited from homeassistant.components.image.ImageEntity
None	__init__ (self, HomeAssistant hass, bool verify_ssl=False)
None	async_update_token (self)
str	content_type (self)
str|None	entity_picture (self)
bytes|None	image (self)
datetime|None	image_last_updated (self)
str|None|UndefinedType	image_url (self)
str|None	state (self)
dict[str, str|None]	state_attributes (self)

Public Attributes
	cached_map
	map_flag
	parser
Public Attributes inherited from homeassistant.components.roborock.entity.RoborockCoordinatedEntityV1
	listener_requests
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Public Attributes inherited from homeassistant.components.roborock.coordinator.RoborockDataUpdateCoordinator
	api
	cloud_api
	current_map
	device_info
	roborock_device_info
Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update
	config_entry
	data
	hass
	last_exception
	last_update_success
	logger
	name
	setup_method
	update_interval
	update_method

Private Member Functions
bytes	_create_image (self, bytes map_bytes)
None	_handle_coordinator_update (self)

Private Attributes
	_attr_entity_category
	_attr_image_last_updated
	_attr_name

Static Private Attributes
bool	_attr_has_entity_name = True

Additional Inherited Members
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.image.ImageEntity
	bool
	None
	str
	UndefinedType

Detailed Description

A class to let you visualize the map.

Definition at line 54 of file image.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.roborock.image.RoborockMap.__init__	(		self,
		str	unique_id,
		RoborockDataUpdateCoordinator	coordinator,
		int	map_flag,
		bytes	starting_map,
		str	map_name,
		list[Drawable]	drawables
	)

Initialize a Roborock map.

Definition at line 60 of file image.py.

Member Function Documentation

_create_image()

bytes homeassistant.components.roborock.image.RoborockMap._create_image (   self, bytes  map_bytes  )

private

Create an image using the map parser.

Definition at line 136 of file image.py.

_handle_coordinator_update()

None homeassistant.components.roborock.image.RoborockMap._handle_coordinator_update (   self )

private

Definition at line 110 of file image.py.

async_image()

bytes | None homeassistant.components.roborock.image.RoborockMap.async_image

(

self

)

Update the image if it is not cached.

Reimplemented from homeassistant.components.image.ImageEntity.

Definition at line 120 of file image.py.

available()

bool homeassistant.components.roborock.image.RoborockMap.available

(

self

)

Determines if the entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 88 of file image.py.

is_map_valid()

bool homeassistant.components.roborock.image.RoborockMap.is_map_valid

(

self

)

Update the map if it is valid.

Update this map if it is the currently active map, and the
vacuum is cleaning, or if it has never been set at all.

Definition at line 97 of file image.py.

is_selected()

bool homeassistant.components.roborock.image.RoborockMap.is_selected

(

self

)

Return if this map is the currently selected map.

Definition at line 93 of file image.py.

Member Data Documentation

_attr_entity_category

homeassistant.components.roborock.image.RoborockMap._attr_entity_category

private

Definition at line 85 of file image.py.

_attr_has_entity_name

bool homeassistant.components.roborock.image.RoborockMap._attr_has_entity_name = True

staticprivate

Definition at line 57 of file image.py.

_attr_image_last_updated

homeassistant.components.roborock.image.RoborockMap._attr_image_last_updated

private

Definition at line 76 of file image.py.

_attr_name

homeassistant.components.roborock.image.RoborockMap._attr_name

private

Definition at line 72 of file image.py.

cached_map

homeassistant.components.roborock.image.RoborockMap.cached_map

Definition at line 79 of file image.py.

map_flag

homeassistant.components.roborock.image.RoborockMap.map_flag

Definition at line 77 of file image.py.

parser

homeassistant.components.roborock.image.RoborockMap.parser

Definition at line 73 of file image.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/roborock/image.py