Wait for a script to finish before continuing. More...

#include <script.h>

Inheritance diagram for esphome::script::ScriptWaitAction< C, Ts >:

Public Member Functions
	ScriptWaitAction (C *script)

void	setup () override

void	play_complex (const Ts &...x) override

void	loop () override

void	play (const Ts &...x) override

void	stop () override

Public Member Functions inherited from esphome::Action< Ts... >
virtual void	stop_complex ()

virtual bool	is_running ()
	Check if this or any of the following actions are currently running.

int	num_running_total ()
	The total number of actions that are currently running in this plus any of the following actions in the chain.

Public Member Functions inherited from esphome::Component
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.

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

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

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
template<int... S>
void	play_next_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)

Protected Member Functions inherited from esphome::Action< Ts... >
void	play_next_ (const Ts &...x)

void	play_next_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)

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

void	stop_next_ ()

bool	is_running_next_ ()

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 (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

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

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

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

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
C *	script_

std::forward_list< std::tuple< Ts... > >	param_queue_

Protected Attributes inherited from esphome::Action< Ts... >
friend	ActionList< Ts... >

Action< Ts... > *	next_

int	num_running_
	The number of instances of this sequence in the list of actions that is currently being executed.

Protected Attributes inherited from esphome::Component
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<class C, typename... Ts>
class esphome::script::ScriptWaitAction< C, Ts >

Wait for a script to finish before continuing.

Uses queue-based storage to safely handle concurrent executions. While concurrent execution from the same trigger is uncommon, it's possible (e.g., rapid button presses, high-frequency sensor updates), so we use queue-based storage for correctness.

Definition at line 275 of file script.h.

Constructor & Destructor Documentation

◆ ScriptWaitAction()

template<class C , typename... Ts>

esphome::script::ScriptWaitAction< C, Ts >::ScriptWaitAction ( C * script )

inline

Definition at line 277 of file script.h.

Member Function Documentation

◆ loop()

template<class C , typename... Ts>

void esphome::script::ScriptWaitAction< C, Ts >::loop ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 299 of file script.h.

◆ play()

template<class C , typename... Ts>

void esphome::script::ScriptWaitAction< C, Ts >::play ( const Ts &... x )

inlineoverridevirtual

Implements esphome::Action< Ts... >.

Definition at line 315 of file script.h.

◆ play_complex()

template<class C , typename... Ts>

void esphome::script::ScriptWaitAction< C, Ts >::play_complex ( const Ts &... x )

inlineoverridevirtual

Reimplemented from esphome::Action< Ts... >.

Definition at line 284 of file script.h.

◆ play_next_tuple_()

template<class C , typename... Ts>

template<int... S>

void esphome::script::ScriptWaitAction< C, Ts >::play_next_tuple_	(	const std::tuple< Ts... > &	tuple,
		seq< S... >	)

inlineprotected

Definition at line 324 of file script.h.

◆ setup()

template<class C , typename... Ts>

void esphome::script::ScriptWaitAction< C, Ts >::setup ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 279 of file script.h.

◆ stop()

template<class C , typename... Ts>

void esphome::script::ScriptWaitAction< C, Ts >::stop ( )

inlineoverridevirtual

Reimplemented from esphome::Action< Ts... >.

Definition at line 318 of file script.h.

Field Documentation

◆ param_queue_

template<class C , typename... Ts>

std::forward_list<std::tuple<Ts...> > esphome::script::ScriptWaitAction< C, Ts >::param_queue_

protected

Definition at line 329 of file script.h.

◆ script_

template<class C , typename... Ts>

C* esphome::script::ScriptWaitAction< C, Ts >::script_

protected

Definition at line 328 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

Constructor & Destructor Documentation

◆ ScriptWaitAction()

Member Function Documentation

◆ loop()

◆ play()

◆ play_complex()

◆ play_next_tuple_()

◆ setup()

◆ stop()

Field Documentation

◆ param_queue_

◆ script_