ESPHome  2024.3.1
Public Member Functions | Protected Attributes
esphome::light::AutomationLightEffect Class Reference

#include <base_light_effects.h>

Inheritance diagram for esphome::light::AutomationLightEffect:
esphome::light::LightEffect

Public Member Functions

 AutomationLightEffect (const std::string &name)
 
void stop () override
 
void apply () override
 
Triggerget_trig () const
 
- Public Member Functions inherited from esphome::light::LightEffect
 LightEffect (std::string name)
 
virtual void start ()
 Initialize this LightEffect. Will be called once after creation. More...
 
virtual void start_internal ()
 
const std::string & get_name ()
 
virtual void init ()
 Internal method called by the LightState when this light effect is registered in it. More...
 
void init_internal (LightState *state)
 

Protected Attributes

Triggertrig_ {new Trigger<>}
 
- Protected Attributes inherited from esphome::light::LightEffect
LightStatestate_ {nullptr}
 
std::string name_
 

Detailed Description

Definition at line 135 of file base_light_effects.h.

Constructor & Destructor Documentation

◆ AutomationLightEffect()

esphome::light::AutomationLightEffect::AutomationLightEffect ( const std::string &  name)
inline

Definition at line 137 of file base_light_effects.h.

Member Function Documentation

◆ apply()

void esphome::light::AutomationLightEffect::apply ( )
inlineoverridevirtual

Implements esphome::light::LightEffect.

Definition at line 139 of file base_light_effects.h.

◆ get_trig()

Trigger* esphome::light::AutomationLightEffect::get_trig ( ) const
inline

Definition at line 144 of file base_light_effects.h.

◆ stop()

void esphome::light::AutomationLightEffect::stop ( )
inlineoverridevirtual

Reimplemented from esphome::light::LightEffect.

Definition at line 138 of file base_light_effects.h.

Field Documentation

◆ trig_

Trigger* esphome::light::AutomationLightEffect::trig_ {new Trigger<>}
protected

Definition at line 147 of file base_light_effects.h.


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