ESPHome  2024.5.3
Public Member Functions
esphome::script::SingleScript< Ts > Class Template Reference

A script type for which only a single instance at a time is allowed. More...

#include <script.h>

Inheritance diagram for esphome::script::SingleScript< Ts >:
esphome::script::Script< Ts... > esphome::script::ScriptLogger esphome::Trigger< Ts... >

Public Member Functions

void execute (Ts... x) override
 
- Public Member Functions inherited from esphome::script::Script< Ts... >
virtual bool is_running ()
 Check if any instance of this script is currently running. More...
 
virtual void stop ()
 Stop all instances of this script. More...
 
void execute_tuple (const std::tuple< Ts... > &tuple)
 
void set_name (const std::string &name)
 
- Public Member Functions inherited from esphome::Trigger< Ts... >
void trigger (Ts... x)
 Inform the parent automation that the event has triggered. More...
 
void set_automation_parent (Automation< Ts... > *automation_parent)
 
void stop_action ()
 Stop any action connected to this trigger. More...
 
bool is_action_running ()
 Returns true if any action connected to this trigger is running. More...
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::script::Script< Ts... >
void execute_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 
- Protected Member Functions inherited from esphome::script::ScriptLogger
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 Attributes inherited from esphome::script::Script< Ts... >
std::string name_
 
- Protected Attributes inherited from esphome::Trigger< Ts... >
Automation< Ts... > * automation_parent_
 

Detailed Description

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

A script type for which only a single instance at a time is allowed.

If a new instance is executed while the previous one hasn't finished yet, a warning is printed and the new instance is discarded.

Definition at line 56 of file script.h.

Member Function Documentation

◆ execute()

template<typename... Ts>
void esphome::script::SingleScript< Ts >::execute ( Ts...  x)
inlineoverridevirtual

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

Definition at line 58 of file script.h.


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