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

Public Member Functions

None __init__ (self, ConfigEntry conf, Twinkly client, device_info, str|None software_version=None)
 
None async_added_to_hass (self)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None async_update (self)
 
None async_update_current_movie (self)
 
None async_update_movies (self)
 
DeviceInfo|None device_info (self)
 
str|None effect (self)
 
list[streffect_list (self)
 
- 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)
 
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_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)
 
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)
 

Private Attributes

 _attr_available
 
 _attr_brightness
 
 _attr_color_mode
 
 _attr_is_on
 
 _attr_rgb_color
 
 _attr_rgbw_color
 
 _attr_supported_color_modes
 
 _attr_supported_features
 
 _client
 
 _conf
 
 _current_movie
 
 _model
 
 _movies
 
 _name
 
 _software_version
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 
string _attr_translation_key = "light"
 

Additional Inherited Members

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

Detailed Description

Implementation of the light for the Twinkly service.

Definition at line 65 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.twinkly.light.TwinklyLight.__init__ (   self,
ConfigEntry  conf,
Twinkly  client,
  device_info,
str | None   software_version = None 
)
Initialize a TwinklyLight entity.

Definition at line 72 of file light.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.twinkly.light.TwinklyLight.async_added_to_hass (   self)
Device is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 135 of file light.py.

◆ async_turn_off()

None homeassistant.components.twinkly.light.TwinklyLight.async_turn_off (   self,
**Any  kwargs 
)
Turn device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 223 of file light.py.

◆ async_turn_on()

None homeassistant.components.twinkly.light.TwinklyLight.async_turn_on (   self,
**Any  kwargs 
)
Turn device on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 153 of file light.py.

◆ async_update()

None homeassistant.components.twinkly.light.TwinklyLight.async_update (   self)
Asynchronously updates the device properties.

Definition at line 227 of file light.py.

◆ async_update_current_movie()

None homeassistant.components.twinkly.light.TwinklyLight.async_update_current_movie (   self)
Update the current active movie.

Definition at line 304 of file light.py.

◆ async_update_movies()

None homeassistant.components.twinkly.light.TwinklyLight.async_update_movies (   self)
Update the list of movies (effects).

Definition at line 297 of file light.py.

◆ device_info()

DeviceInfo | None homeassistant.components.twinkly.light.TwinklyLight.device_info (   self)
Get device specific attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 113 of file light.py.

◆ effect()

str | None homeassistant.components.twinkly.light.TwinklyLight.effect (   self)
Return the current effect.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 124 of file light.py.

◆ effect_list()

list[str] homeassistant.components.twinkly.light.TwinklyLight.effect_list (   self)
Return the list of saved effects.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 131 of file light.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.twinkly.light.TwinklyLight._attr_available
private

Definition at line 105 of file light.py.

◆ _attr_brightness

homeassistant.components.twinkly.light.TwinklyLight._attr_brightness
private

Definition at line 239 of file light.py.

◆ _attr_color_mode

homeassistant.components.twinkly.light.TwinklyLight._attr_color_mode
private

Definition at line 85 of file light.py.

◆ _attr_has_entity_name

bool homeassistant.components.twinkly.light.TwinklyLight._attr_has_entity_name = True
staticprivate

Definition at line 68 of file light.py.

◆ _attr_is_on

homeassistant.components.twinkly.light.TwinklyLight._attr_is_on
private

Definition at line 104 of file light.py.

◆ _attr_name

homeassistant.components.twinkly.light.TwinklyLight._attr_name = None
staticprivate

Definition at line 69 of file light.py.

◆ _attr_rgb_color

homeassistant.components.twinkly.light.TwinklyLight._attr_rgb_color
private

Definition at line 90 of file light.py.

◆ _attr_rgbw_color

homeassistant.components.twinkly.light.TwinklyLight._attr_rgbw_color
private

Definition at line 86 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.twinkly.light.TwinklyLight._attr_supported_color_modes
private

Definition at line 84 of file light.py.

◆ _attr_supported_features

homeassistant.components.twinkly.light.TwinklyLight._attr_supported_features
private

Definition at line 110 of file light.py.

◆ _attr_translation_key

string homeassistant.components.twinkly.light.TwinklyLight._attr_translation_key = "light"
staticprivate

Definition at line 70 of file light.py.

◆ _client

homeassistant.components.twinkly.light.TwinklyLight._client
private

Definition at line 101 of file light.py.

◆ _conf

homeassistant.components.twinkly.light.TwinklyLight._conf
private

Definition at line 81 of file light.py.

◆ _current_movie

homeassistant.components.twinkly.light.TwinklyLight._current_movie
private

Definition at line 309 of file light.py.

◆ _model

homeassistant.components.twinkly.light.TwinklyLight._model
private

Definition at line 99 of file light.py.

◆ _movies

homeassistant.components.twinkly.light.TwinklyLight._movies
private

Definition at line 302 of file light.py.

◆ _name

homeassistant.components.twinkly.light.TwinklyLight._name
private

Definition at line 98 of file light.py.

◆ _software_version

homeassistant.components.twinkly.light.TwinklyLight._software_version
private

Definition at line 108 of file light.py.


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