ESPHome  2024.7.1
Data Structures | Public Member Functions | Protected Member Functions | Protected Attributes
esphome::sm10bit_base::Sm10BitBase Class Reference

#include <sm10bit_base.h>

Inheritance diagram for esphome::sm10bit_base::Sm10BitBase:
esphome::Component esphome::sm2235::SM2235 esphome::sm2335::SM2335

Data Structures

class  Channel
 

Public Member Functions

void set_model (uint8_t model_id)
 
void set_data_pin (GPIOPin *data_pin)
 
void set_clock_pin (GPIOPin *clock_pin)
 
void set_max_power_color_channels (uint8_t max_power_color_channels)
 
void set_max_power_white_channels (uint8_t max_power_white_channels)
 
float get_setup_priority () const override
 
void setup () override
 
void dump_config () override
 
void loop () override
 
- Public Member Functions inherited from esphome::Component
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 set_channel_value_ (uint8_t channel, uint16_t value)
 
void write_bit_ (bool value)
 
void write_byte_ (uint8_t data)
 
void write_buffer_ (uint8_t *buffer, uint8_t size)
 
- 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

GPIOPindata_pin_
 
GPIOPinclock_pin_
 
uint8_t model_id_
 
uint8_t max_power_color_channels_ {2}
 
uint8_t max_power_white_channels_ {4}
 
uint8_t update_channel_
 
std::vector< uint16_t > pwm_amounts_
 
bool update_ {true}
 
- 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 sm10bit_base.h.

Member Function Documentation

◆ dump_config()

void esphome::sm10bit_base::Sm10BitBase::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::sm2235::SM2235, and esphome::sm2335::SM2335.

◆ get_setup_priority()

float esphome::sm10bit_base::Sm10BitBase::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 25 of file sm10bit_base.h.

◆ loop()

void esphome::sm10bit_base::Sm10BitBase::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 35 of file sm10bit_base.cpp.

◆ set_channel_value_()

void esphome::sm10bit_base::Sm10BitBase::set_channel_value_ ( uint8_t  channel,
uint16_t  value 
)
protected

Definition at line 84 of file sm10bit_base.cpp.

◆ set_clock_pin()

void esphome::sm10bit_base::Sm10BitBase::set_clock_pin ( GPIOPin clock_pin)
inline

Definition at line 17 of file sm10bit_base.h.

◆ set_data_pin()

void esphome::sm10bit_base::Sm10BitBase::set_data_pin ( GPIOPin data_pin)
inline

Definition at line 16 of file sm10bit_base.h.

◆ set_max_power_color_channels()

void esphome::sm10bit_base::Sm10BitBase::set_max_power_color_channels ( uint8_t  max_power_color_channels)
inline

Definition at line 18 of file sm10bit_base.h.

◆ set_max_power_white_channels()

void esphome::sm10bit_base::Sm10BitBase::set_max_power_white_channels ( uint8_t  max_power_white_channels)
inline

Definition at line 21 of file sm10bit_base.h.

◆ set_model()

void esphome::sm10bit_base::Sm10BitBase::set_model ( uint8_t  model_id)
inline

Definition at line 15 of file sm10bit_base.h.

◆ setup()

void esphome::sm10bit_base::Sm10BitBase::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::sm2235::SM2235, and esphome::sm2335::SM2335.

◆ write_bit_()

void esphome::sm10bit_base::Sm10BitBase::write_bit_ ( bool  value)
protected

Definition at line 91 of file sm10bit_base.cpp.

◆ write_buffer_()

void esphome::sm10bit_base::Sm10BitBase::write_buffer_ ( uint8_t *  buffer,
uint8_t  size 
)
protected

Definition at line 114 of file sm10bit_base.cpp.

◆ write_byte_()

void esphome::sm10bit_base::Sm10BitBase::write_byte_ ( uint8_t  data)
protected

Definition at line 100 of file sm10bit_base.cpp.

Field Documentation

◆ clock_pin_

GPIOPin* esphome::sm10bit_base::Sm10BitBase::clock_pin_
protected

Definition at line 53 of file sm10bit_base.h.

◆ data_pin_

GPIOPin* esphome::sm10bit_base::Sm10BitBase::data_pin_
protected

Definition at line 52 of file sm10bit_base.h.

◆ max_power_color_channels_

uint8_t esphome::sm10bit_base::Sm10BitBase::max_power_color_channels_ {2}
protected

Definition at line 55 of file sm10bit_base.h.

◆ max_power_white_channels_

uint8_t esphome::sm10bit_base::Sm10BitBase::max_power_white_channels_ {4}
protected

Definition at line 56 of file sm10bit_base.h.

◆ model_id_

uint8_t esphome::sm10bit_base::Sm10BitBase::model_id_
protected

Definition at line 54 of file sm10bit_base.h.

◆ pwm_amounts_

std::vector<uint16_t> esphome::sm10bit_base::Sm10BitBase::pwm_amounts_
protected

Definition at line 58 of file sm10bit_base.h.

◆ update_

bool esphome::sm10bit_base::Sm10BitBase::update_ {true}
protected

Definition at line 59 of file sm10bit_base.h.

◆ update_channel_

uint8_t esphome::sm10bit_base::Sm10BitBase::update_channel_
protected

Definition at line 57 of file sm10bit_base.h.


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