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

Public Member Functions

None __init__ (self, LIFXUpdateCoordinator coordinator, LIFXManager manager, ConfigEntry entry)
 
None async_added_to_hass (self)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None async_will_remove_from_hass (self)
 
int brightness (self)
 
int|None color_temp_kelvin (self)
 
None default_effect (self, **Any kwargs)
 
str|None effect (self)
 
None get_color (self)
 
bool is_on (self)
 
None set_color (self, list[float|int|None] hsbk, dict[str, Any] kwargs, int duration=0)
 
None set_hev_cycle_state (self, bool power, int|None duration=None)
 
None set_power (self, bool pwr, int duration=0)
 
None set_state (self, **Any kwargs)
 
None update_during_transition (self, int when)
 
- Public Member Functions inherited from homeassistant.components.lifx.entity.LIFXEntity
None __init__ (self, LIFXUpdateCoordinator coordinator)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.lifx.coordinator.LIFXUpdateCoordinator
None __init__ (self, HomeAssistant hass, LIFXConnection connection, str title)
 
None async_apply_theme (self, str theme_name)
 
Callable[[], None] async_enable_rssi_updates (self)
 
int async_get_active_effect (self)
 
None async_get_color (self)
 
None async_get_color_zones (self)
 
str|None async_get_entity_id (self, Platform platform, str key)
 
None async_get_extended_color_zones (self)
 
bool|None async_get_hev_cycle_state (self)
 
None async_identify_bulb (self)
 
None async_set_color (self, list[float|int|None] hsbk, int|None duration)
 
None async_set_color_zones (self, int start_index, int end_index, list[float|int|None] hsbk, int|None duration, int apply)
 
None async_set_extended_color_zones (self, list[tuple[int|float, int|float, int|float, int|float]] colors, int|None colors_count=None, int duration=0, int apply=1)
 
None async_set_hev_cycle_state (self, bool enable, int duration=0)
 
None async_set_infrared_brightness (self, str option)
 
None async_set_matrix_effect (self, str effect, list[tuple[int, int, int, int]]|None palette=None, float|None speed=None, bool power_on=True, str|None sky_type=None, int|None cloud_saturation_min=None, int|None cloud_saturation_max=None)
 
None async_set_multizone_effect (self, str effect, float speed=3.0, str direction="RIGHT", str|None theme_name=None, bool power_on=True)
 
None async_set_power (self, bool state, int|None duration)
 
None async_set_waveform_optional (self, dict[str, Any] value, bool rapid=False)
 
None async_setup (self)
 
str|None current_infrared_brightness (self)
 
dict[str, Any] diagnostics (self)
 
int get_number_of_zones (self)
 
bool is_extended_multizone (self)
 
bool is_legacy_multizone (self)
 
bool is_matrix (self)
 
str label (self)
 
str mac_address (self)
 
int rssi (self)
 
str rssi_uom (self)
 
str serial_number (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
dict[str, Any] capability_attributes (self)
 
ColorMode|str|None color_mode (self)
 
int|None color_temp (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)
 
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_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)
 

Public Attributes

 entry
 
 mac_addr
 
 manager
 
 postponed_update
 
- Public Attributes inherited from homeassistant.components.lifx.entity.LIFXEntity
 bulb
 
- Public Attributes inherited from homeassistant.components.lifx.coordinator.LIFXUpdateCoordinator
 active_effect
 
 connection
 
 last_used_theme
 
 lock
 
- 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
 

Private Member Functions

None _cancel_postponed_update (self)
 

Private Attributes

 _attr_color_mode
 
 _attr_effect
 
 _attr_max_color_temp_kelvin
 
 _attr_min_color_temp_kelvin
 
 _attr_supported_color_modes
 
 _attr_unique_id
 

Static Private Attributes

 _attr_name = None
 
 _attr_supported_features = LightEntityFeature.TRANSITION | LightEntityFeature.EFFECT
 

Additional Inherited Members

- 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

Representation of a LIFX light.

Definition at line 117 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.lifx.light.LIFXLight.__init__ (   self,
LIFXUpdateCoordinator  coordinator,
LIFXManager  manager,
ConfigEntry  entry 
)
Initialize the light.

Definition at line 123 of file light.py.

Member Function Documentation

◆ _cancel_postponed_update()

None homeassistant.components.lifx.light.LIFXLight._cancel_postponed_update (   self)
private
Cancel postponed update, if applicable.

Definition at line 334 of file light.py.

◆ async_added_to_hass()

None homeassistant.components.lifx.light.LIFXLight.async_added_to_hass (   self)
Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 327 of file light.py.

◆ async_turn_off()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 206 of file light.py.

◆ async_turn_on()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 202 of file light.py.

◆ async_will_remove_from_hass()

None homeassistant.components.lifx.light.LIFXLight.async_will_remove_from_hass (   self)
Run when entity will be removed from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 340 of file light.py.

◆ brightness()

int homeassistant.components.lifx.light.LIFXLight.brightness (   self)
Return the brightness of this light between 0..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 153 of file light.py.

◆ color_temp_kelvin()

int | None homeassistant.components.lifx.light.LIFXLight.color_temp_kelvin (   self)
Return the color temperature of this light in kelvin.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 159 of file light.py.

◆ default_effect()

None homeassistant.components.lifx.light.LIFXLight.default_effect (   self,
**Any  kwargs 
)
Start an effect with default parameters.

Definition at line 318 of file light.py.

◆ effect()

str | None homeassistant.components.lifx.light.LIFXLight.effect (   self)
Return the name of the currently running effect.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 169 of file light.py.

◆ get_color()

None homeassistant.components.lifx.light.LIFXLight.get_color (   self)
Send a get color message to the bulb.

Definition at line 307 of file light.py.

◆ is_on()

bool homeassistant.components.lifx.light.LIFXLight.is_on (   self)
Return true if light is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 164 of file light.py.

◆ set_color()

None homeassistant.components.lifx.light.LIFXLight.set_color (   self,
list[float | int | None hsbk,
dict[str, Any]  kwargs,
int   duration = 0 
)
Send a color change to the bulb.

Reimplemented in homeassistant.components.lifx.light.LIFXExtendedMultiZone, and homeassistant.components.lifx.light.LIFXMultiZone.

Definition at line 294 of file light.py.

◆ set_hev_cycle_state()

None homeassistant.components.lifx.light.LIFXLight.set_hev_cycle_state (   self,
bool  power,
int | None   duration = None 
)
Set the state of the HEV LEDs on a LIFX Clean bulb.

Definition at line 271 of file light.py.

◆ set_power()

None homeassistant.components.lifx.light.LIFXLight.set_power (   self,
bool  pwr,
int   duration = 0 
)
Send a power change to the bulb.

Definition at line 283 of file light.py.

◆ set_state()

None homeassistant.components.lifx.light.LIFXLight.set_state (   self,
**Any  kwargs 
)
Set a color on the light and turn it on/off.

Definition at line 210 of file light.py.

◆ update_during_transition()

None homeassistant.components.lifx.light.LIFXLight.update_during_transition (   self,
int  when 
)
Update state at the start and end of a transition.

Definition at line 177 of file light.py.

Member Data Documentation

◆ _attr_color_mode

homeassistant.components.lifx.light.LIFXLight._attr_color_mode
private

Definition at line 148 of file light.py.

◆ _attr_effect

homeassistant.components.lifx.light.LIFXLight._attr_effect
private

Definition at line 150 of file light.py.

◆ _attr_max_color_temp_kelvin

homeassistant.components.lifx.light.LIFXLight._attr_max_color_temp_kelvin
private

Definition at line 142 of file light.py.

◆ _attr_min_color_temp_kelvin

homeassistant.components.lifx.light.LIFXLight._attr_min_color_temp_kelvin
private

Definition at line 141 of file light.py.

◆ _attr_name

homeassistant.components.lifx.light.LIFXLight._attr_name = None
staticprivate

Definition at line 121 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.lifx.light.LIFXLight._attr_supported_color_modes
private

Definition at line 149 of file light.py.

◆ _attr_supported_features

homeassistant.components.lifx.light.LIFXLight._attr_supported_features = LightEntityFeature.TRANSITION | LightEntityFeature.EFFECT
staticprivate

Definition at line 120 of file light.py.

◆ _attr_unique_id

homeassistant.components.lifx.light.LIFXLight._attr_unique_id
private

Definition at line 140 of file light.py.

◆ entry

homeassistant.components.lifx.light.LIFXLight.entry

Definition at line 139 of file light.py.

◆ mac_addr

homeassistant.components.lifx.light.LIFXLight.mac_addr

Definition at line 132 of file light.py.

◆ manager

homeassistant.components.lifx.light.LIFXLight.manager

Definition at line 134 of file light.py.

◆ postponed_update

homeassistant.components.lifx.light.LIFXLight.postponed_update

Definition at line 196 of file light.py.


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