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

Public Member Functions

None __init__ (self, AqualinkDevice dev)
 
bool assumed_state (self)
 
None async_added_to_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)
 
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)
 
dict[str, Any]|None capability_attributes (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)
 
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)
 

Public Attributes

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

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

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

Detailed Description

Abstract class for all Aqualink platforms.

Entity state is updated via the interval timer within the integration.
Any entity state change via the iaqualink library triggers an internal
state refresh which is then propagated to all the entities in the system
via the refresh_system decorator above to the _update_callback in this
class.

Definition at line 14 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.iaqualink.entity.AqualinkEntity.__init__ (   self,
AqualinkDevice  dev 
)
Initialize the entity.

Definition at line 26 of file entity.py.

Member Function Documentation

◆ assumed_state()

bool homeassistant.components.iaqualink.entity.AqualinkEntity.assumed_state (   self)
Return whether the state is based on actual reading from the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 45 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.iaqualink.entity.AqualinkEntity.async_added_to_hass (   self)
Set up a listener when this entity is added to HA.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 38 of file entity.py.

◆ available()

bool homeassistant.components.iaqualink.entity.AqualinkEntity.available (   self)
Return whether the device is available or not.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 50 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.iaqualink.entity.AqualinkEntity._attr_device_info
private

Definition at line 30 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.iaqualink.entity.AqualinkEntity._attr_should_poll = False
staticprivate

Definition at line 24 of file entity.py.

◆ _attr_unique_id

homeassistant.components.iaqualink.entity.AqualinkEntity._attr_unique_id
private

Definition at line 29 of file entity.py.

◆ dev

homeassistant.components.iaqualink.entity.AqualinkEntity.dev

Definition at line 28 of file entity.py.


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