ESPHome  2022.1.2
Data Structures | Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::tlc5947::TLC5947 Class Reference

#include <tlc5947.h>

Inheritance diagram for esphome::tlc5947::TLC5947:
esphome::Component

Data Structures

class  Channel
 

Public Member Functions

void set_data_pin (GPIOPin *data_pin)
 
void set_clock_pin (GPIOPin *clock_pin)
 
void set_lat_pin (GPIOPin *lat_pin)
 
void set_outenable_pin (GPIOPin *outenable_pin)
 
void set_num_chips (uint8_t num_chips)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void loop () override
 Send new values if they were updated. More...
 
- 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 ()
 
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...
 

Data Fields

const uint8_t N_CHANNELS_PER_CHIP = 24
 

Protected Member Functions

void set_channel_value_ (uint16_t channel, uint16_t value)
 
- 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()> &&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

GPIOPindata_pin_
 
GPIOPinclock_pin_
 
GPIOPinlat_pin_
 
GPIOPinoutenable_pin_ {nullptr}
 
uint8_t num_chips_
 
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 13 of file tlc5947.h.

Member Function Documentation

◆ dump_config()

void esphome::tlc5947::TLC5947::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 25 of file tlc5947.cpp.

◆ get_setup_priority()

float esphome::tlc5947::TLC5947::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file tlc5947.h.

◆ loop()

void esphome::tlc5947::TLC5947::loop ( )
overridevirtual

Send new values if they were updated.

Reimplemented from esphome::Component.

Definition at line 35 of file tlc5947.cpp.

◆ set_channel_value_()

void esphome::tlc5947::TLC5947::set_channel_value_ ( uint16_t  channel,
uint16_t  value 
)
inlineprotected

Definition at line 50 of file tlc5947.h.

◆ set_clock_pin()

void esphome::tlc5947::TLC5947::set_clock_pin ( GPIOPin clock_pin)
inline

Definition at line 20 of file tlc5947.h.

◆ set_data_pin()

void esphome::tlc5947::TLC5947::set_data_pin ( GPIOPin data_pin)
inline

Definition at line 19 of file tlc5947.h.

◆ set_lat_pin()

void esphome::tlc5947::TLC5947::set_lat_pin ( GPIOPin lat_pin)
inline

Definition at line 21 of file tlc5947.h.

◆ set_num_chips()

void esphome::tlc5947::TLC5947::set_num_chips ( uint8_t  num_chips)
inline

Definition at line 23 of file tlc5947.h.

◆ set_outenable_pin()

void esphome::tlc5947::TLC5947::set_outenable_pin ( GPIOPin outenable_pin)
inline

Definition at line 22 of file tlc5947.h.

◆ setup()

void esphome::tlc5947::TLC5947::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file tlc5947.cpp.

Field Documentation

◆ clock_pin_

GPIOPin* esphome::tlc5947::TLC5947::clock_pin_
protected

Definition at line 60 of file tlc5947.h.

◆ data_pin_

GPIOPin* esphome::tlc5947::TLC5947::data_pin_
protected

Definition at line 59 of file tlc5947.h.

◆ lat_pin_

GPIOPin* esphome::tlc5947::TLC5947::lat_pin_
protected

Definition at line 61 of file tlc5947.h.

◆ N_CHANNELS_PER_CHIP

const uint8_t esphome::tlc5947::TLC5947::N_CHANNELS_PER_CHIP = 24

Definition at line 17 of file tlc5947.h.

◆ num_chips_

uint8_t esphome::tlc5947::TLC5947::num_chips_
protected

Definition at line 63 of file tlc5947.h.

◆ outenable_pin_

GPIOPin* esphome::tlc5947::TLC5947::outenable_pin_ {nullptr}
protected

Definition at line 62 of file tlc5947.h.

◆ pwm_amounts_

std::vector<uint16_t> esphome::tlc5947::TLC5947::pwm_amounts_
protected

Definition at line 65 of file tlc5947.h.

◆ update_

bool esphome::tlc5947::TLC5947::update_ {true}
protected

Definition at line 66 of file tlc5947.h.


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