homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity Class Reference

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

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

Public Member Functions
None	__init__ (self, Device device, TPLinkDataUpdateCoordinator coordinator, *Feature feature, TPLinkFeatureEntityDescription description, Device|None parent=None)
Public Member Functions inherited from homeassistant.components.tplink.entity.CoordinatedTPLinkEntity
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)

Public Attributes
	entity_description
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

Static Public Attributes
	child_coordinator
	coordinator
	description = desc,
	descriptions
	device
EntityCategory|None	entity_category = cls._category_for_feature(feature),
	entity_class
	entity_registry_enabled_default = feature.category
	feat
	feature = feat,
	feature_type
	name = name,
	None
	parent = parent,
	translation_key = translation_key,
	UndefinedType

Private Member Functions
EntityCategory|None	_category_for_feature (cls, Feature|None feature)
def	_D
def	_E
def	_E
str	_get_unique_id (self)

Static Private Member Functions
str	_get_feature_unique_id (Device device, TPLinkFeatureEntityDescription entity_description)

Detailed Description

Common base class for all coordinated tplink feature entities.

Definition at line 236 of file entity.py.

Constructor & Destructor Documentation

__init__()

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

Initialize the entity.

Reimplemented in homeassistant.components.tplink.select.TPLinkSelectEntity, and homeassistant.components.tplink.number.TPLinkNumberEntity.

Definition at line 242 of file entity.py.

Member Function Documentation

_category_for_feature()

EntityCategory | None homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity._category_for_feature (   cls, Feature | None  feature  )

private

Return entity category for a feature.

Definition at line 278 of file entity.py.

_D()

def homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity._D

private

Definition at line 295 of file entity.py.

_E() [1/2]

def homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity._E

private

Definition at line 342 of file entity.py.

_E() [2/2]

def homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity._E

private

Definition at line 391 of file entity.py.

_get_feature_unique_id()

str homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity._get_feature_unique_id ( Device  device, TPLinkFeatureEntityDescription   entity_description  )

staticprivate

Return unique ID for the entity.

Definition at line 260 of file entity.py.

_get_unique_id()

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

private

Return unique ID for the entity.

Reimplemented from homeassistant.components.tplink.entity.CoordinatedTPLinkEntity.

Definition at line 255 of file entity.py.

Member Data Documentation

child_coordinator

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.child_coordinator

static

Definition at line 428 of file entity.py.

coordinator

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.coordinator

static

Definition at line 415 of file entity.py.

description

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.description = desc,

static

Definition at line 366 of file entity.py.

descriptions

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.descriptions

static

Definition at line 379 of file entity.py.

device

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.device

static

Definition at line 321 of file entity.py.

entity_category

EntityCategory | None homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.entity_category = cls._category_for_feature(feature),

static

Definition at line 327 of file entity.py.

entity_class

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.entity_class

static

Definition at line 417 of file entity.py.

entity_description

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.entity_description

Definition at line 252 of file entity.py.

entity_registry_enabled_default

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.entity_registry_enabled_default = feature.category

static

Definition at line 329 of file entity.py.

feat

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.feat

static

Definition at line 379 of file entity.py.

feature

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.feature = feat,

static

Definition at line 365 of file entity.py.

feature_type

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.feature_type

static

Definition at line 416 of file entity.py.

name

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.name = name,

static

Definition at line 321 of file entity.py.

None

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.None

static

Definition at line 310 of file entity.py.

parent

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.parent = parent,

static

Definition at line 321 of file entity.py.

translation_key

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.translation_key = translation_key,

static

Definition at line 319 of file entity.py.

UndefinedType

homeassistant.components.tplink.entity.CoordinatedTPLinkFeatureEntity.UndefinedType

static

Definition at line 314 of file entity.py.

---

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

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