Inheritance diagram for homeassistant.components.vacuum.StateVacuumEntity:

Collaboration diagram for homeassistant.components.vacuum.StateVacuumEntity:

Public Member Functions
None	async_clean_spot (self, **Any kwargs)

None	async_locate (self, **Any kwargs)

None	async_pause (self)

None	async_return_to_base (self, **Any kwargs)

None	async_send_command (self, str command, dict[str, Any]\|list[Any]\|None params=None, **Any kwargs)

None	async_set_fan_speed (self, str fan_speed, **Any kwargs)

None	async_start (self)

None	async_stop (self, **Any kwargs)

str	battery_icon (self)

int\|None	battery_level (self)

dict[str, Any]\|None	capability_attributes (self)

None	clean_spot (self, **Any kwargs)

str\|None	fan_speed (self)

list[str]	fan_speed_list (self)

None	locate (self, **Any kwargs)

None	pause (self)

None	return_to_base (self, **Any kwargs)

None	send_command (self, str command, dict[str, Any]\|list[Any]\|None params=None, **Any kwargs)

None	set_fan_speed (self, str fan_speed, **Any kwargs)

None	start (self)

str\|None	state (self)

dict[str, Any]	state_attributes (self)

None	stop (self, **Any kwargs)

VacuumEntityFeature	supported_features (self)

VacuumEntityFeature	supported_features_compat (self)

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_added_to_hass (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_will_remove_from_hass (self)

None	async_write_ha_state (self)

str\|None	attribution (self)

bool	available (self)

str\|None	device_class (self)

DeviceInfo\|None	device_info (self)

bool	enabled (self)

EntityCategory\|None	entity_category (self)

str\|None	entity_picture (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)

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 Attributes
	state

Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Static Public Attributes
	None

	VacuumEntityFeature

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Static Private Attributes
	_entity_component_unrecorded_attributes

Detailed Description

Representation of a vacuum cleaner robot that supports states.

Definition at line 223 of file __init__.py.

Member Function Documentation

◆ async_clean_spot()

None homeassistant.components.vacuum.StateVacuumEntity.async_clean_spot	(		self,
		**Any	kwargs
	)

Perform a spot clean-up.

This method must be run in the event loop.

Reimplemented in homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, homeassistant.components.template.vacuum.TemplateVacuum, homeassistant.components.roborock.vacuum.RoborockVacuum, homeassistant.components.mqtt.vacuum.MqttStateVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 334 of file __init__.py.

◆ async_locate()

None homeassistant.components.vacuum.StateVacuumEntity.async_locate	(		self,
		**Any	kwargs
	)

Locate the vacuum cleaner.

This method must be run in the event loop.

Reimplemented in homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, homeassistant.components.template.vacuum.TemplateVacuum, homeassistant.components.sharkiq.vacuum.SharkVacuumEntity, homeassistant.components.roborock.vacuum.RoborockVacuum, homeassistant.components.mqtt.vacuum.MqttStateVacuum, homeassistant.components.matter.vacuum.MatterVacuum, homeassistant.components.ecovacs.vacuum.EcovacsVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 345 of file __init__.py.

◆ async_pause()

None homeassistant.components.vacuum.StateVacuumEntity.async_pause ( self )

Pause the cleaning task.

This method must be run in the event loop.

Definition at line 403 of file __init__.py.

◆ async_return_to_base()

None homeassistant.components.vacuum.StateVacuumEntity.async_return_to_base	(		self,
		**Any	kwargs
	)

Set the vacuum cleaner to return to the dock.

This method must be run in the event loop.

Definition at line 323 of file __init__.py.

◆ async_send_command()

None homeassistant.components.vacuum.StateVacuumEntity.async_send_command	(		self,
		str	command,
		dict[str, Any] \| list[Any] \| None	params = `None`,
		**Any	kwargs
	)

Send a command to a vacuum cleaner.

This method must be run in the event loop.

Reimplemented in homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, homeassistant.components.roborock.vacuum.RoborockVacuum, homeassistant.components.mqtt.vacuum.MqttStateVacuum, homeassistant.components.ecovacs.vacuum.EcovacsVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 374 of file __init__.py.

◆ async_set_fan_speed()

None homeassistant.components.vacuum.StateVacuumEntity.async_set_fan_speed	(		self,
		str	fan_speed,
		**Any	kwargs
	)

Set fan speed.

This method must be run in the event loop.

Reimplemented in homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, homeassistant.components.template.vacuum.TemplateVacuum, homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum, homeassistant.components.sharkiq.vacuum.SharkVacuumEntity, homeassistant.components.romy.vacuum.RomyVacuumEntity, homeassistant.components.roborock.vacuum.RoborockVacuum, homeassistant.components.mqtt.vacuum.MqttStateVacuum, and homeassistant.components.ecovacs.vacuum.EcovacsVacuum.

Definition at line 356 of file __init__.py.

◆ async_start()

None homeassistant.components.vacuum.StateVacuumEntity.async_start ( self )

Start or resume the cleaning task.

This method must be run in the event loop.

Definition at line 392 of file __init__.py.

◆ async_stop()

None homeassistant.components.vacuum.StateVacuumEntity.async_stop	(		self,
		**Any	kwargs
	)

Stop the vacuum cleaner.

This method must be run in the event loop.

Definition at line 312 of file __init__.py.

◆ battery_icon()

str homeassistant.components.vacuum.StateVacuumEntity.battery_icon ( self )

Return the battery icon for the vacuum cleaner.

Reimplemented in homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.

Definition at line 245 of file __init__.py.

◆ battery_level()

int | None homeassistant.components.vacuum.StateVacuumEntity.battery_level ( self )

Return the battery level of the vacuum cleaner.

Reimplemented in homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, homeassistant.components.tuya.vacuum.TuyaVacuumEntity, homeassistant.components.sharkiq.vacuum.SharkVacuumEntity, homeassistant.components.roborock.vacuum.RoborockVacuum, homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 240 of file __init__.py.

◆ capability_attributes()

dict[str, Any] | None homeassistant.components.vacuum.StateVacuumEntity.capability_attributes ( self )

Return capability attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 254 of file __init__.py.

◆ clean_spot()

None homeassistant.components.vacuum.StateVacuumEntity.clean_spot	(		self,
		**Any	kwargs
	)

Perform a spot clean-up.

Reimplemented in homeassistant.components.sharkiq.vacuum.SharkVacuumEntity, homeassistant.components.neato.vacuum.NeatoConnectedVacuum, homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 330 of file __init__.py.

◆ fan_speed()

str | None homeassistant.components.vacuum.StateVacuumEntity.fan_speed ( self )

Return the fan speed of the vacuum cleaner.

Reimplemented in homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, homeassistant.components.tuya.vacuum.TuyaVacuumEntity, homeassistant.components.sharkiq.vacuum.SharkVacuumEntity, homeassistant.components.roomba.roomba.RoombaVacuumCarpetBoost, homeassistant.components.roomba.braava.BraavaJet, homeassistant.components.roborock.vacuum.RoborockVacuum, homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 261 of file __init__.py.

◆ fan_speed_list()

list[str] homeassistant.components.vacuum.StateVacuumEntity.fan_speed_list ( self )

Get the list of available fan speed steps of the vacuum cleaner.

Reimplemented in homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 266 of file __init__.py.

◆ locate()

None homeassistant.components.vacuum.StateVacuumEntity.locate	(		self,
		**Any	kwargs
	)

Locate the vacuum cleaner.

Reimplemented in homeassistant.components.tuya.vacuum.TuyaVacuumEntity, homeassistant.components.neato.vacuum.NeatoConnectedVacuum, and homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.

Definition at line 341 of file __init__.py.

◆ pause()

None homeassistant.components.vacuum.StateVacuumEntity.pause ( self )

Pause the cleaning task.

Reimplemented in homeassistant.components.neato.vacuum.NeatoConnectedVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 399 of file __init__.py.

◆ return_to_base()

None homeassistant.components.vacuum.StateVacuumEntity.return_to_base	(		self,
		**Any	kwargs
	)

Set the vacuum cleaner to return to the dock.

Reimplemented in homeassistant.components.tuya.vacuum.TuyaVacuumEntity, homeassistant.components.neato.vacuum.NeatoConnectedVacuum, homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 319 of file __init__.py.

◆ send_command()

None homeassistant.components.vacuum.StateVacuumEntity.send_command	(		self,
		str	command,
		dict[str, Any] \| list[Any] \| None	params = `None`,
		**Any	kwargs
	)

Send a command to a vacuum cleaner.

Reimplemented in homeassistant.components.tuya.vacuum.TuyaVacuumEntity, homeassistant.components.sharkiq.vacuum.SharkVacuumEntity, and homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.

Definition at line 365 of file __init__.py.

◆ set_fan_speed()

None homeassistant.components.vacuum.StateVacuumEntity.set_fan_speed	(		self,
		str	fan_speed,
		**Any	kwargs
	)

Set fan speed.

Reimplemented in homeassistant.components.tuya.vacuum.TuyaVacuumEntity, homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 352 of file __init__.py.

◆ start()

None homeassistant.components.vacuum.StateVacuumEntity.start ( self )

Start or resume the cleaning task.

Reimplemented in homeassistant.components.neato.vacuum.NeatoConnectedVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 388 of file __init__.py.

◆ state()

str | None homeassistant.components.vacuum.StateVacuumEntity.state ( self )

Return the state of the vacuum cleaner.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 286 of file __init__.py.

◆ state_attributes()

dict[str, Any] homeassistant.components.vacuum.StateVacuumEntity.state_attributes ( self )

Return the state attributes of the vacuum cleaner.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 271 of file __init__.py.

◆ stop()

None homeassistant.components.vacuum.StateVacuumEntity.stop	(		self,
		**Any	kwargs
	)

Stop the vacuum cleaner.

Reimplemented in homeassistant.components.tuya.vacuum.TuyaVacuumEntity, homeassistant.components.neato.vacuum.NeatoConnectedVacuum, homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum, and homeassistant.components.demo.vacuum.StateDemoVacuum.

Definition at line 308 of file __init__.py.

◆ supported_features()

VacuumEntityFeature homeassistant.components.vacuum.StateVacuumEntity.supported_features ( self )

Flag vacuum cleaner features that are supported.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 291 of file __init__.py.

◆ supported_features_compat()

VacuumEntityFeature homeassistant.components.vacuum.StateVacuumEntity.supported_features_compat ( self )

Return the supported features as VacuumEntityFeature.

Remove this compatibility shim in 2025.1 or later.

Definition at line 296 of file __init__.py.

Member Data Documentation

◆ _entity_component_unrecorded_attributes

homeassistant.components.vacuum.StateVacuumEntity._entity_component_unrecorded_attributes

staticprivate

Definition at line 230 of file __init__.py.

◆ None

homeassistant.components.vacuum.StateVacuumEntity.None

static

Definition at line 233 of file __init__.py.

◆ state

homeassistant.components.vacuum.StateVacuumEntity.state

Definition at line 247 of file __init__.py.

◆ VacuumEntityFeature

homeassistant.components.vacuum.StateVacuumEntity.VacuumEntityFeature

static

Definition at line 237 of file __init__.py.

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

core/homeassistant/components/vacuum/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Static Public Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ async_clean_spot()

◆ async_locate()

◆ async_pause()

◆ async_return_to_base()

◆ async_send_command()

◆ async_set_fan_speed()

◆ async_start()

◆ async_stop()

◆ battery_icon()

◆ battery_level()

◆ capability_attributes()

◆ clean_spot()

◆ fan_speed()

◆ fan_speed_list()

◆ locate()

◆ pause()

◆ return_to_base()

◆ send_command()

◆ set_fan_speed()

◆ start()

◆ state()

◆ state_attributes()

◆ stop()

◆ supported_features()

◆ supported_features_compat()

Member Data Documentation

◆ _entity_component_unrecorded_attributes

◆ None

◆ state

◆ VacuumEntityFeature