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

Public Member Functions

None __init__ (self, FritzboxDataUpdateCoordinator coordinator, str ain, EntityDescription|None entity_description=None)
 
FritzhomeEntityBase data (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.fritzbox.coordinator.FritzboxDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, str name)
 
None async_setup (self)
 
None cleanup_removed_devices (self, list[str] available_ains)
 
- 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

 ain
 
 entity_description
 
- Public Attributes inherited from homeassistant.components.fritzbox.coordinator.FritzboxDataUpdateCoordinator
 configuration_url
 
 data
 
 fritz
 
 has_templates
 
 new_devices
 
 new_templates
 
- 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_has_entity_name
 
 _attr_name
 
 _attr_unique_id
 

Detailed Description

Basis FritzBox entity.

Definition at line 18 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.fritzbox.entity.FritzBoxEntity.__init__ (   self,
FritzboxDataUpdateCoordinator  coordinator,
str  ain,
EntityDescription | None   entity_description = None 
)
Initialize the FritzBox entity.

Definition at line 21 of file entity.py.

Member Function Documentation

◆ data()

FritzhomeEntityBase homeassistant.components.fritzbox.entity.FritzBoxEntity.data (   self)
Return data object from coordinator.

Reimplemented in homeassistant.components.fritzbox.entity.FritzBoxDeviceEntity, and homeassistant.components.fritzbox.button.FritzBoxTemplate.

Definition at line 41 of file entity.py.

Member Data Documentation

◆ _attr_has_entity_name

homeassistant.components.fritzbox.entity.FritzBoxEntity._attr_has_entity_name
private

Definition at line 32 of file entity.py.

◆ _attr_name

homeassistant.components.fritzbox.entity.FritzBoxEntity._attr_name
private

Definition at line 36 of file entity.py.

◆ _attr_unique_id

homeassistant.components.fritzbox.entity.FritzBoxEntity._attr_unique_id
private

Definition at line 34 of file entity.py.

◆ ain

homeassistant.components.fritzbox.entity.FritzBoxEntity.ain
Initialize the FritzBox entity.

Definition at line 30 of file entity.py.

◆ entity_description

homeassistant.components.fritzbox.entity.FritzBoxEntity.entity_description

Definition at line 33 of file entity.py.


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