ESPHome  2024.12.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::tm1638::TM1638Component Class Reference

#include <tm1638.h>

Inheritance diagram for esphome::tm1638::TM1638Component:
esphome::PollingComponent esphome::Component

Public Member Functions

void set_writer (tm1638_writer_t &&writer)
 
void setup () override
 
void dump_config () override
 
void update () override
 
float get_setup_priority () const override
 
void set_intensity (uint8_t brightness_level)
 
void display ()
 
void set_clk_pin (GPIOPin *pin)
 
void set_dio_pin (GPIOPin *pin)
 
void set_stb_pin (GPIOPin *pin)
 
void register_listener (KeyListener *listener)
 
uint8_t printf (uint8_t pos, const char *format,...) __attribute__((format(printf
 Evaluate the printf-format and print the result at the given position. More...
 
uint8_t uint8_t printf (const char *format,...) __attribute__((format(printf
 Evaluate the printf-format and print the result at position 0. More...
 
uint8_t uint8_t uint8_t print (uint8_t pos, const char *str)
 Print str at the given position. More...
 
uint8_t print (const char *str)
 Print str at position 0. More...
 
void loop () override
 
uint8_t get_keys ()
 
uint8_t strftime (uint8_t pos, const char *format, ESPTime time) __attribute__((format(strftime
 Evaluate the strftime-format and print the result at the given position. More...
 
uint8_t uint8_t strftime (const char *format, ESPTime time) __attribute__((format(strftime
 Evaluate the strftime-format and print the result at position 0. More...
 
uint8_t uint8_t void set_led (int led_pos, bool led_on_off)
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
void start_poller ()
 
void stop_poller ()
 
- 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_7seg_ (int seg_pos, uint8_t seg_bits)
 
void send_command_ (uint8_t value)
 
void send_command_leave_open_ (uint8_t value)
 
void send_commands_ (uint8_t const commands[], uint8_t num_commands)
 
void send_command_sequence_ (uint8_t commands[], uint8_t num_commands, uint8_t starting_address)
 
void shift_out_ (uint8_t value)
 
void reset_ ()
 
uint8_t shift_in_ ()
 
- 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

uint8_t intensity_ {}
 
GPIOPinclk_pin_
 brghtness of the display 0 through 7 More...
 
GPIOPinstb_pin_
 
GPIOPindio_pin_
 
uint8_t * buffer_ = new uint8_t[8]
 
optional< tm1638_writer_twriter_ {}
 
std::vector< KeyListener * > listeners_ {}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- 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 23 of file tm1638.h.

Member Function Documentation

◆ display()

void esphome::tm1638::TM1638Component::display ( )

Definition at line 96 of file tm1638.cpp.

◆ dump_config()

void esphome::tm1638::TM1638Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 45 of file tm1638.cpp.

◆ get_keys()

uint8_t esphome::tm1638::TM1638Component::get_keys ( )

Definition at line 63 of file tm1638.cpp.

◆ get_setup_priority()

float esphome::tm1638::TM1638Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 94 of file tm1638.cpp.

◆ loop()

void esphome::tm1638::TM1638Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 54 of file tm1638.cpp.

◆ print() [1/2]

uint8_t esphome::tm1638::TM1638Component::print ( uint8_t  pos,
const char *  str 
)

Print str at the given position.

Definition at line 151 of file tm1638.cpp.

◆ print() [2/2]

uint8_t esphome::tm1638::TM1638Component::print ( const char *  str)

Print str at position 0.

Definition at line 191 of file tm1638.cpp.

◆ printf() [1/2]

uint8_t esphome::tm1638::TM1638Component::printf ( uint8_t  pos,
const char *  format,
  ... 
)

Evaluate the printf-format and print the result at the given position.

Definition at line 193 of file tm1638.cpp.

◆ printf() [2/2]

uint8_t esphome::tm1638::TM1638Component::printf ( const char *  format,
  ... 
)

Evaluate the printf-format and print the result at position 0.

Definition at line 203 of file tm1638.cpp.

◆ register_listener()

void esphome::tm1638::TM1638Component::register_listener ( KeyListener listener)
inline

Definition at line 37 of file tm1638.h.

◆ reset_()

void esphome::tm1638::TM1638Component::reset_ ( )
protected

Definition at line 102 of file tm1638.cpp.

◆ send_command_()

void esphome::tm1638::TM1638Component::send_command_ ( uint8_t  value)
protected

Definition at line 225 of file tm1638.cpp.

◆ send_command_leave_open_()

void esphome::tm1638::TM1638Component::send_command_leave_open_ ( uint8_t  value)
protected

Definition at line 242 of file tm1638.cpp.

◆ send_command_sequence_()

void esphome::tm1638::TM1638Component::send_command_sequence_ ( uint8_t  commands[],
uint8_t  num_commands,
uint8_t  starting_address 
)
protected

Definition at line 247 of file tm1638.cpp.

◆ send_commands_()

void esphome::tm1638::TM1638Component::send_commands_ ( uint8_t const  commands[],
uint8_t  num_commands 
)
protected

Definition at line 232 of file tm1638.cpp.

◆ set_7seg_()

void esphome::tm1638::TM1638Component::set_7seg_ ( int  seg_pos,
uint8_t  seg_bits 
)
protected

Definition at line 126 of file tm1638.cpp.

◆ set_clk_pin()

void esphome::tm1638::TM1638Component::set_clk_pin ( GPIOPin pin)
inline

Definition at line 33 of file tm1638.h.

◆ set_dio_pin()

void esphome::tm1638::TM1638Component::set_dio_pin ( GPIOPin pin)
inline

Definition at line 34 of file tm1638.h.

◆ set_intensity()

void esphome::tm1638::TM1638Component::set_intensity ( uint8_t  brightness_level)

Definition at line 137 of file tm1638.cpp.

◆ set_led()

void esphome::tm1638::TM1638Component::set_led ( int  led_pos,
bool  led_on_off 
)

Definition at line 115 of file tm1638.cpp.

◆ set_stb_pin()

void esphome::tm1638::TM1638Component::set_stb_pin ( GPIOPin pin)
inline

Definition at line 35 of file tm1638.h.

◆ set_writer()

void esphome::tm1638::TM1638Component::set_writer ( tm1638_writer_t &&  writer)
inline

Definition at line 25 of file tm1638.h.

◆ setup()

void esphome::tm1638::TM1638Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 22 of file tm1638.cpp.

◆ shift_in_()

uint8_t esphome::tm1638::TM1638Component::shift_in_ ( )
protected

Definition at line 258 of file tm1638.cpp.

◆ shift_out_()

void esphome::tm1638::TM1638Component::shift_out_ ( uint8_t  value)
protected

Definition at line 272 of file tm1638.cpp.

◆ strftime() [1/2]

uint8_t esphome::tm1638::TM1638Component::strftime ( uint8_t  pos,
const char *  format,
ESPTime  time 
)

Evaluate the strftime-format and print the result at the given position.

Definition at line 214 of file tm1638.cpp.

◆ strftime() [2/2]

uint8_t esphome::tm1638::TM1638Component::strftime ( const char *  format,
ESPTime  time 
)

Evaluate the strftime-format and print the result at position 0.

Definition at line 221 of file tm1638.cpp.

◆ update()

void esphome::tm1638::TM1638Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 86 of file tm1638.cpp.

Field Documentation

◆ buffer_

uint8_t* esphome::tm1638::TM1638Component::buffer_ = new uint8_t[8]
protected

Definition at line 72 of file tm1638.h.

◆ clk_pin_

GPIOPin* esphome::tm1638::TM1638Component::clk_pin_
protected

brghtness of the display 0 through 7

Definition at line 69 of file tm1638.h.

◆ dio_pin_

GPIOPin* esphome::tm1638::TM1638Component::dio_pin_
protected

Definition at line 71 of file tm1638.h.

◆ intensity_

uint8_t esphome::tm1638::TM1638Component::intensity_ {}
protected

Definition at line 68 of file tm1638.h.

◆ listeners_

std::vector<KeyListener *> esphome::tm1638::TM1638Component::listeners_ {}
protected

Definition at line 74 of file tm1638.h.

◆ stb_pin_

GPIOPin* esphome::tm1638::TM1638Component::stb_pin_
protected

Definition at line 70 of file tm1638.h.

◆ writer_

optional<tm1638_writer_t> esphome::tm1638::TM1638Component::writer_ {}
protected

Definition at line 73 of file tm1638.h.


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