A light in Home Assistant, driven from here: its state and attributes are imported over the native API, and every change made on this side is sent back as a light.turn_on or light.turn_off action. More...

#include <homeassistant_light.h>

Inheritance diagram for esphome::homeassistant::HomeassistantLight:

Data Structures
struct	Attributes
	What Home Assistant reported last, in its own units. More...

Public Member Functions
void	set_entity_id (const char *entity_id)

void	set_report_timeout (uint8_t seconds)
	How long a sent change may take to come back as a report before the light returns to the reported state.

void	setup () override

void	dump_config () override

float	get_setup_priority () const override

light::LightTraits	get_traits () override

void	setup_state (light::LightState *state) override

void	update_state (light::LightState *state) override

void	write_state (light::LightState *state) override

Public Member Functions inherited from esphome::light::LightOutput
virtual std::unique_ptr< LightTransformer >	create_default_transition ()
	Return the default transformer used for transitions.

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

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)

Protected Member Functions
optional< uint16_t >	parse_integer_ (const char *name, StringRef value, uint16_t max)
	Parses a Home Assistant attribute as an integer from 1 to max, logging anything else.

void	on_report_ (bool changed)
	A state or attribute report: answers a pending echo when it changed something, and schedules the apply.

template<typename T >
void	import_ (T &field, const T &value)
	Takes over a reported attribute, reporting whether it changed.

void	schedule_apply_ ()
	Schedules apply_imported_() once for the attributes of one update.

void	apply_imported_ ()

bool	is_imported_ (const Attributes &outgoing) const
	True when Home Assistant reported exactly what a change would make of it.

void	fall_back_ ()
	Returns the light to the reported state after a change that did not reach Home Assistant.

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
const char *	entity_id_ {nullptr}

light::LightState *	state_ {nullptr}

light::LightTraits	traits_ {}

Attributes	imported_ {}

bool	apply_scheduled_: 1 {false}

bool	initial_write_: 1 {true}

bool	initial_seen_: 1 {false}

bool	echo_pending_: 1 {false}

bool	report_held_: 1 {false}

bool	transitioned_: 1 {false}

uint8_t	report_timeout_s_ {10}

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_

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

Detailed Description

A light in Home Assistant, driven from here: its state and attributes are imported over the native API, and every change made on this side is sent back as a light.turn_on or light.turn_off action.

Definition at line 15 of file homeassistant_light.h.

Member Function Documentation

◆ apply_imported_()

void esphome::homeassistant::HomeassistantLight::apply_imported_ ( )

protected

Definition at line 220 of file homeassistant_light.cpp.

◆ dump_config()

void esphome::homeassistant::HomeassistantLight::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 172 of file homeassistant_light.cpp.

◆ fall_back_()

void esphome::homeassistant::HomeassistantLight::fall_back_ ( )

protected

Returns the light to the reported state after a change that did not reach Home Assistant.

Definition at line 309 of file homeassistant_light.cpp.

◆ get_setup_priority()

float esphome::homeassistant::HomeassistantLight::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 22 of file homeassistant_light.h.

◆ get_traits()

light::LightTraits esphome::homeassistant::HomeassistantLight::get_traits ( )

inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 24 of file homeassistant_light.h.

◆ import_()

template<typename T >

void esphome::homeassistant::HomeassistantLight::import_	(	T &	field,
		const T &	value )

inlineprotected

Takes over a reported attribute, reporting whether it changed.

Definition at line 47 of file homeassistant_light.h.

◆ is_imported_()

bool esphome::homeassistant::HomeassistantLight::is_imported_ ( const Attributes & outgoing ) const

protected

True when Home Assistant reported exactly what a change would make of it.

Definition at line 287 of file homeassistant_light.cpp.

◆ on_report_()

void esphome::homeassistant::HomeassistantLight::on_report_ ( bool changed )

protected

A state or attribute report: answers a pending echo when it changed something, and schedules the apply.

Definition at line 197 of file homeassistant_light.cpp.

◆ parse_integer_()

optional< uint16_t > esphome::homeassistant::HomeassistantLight::parse_integer_	(	const char *	name,
		StringRef	value,
		uint16_t	max )

protected

Parses a Home Assistant attribute as an integer from 1 to max, logging anything else.

Definition at line 179 of file homeassistant_light.cpp.

◆ schedule_apply_()

void esphome::homeassistant::HomeassistantLight::schedule_apply_ ( )

protected

Schedules apply_imported_() once for the attributes of one update.

Definition at line 212 of file homeassistant_light.cpp.

◆ set_entity_id()

void esphome::homeassistant::HomeassistantLight::set_entity_id ( const char * entity_id )

inline

Definition at line 17 of file homeassistant_light.h.

◆ set_report_timeout()

void esphome::homeassistant::HomeassistantLight::set_report_timeout ( uint8_t seconds )

inline

How long a sent change may take to come back as a report before the light returns to the reported state.

Definition at line 19 of file homeassistant_light.h.

◆ setup()

void esphome::homeassistant::HomeassistantLight::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 69 of file homeassistant_light.cpp.

◆ setup_state()

void esphome::homeassistant::HomeassistantLight::setup_state ( light::LightState * state )

inlineoverridevirtual

Reimplemented from esphome::light::LightOutput.

Definition at line 25 of file homeassistant_light.h.

◆ update_state()

void esphome::homeassistant::HomeassistantLight::update_state ( light::LightState * state )

overridevirtual

Reimplemented from esphome::light::LightOutput.

Definition at line 271 of file homeassistant_light.cpp.

◆ write_state()

void esphome::homeassistant::HomeassistantLight::write_state ( light::LightState * state )

overridevirtual

Implements esphome::light::LightOutput.

Definition at line 318 of file homeassistant_light.cpp.

Field Documentation

◆ apply_scheduled_

bool esphome::homeassistant::HomeassistantLight::apply_scheduled_

protected

Definition at line 63 of file homeassistant_light.h.

◆ echo_pending_

bool esphome::homeassistant::HomeassistantLight::echo_pending_

protected

Definition at line 66 of file homeassistant_light.h.

◆ entity_id_

const char* esphome::homeassistant::HomeassistantLight::entity_id_ {nullptr}

protected

Definition at line 59 of file homeassistant_light.h.

◆ imported_

Attributes esphome::homeassistant::HomeassistantLight::imported_ {}

protected

Definition at line 62 of file homeassistant_light.h.

◆ initial_seen_

bool esphome::homeassistant::HomeassistantLight::initial_seen_

protected

Definition at line 65 of file homeassistant_light.h.

◆ initial_write_

bool esphome::homeassistant::HomeassistantLight::initial_write_

protected

Definition at line 64 of file homeassistant_light.h.

◆ report_held_

bool esphome::homeassistant::HomeassistantLight::report_held_

protected

Definition at line 67 of file homeassistant_light.h.

◆ report_timeout_s_

uint8_t esphome::homeassistant::HomeassistantLight::report_timeout_s_ {10}

protected

Definition at line 69 of file homeassistant_light.h.

◆ state_

light::LightState* esphome::homeassistant::HomeassistantLight::state_ {nullptr}

protected

Definition at line 60 of file homeassistant_light.h.

◆ traits_

light::LightTraits esphome::homeassistant::HomeassistantLight::traits_ {}

protected

Definition at line 61 of file homeassistant_light.h.

◆ transitioned_

bool esphome::homeassistant::HomeassistantLight::transitioned_

protected

Definition at line 68 of file homeassistant_light.h.

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

esphome/components/homeassistant/light/homeassistant_light.h
esphome/components/homeassistant/light/homeassistant_light.cpp

Data Structures

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply_imported_()

◆ dump_config()

◆ fall_back_()

◆ get_setup_priority()

◆ get_traits()

◆ import_()

◆ is_imported_()

◆ on_report_()

◆ parse_integer_()

◆ schedule_apply_()

◆ set_entity_id()

◆ set_report_timeout()

◆ setup()

◆ setup_state()

◆ update_state()

◆ write_state()

Field Documentation

◆ apply_scheduled_

◆ echo_pending_

◆ entity_id_

◆ imported_

◆ initial_seen_

◆ initial_write_

◆ report_held_

◆ report_timeout_s_

◆ state_

◆ traits_

◆ transitioned_