homeassistant.components.tplink.entity.CoordinatedTPLinkEntity Class Reference

Inheritance diagram for homeassistant.components.tplink.entity.CoordinatedTPLinkEntity:

Collaboration diagram for homeassistant.components.tplink.entity.CoordinatedTPLinkEntity:

Public Member Functions
None	__init__ (self, Device device, TPLinkDataUpdateCoordinator coordinator, *Feature|None feature=None, Device|None parent=None)
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.tplink.coordinator.TPLinkDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, Device device, timedelta update_interval)
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)

Private Member Functions
None	_async_call_update_attrs (self)
None	_async_update_attrs (self)
str	_get_unique_id (self)
None	_handle_coordinator_update (self)

Private Attributes
	_attr_available
	_attr_device_info
	_attr_unique_id
	_feature

Static Private Attributes
bool	_attr_has_entity_name = True

Additional Inherited Members
Public Attributes inherited from homeassistant.components.tplink.coordinator.TPLinkDataUpdateCoordinator
	device
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

Common base class for all coordinated tplink entities.

Definition at line 135 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.tplink.entity.CoordinatedTPLinkEntity.__init__	(		self,
		Device	device,
		TPLinkDataUpdateCoordinator	coordinator,
		*Feature | None	feature = None,
		Device | None	parent = None
	)

Initialize the entity.

Definition at line 141 of file entity.py.

Member Function Documentation

_async_call_update_attrs()

None homeassistant.components.tplink.entity.CoordinatedTPLinkEntity._async_call_update_attrs (   self )

private

Call update_attrs and make entity unavailable on errors.

Definition at line 208 of file entity.py.

_async_update_attrs()

None homeassistant.components.tplink.entity.CoordinatedTPLinkEntity._async_update_attrs (   self )

private

Platforms implement this to update the entity internals.

Reimplemented in homeassistant.components.tplink.siren.TPLinkSirenEntity, homeassistant.components.tplink.sensor.TPLinkSensorEntity, homeassistant.components.tplink.select.TPLinkSelectEntity, homeassistant.components.tplink.number.TPLinkNumberEntity, homeassistant.components.tplink.light.TPLinkLightEffectEntity, homeassistant.components.tplink.light.TPLinkLightEntity, homeassistant.components.tplink.fan.TPLinkFanEntity, homeassistant.components.tplink.climate.TPLinkClimateEntity, homeassistant.components.tplink.button.TPLinkButtonEntity, and homeassistant.components.tplink.binary_sensor.TPLinkBinarySensorEntity.

Definition at line 203 of file entity.py.

_get_unique_id()

str homeassistant.components.tplink.entity.CoordinatedTPLinkEntity._get_unique_id (   self )

private

Return unique ID for the entity.

Reimplemented in homeassistant.components.tplink.light.TPLinkLightEntity, homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity, and homeassistant.components.tplink.climate.TPLinkClimateEntity.

Definition at line 197 of file entity.py.

_handle_coordinator_update()

None homeassistant.components.tplink.entity.CoordinatedTPLinkEntity._handle_coordinator_update (   self )

private

Handle updated data from the coordinator.

Definition at line 225 of file entity.py.

available()

bool homeassistant.components.tplink.entity.CoordinatedTPLinkEntity.available

(

self

)

Return if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 231 of file entity.py.

Member Data Documentation

_attr_available

homeassistant.components.tplink.entity.CoordinatedTPLinkEntity._attr_available

private

Definition at line 220 of file entity.py.

_attr_device_info

homeassistant.components.tplink.entity.CoordinatedTPLinkEntity._attr_device_info

private

Definition at line 173 of file entity.py.

_attr_has_entity_name

bool homeassistant.components.tplink.entity.CoordinatedTPLinkEntity._attr_has_entity_name = True

staticprivate

Definition at line 138 of file entity.py.

_attr_unique_id

homeassistant.components.tplink.entity.CoordinatedTPLinkEntity._attr_unique_id

private

Definition at line 193 of file entity.py.

_feature

homeassistant.components.tplink.entity.CoordinatedTPLinkEntity._feature

private

Definition at line 152 of file entity.py.

---

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

• core/homeassistant/components/tplink/entity.py