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

Public Member Functions

None __init__ (self, Device device, CapabilityEntity capability, **Any kwargs)
 
None async_added_to_hass (self)
 
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)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (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)
 

Static Public Attributes

 bool
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

None _subscribe (self, type[EventT] event_type, Callable[[EventT], Coroutine[Any, Any, None]] callback)
 

Private Attributes

 _attr_available
 
 _attr_unique_id
 
 _capability
 
 _device
 

Static Private Attributes

bool _attr_has_entity_name = True
 
bool _attr_should_poll = False
 

Additional Inherited Members

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

Detailed Description

Ecovacs entity.

Definition at line 25 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ecovacs.entity.EcovacsEntity.__init__ (   self,
Device  device,
CapabilityEntity  capability,
**Any  kwargs 
)
Initialize entity.

Definition at line 32 of file entity.py.

Member Function Documentation

◆ _subscribe()

None homeassistant.components.ecovacs.entity.EcovacsEntity._subscribe (   self,
type[EventT event_type,
Callable[[EventT], Coroutine[Any, Any, None]]  callback 
)
private
Subscribe to events.

Definition at line 83 of file entity.py.

◆ async_added_to_hass()

◆ async_update()

None homeassistant.components.ecovacs.entity.EcovacsEntity.async_update (   self)
Update the entity.

Only used by the generic entity update service.

Reimplemented in homeassistant.components.ecovacs.image.EcovacsMap.

Definition at line 92 of file entity.py.

◆ device_info()

DeviceInfo | None homeassistant.components.ecovacs.entity.EcovacsEntity.device_info (   self)
Return device specific attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 49 of file entity.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.ecovacs.entity.EcovacsEntity._attr_available
private

Definition at line 78 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.ecovacs.entity.EcovacsEntity._attr_has_entity_name = True
staticprivate

Definition at line 29 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.ecovacs.entity.EcovacsEntity._attr_should_poll = False
staticprivate

Definition at line 28 of file entity.py.

◆ _attr_unique_id

homeassistant.components.ecovacs.entity.EcovacsEntity._attr_unique_id
private

Definition at line 40 of file entity.py.

◆ _capability

homeassistant.components.ecovacs.entity.EcovacsEntity._capability
private

Definition at line 45 of file entity.py.

◆ _device

homeassistant.components.ecovacs.entity.EcovacsEntity._device
private

Definition at line 44 of file entity.py.

◆ bool

homeassistant.components.ecovacs.entity.EcovacsEntity.bool
static

Definition at line 30 of file entity.py.


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