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

Public Member Functions

None __init__ (self, Device device)
 
None async_added_to_hass (self)
 
None async_dock (self)
 
None async_pause (self)
 
None async_start_mowing (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)
 
dict[str, Any]|None capability_attributes (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)
 
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)
 
dict[str, Any]|None state_attributes (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.lawn_mower.LawnMowerEntity
LawnMowerActivity|None activity (self)
 
None dock (self)
 
None pause (self)
 
None start_mowing (self)
 
str|None state (self)
 
LawnMowerEntityFeature supported_features (self)
 

Static Public Attributes

 entity_description = LawnMowerEntityEntityDescription(key="mower", name=None)
 
- 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.lawn_mower.LawnMowerEntity
 LawnMowerEntityFeature
 
 None
 

Private Member Functions

None _clean_command (self, CleanAction action)
 

Private Attributes

 _attr_activity
 

Static Private Attributes

tuple _attr_supported_features
 

Additional Inherited Members

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

Detailed Description

Ecovacs Mower.

Definition at line 53 of file lawn_mower.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ecovacs.lawn_mower.EcovacsMower.__init__ (   self,
Device  device 
)
Initialize the mower.

Definition at line 67 of file lawn_mower.py.

Member Function Documentation

◆ _clean_command()

None homeassistant.components.ecovacs.lawn_mower.EcovacsMower._clean_command (   self,
CleanAction  action 
)
private

Definition at line 81 of file lawn_mower.py.

◆ async_added_to_hass()

None homeassistant.components.ecovacs.lawn_mower.EcovacsMower.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 71 of file lawn_mower.py.

◆ async_dock()

None homeassistant.components.ecovacs.lawn_mower.EcovacsMower.async_dock (   self)
Parks the mower until next schedule.

Reimplemented from homeassistant.components.lawn_mower.LawnMowerEntity.

Definition at line 94 of file lawn_mower.py.

◆ async_pause()

None homeassistant.components.ecovacs.lawn_mower.EcovacsMower.async_pause (   self)
Pauses the mower.

Reimplemented from homeassistant.components.lawn_mower.LawnMowerEntity.

Definition at line 90 of file lawn_mower.py.

◆ async_start_mowing()

None homeassistant.components.ecovacs.lawn_mower.EcovacsMower.async_start_mowing (   self)
Resume schedule.

Reimplemented from homeassistant.components.lawn_mower.LawnMowerEntity.

Definition at line 86 of file lawn_mower.py.

Member Data Documentation

◆ _attr_activity

homeassistant.components.ecovacs.lawn_mower.EcovacsMower._attr_activity
private

Definition at line 76 of file lawn_mower.py.

◆ _attr_supported_features

tuple homeassistant.components.ecovacs.lawn_mower.EcovacsMower._attr_supported_features
staticprivate
Initial value:
= (
LawnMowerEntityFeature.DOCK
| LawnMowerEntityFeature.PAUSE
| LawnMowerEntityFeature.START_MOWING
)

Definition at line 59 of file lawn_mower.py.

◆ entity_description

homeassistant.components.ecovacs.lawn_mower.EcovacsMower.entity_description = LawnMowerEntityEntityDescription(key="mower", name=None)
static

Definition at line 65 of file lawn_mower.py.


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