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

Public Member Functions

None __init__ (self, Eq3ConfigEntry entry, str|None unique_id_key=None)
 
None async_added_to_hass (self)
 
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)
 
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)
 

Private Member Functions

None _async_on_connected (self)
 
None _async_on_disconnected (self)
 
None _async_on_updated (self)
 

Private Attributes

 _attr_available
 
 _attr_device_info
 
 _attr_unique_id
 
 _eq3_config
 
 _thermostat
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Base class for all eQ-3 entities.

Definition at line 22 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.eq3btsmart.entity.Eq3Entity.__init__ (   self,
Eq3ConfigEntry  entry,
str | None   unique_id_key = None 
)
Initialize the eq3 entity.

Definition at line 27 of file entity.py.

Member Function Documentation

◆ _async_on_connected()

None homeassistant.components.eq3btsmart.entity.Eq3Entity._async_on_connected (   self)
private
Handle connection to the thermostat.

Definition at line 83 of file entity.py.

◆ _async_on_disconnected()

None homeassistant.components.eq3btsmart.entity.Eq3Entity._async_on_disconnected (   self)
private
Handle disconnection from the thermostat.

Definition at line 76 of file entity.py.

◆ _async_on_updated()

None homeassistant.components.eq3btsmart.entity.Eq3Entity._async_on_updated (   self)
private
Handle updated data from the thermostat.

Reimplemented in homeassistant.components.eq3btsmart.climate.Eq3Climate.

Definition at line 70 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.eq3btsmart.entity.Eq3Entity.async_added_to_hass (   self)
Run when entity about to be added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 45 of file entity.py.

◆ async_will_remove_from_hass()

None homeassistant.components.eq3btsmart.entity.Eq3Entity.async_will_remove_from_hass (   self)
Run when entity will be removed from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 65 of file entity.py.

◆ available()

bool homeassistant.components.eq3btsmart.entity.Eq3Entity.available (   self)
Whether the entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.eq3btsmart.number.Eq3NumberEntity.

Definition at line 90 of file entity.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.eq3btsmart.entity.Eq3Entity._attr_available
private

Definition at line 79 of file entity.py.

◆ _attr_device_info

homeassistant.components.eq3btsmart.entity.Eq3Entity._attr_device_info
private

Definition at line 36 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.eq3btsmart.entity.Eq3Entity._attr_has_entity_name = True
staticprivate

Definition at line 25 of file entity.py.

◆ _attr_unique_id

homeassistant.components.eq3btsmart.entity.Eq3Entity._attr_unique_id
private

Definition at line 43 of file entity.py.

◆ _eq3_config

homeassistant.components.eq3btsmart.entity.Eq3Entity._eq3_config
private

Definition at line 34 of file entity.py.

◆ _thermostat

homeassistant.components.eq3btsmart.entity.Eq3Entity._thermostat
private

Definition at line 35 of file entity.py.


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