ESPHome  2024.11.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::tm1637::TM1637Display Class Reference

#include <tm1637.h>

Inheritance diagram for esphome::tm1637::TM1637Display:
esphome::PollingComponent esphome::Component

Public Member Functions

void set_writer (tm1637_writer_t &&writer)
 
void setup () override
 
void dump_config () override
 
void set_clk_pin (GPIOPin *pin)
 
void set_dio_pin (GPIOPin *pin)
 
float get_setup_priority () const override
 
void update () override
 
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 set_intensity (uint8_t intensity)
 
void set_inverted (bool inverted)
 
void set_length (uint8_t length)
 
void set_on (bool on)
 
void display ()
 
void loop () override
 
uint8_t get_keys ()
 
void add_tm1637_key (TM1637Key *tm1637_key)
 
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...
 
- 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 bit_delay_ ()
 
void setup_pins_ ()
 
bool send_byte_ (uint8_t b)
 
uint8_t read_byte_ ()
 
void start_ ()
 
void stop_ ()
 
- 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

GPIOPindio_pin_
 
GPIOPinclk_pin_
 
uint8_t intensity_
 
uint8_t length_
 
bool inverted_
 
bool on_ {true}
 
optional< tm1637_writer_twriter_ {}
 
uint8_t buffer_ [6] = {0}
 
std::vector< TM1637Key * > tm1637_keys_ {}
 
- 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 24 of file tm1637.h.

Member Function Documentation

◆ add_tm1637_key()

void esphome::tm1637::TM1637Display::add_tm1637_key ( TM1637Key tm1637_key)
inline

Definition at line 59 of file tm1637.h.

◆ bit_delay_()

void esphome::tm1637::TM1637Display::bit_delay_ ( )
protected

Definition at line 186 of file tm1637.cpp.

◆ display()

void esphome::tm1637::TM1637Display::display ( )

Definition at line 201 of file tm1637.cpp.

◆ dump_config()

void esphome::tm1637::TM1637Display::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 137 of file tm1637.cpp.

◆ get_keys()

uint8_t esphome::tm1637::TM1637Display::get_keys ( )

Definition at line 154 of file tm1637.cpp.

◆ get_setup_priority()

float esphome::tm1637::TM1637Display::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 185 of file tm1637.cpp.

◆ loop()

void esphome::tm1637::TM1637Display::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 148 of file tm1637.cpp.

◆ print() [1/2]

uint8_t esphome::tm1637::TM1637Display::print ( uint8_t  pos,
const char *  str 
)

Print str at the given position.

Definition at line 300 of file tm1637.cpp.

◆ print() [2/2]

uint8_t esphome::tm1637::TM1637Display::print ( const char *  str)

Print str at position 0.

Definition at line 350 of file tm1637.cpp.

◆ printf() [1/2]

uint8_t esphome::tm1637::TM1637Display::printf ( uint8_t  pos,
const char *  format,
  ... 
)

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

Definition at line 351 of file tm1637.cpp.

◆ printf() [2/2]

uint8_t esphome::tm1637::TM1637Display::printf ( const char *  format,
  ... 
)

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

Definition at line 361 of file tm1637.cpp.

◆ read_byte_()

uint8_t esphome::tm1637::TM1637Display::read_byte_ ( )
protected

Definition at line 270 of file tm1637.cpp.

◆ send_byte_()

bool esphome::tm1637::TM1637Display::send_byte_ ( uint8_t  b)
protected

Definition at line 231 of file tm1637.cpp.

◆ set_clk_pin()

void esphome::tm1637::TM1637Display::set_clk_pin ( GPIOPin pin)
inline

Definition at line 32 of file tm1637.h.

◆ set_dio_pin()

void esphome::tm1637::TM1637Display::set_dio_pin ( GPIOPin pin)
inline

Definition at line 33 of file tm1637.h.

◆ set_intensity()

void esphome::tm1637::TM1637Display::set_intensity ( uint8_t  intensity)
inline

Definition at line 49 of file tm1637.h.

◆ set_inverted()

void esphome::tm1637::TM1637Display::set_inverted ( bool  inverted)
inline

Definition at line 50 of file tm1637.h.

◆ set_length()

void esphome::tm1637::TM1637Display::set_length ( uint8_t  length)
inline

Definition at line 51 of file tm1637.h.

◆ set_on()

void esphome::tm1637::TM1637Display::set_on ( bool  on)
inline

Definition at line 52 of file tm1637.h.

◆ set_writer()

void esphome::tm1637::TM1637Display::set_writer ( tm1637_writer_t &&  writer)
inline

Definition at line 26 of file tm1637.h.

◆ setup()

void esphome::tm1637::TM1637Display::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 127 of file tm1637.cpp.

◆ setup_pins_()

void esphome::tm1637::TM1637Display::setup_pins_ ( )
protected

◆ start_()

void esphome::tm1637::TM1637Display::start_ ( )
protected

Definition at line 187 of file tm1637.cpp.

◆ stop_()

void esphome::tm1637::TM1637Display::stop_ ( )
protected

Definition at line 192 of file tm1637.cpp.

◆ strftime() [1/2]

uint8_t esphome::tm1637::TM1637Display::strftime ( uint8_t  pos,
const char *  format,
ESPTime  time 
)

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

Definition at line 372 of file tm1637.cpp.

◆ strftime() [2/2]

uint8_t esphome::tm1637::TM1637Display::strftime ( const char *  format,
ESPTime  time 
)

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

Definition at line 379 of file tm1637.cpp.

◆ update()

void esphome::tm1637::TM1637Display::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 177 of file tm1637.cpp.

Field Documentation

◆ buffer_

uint8_t esphome::tm1637::TM1637Display::buffer_[6] = {0}
protected

Definition at line 82 of file tm1637.h.

◆ clk_pin_

GPIOPin* esphome::tm1637::TM1637Display::clk_pin_
protected

Definition at line 76 of file tm1637.h.

◆ dio_pin_

GPIOPin* esphome::tm1637::TM1637Display::dio_pin_
protected

Definition at line 75 of file tm1637.h.

◆ intensity_

uint8_t esphome::tm1637::TM1637Display::intensity_
protected

Definition at line 77 of file tm1637.h.

◆ inverted_

bool esphome::tm1637::TM1637Display::inverted_
protected

Definition at line 79 of file tm1637.h.

◆ length_

uint8_t esphome::tm1637::TM1637Display::length_
protected

Definition at line 78 of file tm1637.h.

◆ on_

bool esphome::tm1637::TM1637Display::on_ {true}
protected

Definition at line 80 of file tm1637.h.

◆ tm1637_keys_

std::vector<TM1637Key *> esphome::tm1637::TM1637Display::tm1637_keys_ {}
protected

Definition at line 84 of file tm1637.h.

◆ writer_

optional<tm1637_writer_t> esphome::tm1637::TM1637Display::writer_ {}
protected

Definition at line 81 of file tm1637.h.


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