ESPHome  2024.7.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::light::AddressableLight Class Referenceabstract

#include <addressable_light.h>

Inheritance diagram for esphome::light::AddressableLight:
esphome::light::LightOutput esphome::Component esphome::beken_spi_led_strip::BekenSPILEDStripLightOutput esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput esphome::fastled_base::FastLEDLightOutput esphome::light::AddressableLightWrapper esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE > esphome::partition::PartitionLightOutput esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput esphome::spi_led_strip::SpiLedStrip

Public Member Functions

virtual int32_t size () const =0
ESPColorView operator[] (int32_t index) const
ESPColorView get (int32_t index)
virtual void clear_effect_data ()=0
ESPRangeView range (int32_t from, int32_t to)
ESPRangeView all ()
ESPRangeIterator begin ()
ESPRangeIterator end ()
void shift_left (int32_t amnt)
void shift_right (int32_t amnt)
bool is_effect_active () const
void set_effect_active (bool effect_active)
std::unique_ptr< LightTransformercreate_default_transition () override
void set_correction (float red, float green, float blue, float white=1.0f)
void setup_state (LightState *state) override
void update_state (LightState *state) override
void schedule_show ()
void set_power_supply (power_supply::PowerSupply *power_supply)
void call_setup () override
- Public Member Functions inherited from esphome::light::LightOutput
virtual LightTraits get_traits ()=0
 Return the LightTraits of this LightOutput. More...
virtual void write_state (LightState *state)=0
 Called from loop() every time the light state has changed, and should should write the new state to hardware. 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 () 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 mark_shown_ ()
virtual ESPColorView get_view_internal (int32_t index) const =0
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
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

bool effect_active_ {false}
ESPColorCorrection correction_ {}
power_supply::PowerSupplyRequester power_
LightStatestate_parent_ {nullptr}
- 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 31 of file addressable_light.h.

Member Function Documentation

◆ all()

ESPRangeView esphome::light::AddressableLight::all ( )

Definition at line 42 of file addressable_light.h.

◆ begin()

ESPRangeIterator esphome::light::AddressableLight::begin ( )

Definition at line 43 of file addressable_light.h.

◆ call_setup()

void esphome::light::AddressableLight::call_setup ( )

Reimplemented from esphome::Component.

Definition at line 9 of file addressable_light.cpp.

◆ clear_effect_data()

virtual void esphome::light::AddressableLight::clear_effect_data ( )
pure virtual

◆ create_default_transition()

std::unique_ptr< LightTransformer > esphome::light::AddressableLight::create_default_transition ( )

Reimplemented from esphome::light::LightOutput.

Definition at line 26 of file addressable_light.cpp.

◆ end()

ESPRangeIterator esphome::light::AddressableLight::end ( )

Definition at line 44 of file addressable_light.h.

◆ get()

ESPColorView esphome::light::AddressableLight::get ( int32_t  index)

Definition at line 35 of file addressable_light.h.

◆ get_view_internal()

virtual ESPColorView esphome::light::AddressableLight::get_view_internal ( int32_t  index) const
protectedpure virtual

◆ is_effect_active()

bool esphome::light::AddressableLight::is_effect_active ( ) const

Definition at line 64 of file addressable_light.h.

◆ mark_shown_()

void esphome::light::AddressableLight::mark_shown_ ( )

Definition at line 87 of file addressable_light.h.

◆ operator[]()

ESPColorView esphome::light::AddressableLight::operator[] ( int32_t  index) const

Definition at line 34 of file addressable_light.h.

◆ range()

ESPRangeView esphome::light::AddressableLight::range ( int32_t  from,
int32_t  to 

Definition at line 37 of file addressable_light.h.

◆ schedule_show()

void esphome::light::AddressableLight::schedule_show ( )

Definition at line 76 of file addressable_light.h.

◆ set_correction()

void esphome::light::AddressableLight::set_correction ( float  red,
float  green,
float  blue,
float  white = 1.0f 

Definition at line 67 of file addressable_light.h.

◆ set_effect_active()

void esphome::light::AddressableLight::set_effect_active ( bool  effect_active)

Definition at line 65 of file addressable_light.h.

◆ set_power_supply()

void esphome::light::AddressableLight::set_power_supply ( power_supply::PowerSupply power_supply)

Definition at line 79 of file addressable_light.h.

◆ setup_state()

void esphome::light::AddressableLight::setup_state ( LightState state)

Reimplemented from esphome::light::LightOutput.

Definition at line 71 of file addressable_light.h.

◆ shift_left()

void esphome::light::AddressableLight::shift_left ( int32_t  amnt)

Definition at line 45 of file addressable_light.h.

◆ shift_right()

void esphome::light::AddressableLight::shift_right ( int32_t  amnt)

Definition at line 54 of file addressable_light.h.

◆ size()

virtual int32_t esphome::light::AddressableLight::size ( ) const
pure virtual

◆ update_state()

void esphome::light::AddressableLight::update_state ( LightState state)

Reimplemented from esphome::light::LightOutput.

Definition at line 38 of file addressable_light.cpp.

Field Documentation

◆ correction_

ESPColorCorrection esphome::light::AddressableLight::correction_ {}

Definition at line 101 of file addressable_light.h.

◆ effect_active_

bool esphome::light::AddressableLight::effect_active_ {false}

Definition at line 100 of file addressable_light.h.

◆ power_

power_supply::PowerSupplyRequester esphome::light::AddressableLight::power_

Definition at line 103 of file addressable_light.h.

◆ state_parent_

LightState* esphome::light::AddressableLight::state_parent_ {nullptr}

Definition at line 105 of file addressable_light.h.

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