A script type that queues new instances that are created. More...

#include <script.h>

Inheritance diagram for esphome::script::QueueingScript< Ts >:

Public Member Functions
void	execute (Ts... x) override

void	stop () override

void	loop () override

void	set_max_runs (int max_runs)

Public Member Functions inherited from esphome::script::Script< Ts... >
virtual bool	is_running ()
	Check if any instance of this script is currently running.

void	execute_tuple (const std::tuple< Ts... > &tuple)

void	set_name (const LogString *name)

Public Member Functions inherited from esphome::Trigger< Ts... >
void	trigger (const Ts &...x)
	Inform the parent automation that the event has triggered.

void	set_automation_parent (Automation< Ts... > *automation_parent)

void	stop_action ()
	Stop any action connected to this trigger.

bool	is_action_running ()
	Returns true if any action connected to this trigger is running.

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

virtual void	dump_config ()

virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

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.

virtual void	mark_failed ()
	Mark this component as failed.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error ()

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

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

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
void	lazy_init_queue_ ()

template<size_t... S>
void	trigger_tuple_ (const std::tuple< Ts... > &tuple, std::index_sequence< S... >)

Protected Member Functions inherited from esphome::script::Script< Ts... >
void	execute_tuple_ (const std::tuple< Ts... > &tuple, std::index_sequence< S... >)

Protected Member Functions inherited from esphome::script::ScriptLogger
void	esp_logw_ (int line, const __FlashStringHelper format, const char param)

void	esp_logd_ (int line, const __FlashStringHelper format, const char param)

void	esp_log_ (int level, int line, const __FlashStringHelper format, const char param)

void	esp_logw_ (int line, const char format, const char param)

void	esp_logd_ (int line, const char format, const char param)

void	esp_log_ (int level, int line, const char format, const char param)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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 (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

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 (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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 (uint32_t id)

Protected Attributes
int	num_queued_ = 0

int	max_runs_ = 0

size_t	queue_front_ = 0

std::unique_ptr< std::unique_ptr< std::tuple< Ts... > >[]>	var_queue_

Protected Attributes inherited from esphome::script::Script< Ts... >
const LogString *	name_

Protected Attributes inherited from esphome::Trigger< Ts... >
Automation< Ts... > *	automation_parent_

Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

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

Detailed Description

template<typename... Ts>
class esphome::script::QueueingScript< Ts >

A script type that queues new instances that are created.

Only one instance of the script can be active at a time.

Ring buffer implementation:

num_queued_ tracks the number of queued (waiting) instances, NOT including the currently running one
queue_front_ points to the next item to execute (read position)
Buffer size is max_runs_ - 1 (max total instances minus the running one)
Write position is calculated as: (queue_front_ + num_queued_) % (max_runs_ - 1)
When an item finishes, queue_front_ advances: (queue_front_ + 1) % (max_runs_ - 1)
First execute() runs immediately without queuing (num_queued_ stays 0)
Subsequent executes while running are queued starting at position 0
Maximum total instances = max_runs_ (includes 1 running + (max_runs_ - 1) queued)

Definition at line 112 of file script.h.

Member Function Documentation

◆ execute()

template<typename... Ts>

void esphome::script::QueueingScript< Ts >::execute ( Ts... x )

inlineoverridevirtual

Implements esphome::script::Script< Ts... >.

Definition at line 114 of file script.h.

◆ lazy_init_queue_()

template<typename... Ts>

void esphome::script::QueueingScript< Ts >::lazy_init_queue_ ( )

inlineprotected

Definition at line 169 of file script.h.

◆ loop()

template<typename... Ts>

void esphome::script::QueueingScript< Ts >::loop ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 153 of file script.h.

◆ set_max_runs()

template<typename... Ts>

void esphome::script::QueueingScript< Ts >::set_max_runs ( int max_runs )

inline

Definition at line 164 of file script.h.

◆ stop()

template<typename... Ts>

void esphome::script::QueueingScript< Ts >::stop ( )

inlineoverridevirtual

Reimplemented from esphome::script::Script< Ts... >.

Definition at line 144 of file script.h.

◆ trigger_tuple_()

template<typename... Ts>

template<size_t... S>

void esphome::script::QueueingScript< Ts >::trigger_tuple_	(	const std::tuple< Ts... > &	tuple,
		std::index_sequence< S... >	)

inlineprotected

Definition at line 177 of file script.h.

Field Documentation

◆ max_runs_

template<typename... Ts>

int esphome::script::QueueingScript< Ts >::max_runs_ = 0

protected

Definition at line 182 of file script.h.

◆ num_queued_

template<typename... Ts>

int esphome::script::QueueingScript< Ts >::num_queued_ = 0

protected

Definition at line 181 of file script.h.

◆ queue_front_

template<typename... Ts>

size_t esphome::script::QueueingScript< Ts >::queue_front_ = 0

protected

Definition at line 183 of file script.h.

◆ var_queue_

template<typename... Ts>

std::unique_ptr<std::unique_ptr<std::tuple<Ts...> >[]> esphome::script::QueueingScript< Ts >::var_queue_

protected

Definition at line 184 of file script.h.

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

esphome/components/script/script.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ execute()

◆ lazy_init_queue_()

◆ loop()

◆ set_max_runs()

◆ stop()

◆ trigger_tuple_()

Field Documentation

◆ max_runs_

◆ num_queued_

◆ queue_front_

◆ var_queue_