ESPHome 2026.2.1
Loading...
Searching...
No Matches
esphome::dsmr::Dsmr Class Reference

#include <dsmr.h>

Inheritance diagram for esphome::dsmr::Dsmr:
esphome::Component esphome::uart::UARTDevice

Public Member Functions

 Dsmr (uart::UARTComponent *uart, bool crc_check)
 
void setup () override
 
void loop () override
 
bool parse_telegram ()
 
void publish_sensors (MyData &data)
 
void dump_config () override
 
void set_decryption_key (const char *decryption_key)
 
void set_max_telegram_length (size_t length)
 
void set_request_pin (GPIOPin *request_pin)
 
void set_request_interval (uint32_t interval)
 
void set_receive_timeout (uint32_t timeout)
 
 DSMR_SENSOR_LIST (DSMR_SET_SENSOR,) DSMR_TEXT_SENSOR_LIST(DSMR_SET_TEXT_SENSOR
 
void set_telegram (text_sensor::TextSensor *sensor)
 
- Public Member Functions inherited from esphome::Component
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.
 
bool is_idle () const
 Check if this component is idle.
 
virtual void mark_failed ()
 Mark this component as failed.
 
 ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)
 
void mark_failed (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 (const char *message=nullptr)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
 ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const char *name, uint32_t length=5000)
 Set warning status flag and automatically clear it after a timeout.
 
void status_momentary_error (const char *name, uint32_t length=5000)
 Set error status flag and automatically clear it after a timeout.
 
bool has_overridden_loop () const
 
void set_component_source (const LogString *source)
 Set where this component was loaded from for some debug messages.
 
const LogString * get_component_log_str () const
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 
- Public Member Functions inherited from esphome::uart::UARTDevice
 UARTDevice ()=default
 
 UARTDevice (UARTComponent *parent)
 
void set_uart_parent (UARTComponent *parent)
 
void write_byte (uint8_t data)
 
void set_rx_full_threshold (size_t rx_full_threshold)
 
void set_rx_full_threshold_ms (size_t time)
 
size_t get_rx_full_threshold ()
 
void set_rx_timeout (size_t rx_timeout)
 
size_t get_rx_timeout ()
 
void write_array (const uint8_t *data, size_t len)
 
void write_array (const std::vector< uint8_t > &data)
 
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
 
void write_str (const char *str)
 
bool read_byte (uint8_t *data)
 
bool peek_byte (uint8_t *data)
 
bool read_array (uint8_t *data, size_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
 
size_t available ()
 
void flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning.
 

Protected Member Functions

void receive_telegram_ ()
 
void receive_encrypted_telegram_ ()
 
void reset_telegram_ ()
 
void drain_rx_buffer_ ()
 
bool available_within_timeout_ ()
 Wait for UART data to become available within the read timeout.
 
bool request_interval_reached_ ()
 
bool ready_to_request_data_ ()
 
void start_requesting_data_ ()
 
void stop_requesting_data_ ()
 
bool receive_timeout_reached_ ()
 
 DSMR_SENSOR_LIST (DSMR_DECLARE_SENSOR,) DSMR_TEXT_SENSOR_LIST(DSMR_DECLARE_TEXT_SENSOR
 
- 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 (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 (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time
 
ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)
 
 ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)
 
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 (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
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 (uint32_t id)
 

Protected Attributes

uint32_t request_interval_
 
GPIOPinrequest_pin_ {nullptr}
 
uint32_t last_request_time_ {0}
 
bool requesting_data_ {false}
 
uint32_t receive_timeout_
 
size_t max_telegram_len_
 
char * telegram_ {nullptr}
 
size_t bytes_read_ {0}
 
uint8_t * crypt_telegram_ {nullptr}
 
size_t crypt_telegram_len_ {0}
 
size_t crypt_bytes_read_ {0}
 
uint32_t last_read_time_ {0}
 
bool header_found_ {false}
 
bool footer_found_ {false}
 
text_sensor::TextSensors_telegram_ {nullptr}
 
std::vector< uint8_t > decryption_key_ {}
 
bool crc_check_
 
- Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo cancel_interval )(const char *name)
 Cancel an interval function.
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t initial_wait_time
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t max_attempts
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint32_t initial_wait_time
 
uint32_t uint8_t max_attempts
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint8_t max_attempts
 
uint8_t std::function< RetryResult(uint8_t)> && f
 
uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo cancel_timeout )(const char *name)
 Cancel a timeout function.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi defer )(const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo cancel_defer )(const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
const LogString * 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.
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
 

Detailed Description

Definition at line 43 of file dsmr.h.

Constructor & Destructor Documentation

◆ Dsmr()

esphome::dsmr::Dsmr::Dsmr ( uart::UARTComponent * uart,
bool crc_check )
inline

Definition at line 45 of file dsmr.h.

Member Function Documentation

◆ available_within_timeout_()

bool esphome::dsmr::Dsmr::available_within_timeout_ ( )
protected

Wait for UART data to become available within the read timeout.

The smart meter might provide data in chunks, causing available() to return 0. When we're already reading a telegram, then we don't return right away (to handle further data in an upcoming loop) but wait a little while using this method to see if more data are incoming. By not returning, we prevent other components from taking so much time that the UART RX buffer overflows and bytes of the telegram get lost in the process.

Definition at line 58 of file dsmr.cpp.

◆ drain_rx_buffer_()

void esphome::dsmr::Dsmr::drain_rx_buffer_ ( )
protected

Definition at line 121 of file dsmr.cpp.

◆ DSMR_SENSOR_LIST() [1/2]

esphome::dsmr::Dsmr::DSMR_SENSOR_LIST ( DSMR_DECLARE_SENSOR )
protected

◆ DSMR_SENSOR_LIST() [2/2]

esphome::dsmr::Dsmr::DSMR_SENSOR_LIST ( DSMR_SET_SENSOR )

◆ dump_config()

void esphome::dsmr::Dsmr::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 307 of file dsmr.cpp.

◆ loop()

void esphome::dsmr::Dsmr::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file dsmr.cpp.

◆ parse_telegram()

bool esphome::dsmr::Dsmr::parse_telegram ( )

Definition at line 282 of file dsmr.cpp.

◆ publish_sensors()

void esphome::dsmr::Dsmr::publish_sensors ( MyData & data)
inline

Definition at line 52 of file dsmr.h.

◆ ready_to_request_data_()

bool esphome::dsmr::Dsmr::ready_to_request_data_ ( )
protected

Definition at line 30 of file dsmr.cpp.

◆ receive_encrypted_telegram_()

void esphome::dsmr::Dsmr::receive_encrypted_telegram_ ( )
protected

Definition at line 205 of file dsmr.cpp.

◆ receive_telegram_()

void esphome::dsmr::Dsmr::receive_telegram_ ( )
protected

Definition at line 139 of file dsmr.cpp.

◆ receive_timeout_reached_()

bool esphome::dsmr::Dsmr::receive_timeout_reached_ ( )
protected

Definition at line 56 of file dsmr.cpp.

◆ request_interval_reached_()

bool esphome::dsmr::Dsmr::request_interval_reached_ ( )
protected

Definition at line 49 of file dsmr.cpp.

◆ reset_telegram_()

void esphome::dsmr::Dsmr::reset_telegram_ ( )
protected

Definition at line 131 of file dsmr.cpp.

◆ set_decryption_key()

void esphome::dsmr::Dsmr::set_decryption_key ( const char * decryption_key)

Definition at line 327 of file dsmr.cpp.

◆ set_max_telegram_length()

void esphome::dsmr::Dsmr::set_max_telegram_length ( size_t length)
inline

Definition at line 67 of file dsmr.h.

◆ set_receive_timeout()

void esphome::dsmr::Dsmr::set_receive_timeout ( uint32_t timeout)
inline

Definition at line 70 of file dsmr.h.

◆ set_request_interval()

void esphome::dsmr::Dsmr::set_request_interval ( uint32_t interval)
inline

Definition at line 69 of file dsmr.h.

◆ set_request_pin()

void esphome::dsmr::Dsmr::set_request_pin ( GPIOPin * request_pin)
inline

Definition at line 68 of file dsmr.h.

◆ set_telegram()

void esphome::dsmr::Dsmr::set_telegram ( text_sensor::TextSensor * sensor)
inline

Definition at line 82 of file dsmr.h.

◆ setup()

void esphome::dsmr::Dsmr::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file dsmr.cpp.

◆ start_requesting_data_()

void esphome::dsmr::Dsmr::start_requesting_data_ ( )
protected

Definition at line 95 of file dsmr.cpp.

◆ stop_requesting_data_()

void esphome::dsmr::Dsmr::stop_requesting_data_ ( )
protected

Definition at line 108 of file dsmr.cpp.

Field Documentation

◆ bytes_read_

size_t esphome::dsmr::Dsmr::bytes_read_ {0}
protected

Definition at line 116 of file dsmr.h.

◆ crc_check_

bool esphome::dsmr::Dsmr::crc_check_
protected

Definition at line 135 of file dsmr.h.

◆ crypt_bytes_read_

size_t esphome::dsmr::Dsmr::crypt_bytes_read_ {0}
protected

Definition at line 119 of file dsmr.h.

◆ crypt_telegram_

uint8_t* esphome::dsmr::Dsmr::crypt_telegram_ {nullptr}
protected

Definition at line 117 of file dsmr.h.

◆ crypt_telegram_len_

size_t esphome::dsmr::Dsmr::crypt_telegram_len_ {0}
protected

Definition at line 118 of file dsmr.h.

◆ decryption_key_

std::vector<uint8_t> esphome::dsmr::Dsmr::decryption_key_ {}
protected

Definition at line 134 of file dsmr.h.

◆ footer_found_

bool esphome::dsmr::Dsmr::footer_found_ {false}
protected

Definition at line 122 of file dsmr.h.

◆ header_found_

bool esphome::dsmr::Dsmr::header_found_ {false}
protected

Definition at line 121 of file dsmr.h.

◆ last_read_time_

uint32_t esphome::dsmr::Dsmr::last_read_time_ {0}
protected

Definition at line 120 of file dsmr.h.

◆ last_request_time_

uint32_t esphome::dsmr::Dsmr::last_request_time_ {0}
protected

Definition at line 105 of file dsmr.h.

◆ max_telegram_len_

size_t esphome::dsmr::Dsmr::max_telegram_len_
protected

Definition at line 114 of file dsmr.h.

◆ receive_timeout_

uint32_t esphome::dsmr::Dsmr::receive_timeout_
protected

Definition at line 112 of file dsmr.h.

◆ request_interval_

uint32_t esphome::dsmr::Dsmr::request_interval_
protected

Definition at line 102 of file dsmr.h.

◆ request_pin_

GPIOPin* esphome::dsmr::Dsmr::request_pin_ {nullptr}
protected

Definition at line 104 of file dsmr.h.

◆ requesting_data_

bool esphome::dsmr::Dsmr::requesting_data_ {false}
protected

Definition at line 106 of file dsmr.h.

◆ s_telegram_

text_sensor::TextSensor* esphome::dsmr::Dsmr::s_telegram_ {nullptr}
protected

Definition at line 125 of file dsmr.h.

◆ telegram_

char* esphome::dsmr::Dsmr::telegram_ {nullptr}
protected

Definition at line 115 of file dsmr.h.


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