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

Public Member Functions

None __init__ (self, str device_url, OverkizDataUpdateCoordinator coordinator, EntityDescription description)
 
- Public Member Functions inherited from homeassistant.components.overkiz.entity.OverkizEntity
None __init__ (self, str device_url, OverkizDataUpdateCoordinator coordinator)
 
Device device (self)
 
DeviceInfo generate_device_info (self)
 
bool is_sub_device (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.overkiz.coordinator.OverkizDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *str name, OverkizClient client, list[Device] devices, Place|None places, timedelta|None update_interval=None, str config_entry_id)
 
- 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.overkiz.entity.OverkizEntity
 base_device_url
 
 device_url
 
 executor
 
 index_device_url
 
- Public Attributes inherited from homeassistant.components.overkiz.coordinator.OverkizDataUpdateCoordinator
 areas
 
 client
 
 config_entry_id
 
 data
 
 devices
 
 executions
 
 is_stateless
 
 update_interval
 
- 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 Attributes

 _attr_name
 
 _attr_unique_id
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.overkiz.entity.OverkizEntity
 None
 

Detailed Description

Representation of a Overkiz device entity based on a description.

Definition at line 106 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.overkiz.entity.OverkizDescriptiveEntity.__init__ (   self,
str  device_url,
OverkizDataUpdateCoordinator  coordinator,
EntityDescription  description 
)
Initialize the device.

Reimplemented in homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel.

Definition at line 109 of file entity.py.

Member Data Documentation

◆ _attr_name

homeassistant.components.overkiz.entity.OverkizDescriptiveEntity._attr_name
private

Definition at line 123 of file entity.py.

◆ _attr_unique_id

homeassistant.components.overkiz.entity.OverkizDescriptiveEntity._attr_unique_id
private

Definition at line 118 of file entity.py.

◆ entity_description

homeassistant.components.overkiz.entity.OverkizDescriptiveEntity.entity_description

Definition at line 117 of file entity.py.


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