ESPHome  2022.1.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::light::AddressableLightWrapper Class Reference

#include <addressable_light_wrapper.h>

Inheritance diagram for esphome::light::AddressableLightWrapper:
esphome::light::AddressableLight esphome::light::LightOutput esphome::Component

Public Member Functions

 AddressableLightWrapper (light::LightState *light_state)
 
int32_t size () const override
 
void clear_effect_data () override
 
light::LightTraits get_traits () override
 
void write_state (light::LightState *state) override
 
- Public Member Functions inherited from esphome::light::AddressableLight
ESPColorView operator[] (int32_t index) const
 
ESPColorView get (int32_t index)
 
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::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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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

light::ESPColorView get_view_internal (int32_t index) const override
 
- Protected Member Functions inherited from esphome::light::AddressableLight
void mark_shown_ ()
 
- 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()> &&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()> &&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

light::LightStatelight_state_
 
uint8_t * wrapper_state_
 
ColorMode color_mode_ {ColorMode::UNKNOWN}
 
- Protected Attributes inherited from esphome::light::AddressableLight
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 9 of file addressable_light_wrapper.h.

Constructor & Destructor Documentation

◆ AddressableLightWrapper()

esphome::light::AddressableLightWrapper::AddressableLightWrapper ( light::LightState light_state)
inlineexplicit

Definition at line 11 of file addressable_light_wrapper.h.

Member Function Documentation

◆ clear_effect_data()

void esphome::light::AddressableLightWrapper::clear_effect_data ( )
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 17 of file addressable_light_wrapper.h.

◆ get_traits()

light::LightTraits esphome::light::AddressableLightWrapper::get_traits ( )
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 19 of file addressable_light_wrapper.h.

◆ get_view_internal()

light::ESPColorView esphome::light::AddressableLightWrapper::get_view_internal ( int32_t  index) const
inlineoverrideprotectedvirtual

Implements esphome::light::AddressableLight.

Definition at line 116 of file addressable_light_wrapper.h.

◆ size()

int32_t esphome::light::AddressableLightWrapper::size ( ) const
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 15 of file addressable_light_wrapper.h.

◆ write_state()

void esphome::light::AddressableLightWrapper::write_state ( light::LightState state)
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 73 of file addressable_light_wrapper.h.

Field Documentation

◆ color_mode_

ColorMode esphome::light::AddressableLightWrapper::color_mode_ {ColorMode::UNKNOWN}
protected

Definition at line 123 of file addressable_light_wrapper.h.

◆ light_state_

light::LightState* esphome::light::AddressableLightWrapper::light_state_
protected

Definition at line 121 of file addressable_light_wrapper.h.

◆ wrapper_state_

uint8_t* esphome::light::AddressableLightWrapper::wrapper_state_
protected

Definition at line 122 of file addressable_light_wrapper.h.


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