Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tplink.light.TPLinkLightEntity Class Reference
Inheritance diagram for homeassistant.components.tplink.light.TPLinkLightEntity:
[legend]
Collaboration diagram for homeassistant.components.tplink.light.TPLinkLightEntity:
[legend]

Public Member Functions

None __init__ (self, Device device, TPLinkDataUpdateCoordinator coordinator, *Light light_module, Device|None parent=None)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
- 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.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 Member Functions inherited from homeassistant.components.light.LightEntity
int|None brightness (self)
 
dict[str, Any] capability_attributes (self)
 
ColorMode|str|None color_mode (self)
 
int|None color_temp (self)
 
int|None color_temp_kelvin (self)
 
str|None effect (self)
 
list[str]|None effect_list (self)
 
tuple[float, float]|None hs_color (self)
 
int max_color_temp_kelvin (self)
 
int max_mireds (self)
 
int min_color_temp_kelvin (self)
 
int min_mireds (self)
 
tuple[int, int, int]|None rgb_color (self)
 
tuple[int, int, int, int]|None rgbw_color (self)
 
tuple[int, int, int, int, int]|None rgbww_color (self)
 
dict[str, Any]|None state_attributes (self)
 
set[ColorMode]|set[str]|None supported_color_modes (self)
 
LightEntityFeature supported_features (self)
 
LightEntityFeature supported_features_compat (self)
 
tuple[float, float]|None xy_color (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
bool|None is_on (self)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.components.light.LightEntity
 int
 
 LightEntityFeature
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

tuple[int|None, int|None_async_extract_brightness_transition (self, **Any kwargs)
 
None _async_set_color_temp (self, float color_temp, int|None brightness, int|None transition)
 
None _async_set_hsv (self, tuple[int, int] hs_color, int|None brightness, int|None transition)
 
None _async_turn_on_with_brightness (self, int|None brightness, int|None transition)
 
None _async_update_attrs (self)
 
ColorMode _determine_color_mode (self)
 
str _get_unique_id (self)
 

Private Attributes

 _attr_brightness
 
 _attr_color_mode
 
 _attr_color_temp_kelvin
 
 _attr_hs_color
 
 _attr_is_on
 
 _attr_max_color_temp_kelvin
 
 _attr_min_color_temp_kelvin
 
 _attr_name
 
 _attr_supported_color_modes
 
 _fixed_color_mode
 
 _light_module
 
 _parent
 

Static Private Attributes

 _attr_supported_features = LightEntityFeature.TRANSITION
 

Additional Inherited Members

- 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
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Representation of a TPLink Smart Bulb.

Definition at line 183 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tplink.light.TPLinkLightEntity.__init__ (   self,
Device  device,
TPLinkDataUpdateCoordinator  coordinator,
*Light  light_module,
Device | None   parent = None 
)
Initialize the light.

Definition at line 189 of file light.py.

Member Function Documentation

◆ _async_extract_brightness_transition()

tuple[int | None, int | None] homeassistant.components.tplink.light.TPLinkLightEntity._async_extract_brightness_transition (   self,
**Any   kwargs 
)
private

Definition at line 243 of file light.py.

◆ _async_set_color_temp()

None homeassistant.components.tplink.light.TPLinkLightEntity._async_set_color_temp (   self,
float  color_temp,
int | None  brightness,
int | None   transition 
)
private

Definition at line 269 of file light.py.

◆ _async_set_hsv()

None homeassistant.components.tplink.light.TPLinkLightEntity._async_set_hsv (   self,
tuple[int, int hs_color,
int | None  brightness,
int | None   transition 
)
private

Definition at line 262 of file light.py.

◆ _async_turn_on_with_brightness()

None homeassistant.components.tplink.light.TPLinkLightEntity._async_turn_on_with_brightness (   self,
int | None  brightness,
int | None   transition 
)
private

Definition at line 289 of file light.py.

◆ _async_update_attrs()

None homeassistant.components.tplink.light.TPLinkLightEntity._async_update_attrs (   self)
private
Update the entity's attributes.

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

Reimplemented in homeassistant.components.tplink.light.TPLinkLightEffectEntity.

Definition at line 334 of file light.py.

◆ _determine_color_mode()

ColorMode homeassistant.components.tplink.light.TPLinkLightEntity._determine_color_mode (   self)
private
Return the active color mode.

Definition at line 322 of file light.py.

◆ _get_unique_id()

str homeassistant.components.tplink.light.TPLinkLightEntity._get_unique_id (   self)
private
Return unique ID for the entity.

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

Definition at line 219 of file light.py.

◆ async_turn_off()

None homeassistant.components.tplink.light.TPLinkLightEntity.async_turn_off (   self,
**Any  kwargs 
)
Turn the light off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 314 of file light.py.

◆ async_turn_on()

None homeassistant.components.tplink.light.TPLinkLightEntity.async_turn_on (   self,
**Any  kwargs 
)
Turn the light on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Reimplemented in homeassistant.components.tplink.light.TPLinkLightEffectEntity.

Definition at line 301 of file light.py.

Member Data Documentation

◆ _attr_brightness

homeassistant.components.tplink.light.TPLinkLightEntity._attr_brightness
private

Definition at line 339 of file light.py.

◆ _attr_color_mode

homeassistant.components.tplink.light.TPLinkLightEntity._attr_color_mode
private

Definition at line 341 of file light.py.

◆ _attr_color_temp_kelvin

homeassistant.components.tplink.light.TPLinkLightEntity._attr_color_temp_kelvin
private

Definition at line 343 of file light.py.

◆ _attr_hs_color

homeassistant.components.tplink.light.TPLinkLightEntity._attr_hs_color
private

Definition at line 346 of file light.py.

◆ _attr_is_on

homeassistant.components.tplink.light.TPLinkLightEntity._attr_is_on
private

Definition at line 337 of file light.py.

◆ _attr_max_color_temp_kelvin

homeassistant.components.tplink.light.TPLinkLightEntity._attr_max_color_temp_kelvin
private

Definition at line 207 of file light.py.

◆ _attr_min_color_temp_kelvin

homeassistant.components.tplink.light.TPLinkLightEntity._attr_min_color_temp_kelvin
private

Definition at line 206 of file light.py.

◆ _attr_name

homeassistant.components.tplink.light.TPLinkLightEntity._attr_name
private

Definition at line 201 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.tplink.light.TPLinkLightEntity._attr_supported_color_modes
private

Definition at line 212 of file light.py.

◆ _attr_supported_features

homeassistant.components.tplink.light.TPLinkLightEntity._attr_supported_features = LightEntityFeature.TRANSITION
staticprivate

Definition at line 186 of file light.py.

◆ _fixed_color_mode

homeassistant.components.tplink.light.TPLinkLightEntity._fixed_color_mode
private

Definition at line 215 of file light.py.

◆ _light_module

homeassistant.components.tplink.light.TPLinkLightEntity._light_module
private

Definition at line 199 of file light.py.

◆ _parent

homeassistant.components.tplink.light.TPLinkLightEntity._parent
private

Definition at line 198 of file light.py.

◆ None

homeassistant.components.tplink.light.TPLinkLightEntity.None
static

Definition at line 187 of file light.py.


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