This class represents the communication layer between the front-end MQTT layer and the hardware output layer. More...

#include <light_state.h>

Inheritance diagram for esphome::light::LightState:

Public Member Functions
	LightState (LightOutput *output)

LightTraits	get_traits ()

LightCall	turn_on ()
	Make a light state call.

LightCall	turn_off ()

LightCall	toggle ()

const LightColorValues &	get_reported_values () const
	The values reported to the frontend: current_values while a light publishes intermediate states on an interval, otherwise remote_values.

bool	is_transitioning () const
	True from the call that starts a transition or flash until it reaches its target.

bool	called_since_clear () const
	True once a call is performed after clear_called(), so an output can tell whether a call came after something it noted.

void	clear_called ()

LightCall	make_call ()

bool	set_external_state (const LightColorValues &values)
	Take over the state of a light mirrored from elsewhere: current and target values at once, published but not written or saved; a running effect stops.

void	setup () override
	Load state from preferences.

void	dump_config () override

void	loop () override

float	get_setup_priority () const override
	Shortly after HARDWARE.

void	publish_state ()
	Publish the currently active state to the frontend.

LightOutput *	get_output () const
	Get the light output associated with this object.

StringRef	get_effect_name ()
	Return the name of the current effect, or if no effect is active "None".

void	add_remote_values_listener (LightRemoteValuesListener *listener)
	Add a listener for remote values changes.

void	add_target_state_reached_listener (LightTargetStateReachedListener *listener)
	Add a listener for target state reached.

void	set_default_transition_length (uint32_t default_transition_length)
	Set the default transition length, i.e. the transition length when no transition is provided.

uint32_t	get_default_transition_length () const

void	set_flash_transition_length (uint32_t flash_transition_length)
	Set the flash transition length; only compiled in when a light configures one.

uint32_t	get_flash_transition_length () const

	ESPDEPRECATED ("set_flash_transition_length() does nothing unless flash_transition_length is set in YAML. Removed in " "2027.4.0", "2026.10.0") void set_flash_transition_length(uint32_t flash_transition_length)

uint32_t	get_flash_transition_length () const

	ESPDEPRECATED ("set_gamma_correct() does nothing; gamma is fixed at build time by gamma_correct in YAML. Removed in " "2027.4.0", "2026.10.0") void set_gamma_correct(float gamma_correct)

float	get_gamma_correct () const
	The gamma correction factor, read from the entry after the gamma lookup table; 0 without one.

void	set_transition_state_publish_interval (uint32_t transition_state_publish_interval)

uint32_t	get_transition_state_publish_interval () const

void	set_gamma_table (const GammaTable *table)
	Set the pre-computed PROGMEM gamma curve.

const uint16_t *	get_gamma_table () const
	Get the forward gamma lookup table, 256 PROGMEM entries.

float	gamma_correct_lut (float value) const
	Apply gamma correction using the pre-computed forward LUT.

float	gamma_uncorrect_lut (float value) const
	Reverse gamma correction by binary-searching the forward LUT.

float	gamma_correct_lut (float value) const
	No gamma LUT — passthrough.

float	gamma_uncorrect_lut (float value) const

void	set_state_callback (void(*callback)(LightStateRTCState &, bool restored))
	Set the callback that resolves the boot-time state, called once during setup then cleared.

void	set_save_enabled (bool save_enabled)
	Set whether this light persists its state to preferences at all.

void	set_resume_effect (bool resume_effect)
	Set whether a plain turn-on restores the effect that was active when the light was turned off.

bool	supports_effects () const
	Return whether the light has any effects that meet the trait requirements.

const ConstVector< LightEffect * > &	get_effects () const
	Get all effects for this light state.

void	add_effects (LightEffect const effects, size_t count)
	Codegen only: point at the generated table of this light's effects, which must outlive it.

size_t	get_effect_count () const
	Get the total number of effects available for this light.

uint32_t	get_current_effect_index () const
	Get the currently active effect index (0 = no effect, 1+ = effect index).

uint32_t	get_effect_index (const std::string &effect_name) const
	Get effect index by name. Returns 0 if effect not found.

uint32_t	get_effect_index (const char *name, size_t len) const
	Get effect index by name (const char* overload, avoids std::string construction).

LightEffect *	get_effect_by_index (uint32_t index) const
	Get effect by index. Returns nullptr if index is invalid.

std::string	get_effect_name_by_index (uint32_t index) const
	Get effect name by index. Returns "None" for index 0, empty string for invalid index.

void	current_values_as_binary (bool *binary)
	The result of all the current_values_as_* methods have gamma correction applied.

void	current_values_as_brightness (float *brightness)

void	current_values_as_rgb (float red, float green, float *blue)

void	current_values_as_rgbw (float red, float green, float blue, float white)

void	current_values_as_rgbww (float red, float green, float blue, float cold_white, float *warm_white, bool constant_brightness=false)

void	current_values_as_rgbct (float red, float green, float blue, float color_temperature, float *white_brightness)

void	current_values_as_cwww (float cold_white, float warm_white, bool constant_brightness=false)

void	current_values_as_ct (float color_temperature, float white_brightness)

bool	is_transformer_active () const
	Indicator if a transformer (e.g.

Public Member Functions inherited from esphome::EntityBase
	ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const
	The name is in flash here; the first call makes a RAM copy that is kept for the life of the device.

StringRef	get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE > buffer) const
	Get the name of this Entity, copied out of flash into buffer.

	ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const

const StringRef &	get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE >) const

bool	name_equals (const StringRef &other) const

const ProgmemStringRef &	get_name_progmem () const
	The name as stored, for consumers that read flash themselves (e.g. API progmem fields).

size_t	write_name_to (char *buf, size_t buf_size) const
	Copy the name into buf (null terminated), returns its length.

const LogString *	get_log_name () const
	Get the name for a "%s" log argument (LOG_STR_ARG).

bool	has_own_name () const

uint32_t	get_object_id_hash () const

StringRef	get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
	Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.

size_t	write_object_id_to (char *buf, size_t buf_size) const
	Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

EntityCategory	get_entity_category () const

const char *	get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const

ProgmemStringRef	get_device_class_progmem () const
	The device class as stored (in flash on ESP8266), for consumers that read flash themselves.

StringRef	get_unit_of_measurement_ref () const

const char *	get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const

ProgmemStringRef	get_icon_progmem () const
	The icon as stored (in flash on ESP8266), for consumers that read flash themselves.

uint32_t	get_device_id () const

Device *	get_device () const

bool	has_state () const

void	set_has_state (bool state)

	ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
	Get a unique hash for storing preferences/settings for this entity.

template<typename T >
ESPPreferenceObject	make_entity_preference (uint32_t version=0)
	Create a preference object for storing this entity's state/settings.

template<typename T >
ESPPreferenceObject	make_entity_preference (uint32_t version, bool in_flash)
	As make_entity_preference(), stored in flash or RTC memory where the backend supports the choice.

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

bool	status_comm_result (bool ok)
	Clears the warning when `ok`, else sets it with `message` (default "Communication failed"); returns `ok`.

bool	status_comm_result (bool ok, const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

	ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name

void	status_momentary_warning (uint32_t length=5000)
	Set warning status flag and clear it after `length` ms.

void	status_momentary_warning (const LogString *message, uint32_t length=5000)

	ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name

void	status_momentary_error (uint32_t length=5000)
	Set error status flag and clear it after `length` ms.

void	status_momentary_error (const LogString *message, uint32_t length=5000)

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Data Fields
LightColorValues	current_values
	The current values of the light as outputted to the light.

LightColorValues	remote_values
	The remote color values reported to the frontend.

Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Protected Member Functions
void	apply_effect_and_transformer_ ()

void	write_if_pending_ ()

void	start_effect_ (uint32_t effect_index)
	Internal method to start an effect with the given index.

LightEffect *	get_active_effect_ ()
	Internal method to get the currently active effect.

void	stop_effect_ ()
	Internal method to stop the current effect (if one is active).

void	start_transition_ (const LightColorValues &target, uint32_t length, bool set_remote_values)
	Internal method to start a transition to the target color with the given length.

void	start_flash_ (const LightColorValues &target, uint32_t length, bool set_remote_values)
	Internal method to start a flash for the specified amount of time.

void	set_immediately_ (const LightColorValues &target, bool set_remote_values)
	Internal method to set the color values to target immediately (with no transition).

void	set_transformer_remote_values_ (const LightColorValues &target, bool set_remote_values)
	Point remote_values at the new transformer's target and, when this light publishes intermediate states on an interval, start the interval clock.

void	set_transformer_remote_values_ (const LightColorValues &target, bool set_remote_values)

void	save_remote_values_ ()
	Internal method to save the current remote_values to the preferences.

void	disable_loop_if_idle_ ()
	Disable loop if neither transformer nor effect is active.

void	schedule_write_ ()
	Schedule a write to the light output and enable the loop to process it.

Protected Member Functions inherited from esphome::EntityBase
friend	void::setup ()

friend	void::original_setup ()

void	configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields)
	Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.

void	set_device_ (Device *device)

ESPPreferenceObject	make_entity_preference_ (size_t size, uint32_t version)
	Non-template helpers for make_entity_preference() to avoid code bloat.

ESPPreferenceObject	make_entity_preference_ (size_t size, uint32_t version, bool in_flash)

uint32_t	entity_preference_key_ (uint32_t version)
	Key for both helpers; preference hash migration goes here.

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

bool	set_error_flag_ (const LogString *message)
	Set the error flag and log it; true when it was not set before.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
friend	LightOutput

friend	LightCall

LightOutput *	output_
	Store the output to allow effects to have more access.

std::unique_ptr< LightTransformer >	transformer_ {nullptr}
	The currently active transformer for this light (transition/flash).

ConstVector< LightEffect * >	effects_
	List of effects for this light.

ESPPreferenceObject	rtc_
	Object used to store the persisted values of the light.

std::unique_ptr< std::vector< LightRemoteValuesListener * > >	remote_values_listeners_
	Listeners for remote values changes.

std::unique_ptr< std::vector< LightTargetStateReachedListener * > >	target_state_reached_listeners_
	Listeners for target state reached.

void(*	state_callback_ )(LightStateRTCState &, bool restored)
	Callback that resolves the boot-time state — called once during setup, then cleared.

uint32_t	default_transition_length_ {}
	Default transition length for all transitions in ms.

uint32_t	flash_transition_length_ {}
	Transition length to use for flash transitions.

uint32_t	transition_state_publish_interval_ {0}

uint32_t	last_transition_state_publish_ {0}

const GammaTable *	gamma_table_ {nullptr}

uint16_t	active_effect_index_ {}
	1-based index of the active effect, 0 if none; codegen caps effects at MAX_EFFECTS in effects.py

uint16_t	previous_effect_index_ {0}
	The effect index that was active when the light was last turned off; shares the active index's word.

bool	next_write_ {true}
	Whether the light value should be written in the next cycle.

bool	is_transformer_active_: 1 {false}

bool	called_: 1 {false}

bool	save_enabled_: 1 {false}
	Whether this light persists its state to preferences at all.

bool	transition_publish_enabled_: 1 {false}
	True while the active transformer publishes current_values on an interval from loop().

bool	resume_effect_: 1 {false}
	Whether a plain turn-on restores the effect that was active when the light was turned off.

Protected Attributes inherited from esphome::EntityBase
ProgmemStringRef	name_

uint32_t	object_id_hash_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

uint8_t	device_class_idx_ {}

uint8_t	uom_idx_ {}

uint8_t	icon_idx_ {}

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Detailed Description

This class represents the communication layer between the front-end MQTT layer and the hardware output layer.

Definition at line 68 of file light_state.h.

Constructor & Destructor Documentation

◆ LightState()

esphome::light::LightState::LightState ( LightOutput * output )

Definition at line 30 of file light_state.cpp.

Member Function Documentation

◆ add_effects()

void esphome::light::LightState::add_effects	(	LightEffect const	effects,
		size_t	count )

inline

Codegen only: point at the generated table of this light's effects, which must outlive it.

Codegen caps the count at 65535, so an effect index always fits the uint16_t active index.

Definition at line 234 of file light_state.h.

◆ add_remote_values_listener()

void esphome::light::LightState::add_remote_values_listener ( LightRemoteValuesListener * listener )

Add a listener for remote values changes.

Listener is notified when the light's remote values change (state, brightness, color, etc.) Lazily allocates the listener vector on first registration.

Definition at line 237 of file light_state.cpp.

◆ add_target_state_reached_listener()

void esphome::light::LightState::add_target_state_reached_listener ( LightTargetStateReachedListener * listener )

Add a listener for target state reached.

Listener is notified when the light finishes a transition and reaches its target state. Lazily allocates the listener vector on first registration.

Definition at line 243 of file light_state.cpp.

◆ apply_effect_and_transformer_()

void esphome::light::LightState::apply_effect_and_transformer_ ( )

protected

Definition at line 132 of file light_state.cpp.

◆ called_since_clear()

bool esphome::light::LightState::called_since_clear ( ) const

inline

True once a call is performed after clear_called(), so an output can tell whether a call came after something it noted.

Every call that changes the light reaches update_state() within a loop pass.

Definition at line 96 of file light_state.h.

◆ clear_called()

void esphome::light::LightState::clear_called ( )

inline

Definition at line 97 of file light_state.h.

◆ current_values_as_binary()

void esphome::light::LightState::current_values_as_binary ( bool * binary )

inline

The result of all the current_values_as_* methods have gamma correction applied.

Definition at line 291 of file light_state.h.

◆ current_values_as_brightness()

void esphome::light::LightState::current_values_as_brightness ( float * brightness )

Definition at line 250 of file light_state.cpp.

◆ current_values_as_ct()

void esphome::light::LightState::current_values_as_ct	(	float *	color_temperature,
		float *	white_brightness )

Definition at line 326 of file light_state.cpp.

◆ current_values_as_cwww()

void esphome::light::LightState::current_values_as_cwww	(	float *	cold_white,
		float *	warm_white,
		bool	constant_brightness = false )

Definition at line 285 of file light_state.cpp.

◆ current_values_as_rgb()

void esphome::light::LightState::current_values_as_rgb	(	float *	red,
		float *	green,
		float *	blue )

Definition at line 254 of file light_state.cpp.

◆ current_values_as_rgbct()

void esphome::light::LightState::current_values_as_rgbct	(	float *	red,
		float *	green,
		float *	blue,
		float *	color_temperature,
		float *	white_brightness )

Definition at line 275 of file light_state.cpp.

◆ current_values_as_rgbw()

void esphome::light::LightState::current_values_as_rgbw	(	float *	red,
		float *	green,
		float *	blue,
		float *	white )

Definition at line 260 of file light_state.cpp.

◆ current_values_as_rgbww()

void esphome::light::LightState::current_values_as_rgbww	(	float *	red,
		float *	green,
		float *	blue,
		float *	cold_white,
		float *	warm_white,
		bool	constant_brightness = false )

Definition at line 267 of file light_state.cpp.

◆ disable_loop_if_idle_()

void esphome::light::LightState::disable_loop_if_idle_ ( )

protected

Disable loop if neither transformer nor effect is active.

Definition at line 442 of file light_state.cpp.

◆ dump_config()

void esphome::light::LightState::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 97 of file light_state.cpp.

◆ ESPDEPRECATED() [1/2]

esphome::light::LightState::ESPDEPRECATED	(	"set_flash_transition_length() does nothing unless flash_transition_length is set in YAML. Removed in " "2027.4.0"	,
		"2026.10.0"	)

inline

Definition at line 173 of file light_state.h.

◆ ESPDEPRECATED() [2/2]

esphome::light::LightState::ESPDEPRECATED	(	"set_gamma_correct() does nothing; gamma is fixed at build time by gamma_correct in YAML. Removed in " "2027.4.0"	,
		"2026.10.0"	)

inline

Definition at line 181 of file light_state.h.

◆ gamma_correct_lut() [1/2]

float esphome::light::LightState::gamma_correct_lut ( float value ) const

Apply gamma correction using the pre-computed forward LUT.

Definition at line 341 of file light_state.cpp.

◆ gamma_correct_lut() [2/2]

float esphome::light::LightState::gamma_correct_lut ( float value ) const

inline

No gamma LUT — passthrough.

Definition at line 208 of file light_state.h.

◆ gamma_uncorrect_lut() [1/2]

float esphome::light::LightState::gamma_uncorrect_lut ( float value ) const

Reverse gamma correction by binary-searching the forward LUT.

Definition at line 357 of file light_state.cpp.

◆ gamma_uncorrect_lut() [2/2]

float esphome::light::LightState::gamma_uncorrect_lut ( float value ) const

inline

Definition at line 209 of file light_state.h.

◆ get_active_effect_()

LightEffect * esphome::light::LightState::get_active_effect_ ( )

protected

Internal method to get the currently active effect.

Definition at line 389 of file light_state.cpp.

◆ get_current_effect_index()

uint32_t esphome::light::LightState::get_current_effect_index ( ) const

inline

Get the currently active effect index (0 = no effect, 1+ = effect index).

Definition at line 242 of file light_state.h.

◆ get_default_transition_length()

uint32_t esphome::light::LightState::get_default_transition_length ( ) const

inline

Definition at line 163 of file light_state.h.

◆ get_effect_by_index()

LightEffect * esphome::light::LightState::get_effect_by_index ( uint32_t index ) const

inline

Get effect by index. Returns nullptr if index is invalid.

Definition at line 272 of file light_state.h.

◆ get_effect_count()

size_t esphome::light::LightState::get_effect_count ( ) const

inline

Get the total number of effects available for this light.

Definition at line 239 of file light_state.h.

◆ get_effect_index() [1/2]

uint32_t esphome::light::LightState::get_effect_index	(	const char *	name,
		size_t	len ) const

inline

Get effect index by name (const char* overload, avoids std::string construction).

Definition at line 258 of file light_state.h.

◆ get_effect_index() [2/2]

uint32_t esphome::light::LightState::get_effect_index ( const std::string & effect_name ) const

inline

Get effect index by name. Returns 0 if effect not found.

Definition at line 245 of file light_state.h.

◆ get_effect_name()

StringRef esphome::light::LightState::get_effect_name ( )

Return the name of the current effect, or if no effect is active "None".

Definition at line 230 of file light_state.cpp.

◆ get_effect_name_by_index()

std::string esphome::light::LightState::get_effect_name_by_index ( uint32_t index ) const

inline

Get effect name by index. Returns "None" for index 0, empty string for invalid index.

Definition at line 280 of file light_state.h.

◆ get_effects()

const ConstVector< LightEffect * > & esphome::light::LightState::get_effects ( ) const

inline

Get all effects for this light state.

Definition at line 230 of file light_state.h.

◆ get_flash_transition_length() [1/2]

uint32_t esphome::light::LightState::get_flash_transition_length ( ) const

inline

Definition at line 170 of file light_state.h.

◆ get_flash_transition_length() [2/2]

uint32_t esphome::light::LightState::get_flash_transition_length ( ) const

inline

Definition at line 177 of file light_state.h.

◆ get_gamma_correct()

float esphome::light::LightState::get_gamma_correct ( ) const

The gamma correction factor, read from the entry after the gamma lookup table; 0 without one.

Definition at line 332 of file light_state.cpp.

◆ get_gamma_table()

const uint16_t * esphome::light::LightState::get_gamma_table ( ) const

inline

Get the forward gamma lookup table, 256 PROGMEM entries.

Definition at line 200 of file light_state.h.

◆ get_output()

LightOutput * esphome::light::LightState::get_output ( ) const

Get the light output associated with this object.

Definition at line 228 of file light_state.cpp.

◆ get_reported_values()

const LightColorValues & esphome::light::LightState::get_reported_values ( ) const

inline

The values reported to the frontend: current_values while a light publishes intermediate states on an interval, otherwise remote_values.

Each interval sample is a publish_state(), so on_state automations run on every sample as well.

Definition at line 82 of file light_state.h.

◆ get_setup_priority()

float esphome::light::LightState::get_setup_priority ( ) const

inlineoverridevirtual

Shortly after HARDWARE.

Reimplemented from esphome::Component.

Definition at line 112 of file light_state.h.

◆ get_traits()

LightTraits esphome::light::LightState::get_traits ( )

Definition at line 32 of file light_state.cpp.

◆ get_transition_state_publish_interval()

uint32_t esphome::light::LightState::get_transition_state_publish_interval ( ) const

inline

Definition at line 192 of file light_state.h.

◆ is_transformer_active()

bool esphome::light::LightState::is_transformer_active ( ) const

inline

Indicator if a transformer (e.g.

transition) is active. This is useful for effects e.g. at the start of the apply() method, add a check like:

if (this->state_->is_transformer_active()) { // Something is already running. return; }

Definition at line 318 of file light_state.h.

◆ is_transitioning()

bool esphome::light::LightState::is_transitioning ( ) const

inline

True from the call that starts a transition or flash until it reaches its target.

Definition at line 92 of file light_state.h.

◆ loop()

void esphome::light::LightState::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 127 of file light_state.cpp.

◆ make_call()

LightCall esphome::light::LightState::make_call ( )

Definition at line 36 of file light_state.cpp.

◆ publish_state()

void esphome::light::LightState::publish_state ( )

Publish the currently active state to the frontend.

Definition at line 217 of file light_state.cpp.

◆ save_remote_values_()

void esphome::light::LightState::save_remote_values_ ( )

protected

Internal method to save the current remote_values to the preferences.

Definition at line 461 of file light_state.cpp.

◆ schedule_write_()

void esphome::light::LightState::schedule_write_ ( )

inlineprotected

Schedule a write to the light output and enable the loop to process it.

Definition at line 363 of file light_state.h.

◆ set_default_transition_length()

void esphome::light::LightState::set_default_transition_length ( uint32_t default_transition_length )

inline

Set the default transition length, i.e. the transition length when no transition is provided.

Definition at line 160 of file light_state.h.

◆ set_external_state()

bool esphome::light::LightState::set_external_state ( const LightColorValues & values )

Take over the state of a light mirrored from elsewhere: current and target values at once, published but not written or saved; a running effect stops.

False while a write is pending or a transition or flash runs.

Definition at line 194 of file light_state.cpp.

◆ set_flash_transition_length()

void esphome::light::LightState::set_flash_transition_length ( uint32_t flash_transition_length )

inline

Set the flash transition length; only compiled in when a light configures one.

Definition at line 167 of file light_state.h.

◆ set_gamma_table()

void esphome::light::LightState::set_gamma_table ( const GammaTable * table )

inline

Set the pre-computed PROGMEM gamma curve.

Definition at line 197 of file light_state.h.

◆ set_immediately_()

void esphome::light::LightState::set_immediately_	(	const LightColorValues &	target,
		bool	set_remote_values )

protected

Internal method to set the color values to target immediately (with no transition).

Definition at line 428 of file light_state.cpp.

◆ set_resume_effect()

void esphome::light::LightState::set_resume_effect ( bool resume_effect )

inline

Set whether a plain turn-on restores the effect that was active when the light was turned off.

Definition at line 223 of file light_state.h.

◆ set_save_enabled()

void esphome::light::LightState::set_save_enabled ( bool save_enabled )

inline

Set whether this light persists its state to preferences at all.

Definition at line 219 of file light_state.h.

◆ set_state_callback()

void esphome::light::LightState::set_state_callback ( void(* callback )(LightStateRTCState &, bool restored) )

inline

Set the callback that resolves the boot-time state, called once during setup then cleared.

restored is true only when a persisted state actually loaded, in which case the state argument already holds the loaded values; otherwise it is freshly default-constructed. Values live in flash as code.

Definition at line 216 of file light_state.h.

◆ set_transformer_remote_values_() [1/2]

void esphome::light::LightState::set_transformer_remote_values_	(	const LightColorValues &	target,
		bool	set_remote_values )

protected

Point remote_values at the new transformer's target and, when this light publishes intermediate states on an interval, start the interval clock.

Definition at line 450 of file light_state.cpp.

◆ set_transformer_remote_values_() [2/2]

void esphome::light::LightState::set_transformer_remote_values_	(	const LightColorValues &	target,
		bool	set_remote_values )

inlineprotected

Definition at line 349 of file light_state.h.

◆ set_transition_state_publish_interval()

void esphome::light::LightState::set_transition_state_publish_interval ( uint32_t transition_state_publish_interval )

inline

Definition at line 189 of file light_state.h.

◆ setup()

void esphome::light::LightState::setup ( )

overridevirtual

Load state from preferences.

Reimplemented from esphome::Component.

Definition at line 38 of file light_state.cpp.

◆ start_effect_()

void esphome::light::LightState::start_effect_ ( uint32_t effect_index )

protected

Internal method to start an effect with the given index.

Definition at line 378 of file light_state.cpp.

◆ start_flash_()

void esphome::light::LightState::start_flash_	(	const LightColorValues &	target,
		uint32_t	length,
		bool	set_remote_values )

protected

Internal method to start a flash for the specified amount of time.

Definition at line 414 of file light_state.cpp.

◆ start_transition_()

void esphome::light::LightState::start_transition_	(	const LightColorValues &	target,
		uint32_t	length,
		bool	set_remote_values )

protected

Internal method to start a transition to the target color with the given length.

Definition at line 406 of file light_state.cpp.

◆ stop_effect_()

void esphome::light::LightState::stop_effect_ ( )

protected

Internal method to stop the current effect (if one is active).

Definition at line 396 of file light_state.cpp.

◆ supports_effects()

bool esphome::light::LightState::supports_effects ( ) const

inline

Return whether the light has any effects that meet the trait requirements.

Definition at line 227 of file light_state.h.

◆ toggle()

LightCall esphome::light::LightState::toggle ( )

Definition at line 35 of file light_state.cpp.

◆ turn_off()

LightCall esphome::light::LightState::turn_off ( )

Definition at line 34 of file light_state.cpp.

◆ turn_on()

LightCall esphome::light::LightState::turn_on ( )

Make a light state call.

Definition at line 33 of file light_state.cpp.

◆ write_if_pending_()

void esphome::light::LightState::write_if_pending_ ( )

protected

Definition at line 185 of file light_state.cpp.

Field Documentation

◆ active_effect_index_

uint16_t esphome::light::LightState::active_effect_index_ {}

protected

1-based index of the active effect, 0 if none; codegen caps effects at MAX_EFFECTS in effects.py

Definition at line 415 of file light_state.h.

◆ called_

bool esphome::light::LightState::called_

protected

Definition at line 424 of file light_state.h.

◆ current_values

LightColorValues esphome::light::LightState::current_values

The current values of the light as outputted to the light.

These values represent the "real" state of the light - During transitions this property will be changed continuously (in contrast to .remote_values, where they are constant during transitions).

This value does not have gamma correction applied.

This property is read-only for users. Any changes to it will be ignored.

Definition at line 124 of file light_state.h.

◆ default_transition_length_

uint32_t esphome::light::LightState::default_transition_length_ {}

protected

Default transition length for all transitions in ms.

Definition at line 401 of file light_state.h.

◆ effects_

ConstVector<LightEffect *> esphome::light::LightState::effects_

protected

List of effects for this light.

Definition at line 373 of file light_state.h.

◆ flash_transition_length_

uint32_t esphome::light::LightState::flash_transition_length_ {}

protected

Transition length to use for flash transitions.

Definition at line 404 of file light_state.h.

◆ gamma_table_

const GammaTable* esphome::light::LightState::gamma_table_ {nullptr}

protected

Definition at line 411 of file light_state.h.

◆ is_transformer_active_

bool esphome::light::LightState::is_transformer_active_

protected

Definition at line 423 of file light_state.h.

◆ last_transition_state_publish_

uint32_t esphome::light::LightState::last_transition_state_publish_ {0}

protected

Definition at line 408 of file light_state.h.

◆ LightCall

friend esphome::light::LightState::LightCall

protected

Definition at line 325 of file light_state.h.

◆ LightOutput

friend esphome::light::LightState::LightOutput

protected

Definition at line 324 of file light_state.h.

◆ next_write_

bool esphome::light::LightState::next_write_ {true}

protected

Whether the light value should be written in the next cycle.

Definition at line 421 of file light_state.h.

◆ output_

LightOutput* esphome::light::LightState::output_

protected

Store the output to allow effects to have more access.

Definition at line 369 of file light_state.h.

◆ previous_effect_index_

uint16_t esphome::light::LightState::previous_effect_index_ {0}

protected

The effect index that was active when the light was last turned off; shares the active index's word.

Definition at line 418 of file light_state.h.

◆ remote_values

LightColorValues esphome::light::LightState::remote_values

The remote color values reported to the frontend.

These are different from the "current" values: For example transitions will continuously change the "current" values. But the remote values will immediately switch to the target value for a transition, reducing the number of packets sent.

This value does not have gamma correction applied.

This property is read-only for users. Any changes to it will be ignored.

Definition at line 136 of file light_state.h.

◆ remote_values_listeners_

std::unique_ptr<std::vector<LightRemoteValuesListener *> > esphome::light::LightState::remote_values_listeners_

protected

Listeners for remote values changes.

"Remote values" are light color values that are reported to the frontend and have a lower publish frequency than the "real" color values. For example, during transitions the current color value may change continuously, but the remote values will be reported as the target values starting with the beginning of the transition.

Lazily allocated - only created when a listener is actually registered.

Definition at line 386 of file light_state.h.

◆ resume_effect_

bool esphome::light::LightState::resume_effect_

protected

Whether a plain turn-on restores the effect that was active when the light was turned off.

Definition at line 433 of file light_state.h.

◆ rtc_

ESPPreferenceObject esphome::light::LightState::rtc_

protected

Object used to store the persisted values of the light.

Definition at line 375 of file light_state.h.

◆ save_enabled_

bool esphome::light::LightState::save_enabled_

protected

Whether this light persists its state to preferences at all.

Definition at line 426 of file light_state.h.

◆ state_callback_

void(* esphome::light::LightState::state_callback_) (LightStateRTCState &, bool restored)

inlineprotected

Callback that resolves the boot-time state — called once during setup, then cleared.

Values live in flash as function body; no per-instance data storage beyond this pointer.

Definition at line 398 of file light_state.h.

◆ target_state_reached_listeners_

std::unique_ptr<std::vector<LightTargetStateReachedListener *> > esphome::light::LightState::target_state_reached_listeners_

protected

Listeners for target state reached.

Notified when the state of current_values and remote_values are equal (when the transition is finished).

Lazily allocated - only created when a listener is actually registered.

Definition at line 394 of file light_state.h.

◆ transformer_

std::unique_ptr<LightTransformer> esphome::light::LightState::transformer_ {nullptr}

protected

The currently active transformer for this light (transition/flash).

Definition at line 371 of file light_state.h.

◆ transition_publish_enabled_

bool esphome::light::LightState::transition_publish_enabled_

protected

True while the active transformer publishes current_values on an interval from loop().

Definition at line 429 of file light_state.h.

◆ transition_state_publish_interval_

uint32_t esphome::light::LightState::transition_state_publish_interval_ {0}

protected

Definition at line 407 of file light_state.h.

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

esphome/components/light/light_state.h
esphome/components/light/light_state.cpp

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LightState()

Member Function Documentation

◆ add_effects()

◆ add_remote_values_listener()

◆ add_target_state_reached_listener()

◆ apply_effect_and_transformer_()

◆ called_since_clear()

◆ clear_called()

◆ current_values_as_binary()

◆ current_values_as_brightness()

◆ current_values_as_ct()

◆ current_values_as_cwww()

◆ current_values_as_rgb()

◆ current_values_as_rgbct()

◆ current_values_as_rgbw()

◆ current_values_as_rgbww()

◆ disable_loop_if_idle_()

◆ dump_config()

◆ ESPDEPRECATED() [1/2]

◆ ESPDEPRECATED() [2/2]

◆ gamma_correct_lut() [1/2]

◆ gamma_correct_lut() [2/2]

◆ gamma_uncorrect_lut() [1/2]

◆ gamma_uncorrect_lut() [2/2]

◆ get_active_effect_()

◆ get_current_effect_index()

◆ get_default_transition_length()

◆ get_effect_by_index()

◆ get_effect_count()

◆ get_effect_index() [1/2]

◆ get_effect_index() [2/2]

◆ get_effect_name()

◆ get_effect_name_by_index()

◆ get_effects()

◆ get_flash_transition_length() [1/2]

◆ get_flash_transition_length() [2/2]

◆ get_gamma_correct()

◆ get_gamma_table()

◆ get_output()

◆ get_reported_values()

◆ get_setup_priority()

◆ get_traits()

◆ get_transition_state_publish_interval()

◆ is_transformer_active()

◆ is_transitioning()

◆ loop()

◆ make_call()

◆ publish_state()

◆ save_remote_values_()

◆ schedule_write_()

◆ set_default_transition_length()

◆ set_external_state()

◆ set_flash_transition_length()

◆ set_gamma_table()

◆ set_immediately_()

◆ set_resume_effect()

◆ set_save_enabled()

◆ set_state_callback()

◆ set_transformer_remote_values_() [1/2]

◆ set_transformer_remote_values_() [2/2]

◆ set_transition_state_publish_interval()

◆ setup()

◆ start_effect_()

◆ start_flash_()

◆ start_transition_()

◆ stop_effect_()

◆ supports_effects()

◆ toggle()

◆ turn_off()

◆ turn_on()

◆ write_if_pending_()

Field Documentation

◆ active_effect_index_

◆ called_