Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tplink.deprecate Namespace Reference

Classes

class  DeprecatedInfo
 

Functions

bool async_check_create_deprecated (HomeAssistant hass, str unique_id, TPLinkFeatureEntityDescription entity_description)
 
None async_cleanup_deprecated (HomeAssistant hass, str platform, str entry_id, Sequence[CoordinatedTPLinkFeatureEntity] entities)
 

Detailed Description

Helper class for deprecating entities.

Function Documentation

◆ async_check_create_deprecated()

bool homeassistant.components.tplink.deprecate.async_check_create_deprecated ( HomeAssistant  hass,
str  unique_id,
TPLinkFeatureEntityDescription  entity_description 
)
Return true if the entity should be created based on the deprecated_info.

If deprecated_info is not defined will return true.
If entity not yet created will return false.
If entity disabled will return false.

Definition at line 30 of file deprecate.py.

◆ async_cleanup_deprecated()

None homeassistant.components.tplink.deprecate.async_cleanup_deprecated ( HomeAssistant  hass,
str  platform,
str  entry_id,
Sequence[CoordinatedTPLinkFeatureEntity entities 
)
Remove disabled deprecated entities or create issues if necessary.

Definition at line 61 of file deprecate.py.