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

Public Member Functions

None __init__ (self, ScreenlogicDataUpdateCoordinator coordinator, ScreenLogicEntityDescription entity_description)
 
dict entity_data (self)
 
ScreenLogicGateway gateway (self)
 
str|None mac (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.screenlogic.coordinator.ScreenlogicDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, *ConfigEntry config_entry, ScreenLogicGateway gateway)
 
- 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_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 

Public Attributes

 entity_description
 
- Public Attributes inherited from homeassistant.components.screenlogic.coordinator.ScreenlogicDataUpdateCoordinator
 config_entry
 
 gateway
 
- 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
 

Private Member Functions

None _async_refresh (self)
 
None _async_refresh_timed (self, datetime now)
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _attr_unique_id
 
 _data_key
 
 _data_path
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Detailed Description

Base class for all ScreenLogic entities.

Definition at line 40 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.screenlogic.entity.ScreenLogicEntity.__init__ (   self,
ScreenlogicDataUpdateCoordinator  coordinator,
ScreenLogicEntityDescription  entity_description 
)
Initialize of the entity.

Definition at line 46 of file entity.py.

Member Function Documentation

◆ _async_refresh()

None homeassistant.components.screenlogic.entity.ScreenLogicEntity._async_refresh (   self)
private
Refresh the data from the gateway.

Definition at line 79 of file entity.py.

◆ _async_refresh_timed()

None homeassistant.components.screenlogic.entity.ScreenLogicEntity._async_refresh_timed (   self,
datetime  now 
)
private
Refresh from a timed called.

Definition at line 86 of file entity.py.

◆ entity_data()

dict homeassistant.components.screenlogic.entity.ScreenLogicEntity.entity_data (   self)
Shortcut to the data for this entity.

Definition at line 91 of file entity.py.

◆ gateway()

ScreenLogicGateway homeassistant.components.screenlogic.entity.ScreenLogicEntity.gateway (   self)
Return the gateway.

Definition at line 75 of file entity.py.

◆ mac()

str | None homeassistant.components.screenlogic.entity.ScreenLogicEntity.mac (   self)
Mac address.

Definition at line 69 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.screenlogic.entity.ScreenLogicEntity._attr_device_info
private

Definition at line 60 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.screenlogic.entity.ScreenLogicEntity._attr_has_entity_name = True
staticprivate

Definition at line 44 of file entity.py.

◆ _attr_name

homeassistant.components.screenlogic.entity.ScreenLogicEntity._attr_name
private

Definition at line 58 of file entity.py.

◆ _attr_unique_id

homeassistant.components.screenlogic.entity.ScreenLogicEntity._attr_unique_id
private

Definition at line 57 of file entity.py.

◆ _data_key

homeassistant.components.screenlogic.entity.ScreenLogicEntity._data_key
private

Definition at line 54 of file entity.py.

◆ _data_path

homeassistant.components.screenlogic.entity.ScreenLogicEntity._data_path
private

Definition at line 55 of file entity.py.

◆ entity_description

homeassistant.components.screenlogic.entity.ScreenLogicEntity.entity_description

Definition at line 53 of file entity.py.


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