ESPHome  2024.10.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::status_led::StatusLEDLightOutput Class Reference

#include <status_led_light.h>

Inheritance diagram for esphome::status_led::StatusLEDLightOutput:
esphome::light::LightOutput esphome::Component

Public Member Functions

void set_pin (GPIOPin *pin)
 
void set_output (output::BinaryOutput *output)
 
light::LightTraits get_traits () override
 
void loop () override
 
void setup_state (light::LightState *state) override
 
void write_state (light::LightState *state) override
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
float get_loop_priority () const 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 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
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
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 () 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="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...
 

Protected Member Functions

void output_state_ (bool state)
 
- 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

GPIOPinpin_ {nullptr}
 
output::BinaryOutputoutput_ {nullptr}
 
light::LightStatelightstate_ {}
 
uint32_t last_app_state_ {0xFFFF}
 
- 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 11 of file status_led_light.h.

Member Function Documentation

◆ dump_config()

void esphome::status_led::StatusLEDLightOutput::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 64 of file status_led_light.cpp.

◆ get_loop_priority()

float esphome::status_led::StatusLEDLightOutput::get_loop_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file status_led_light.h.

◆ get_setup_priority()

float esphome::status_led::StatusLEDLightOutput::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 32 of file status_led_light.h.

◆ get_traits()

light::LightTraits esphome::status_led::StatusLEDLightOutput::get_traits ( )
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 16 of file status_led_light.h.

◆ loop()

void esphome::status_led::StatusLEDLightOutput::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file status_led_light.cpp.

◆ output_state_()

void esphome::status_led::StatusLEDLightOutput::output_state_ ( bool  state)
protected

Definition at line 69 of file status_led_light.cpp.

◆ set_output()

void esphome::status_led::StatusLEDLightOutput::set_output ( output::BinaryOutput output)
inline

Definition at line 14 of file status_led_light.h.

◆ set_pin()

void esphome::status_led::StatusLEDLightOutput::set_pin ( GPIOPin pin)
inline

Definition at line 13 of file status_led_light.h.

◆ setup()

void esphome::status_led::StatusLEDLightOutput::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 55 of file status_led_light.cpp.

◆ setup_state()

void esphome::status_led::StatusLEDLightOutput::setup_state ( light::LightState state)
overridevirtual

Reimplemented from esphome::light::LightOutput.

Definition at line 37 of file status_led_light.cpp.

◆ write_state()

void esphome::status_led::StatusLEDLightOutput::write_state ( light::LightState state)
overridevirtual

Implements esphome::light::LightOutput.

Definition at line 43 of file status_led_light.cpp.

Field Documentation

◆ last_app_state_

uint32_t esphome::status_led::StatusLEDLightOutput::last_app_state_ {0xFFFF}
protected

Definition at line 39 of file status_led_light.h.

◆ lightstate_

light::LightState* esphome::status_led::StatusLEDLightOutput::lightstate_ {}
protected

Definition at line 38 of file status_led_light.h.

◆ output_

output::BinaryOutput* esphome::status_led::StatusLEDLightOutput::output_ {nullptr}
protected

Definition at line 37 of file status_led_light.h.

◆ pin_

GPIOPin* esphome::status_led::StatusLEDLightOutput::pin_ {nullptr}
protected

Definition at line 36 of file status_led_light.h.


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