ESPHome  2022.1.2
Public Member Functions | Protected Attributes
esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE > Class Template Reference

#include <neopixelbus_light.h>

Inheritance diagram for esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >:
esphome::light::AddressableLight esphome::light::LightOutput esphome::Component esphome::neopixelbus::NeoPixelRGBLightOutput< T_METHOD, T_COLOR_FEATURE > esphome::neopixelbus::NeoPixelRGBWLightOutput< T_METHOD, T_COLOR_FEATURE >

Public Member Functions

NeoPixelBus< T_COLOR_FEATURE, T_METHOD > * get_controller () const
 
void clear_effect_data () override
 
void add_leds (uint16_t count_pixels, uint8_t pin)
 Add some LEDS, can only be called once. More...
 
void add_leds (uint16_t count_pixels, uint8_t pin_clock, uint8_t pin_data)
 
void add_leds (uint16_t count_pixels)
 
void add_leds (NeoPixelBus< T_COLOR_FEATURE, T_METHOD > *controller)
 
void setup () override
 
void write_state (light::LightState *state) override
 
float get_setup_priority () const override
 
int32_t size () const override
 
void set_pixel_order (ESPNeoPixelOrder order)
 
- 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::light::LightOutput
virtual LightTraits get_traits ()=0
 Return the LightTraits of this LightOutput. More...
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
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 Attributes

NeoPixelBus< T_COLOR_FEATURE, T_METHOD > * controller_ {nullptr}
 
uint8_t * effect_data_ {nullptr}
 
uint8_t rgb_offsets_ [4] {0, 1, 2, 3}
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::light::AddressableLight
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()> &&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...
 

Detailed Description

template<typename T_METHOD, typename T_COLOR_FEATURE>
class esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >

Definition at line 55 of file neopixelbus_light.h.

Member Function Documentation

◆ add_leds() [1/4]

template<typename T_METHOD , typename T_COLOR_FEATURE >
void esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::add_leds ( uint16_t  count_pixels,
uint8_t  pin 
)
inline

Add some LEDS, can only be called once.

Definition at line 65 of file neopixelbus_light.h.

◆ add_leds() [2/4]

template<typename T_METHOD , typename T_COLOR_FEATURE >
void esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::add_leds ( uint16_t  count_pixels,
uint8_t  pin_clock,
uint8_t  pin_data 
)
inline

Definition at line 68 of file neopixelbus_light.h.

◆ add_leds() [3/4]

template<typename T_METHOD , typename T_COLOR_FEATURE >
void esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::add_leds ( uint16_t  count_pixels)
inline

Definition at line 71 of file neopixelbus_light.h.

◆ add_leds() [4/4]

template<typename T_METHOD , typename T_COLOR_FEATURE >
void esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::add_leds ( NeoPixelBus< T_COLOR_FEATURE, T_METHOD > *  controller)
inline

Definition at line 72 of file neopixelbus_light.h.

◆ clear_effect_data()

template<typename T_METHOD , typename T_COLOR_FEATURE >
void esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::clear_effect_data ( )
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 59 of file neopixelbus_light.h.

◆ get_controller()

template<typename T_METHOD , typename T_COLOR_FEATURE >
NeoPixelBus<T_COLOR_FEATURE, T_METHOD>* esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::get_controller ( ) const
inline

Definition at line 57 of file neopixelbus_light.h.

◆ get_setup_priority()

template<typename T_METHOD , typename T_COLOR_FEATURE >
float esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 95 of file neopixelbus_light.h.

◆ set_pixel_order()

template<typename T_METHOD , typename T_COLOR_FEATURE >
void esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::set_pixel_order ( ESPNeoPixelOrder  order)
inline

Definition at line 99 of file neopixelbus_light.h.

◆ setup()

template<typename T_METHOD , typename T_COLOR_FEATURE >
void esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 79 of file neopixelbus_light.h.

◆ size()

template<typename T_METHOD , typename T_COLOR_FEATURE >
int32_t esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::size ( ) const
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 97 of file neopixelbus_light.h.

◆ write_state()

template<typename T_METHOD , typename T_COLOR_FEATURE >
void esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::write_state ( light::LightState state)
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 88 of file neopixelbus_light.h.

Field Documentation

◆ controller_

template<typename T_METHOD , typename T_COLOR_FEATURE >
NeoPixelBus<T_COLOR_FEATURE, T_METHOD>* esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::controller_ {nullptr}
protected

Definition at line 108 of file neopixelbus_light.h.

◆ effect_data_

template<typename T_METHOD , typename T_COLOR_FEATURE >
uint8_t* esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::effect_data_ {nullptr}
protected

Definition at line 109 of file neopixelbus_light.h.

◆ rgb_offsets_

template<typename T_METHOD , typename T_COLOR_FEATURE >
uint8_t esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >::rgb_offsets_[4] {0, 1, 2, 3}
protected

Definition at line 110 of file neopixelbus_light.h.


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