ESPHome  2024.12.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::Action< Ts > Class Template Referenceabstract

#include <automation.h>

Public Member Functions

virtual void play_complex (Ts... x)
 
virtual void stop_complex ()
 
virtual bool is_running ()
 Check if this or any of the following actions are currently running. More...
 
int num_running_total ()
 The total number of actions that are currently running in this plus any of the following actions in the chain. More...
 

Protected Member Functions

virtual void play (Ts... x)=0
 
void play_next_ (Ts... x)
 
template<int... S>
void play_next_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple)
 
virtual void stop ()
 
void stop_next_ ()
 
bool is_running_next_ ()
 

Protected Attributes

friend ActionList< Ts... >
 
Action< Ts... > * next_ {nullptr}
 
int num_running_ {0}
 The number of instances of this sequence in the list of actions that is currently being executed. More...
 

Detailed Description

template<typename... Ts>
class esphome::Action< Ts >

Definition at line 121 of file automation.h.

Member Function Documentation

◆ is_running()

template<typename... Ts>
virtual bool esphome::Action< Ts >::is_running ( )
inlinevirtual

Check if this or any of the following actions are currently running.

Definition at line 136 of file automation.h.

◆ is_running_next_()

template<typename... Ts>
bool esphome::Action< Ts >::is_running_next_ ( )
inlineprotected

Definition at line 173 of file automation.h.

◆ num_running_total()

template<typename... Ts>
int esphome::Action< Ts >::num_running_total ( )
inline

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

Definition at line 140 of file automation.h.

◆ play()

template<typename... Ts>
virtual void esphome::Action< Ts >::play ( Ts...  x)
protectedpure virtual

Implemented in esphome::display::DisplayPageShowPrevAction< Ts >, esphome::display::DisplayPageShowNextAction< Ts >, esphome::wifi::WiFiDisableAction< Ts >, esphome::mqtt::MQTTDisableAction< Ts >, esphome::wifi::WiFiEnableAction< Ts >, esphome::mqtt::MQTTEnableAction< Ts >, esphome::mqtt::MQTTPublishJsonAction< Ts >, esphome::SuspendComponentAction< Ts >, esphome::UpdateComponentAction< Ts >, esphome::ble_client::BLEClientDisconnectAction< Ts >, esphome::WaitUntilAction< Ts >, esphome::fingerprint_grow::AuraLEDControlAction< Ts >, esphome::voice_assistant::StopAction< Ts >, esphome::voice_assistant::StartContinuousAction< Ts >, esphome::ble_client::BLEClientConnectAction< Ts >, esphome::voice_assistant::StartAction< Ts >, esphome::fingerprint_grow::DeleteAllAction< Ts >, esphome::RepeatAction< Ts >, esphome::fingerprint_grow::CancelEnrollmentAction< Ts >, esphome::remote_base::RemoteTransmitterActionBase< Ts >, esphome::remote_base::RemoteTransmitterActionBase< Ts... >, esphome::ble_client::BLEClientRemoveBondAction< Ts >, esphome::fingerprint_grow::EnrollmentAction< Ts >, esphome::WhileAction< Ts >, esphome::ble_client::BLEClientNumericComparisonReplyAction< Ts >, esphome::ezo_pmp::EzoPMPArbitraryCommandAction< Ts >, esphome::script::ScriptWaitAction< C, Ts >, esphome::lvgl::LvglAction< Ts >, esphome::ezo_pmp::EzoPMPChangeI2CAddressAction< Ts >, esphome::ezo_pmp::EzoPMPStopDosingAction< Ts >, esphome::sim800l::Sim800LDisconnectAction< Ts >, esphome::ble_client::BLEClientPasskeyReplyAction< Ts >, esphome::deep_sleep::AllowDeepSleepAction< Ts >, esphome::ezo_pmp::EzoPMPPauseDosingAction< Ts >, esphome::IfAction< Ts >, esphome::deep_sleep::PreventDeepSleepAction< Ts >, esphome::sim800l::Sim800LConnectAction< Ts >, esphome::ezo_pmp::EzoPMPClearCalibrationAction< Ts >, esphome::grove_tb6612fng::GROVETB6612FNGMotorNoStandbyAction< Ts >, esphome::script::ScriptStopAction< C, Ts >, esphome::grove_tb6612fng::GROVETB6612FNGMotorStandbyAction< Ts >, esphome::ezo_pmp::EzoPMPClearTotalVolumeDispensedAction< Ts >, esphome::ezo_pmp::EzoPMPSetCalibrationVolumeAction< Ts >, esphome::sprinkler::ResumeOrStartAction< Ts >, esphome::sprinkler::ResumeOrStartAction<>, esphome::LambdaAction< Ts >, esphome::alarm_control_panel::TriggeredAction< Ts >, esphome::grove_tb6612fng::GROVETB6612FNGMotorRunAction< Ts >, esphome::online_image::OnlineImageReleaseAction< Ts >, esphome::wireguard::WireguardDisableAction< Ts >, esphome::ezo_pmp::EzoPMPDoseWithConstantFlowRateAction< Ts >, esphome::sprinkler::ResumeAction< Ts >, esphome::rf_bridge::RFBridgeStartBucketSniffingAction< Ts >, esphome::script::ScriptExecuteAction< Script< As... >, Ts... >, esphome::http_request::HttpRequestSendAction< Ts >, esphome::micro_wake_word::StopAction< Ts >, esphome::DelayAction< Ts >, esphome::wireguard::WireguardEnableAction< Ts >, esphome::alarm_control_panel::PendingAction< Ts >, esphome::micro_wake_word::StartAction< Ts >, esphome::sprinkler::PauseAction< Ts >, esphome::rf_bridge::RFBridgeStopAdvancedSniffingAction< Ts >, esphome::ezo_pmp::EzoPMPDoseVolumeOverTimeAction< Ts >, esphome::esp32_ble::BLEDisableAction< Ts >, esphome::deep_sleep::EnterDeepSleepAction< Ts >, esphome::esp32_ble::BLEEnableAction< Ts >, esphome::sprinkler::PreviousValveAction< Ts >, esphome::rf_bridge::RFBridgeStartAdvancedSniffingAction< Ts >, esphome::ezo_pmp::EzoPMPDoseVolumeAction< Ts >, esphome::pid::PIDSetControlParametersAction< Ts >, esphome::sprinkler::NextValveAction< Ts >, esphome::ags10::AGS10SetZeroPointAction< Ts >, esphome::rf_bridge::RFBridgeLearnAction< Ts >, esphome::globals::GlobalVarSetAction< C, Ts >, esphome::ezo_pmp::EzoPMPDoseContinuouslyAction< Ts >, esphome::pid::PIDResetIntegralTermAction< Ts >, esphome::sprinkler::ShutdownAction< Ts >, esphome::sprinkler::ShutdownAction<>, esphome::ezo_pmp::EzoPMPFindAction< Ts >, esphome::haier::PowerToggleAction< Ts >, esphome::pcf8563::ReadAction< Ts >, esphome::ble_client::BLEClientWriteAction< Ts >, esphome::cs5460a::CS5460ARestartAction< Ts >, esphome::nau7802::NAU7802CalbrateGainAction< Ts >, esphome::canbus::CanbusSendAction< Ts >, esphome::pcf8563::WriteAction< Ts >, esphome::sprinkler::StartSingleValveAction< Ts >, esphome::sprinkler::StartSingleValveAction<>, esphome::haier::PowerOffAction< Ts >, esphome::nau7802::NAU7802CalbrateInternalOffsetAction< Ts >, esphome::pid::PIDAutotuneAction< Ts >, esphome::lvgl::ObjUpdateAction< Ts >, esphome::rtttl::StopAction< Ts >, esphome::esp32_ble_tracker::ESP32BLEStopScanAction< Ts >, esphome::nau7802::NAU7802CalbrateExternalOffsetAction< Ts >, esphome::haier::PowerOnAction< Ts >, esphome::sprinkler::StartFullCycleAction< Ts >, esphome::dfplayer::PlayFileAction< Ts >, esphome::rf_bridge::RFBridgeSendCodeAction< Ts >, esphome::stepper::SetDecelerationAction< Ts >, esphome::haier::StartSteriCleaningAction< Ts >, esphome::pcf85063::ReadAction< Ts >, esphome::bl0906::ResetEnergyAction< Ts >, esphome::sprinkler::StartFromQueueAction< Ts >, esphome::tm1651::TurnOffAction< Ts >, esphome::pcf85063::WriteAction< Ts >, esphome::ufire_ise::UFireISEResetAction< Ts >, esphome::haier::StartSelfCleaningAction< Ts >, esphome::stepper::SetAccelerationAction< Ts >, esphome::tm1651::TurnOnAction< Ts >, esphome::display_menu_base::ShowMainAction< Ts >, esphome::ufire_ec::UFireECResetAction< Ts >, esphome::integration::ResetAction< Ts >, esphome::sprinkler::SetRunDurationAction< Ts >, esphome::haier::HealthOffAction< Ts >, esphome::light::DimRelativeAction< Ts >, esphome::valve::ValvePublishAction< Ts >, esphome::senseair::SenseAirABCGetPeriodAction< Ts >, esphome::display_menu_base::HideAction< Ts >, esphome::servo::ServoDetachAction< Ts >, esphome::haier::HealthOnAction< Ts >, esphome::speaker::FinishAction< Ts >, esphome::stepper::SetSpeedAction< Ts >, esphome::ufire_ec::UFireECCalibrateProbeAction< Ts >, esphome::ds1307::ReadAction< Ts >, esphome::senseair::SenseAirABCDisableAction< Ts >, esphome::speaker::StopAction< Ts >, esphome::display_menu_base::ShowAction< Ts >, esphome::mhz19::MHZ19ABCDisableAction< Ts >, esphome::ds1307::WriteAction< Ts >, esphome::midea::ac::PowerToggleAction< Ts >, esphome::valve::ControlAction< Ts >, esphome::midea::ac::PowerOffAction< Ts >, esphome::speaker::MuteOffAction< Ts >, esphome::senseair::SenseAirABCEnableAction< Ts >, esphome::hbridge::BrakeAction< Ts >, esphome::lightwaverf::SendRawAction< Ts >, esphome::sprinkler::ClearQueuedValvesAction< Ts >, esphome::display_menu_base::EnterAction< Ts >, esphome::mhz19::MHZ19ABCEnableAction< Ts >, esphome::select::SelectOperationAction< Ts >, esphome::pmwcs3::PMWCS3WaterCalibrationAction< Ts >, esphome::midea::ac::PowerOnAction< Ts >, esphome::animation::AnimationPrevFrameAction< Ts >, esphome::ledc::SetFrequencyAction< Ts >, esphome::api::HomeAssistantServiceCallAction< Ts >, esphome::fan::ToggleAction< Ts >, esphome::rp2040_pwm::SetFrequencyAction< Ts >, esphome::midea::ac::BeeperOffAction< Ts >, esphome::pzemac::ResetEnergyAction< Ts >, esphome::speaker::MuteOnAction< Ts >, esphome::senseair::SenseAirBackgroundCalibrationResultAction< Ts >, esphome::cover::ToggleAction< Ts >, esphome::valve::ToggleAction< Ts >, esphome::display_menu_base::RightAction< Ts >, esphome::esp8266_pwm::SetFrequencyAction< Ts >, esphome::libretiny_pwm::SetFrequencyAction< Ts >, esphome::mhz19::MHZ19CalibrateZeroAction< Ts >, esphome::pmwcs3::PMWCS3AirCalibrationAction< Ts >, esphome::animation::AnimationNextFrameAction< Ts >, esphome::midea::ac::BeeperOnAction< Ts >, esphome::sprinkler::QueueValveAction< Ts >, esphome::haier::BeeperOffAction< Ts >, esphome::fan::TurnOffAction< Ts >, esphome::pzemdc::ResetEnergyAction< Ts >, esphome::number::NumberOperationAction< Ts >, esphome::midea::ac::DisplayToggleAction< Ts >, esphome::senseair::SenseAirBackgroundCalibrationAction< Ts >, esphome::cover::StopAction< Ts >, esphome::lock::OpenAction< Ts >, esphome::switch_::ToggleAction< Ts >, esphome::valve::StopAction< Ts >, esphome::display_menu_base::LeftAction< Ts >, esphome::haier::BeeperOnAction< Ts >, esphome::midea::ac::SwingStepAction< Ts >, esphome::output::TurnOnAction< Ts >, esphome::audio_dac::MuteOnAction< Ts >, esphome::cover::CloseAction< Ts >, esphome::lock::UnlockAction< Ts >, esphome::scd4x::FactoryResetAction< Ts >, esphome::switch_::TurnOffAction< Ts >, esphome::valve::CloseAction< Ts >, esphome::display_menu_base::DownAction< Ts >, esphome::haier::DisplayOffAction< Ts >, esphome::speaker::PlayAction< Ts >, esphome::uart::UARTWriteAction< Ts >, esphome::output::TurnOffAction< Ts >, esphome::audio_dac::MuteOffAction< Ts >, esphome::button::PressAction< Ts >, esphome::cover::OpenAction< Ts >, esphome::dfrobot_sen0395::DfrobotSen0395ResetAction< Ts >, esphome::lock::LockAction< Ts >, esphome::sen5x::StartFanAction< Ts >, esphome::sps30::StartFanAction< Ts >, esphome::switch_::TurnOnAction< Ts >, esphome::valve::OpenAction< Ts >, esphome::at581x::AT581XResetAction< Ts >, esphome::display_menu_base::UpAction< Ts >, esphome::haier::DisplayOnAction< Ts >, esphome::max17043::SleepAction< Ts >, esphome::media_player::MediaPlayerCommandAction< Command, Ts >, esphome::scd30::ForceRecalibrationWithReference< Ts >, and esphome::scd4x::PerformForcedCalibrationAction< Ts >.

◆ play_complex()

template<typename... Ts>
virtual void esphome::Action< Ts >::play_complex ( Ts...  x)
inlinevirtual

Reimplemented in esphome::ble_client::BLEClientDisconnectAction< Ts >, esphome::ble_client::BLEClientConnectAction< Ts >, esphome::RepeatAction< Ts >, esphome::WhileAction< Ts >, esphome::script::ScriptWaitAction< C, Ts >, esphome::IfAction< Ts >, and esphome::ble_client::BLEClientWriteAction< Ts >.

Definition at line 123 of file automation.h.

◆ play_next_()

template<typename... Ts>
void esphome::Action< Ts >::play_next_ ( Ts...  x)
inlineprotected

Definition at line 151 of file automation.h.

◆ play_next_tuple_() [1/2]

template<typename... Ts>
template<int... S>
void esphome::Action< Ts >::play_next_tuple_ ( const std::tuple< Ts... > &  tuple,
seq< S... >   
)
inlineprotected

Definition at line 159 of file automation.h.

◆ play_next_tuple_() [2/2]

template<typename... Ts>
void esphome::Action< Ts >::play_next_tuple_ ( const std::tuple< Ts... > &  tuple)
inlineprotected

Definition at line 162 of file automation.h.

◆ stop()

template<typename... Ts>
virtual void esphome::Action< Ts >::stop ( )
inlineprotectedvirtual

Reimplemented in esphome::WaitUntilAction< Ts >, esphome::RepeatAction< Ts >, esphome::WhileAction< Ts >, esphome::IfAction< Ts >, and esphome::DelayAction< Ts >.

Definition at line 166 of file automation.h.

◆ stop_complex()

template<typename... Ts>
virtual void esphome::Action< Ts >::stop_complex ( )
inlinevirtual

Definition at line 128 of file automation.h.

◆ stop_next_()

template<typename... Ts>
void esphome::Action< Ts >::stop_next_ ( )
inlineprotected

Definition at line 167 of file automation.h.

Field Documentation

◆ ActionList< Ts... >

template<typename... Ts>
friend esphome::Action< Ts >::ActionList< Ts... >
protected

Definition at line 148 of file automation.h.

◆ next_

template<typename... Ts>
Action<Ts...>* esphome::Action< Ts >::next_ {nullptr}
protected

Definition at line 179 of file automation.h.

◆ num_running_

template<typename... Ts>
int esphome::Action< Ts >::num_running_ {0}
protected

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

Definition at line 183 of file automation.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13