ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::ht16k33_char::HT16K33CharDisplay Class Referencefinal

#include <ht16k33_char.h>

Inheritance diagram for esphome::ht16k33_char::HT16K33CharDisplay:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

 HT16K33CharDisplay (char *message, uint8_t capacity, uint8_t intensity)
 message holds capacity bytes of UTF-8 text; intensity is 0 (dimmest) to 15
 
void setup () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_writer (ht16k33_char_writer_t &&writer)
 
void set_intensity (uint8_t intensity)
 0 (dimmest) to 15, clamped
 
void add_secondary_display (uint8_t address)
 
void set_glyph_overrides (const uint32_t *glyphs)
 add_characters entries, each a word with the code point in the low half and the segments in the high half, ending with 0.
 
void clear ()
 For printing from automations; the lambda starts from an empty message.
 
uint8_t print (uint8_t pos, const char *str)
 Write str at byte offset pos, where a .
 
uint8_t print (const char *str)
 
uint8_t printf (uint8_t pos, const char *format,...) __attribute__((format(printf
 
uint8_t uint8_t printf (const char *format,...) __attribute__((format(printf
 
uint8_t uint8_t uint8_t strftime (uint8_t pos, const char *format, ESPTime time) __attribute__((format(strftime
 
uint8_t uint8_t uint8_t uint8_t strftime (const char *format, ESPTime time) __attribute__((format(strftime
 
uint8_t uint8_t uint8_t uint8_t uint8_t clock_display (uint8_t pos, bool show_leading_zero, bool use_ampm, ESPTime time)
 HH:MM, or H:MM without the leading zero; 12-hour when use_ampm.
 
void set_blink (uint8_t blink)
 0 steady, 1 at 2 Hz, 2 at 1 Hz, 3 at 0.5 Hz; before setup only the value is kept
 
void display_power (bool power_status)
 Turn the display on or off.
 
void display_standby (bool standby)
 Stop the oscillator, the lowest power state; before setup only the value is kept.
 
void blank ()
 Clear the display memory; the next update redraws the message.
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms.
 
void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly.
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
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 last before a reboot or deep sleep 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.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const LogString *message)
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok)
 Marks the component failed with message (default "Communication failed") unless ok; returns ok.
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok, const LogString *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 ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus.
 
uint8_t get_i2c_address () const
 Returns the I2C address of the object.
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor
 
ErrorCode read (uint8_t *data, size_t len) const
 reads an array of bytes from the device using an I2CBus
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode write (const uint8_t *data, size_t len) const
 writes an array of bytes to a device using an I2CBus
 
ErrorCode write_read (const uint8_t *write_data, size_t write_len, uint8_t *read_data, size_t read_len) const
 writes an array of bytes to a device, then reads an array, as a single transaction
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len) const
 writes an array of bytes to a specific register in the I²C device
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const
 write an array of bytes to a specific register in the I²C device
 
bool write_registers (const I2CRegValue *table, size_t count) const
 Write each register and value of table in order, stopping at the first failure.
 
template<size_t N>
bool write_registers (const I2CRegValue(&table)[N]) const
 
bool check_chip_id (Component *component, uint8_t a_register, uint8_t expected, uint8_t mask=0xFF)
 Read the 8-bit ID at a_register and accept it when it matches expected in the bits set in mask.
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons.
 
bool read_bytes_raw (uint8_t *data, uint8_t len) const
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool read_bytes_16_le (uint8_t a_register, uint16_t *data, uint8_t len)
 Read len 16-bit values stored least significant byte first; no conversion is compiled on little-endian hosts.
 
bool read_bytes_16_le (uint8_t a_register, int16_t *data, uint8_t len)
 
bool read_byte_16_le (uint8_t a_register, uint16_t *data)
 Read a 16-bit value stored least significant byte first.
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len) const
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len) const
 
bool write_byte (uint8_t a_register, uint8_t data) const
 
bool write_byte_16 (uint8_t a_register, uint16_t data) const
 
bool write_byte_16_le (uint8_t a_register, uint16_t data) const
 Write a 16-bit value least significant byte first.
 
bool update_register (uint8_t a_register, uint8_t mask, uint8_t value)
 Read a register, replace the bits in mask with those of value and write it back.
 

Protected Member Functions

uint8_t chip_count_ () const
 
uint8_t chip_address_ (uint8_t chip) const
 
template<typename F >
void for_each_chip_ (F &&f)
 
uint8_t system_setup_ () const
 
uint8_t display_setup_command_ () const
 
bool write_all_ (uint8_t command)
 
void send_ (uint8_t command)
 Send a command to every chip once set up, and report the result.
 
bool write_frames_ (uint8_t length)
 Draw the first length bytes of the message; the chips it does not reach are cleared.
 
uint8_t find_segments_ (uint32_t codepoint) const
 
uint8_t vprintf_ (uint8_t pos, const char *format, va_list arg)
 
- Protected Member Functions inherited from esphome::Component
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
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 id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
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 id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
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.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Protected Attributes

char *const message_
 
const uint8_t capacity_
 
uint8_t length_ {0}
 
uint8_t intensity_
 
uint8_t display_setup_ {1}
 Display setup register: on bit and blink rate; bit 7 remembers standby, which the register does not use.
 
ht16k33_char_writer_t writer_ {}
 
StaticVector< uint8_t, HT16K33_CHAR_SECONDARY_COUNT > secondary_addresses_
 
const uint32_t * glyph_overrides_ {nullptr}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
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 Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
I2CBus * bus_ {nullptr}
 pointer to I2CBus instance
 
uint8_t address_ {0x00}
 store the address of the device on the bus
 

Additional Inherited Members

- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Definition at line 15 of file ht16k33_char.h.

Constructor & Destructor Documentation

◆ HT16K33CharDisplay()

esphome::ht16k33_char::HT16K33CharDisplay::HT16K33CharDisplay ( char * message,
uint8_t capacity,
uint8_t intensity )
inline

message holds capacity bytes of UTF-8 text; intensity is 0 (dimmest) to 15

Definition at line 18 of file ht16k33_char.h.

Member Function Documentation

◆ add_secondary_display()

void esphome::ht16k33_char::HT16K33CharDisplay::add_secondary_display ( uint8_t address)
inline

Definition at line 30 of file ht16k33_char.h.

◆ blank()

void esphome::ht16k33_char::HT16K33CharDisplay::blank ( )

Clear the display memory; the next update redraws the message.

Definition at line 246 of file ht16k33_char.cpp.

◆ chip_address_()

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::chip_address_ ( uint8_t chip) const
inlineprotected

Definition at line 70 of file ht16k33_char.h.

◆ chip_count_()

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::chip_count_ ( ) const
inlineprotected

Definition at line 63 of file ht16k33_char.h.

◆ clear()

void esphome::ht16k33_char::HT16K33CharDisplay::clear ( )
inline

For printing from automations; the lambda starts from an empty message.

Definition at line 39 of file ht16k33_char.h.

◆ clock_display()

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::clock_display ( uint8_t pos,
bool show_leading_zero,
bool use_ampm,
ESPTime time )

HH:MM, or H:MM without the leading zero; 12-hour when use_ampm.

Definition at line 215 of file ht16k33_char.cpp.

◆ display_power()

void esphome::ht16k33_char::HT16K33CharDisplay::display_power ( bool power_status)

Turn the display on or off.

Definition at line 236 of file ht16k33_char.cpp.

◆ display_setup_command_()

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::display_setup_command_ ( ) const
protected

Definition at line 103 of file ht16k33_char.cpp.

◆ display_standby()

void esphome::ht16k33_char::HT16K33CharDisplay::display_standby ( bool standby)

Stop the oscillator, the lowest power state; before setup only the value is kept.

Definition at line 241 of file ht16k33_char.cpp.

◆ dump_config()

void esphome::ht16k33_char::HT16K33CharDisplay::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 84 of file ht16k33_char.cpp.

◆ find_segments_()

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::find_segments_ ( uint32_t codepoint) const
protected

Definition at line 121 of file ht16k33_char.cpp.

◆ for_each_chip_()

template<typename F >
void esphome::ht16k33_char::HT16K33CharDisplay::for_each_chip_ ( F && f)
inlineprotected

Definition at line 78 of file ht16k33_char.h.

◆ get_setup_priority()

float esphome::ht16k33_char::HT16K33CharDisplay::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 24 of file ht16k33_char.h.

◆ print() [1/2]

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::print ( const char * str)
inline

Definition at line 43 of file ht16k33_char.h.

◆ print() [2/2]

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::print ( uint8_t pos,
const char * str )

Write str at byte offset pos, where a .

, a : and each byte of a multi-byte character count as one. Returns the bytes written.

Definition at line 170 of file ht16k33_char.cpp.

◆ printf() [1/2]

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::printf ( const char * format,
... )

Definition at line 200 of file ht16k33_char.cpp.

◆ printf() [2/2]

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::printf ( uint8_t pos,
const char * format,
... )

Definition at line 192 of file ht16k33_char.cpp.

◆ send_()

void esphome::ht16k33_char::HT16K33CharDisplay::send_ ( uint8_t command)
protected

Send a command to every chip once set up, and report the result.

Definition at line 116 of file ht16k33_char.cpp.

◆ set_blink()

void esphome::ht16k33_char::HT16K33CharDisplay::set_blink ( uint8_t blink)

0 steady, 1 at 2 Hz, 2 at 1 Hz, 3 at 0.5 Hz; before setup only the value is kept

Definition at line 229 of file ht16k33_char.cpp.

◆ set_glyph_overrides()

void esphome::ht16k33_char::HT16K33CharDisplay::set_glyph_overrides ( const uint32_t * glyphs)
inline

add_characters entries, each a word with the code point in the low half and the segments in the high half, ending with 0.

A word is read from flash directly on every platform.

Definition at line 35 of file ht16k33_char.h.

◆ set_intensity()

void esphome::ht16k33_char::HT16K33CharDisplay::set_intensity ( uint8_t intensity)

0 (dimmest) to 15, clamped

Definition at line 224 of file ht16k33_char.cpp.

◆ set_writer()

void esphome::ht16k33_char::HT16K33CharDisplay::set_writer ( ht16k33_char_writer_t && writer)
inline

Definition at line 26 of file ht16k33_char.h.

◆ setup()

void esphome::ht16k33_char::HT16K33CharDisplay::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 68 of file ht16k33_char.cpp.

◆ strftime() [1/2]

uint8_t uint8_t uint8_t uint8_t esphome::ht16k33_char::HT16K33CharDisplay::strftime ( const char * format,
ESPTime time )

◆ strftime() [2/2]

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::strftime ( uint8_t pos,
const char * format,
ESPTime time )

Definition at line 208 of file ht16k33_char.cpp.

◆ system_setup_()

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::system_setup_ ( ) const
protected

Definition at line 99 of file ht16k33_char.cpp.

◆ update()

void esphome::ht16k33_char::HT16K33CharDisplay::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 76 of file ht16k33_char.cpp.

◆ vprintf_()

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::vprintf_ ( uint8_t pos,
const char * format,
va_list arg )
protected

Definition at line 185 of file ht16k33_char.cpp.

◆ write_all_()

bool esphome::ht16k33_char::HT16K33CharDisplay::write_all_ ( uint8_t command)
protected

Definition at line 107 of file ht16k33_char.cpp.

◆ write_frames_()

bool esphome::ht16k33_char::HT16K33CharDisplay::write_frames_ ( uint8_t length)
protected

Draw the first length bytes of the message; the chips it does not reach are cleared.

Definition at line 137 of file ht16k33_char.cpp.

Field Documentation

◆ capacity_

const uint8_t esphome::ht16k33_char::HT16K33CharDisplay::capacity_
protected

Definition at line 93 of file ht16k33_char.h.

◆ display_setup_

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::display_setup_ {1}
protected

Display setup register: on bit and blink rate; bit 7 remembers standby, which the register does not use.

Definition at line 97 of file ht16k33_char.h.

◆ glyph_overrides_

const uint32_t* esphome::ht16k33_char::HT16K33CharDisplay::glyph_overrides_ {nullptr}
protected

Definition at line 103 of file ht16k33_char.h.

◆ intensity_

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::intensity_
protected

Definition at line 95 of file ht16k33_char.h.

◆ length_

uint8_t esphome::ht16k33_char::HT16K33CharDisplay::length_ {0}
protected

Definition at line 94 of file ht16k33_char.h.

◆ message_

char* const esphome::ht16k33_char::HT16K33CharDisplay::message_
protected

Definition at line 92 of file ht16k33_char.h.

◆ secondary_addresses_

StaticVector<uint8_t, HT16K33_CHAR_SECONDARY_COUNT> esphome::ht16k33_char::HT16K33CharDisplay::secondary_addresses_
protected

Definition at line 100 of file ht16k33_char.h.

◆ writer_

ht16k33_char_writer_t esphome::ht16k33_char::HT16K33CharDisplay::writer_ {}
protected

Definition at line 98 of file ht16k33_char.h.


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