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

Public Member Functions

None async_added_to_hass (self)
 
None async_raw_get_positions (self)
 
str battery_icon (self)
 
int|None battery_level (self)
 
None clean_spot (self, **Any kwargs)
 
dict[str, Any] extra_state_attributes (self)
 
str|None fan_speed (self)
 
None locate (self, **Any kwargs)
 
None on_error (self, str error)
 
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, **Any kwargs)
 
str|None state (self)
 
None stop (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.ecovacs.entity.EcovacsLegacyEntity
None __init__ (self, VacBot device)
 
None async_will_remove_from_hass (self)
 
bool available (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_write_ha_state (self)
 
str|None attribution (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)
 
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)
 
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)
 
dict[str, Any]|None capability_attributes (self)
 
list[strfan_speed_list (self)
 
None pause (self)
 
None start (self)
 
dict[str, Any] state_attributes (self)
 
VacuumEntityFeature supported_features (self)
 
VacuumEntityFeature supported_features_compat (self)
 

Public Attributes

 error
 
 state
 
- Public Attributes inherited from homeassistant.components.ecovacs.entity.EcovacsLegacyEntity
 device
 
- 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
 

Static Private Attributes

list _attr_fan_speed_list = [sucks.FAN_SPEED_NORMAL, sucks.FAN_SPEED_HIGH]
 
tuple _attr_supported_features
 

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.vacuum.StateVacuumEntity
 None
 
 VacuumEntityFeature
 

Detailed Description

Legacy Ecovacs vacuums.

Definition at line 74 of file vacuum.py.

Member Function Documentation

◆ async_added_to_hass()

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

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 90 of file vacuum.py.

◆ async_raw_get_positions()

None homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.async_raw_get_positions (   self)
Get bot and chargers positions.

Definition at line 217 of file vacuum.py.

◆ battery_icon()

str homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.battery_icon (   self)
Return the battery icon for the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 154 of file vacuum.py.

◆ battery_level()

int | None homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.battery_level (   self)
Return the battery level of the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 146 of file vacuum.py.

◆ clean_spot()

None homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.clean_spot (   self,
**Any  kwargs 
)
Perform a spot clean-up.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 193 of file vacuum.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.extra_state_attributes (   self)
Return the device-specific state attributes of this vacuum.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 166 of file vacuum.py.

◆ fan_speed()

str | None homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.fan_speed (   self)
Return the fan speed of the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 161 of file vacuum.py.

◆ locate()

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

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 198 of file vacuum.py.

◆ on_error()

None homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.on_error (   self,
str  error 
)
Handle an error event from the robot.

This will not change the entity's state. If the error caused the state
to change, that will come through as a separate on_status event

Definition at line 109 of file vacuum.py.

◆ return_to_base()

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

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 178 of file vacuum.py.

◆ send_command()

None homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.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 208 of file vacuum.py.

◆ set_fan_speed()

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

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 203 of file vacuum.py.

◆ start()

None homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.start (   self,
**Any  kwargs 
)
Turn the vacuum on and start cleaning.

Definition at line 183 of file vacuum.py.

◆ state()

str | None homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.state (   self)
Return the state of the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 126 of file vacuum.py.

◆ stop()

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

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 188 of file vacuum.py.

Member Data Documentation

◆ _attr_fan_speed_list

list homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum._attr_fan_speed_list = [sucks.FAN_SPEED_NORMAL, sucks.FAN_SPEED_HIGH]
staticprivate

Definition at line 77 of file vacuum.py.

◆ _attr_supported_features

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

Definition at line 78 of file vacuum.py.

◆ error

homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.error

Definition at line 116 of file vacuum.py.

◆ state

homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum.state

Definition at line 205 of file vacuum.py.


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