ESPHome  2024.3.1
Public Member Functions | Data Fields
esphome::demo::DemoLight Class Reference

#include <demo_light.h>

Inheritance diagram for esphome::demo::DemoLight:
esphome::light::LightOutput esphome::Component

Public Member Functions

void set_type (DemoLightType type)
 
light::LightTraits get_traits () override
 
void write_state (light::LightState *state) override
 
- Public Member Functions inherited from esphome::light::LightOutput
virtual std::unique_ptr< LightTransformercreate_default_transition ()
 Return the default transformer used for transitions. More...
 
virtual void setup_state (LightState *state)
 
virtual void update_state (LightState *state)
 Called on every update of the current values of the associated LightState, can optionally be used to do processing of this change. More...
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
virtual float get_setup_priority () const
 priority of setup(). More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
bool is_ready ()
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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 char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Data Fields

DemoLightType type_
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
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. More...
 
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. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Detailed Description

Definition at line 26 of file demo_light.h.

Member Function Documentation

◆ get_traits()

light::LightTraits esphome::demo::DemoLight::get_traits ( )
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 29 of file demo_light.h.

◆ set_type()

void esphome::demo::DemoLight::set_type ( DemoLightType  type)
inline

Definition at line 28 of file demo_light.h.

◆ write_state()

void esphome::demo::DemoLight::write_state ( light::LightState state)
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 60 of file demo_light.h.

Field Documentation

◆ type_

DemoLightType esphome::demo::DemoLight::type_

Definition at line 64 of file demo_light.h.


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