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

Public Member Functions

None __init__ (self, DeviceEndpoint elmax_device, str panel_version, ElmaxCoordinator coordinator)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.elmax.coordinator.ElmaxCoordinator
None __init__ (self, HomeAssistant hass, Logger logger, GenericElmax elmax_api_client, PanelEntry panel, str name, timedelta update_interval)
 
None async_shutdown (self)
 
Actuator get_actuator_state (self, str actuator_id)
 
Area get_area_state (self, str area_id)
 
Cover get_cover_state (self, str cover_id)
 
Actuator get_zone_state (self, str zone_id)
 
def http_client (self)
 
def http_client (self, GenericElmax client)
 
PanelEntry panel_entry (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _attr_unique_id
 
 _device
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 

Detailed Description

Wrapper for Elmax entities.

Definition at line 14 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.elmax.entity.ElmaxEntity.__init__ (   self,
DeviceEndpoint  elmax_device,
str  panel_version,
ElmaxCoordinator  coordinator 
)
Construct the object.

Definition at line 17 of file entity.py.

Member Function Documentation

◆ available()

bool homeassistant.components.elmax.entity.ElmaxEntity.available (   self)
Return if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 39 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.elmax.entity.ElmaxEntity._attr_device_info
private

Definition at line 28 of file entity.py.

◆ _attr_name

homeassistant.components.elmax.entity.ElmaxEntity._attr_name
private

Definition at line 27 of file entity.py.

◆ _attr_unique_id

homeassistant.components.elmax.entity.ElmaxEntity._attr_unique_id
private

Definition at line 26 of file entity.py.

◆ _device

homeassistant.components.elmax.entity.ElmaxEntity._device
private

Definition at line 25 of file entity.py.


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