ESPHome 2025.8.0b2
Loading...
Searching...
No Matches
esphome::tm1651::TM1651Display Class Reference

#include <tm1651.h>

Inheritance diagram for esphome::tm1651::TM1651Display:
esphome::Component

Public Member Functions

void set_clk_pin (InternalGPIOPin *pin)
 
void set_dio_pin (InternalGPIOPin *pin)
 
void setup () override
 
void dump_config () override
 
void set_brightness (uint8_t new_brightness)
 
void set_brightness (TM1651Brightness new_brightness)
 
void set_level (uint8_t new_level)
 
void set_level_percent (uint8_t percentage)
 
void turn_off ()
 
void turn_on ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly.
 
virtual float get_setup_priority () const
 priority of setup().
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop().
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called after teardown is complete to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
virtual void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const char *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
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=nullptr)
 
void status_set_error (const char *message=nullptr)
 
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.
 
const char * get_component_source () const
 Get the integration where this component was declared as a string.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 

Protected Member Functions

uint8_t calculate_level_ (uint8_t percentage)
 
void display_level_ ()
 
uint8_t remap_brightness_ (uint8_t new_brightness)
 
void update_brightness_ (uint8_t on_off_control)
 
bool write_byte_ (uint8_t data)
 
void half_cycle_clock_low_ (bool data_bit)
 
void half_cycle_clock_high_ ()
 
bool half_cycle_clock_high_ack_ ()
 
void start_ ()
 
void stop_ ()
 
void delineate_transmission_ (bool dio_state)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function.
 
bool cancel_interval (const char *name)
 
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.
 
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.
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function.
 
bool cancel_timeout (const char *name)
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty.
 

Protected Attributes

InternalGPIOPinclk_pin_
 
InternalGPIOPindio_pin_
 
bool display_on_ {true}
 
uint8_t brightness_ {}
 
uint8_t level_ {0}
 
- Protected Attributes inherited from esphome::Component
const char * component_source_ {nullptr}
 
uint16_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
 Warn if blocked for this many ms (max 65.5s)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 

Detailed Description

Definition at line 16 of file tm1651.h.

Member Function Documentation

◆ calculate_level_()

uint8_t esphome::tm1651::TM1651Display::calculate_level_ ( uint8_t percentage)
protected

Definition at line 145 of file tm1651.cpp.

◆ delineate_transmission_()

void esphome::tm1651::TM1651Display::delineate_transmission_ ( bool dio_state)
protected

Definition at line 245 of file tm1651.cpp.

◆ display_level_()

void esphome::tm1651::TM1651Display::display_level_ ( )
protected

Definition at line 154 of file tm1651.cpp.

◆ dump_config()

void esphome::tm1651::TM1651Display::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 102 of file tm1651.cpp.

◆ half_cycle_clock_high_()

void esphome::tm1651::TM1651Display::half_cycle_clock_high_ ( )
protected

Definition at line 205 of file tm1651.cpp.

◆ half_cycle_clock_high_ack_()

bool esphome::tm1651::TM1651Display::half_cycle_clock_high_ack_ ( )
protected

Definition at line 211 of file tm1651.cpp.

◆ half_cycle_clock_low_()

void esphome::tm1651::TM1651Display::half_cycle_clock_low_ ( bool data_bit)
protected

Definition at line 196 of file tm1651.cpp.

◆ remap_brightness_()

uint8_t esphome::tm1651::TM1651Display::remap_brightness_ ( uint8_t new_brightness)
protected

Definition at line 165 of file tm1651.cpp.

◆ set_brightness() [1/2]

void esphome::tm1651::TM1651Display::set_brightness ( TM1651Brightness new_brightness)
inline

Definition at line 25 of file tm1651.h.

◆ set_brightness() [2/2]

void esphome::tm1651::TM1651Display::set_brightness ( uint8_t new_brightness)

Definition at line 108 of file tm1651.cpp.

◆ set_clk_pin()

void esphome::tm1651::TM1651Display::set_clk_pin ( InternalGPIOPin * pin)
inline

Definition at line 18 of file tm1651.h.

◆ set_dio_pin()

void esphome::tm1651::TM1651Display::set_dio_pin ( InternalGPIOPin * pin)
inline

Definition at line 19 of file tm1651.h.

◆ set_level()

void esphome::tm1651::TM1651Display::set_level ( uint8_t new_level)

Definition at line 115 of file tm1651.cpp.

◆ set_level_percent()

void esphome::tm1651::TM1651Display::set_level_percent ( uint8_t percentage)

Definition at line 124 of file tm1651.cpp.

◆ setup()

void esphome::tm1651::TM1651Display::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 88 of file tm1651.cpp.

◆ start_()

void esphome::tm1651::TM1651Display::start_ ( )
protected

Definition at line 235 of file tm1651.cpp.

◆ stop_()

void esphome::tm1651::TM1651Display::stop_ ( )
protected

Definition at line 240 of file tm1651.cpp.

◆ turn_off()

void esphome::tm1651::TM1651Display::turn_off ( )

Definition at line 131 of file tm1651.cpp.

◆ turn_on()

void esphome::tm1651::TM1651Display::turn_on ( )

Definition at line 136 of file tm1651.cpp.

◆ update_brightness_()

void esphome::tm1651::TM1651Display::update_brightness_ ( uint8_t on_off_control)
protected

Definition at line 175 of file tm1651.cpp.

◆ write_byte_()

bool esphome::tm1651::TM1651Display::write_byte_ ( uint8_t data)
protected

Definition at line 183 of file tm1651.cpp.

Field Documentation

◆ brightness_

uint8_t esphome::tm1651::TM1651Display::brightness_ {}
protected

Definition at line 56 of file tm1651.h.

◆ clk_pin_

InternalGPIOPin* esphome::tm1651::TM1651Display::clk_pin_
protected

Definition at line 52 of file tm1651.h.

◆ dio_pin_

InternalGPIOPin* esphome::tm1651::TM1651Display::dio_pin_
protected

Definition at line 53 of file tm1651.h.

◆ display_on_

bool esphome::tm1651::TM1651Display::display_on_ {true}
protected

Definition at line 55 of file tm1651.h.

◆ level_

uint8_t esphome::tm1651::TM1651Display::level_ {0}
protected

Definition at line 57 of file tm1651.h.


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