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

Public Member Functions

None __init__ (self, AprilaireCoordinator coordinator, str|None unique_id)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.aprilaire.coordinator.AprilaireCoordinator
None __init__ (self, HomeAssistant hass, str|None unique_id, str host, int port)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_set_updated_data (self, Any data)
 
None async_update_listeners (self)
 
DeviceInfo|None create_device_info (self, dict[str, Any] data)
 
str create_device_name (self, dict[str, Any]|None data)
 
DeviceInfo|None device_info (self)
 
str device_name (self)
 
str get_hw_version (self, dict[str, Any] data)
 
def start_listen (self)
 
def stop_listen (self)
 
bool wait_for_ready (self, Callable[[bool], Awaitable[None]] ready_callback)
 

Private Member Functions

def _update_available (self)
 

Private Attributes

 _attr_available
 
 _attr_device_info
 
 _attr_unique_id
 

Static Private Attributes

bool _attr_available = False
 
bool _attr_has_entity_name = True
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.aprilaire.coordinator.AprilaireCoordinator
 client
 
 data
 
 hass
 
 unique_id
 

Detailed Description

Base for Aprilaire entities.

Definition at line 16 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.aprilaire.entity.BaseAprilaireEntity.__init__ (   self,
AprilaireCoordinator  coordinator,
str | None   unique_id 
)
Initialize the entity.

Definition at line 22 of file entity.py.

Member Function Documentation

◆ _update_available()

def homeassistant.components.aprilaire.entity.BaseAprilaireEntity._update_available (   self)
private
Update the entity availability.

Definition at line 34 of file entity.py.

◆ async_update()

None homeassistant.components.aprilaire.entity.BaseAprilaireEntity.async_update (   self)
Implement abstract base method.

Definition at line 45 of file entity.py.

Member Data Documentation

◆ _attr_available [1/2]

bool homeassistant.components.aprilaire.entity.BaseAprilaireEntity._attr_available = False
staticprivate

Definition at line 19 of file entity.py.

◆ _attr_available [2/2]

homeassistant.components.aprilaire.entity.BaseAprilaireEntity._attr_available
private
Update the entity availability.

Definition at line 43 of file entity.py.

◆ _attr_device_info

homeassistant.components.aprilaire.entity.BaseAprilaireEntity._attr_device_info
private
Initialize the entity.

Definition at line 29 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.aprilaire.entity.BaseAprilaireEntity._attr_has_entity_name = True
staticprivate

Definition at line 20 of file entity.py.

◆ _attr_unique_id

homeassistant.components.aprilaire.entity.BaseAprilaireEntity._attr_unique_id
private

Definition at line 30 of file entity.py.


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