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

Public Member Functions

None __init__ (self, FluxLedUpdateCoordinator coordinator, str base_unique_id, list[tuple[int, int, int]] custom_effect_colors, int custom_effect_speed_pct, str custom_effect_transition)
 
None async_set_custom_effect (self, list[tuple[int, int, int]] colors, int speed_pct, str transition)
 
None async_set_music_mode (self, int sensitivity, int brightness, int effect, bool light_screen, tuple[int, int, int]|None foreground_color=None, tuple[int, int, int]|None background_color=None)
 
None async_set_zones (self, list[tuple[int, int, int]] colors, int speed_pct, str effect)
 
int brightness (self)
 
str color_mode (self)
 
int color_temp (self)
 
str|None effect (self)
 
tuple[int, int, intrgb_color (self)
 
tuple[int, int, int, intrgbw_color (self)
 
tuple[int, int, int, int, intrgbww_color (self)
 
- Public Member Functions inherited from homeassistant.components.flux_led.entity.FluxOnOffEntity
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool is_on (self)
 
- Public Member Functions inherited from homeassistant.components.flux_led.entity.FluxEntity
None __init__ (self, FluxLedUpdateCoordinator coordinator, str base_unique_id, str|None key)
 
None async_added_to_hass (self)
 
dict[str, str] extra_state_attributes (self)
 
- 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.flux_led.coordinator.FluxLedUpdateCoordinator
None __init__ (self, HomeAssistant hass, AIOWifiLedBulb device, ConfigEntry entry)
 
- 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)
 
int|None color_temp_kelvin (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)
 
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)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (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)
 

Private Member Functions

int _async_brightness (self, **Any kwargs)
 
None _async_set_effect (self, str effect, int brightness)
 
None _async_set_mode (self, **Any kwargs)
 
None _async_turn_on (self, **Any kwargs)
 

Private Attributes

 _attr_effect_list
 
 _attr_max_mireds
 
 _attr_min_mireds
 
 _attr_supported_color_modes
 
 _custom_effect_colors
 
 _custom_effect_speed_pct
 
 _custom_effect_transition
 

Static Private Attributes

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

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.flux_led.coordinator.FluxLedUpdateCoordinator
 device
 
 entry
 
 force_next_update
 
 title
 
- 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
 
- 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 Flux light.

Definition at line 189 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.flux_led.light.FluxLight.__init__ (   self,
FluxLedUpdateCoordinator  coordinator,
str  base_unique_id,
list[tuple[int, int, int]]  custom_effect_colors,
int  custom_effect_speed_pct,
str  custom_effect_transition 
)
Initialize the light.

Definition at line 198 of file light.py.

Member Function Documentation

◆ _async_brightness()

int homeassistant.components.flux_led.light.FluxLight._async_brightness (   self,
**Any  kwargs 
)
private
Determine brightness from kwargs or current value.

Definition at line 287 of file light.py.

◆ _async_set_effect()

None homeassistant.components.flux_led.light.FluxLight._async_set_effect (   self,
str  effect,
int  brightness 
)
private
Set an effect.

Definition at line 269 of file light.py.

◆ _async_set_mode()

None homeassistant.components.flux_led.light.FluxLight._async_set_mode (   self,
**Any  kwargs 
)
private
Set an effect or color mode.

Definition at line 299 of file light.py.

◆ _async_turn_on()

None homeassistant.components.flux_led.light.FluxLight._async_turn_on (   self,
**Any  kwargs 
)
private
Turn the specified or all lights on.

Reimplemented from homeassistant.components.flux_led.entity.FluxOnOffEntity.

Definition at line 256 of file light.py.

◆ async_set_custom_effect()

None homeassistant.components.flux_led.light.FluxLight.async_set_custom_effect (   self,
list[tuple[int, int, int]]  colors,
int  speed_pct,
str   transition 
)
Set a custom effect on the bulb.

Definition at line 344 of file light.py.

◆ async_set_music_mode()

None homeassistant.components.flux_led.light.FluxLight.async_set_music_mode (   self,
int  sensitivity,
int  brightness,
int  effect,
bool  light_screen,
tuple[int, int, int] | None   foreground_color = None,
tuple[int, int, int] | None   background_color = None 
)
Configure music mode.

Definition at line 364 of file light.py.

◆ async_set_zones()

None homeassistant.components.flux_led.light.FluxLight.async_set_zones (   self,
list[tuple[int, int, int]]  colors,
int  speed_pct,
str   effect 
)
Set a colors for zones.

Definition at line 354 of file light.py.

◆ brightness()

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 220 of file light.py.

◆ color_mode()

str homeassistant.components.flux_led.light.FluxLight.color_mode (   self)
Return the color mode of the light.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 245 of file light.py.

◆ color_temp()

int homeassistant.components.flux_led.light.FluxLight.color_temp (   self)
Return the kelvin value of this light in mired.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 225 of file light.py.

◆ effect()

str | None homeassistant.components.flux_led.light.FluxLight.effect (   self)
Return the current effect.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 252 of file light.py.

◆ rgb_color()

tuple[int, int, int] homeassistant.components.flux_led.light.FluxLight.rgb_color (   self)
Return the rgb color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 230 of file light.py.

◆ rgbw_color()

tuple[int, int, int, int] homeassistant.components.flux_led.light.FluxLight.rgbw_color (   self)
Return the rgbw color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 235 of file light.py.

◆ rgbww_color()

tuple[int, int, int, int, int] homeassistant.components.flux_led.light.FluxLight.rgbww_color (   self)
Return the rgbww aka rgbcw color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 240 of file light.py.

Member Data Documentation

◆ _attr_effect_list

homeassistant.components.flux_led.light.FluxLight._attr_effect_list
private

Definition at line 214 of file light.py.

◆ _attr_max_mireds

homeassistant.components.flux_led.light.FluxLight._attr_max_mireds
private

Definition at line 209 of file light.py.

◆ _attr_min_mireds

homeassistant.components.flux_led.light.FluxLight._attr_min_mireds
private

Definition at line 208 of file light.py.

◆ _attr_name

homeassistant.components.flux_led.light.FluxLight._attr_name = None
staticprivate

Definition at line 194 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.flux_led.light.FluxLight._attr_supported_color_modes
private

Definition at line 210 of file light.py.

◆ _attr_supported_features

homeassistant.components.flux_led.light.FluxLight._attr_supported_features = LightEntityFeature.TRANSITION | LightEntityFeature.EFFECT
staticprivate

Definition at line 196 of file light.py.

◆ _custom_effect_colors

homeassistant.components.flux_led.light.FluxLight._custom_effect_colors
private

Definition at line 215 of file light.py.

◆ _custom_effect_speed_pct

homeassistant.components.flux_led.light.FluxLight._custom_effect_speed_pct
private

Definition at line 216 of file light.py.

◆ _custom_effect_transition

homeassistant.components.flux_led.light.FluxLight._custom_effect_transition
private

Definition at line 217 of file light.py.


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