ESPHome  2024.2.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::spi_led_strip::SpiLedStrip Class Reference

#include <spi_led_strip.h>

Inheritance diagram for esphome::spi_led_strip::SpiLedStrip:
esphome::light::AddressableLight esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_HIGH, spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_1MHZ > esphome::light::LightOutput esphome::Component esphome::spi::SPIClient

Public Member Functions

void setup ()
 
int32_t size () const override
 
light::LightTraits get_traits () override
 
void set_num_leds (uint16_t num_leds)
 
void dump_config ()
 
void write_state (light::LightState *state) override
 
void clear_effect_data () 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 loop ()
 This method will be called repeatedly. More...
 
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 ()
 
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...
 
- Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_HIGH, spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_1MHZ >
 SPIDevice ()
 
 SPIDevice (SPIComponent *parent, GPIOPin *cs_pin)
 
void spi_setup () override
 
void spi_teardown () override
 
void set_spi_parent (SPIComponent *parent)
 
void set_cs_pin (GPIOPin *cs)
 
void set_data_rate (uint32_t data_rate)
 
void set_bit_order (SPIBitOrder order)
 
void set_mode (SPIMode mode)
 
uint8_t read_byte ()
 
void read_array (uint8_t *data, size_t length)
 
void write (uint16_t data, size_t num_bits)
 Write a single data item, up to 32 bits. More...
 
void write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)
 
void write_byte (uint8_t data)
 
void transfer_array (uint8_t *data, size_t length)
 Write the array data, replace with received data. More...
 
void transfer_array (std::array< uint8_t, N > &data)
 
uint8_t transfer_byte (uint8_t data)
 
void write_byte16 (uint16_t data)
 Write 16 bit data. More...
 
void write_array16 (const uint16_t *data, size_t length)
 Write an array of data as 16 bit values, byte-swapping if required. More...
 
void enable ()
 
void disable ()
 
void write_array (const uint8_t *data, size_t length)
 
void write_array (const std::array< uint8_t, N > &data)
 
void write_array (const std::vector< uint8_t > &data)
 
- Public Member Functions inherited from esphome::spi::SPIClient
 SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate)
 
bool spi_is_ready ()
 

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(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

size_t buffer_size_ {}
 
uint8_t * effect_data_ {nullptr}
 
uint8_t * buf_ {nullptr}
 
uint16_t num_leds_
 
- 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}
 
- Protected Attributes inherited from esphome::spi::SPIClient
SPIBitOrder bit_order_ {BIT_ORDER_MSB_FIRST}
 
SPIMode mode_ {MODE0}
 
uint32_t data_rate_ {1000000}
 
SPIComponentparent_ {nullptr}
 
GPIOPincs_ {nullptr}
 
SPIDelegatedelegate_ {SPIDelegate::NULL_DELEGATE}
 

Detailed Description

Definition at line 12 of file spi_led_strip.h.

Member Function Documentation

◆ clear_effect_data()

void esphome::spi_led_strip::SpiLedStrip::clear_effect_data ( )
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 72 of file spi_led_strip.h.

◆ dump_config()

void esphome::spi_led_strip::SpiLedStrip::dump_config ( )
inlinevirtual

Reimplemented from esphome::Component.

Definition at line 46 of file spi_led_strip.h.

◆ get_traits()

light::LightTraits esphome::spi_led_strip::SpiLedStrip::get_traits ( )
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 20 of file spi_led_strip.h.

◆ get_view_internal()

light::ESPColorView esphome::spi_led_strip::SpiLedStrip::get_view_internal ( int32_t  index) const
inlineoverrideprotectedvirtual

Implements esphome::light::AddressableLight.

Definition at line 78 of file spi_led_strip.h.

◆ set_num_leds()

void esphome::spi_led_strip::SpiLedStrip::set_num_leds ( uint16_t  num_leds)
inline

Definition at line 25 of file spi_led_strip.h.

◆ setup()

void esphome::spi_led_strip::SpiLedStrip::setup ( )
inlinevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file spi_led_strip.h.

◆ size()

int32_t esphome::spi_led_strip::SpiLedStrip::size ( ) const
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 18 of file spi_led_strip.h.

◆ write_state()

void esphome::spi_led_strip::SpiLedStrip::write_state ( light::LightState state)
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 55 of file spi_led_strip.h.

Field Documentation

◆ buf_

uint8_t* esphome::spi_led_strip::SpiLedStrip::buf_ {nullptr}
protected

Definition at line 86 of file spi_led_strip.h.

◆ buffer_size_

size_t esphome::spi_led_strip::SpiLedStrip::buffer_size_ {}
protected

Definition at line 84 of file spi_led_strip.h.

◆ effect_data_

uint8_t* esphome::spi_led_strip::SpiLedStrip::effect_data_ {nullptr}
protected

Definition at line 85 of file spi_led_strip.h.

◆ num_leds_

uint16_t esphome::spi_led_strip::SpiLedStrip::num_leds_
protected

Definition at line 87 of file spi_led_strip.h.


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