Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ecovacs.vacuum.EcovacsVacuum Class Reference
Inheritance diagram for homeassistant.components.ecovacs.vacuum.EcovacsVacuum:
[legend]
Collaboration diagram for homeassistant.components.ecovacs.vacuum.EcovacsVacuum:
[legend]

Public Member Functions

None __init__ (self, Device device)
 
None async_added_to_hass (self)
 
None async_locate (self, **Any kwargs)
 
None async_pause (self)
 
dict[str, Any] async_raw_get_positions (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)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.ecovacs.entity.EcovacsEntity
None __init__ (self, Device device, CapabilityEntity capability, **Any kwargs)
 
None async_update (self)
 
DeviceInfo|None device_info (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_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)
 
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)
 
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, strtranslation_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.components.vacuum.StateVacuumEntity
None async_clean_spot (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[strfan_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)
 

Static Public Attributes

 entity_description
 
- Static Public Attributes inherited from homeassistant.components.ecovacs.entity.EcovacsEntity
 bool
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.vacuum.StateVacuumEntity
 None
 
 VacuumEntityFeature
 

Private Member Functions

None _clean_command (self, CleanAction action)
 

Private Attributes

 _attr_battery_level
 
 _attr_fan_speed
 
 _attr_fan_speed_list
 
 _attr_state
 
 _rooms
 

Static Private Attributes

tuple _attr_supported_features
 
 _unrecorded_attributes = frozenset({_ATTR_ROOMS})
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.vacuum.StateVacuumEntity
 state
 

Detailed Description

Ecovacs vacuum.

Definition at line 239 of file vacuum.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.__init__ (   self,
Device  device 
)
Initialize the vacuum.

Definition at line 262 of file vacuum.py.

Member Function Documentation

◆ _clean_command()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum._clean_command (   self,
CleanAction  action 
)
private

Definition at line 350 of file vacuum.py.

◆ async_added_to_hass()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.async_added_to_hass (   self)
Set up the event listeners now that hass is ready.

Reimplemented from homeassistant.components.ecovacs.entity.EcovacsEntity.

Definition at line 274 of file vacuum.py.

◆ async_locate()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.async_locate (   self,
**Any  kwargs 
)
Locate the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 355 of file vacuum.py.

◆ async_pause()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.async_pause (   self)
Pause the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 342 of file vacuum.py.

◆ async_raw_get_positions()

dict[str, Any] homeassistant.components.ecovacs.vacuum.EcovacsVacuum.async_raw_get_positions (   self)
Get bot and chargers positions.

Definition at line 412 of file vacuum.py.

◆ async_return_to_base()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.async_return_to_base (   self,
**Any  kwargs 
)
Set the vacuum cleaner to return to the dock.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 334 of file vacuum.py.

◆ async_send_command()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.async_send_command (   self,
str  command,
dict[str, Any] | list[Any] | None   params = None,
**Any  kwargs 
)
Send a command to a vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 359 of file vacuum.py.

◆ async_set_fan_speed()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.async_set_fan_speed (   self,
str  fan_speed,
**Any  kwargs 
)
Set fan speed.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 328 of file vacuum.py.

◆ async_start()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.async_start (   self)
Start the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 346 of file vacuum.py.

◆ async_stop()

None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.async_stop (   self,
**Any  kwargs 
)
Stop the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 338 of file vacuum.py.

◆ extra_state_attributes()

Mapping[str, Any] | None homeassistant.components.ecovacs.vacuum.EcovacsVacuum.extra_state_attributes (   self)
Return entity specific state attributes.

Implemented by platform classes. Convention for attribute names
is lowercase snake_case.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 305 of file vacuum.py.

Member Data Documentation

◆ _attr_battery_level

homeassistant.components.ecovacs.vacuum.EcovacsVacuum._attr_battery_level
private

Definition at line 279 of file vacuum.py.

◆ _attr_fan_speed

homeassistant.components.ecovacs.vacuum.EcovacsVacuum._attr_fan_speed
private

Definition at line 296 of file vacuum.py.

◆ _attr_fan_speed_list

homeassistant.components.ecovacs.vacuum.EcovacsVacuum._attr_fan_speed_list
private

Definition at line 270 of file vacuum.py.

◆ _attr_state

homeassistant.components.ecovacs.vacuum.EcovacsVacuum._attr_state
private

Definition at line 287 of file vacuum.py.

◆ _attr_supported_features

tuple homeassistant.components.ecovacs.vacuum.EcovacsVacuum._attr_supported_features
staticprivate
Initial value:
= (
VacuumEntityFeature.PAUSE
| VacuumEntityFeature.STOP
| VacuumEntityFeature.RETURN_HOME
| VacuumEntityFeature.BATTERY
| VacuumEntityFeature.SEND_COMMAND
| VacuumEntityFeature.LOCATE
| VacuumEntityFeature.STATE
| VacuumEntityFeature.START
)

Definition at line 247 of file vacuum.py.

◆ _rooms

homeassistant.components.ecovacs.vacuum.EcovacsVacuum._rooms
private

Definition at line 283 of file vacuum.py.

◆ _unrecorded_attributes

homeassistant.components.ecovacs.vacuum.EcovacsVacuum._unrecorded_attributes = frozenset({_ATTR_ROOMS})
staticprivate

Definition at line 245 of file vacuum.py.

◆ entity_description

homeassistant.components.ecovacs.vacuum.EcovacsVacuum.entity_description
static
Initial value:
= StateVacuumEntityDescription(
key="vacuum", translation_key="vacuum", name=None
)

Definition at line 258 of file vacuum.py.


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