ESPHome  2024.5.0
Public Member Functions | Protected Member Functions | Protected Attributes
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 std::string &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)
- Public Member Functions inherited from esphome::Component
virtual float get_setup_priority () const
 priority of setup(). More...
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 ()
bool is_ready ()
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...
- 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 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 ()
int 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. More...

Protected Member Functions

void receive_telegram_ ()
void receive_encrypted_telegram_ ()
void reset_telegram_ ()
bool available_within_timeout_ ()
 Wait for UART data to become available within the read timeout. More...
bool request_interval_reached_ ()
bool ready_to_request_data_ ()
void start_requesting_data_ ()
void stop_requesting_data_ ()
bool receive_timeout_reached_ ()
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
virtual void call_setup ()
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

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}
std::vector< uint8_t > decryption_key_ {}
bool crc_check_
- 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}
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}

Detailed Description

Definition at line 50 of file dsmr.h.

Constructor & Destructor Documentation

◆ Dsmr()

esphome::dsmr::Dsmr::Dsmr ( uart::UARTComponent uart,
bool  crc_check 

Definition at line 52 of file dsmr.h.

Member Function Documentation

◆ available_within_timeout_()

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

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 62 of file dsmr.cpp.


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



◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 274 of file dsmr.cpp.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 22 of file dsmr.cpp.

◆ parse_telegram()

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

Definition at line 255 of file dsmr.cpp.

◆ publish_sensors()

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

Definition at line 59 of file dsmr.h.

◆ ready_to_request_data_()

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

Definition at line 32 of file dsmr.cpp.

◆ receive_encrypted_telegram_()

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

Definition at line 190 of file dsmr.cpp.

◆ receive_telegram_()

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

Definition at line 136 of file dsmr.cpp.

◆ receive_timeout_reached_()

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

Definition at line 60 of file dsmr.cpp.

◆ request_interval_reached_()

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

Definition at line 53 of file dsmr.cpp.

◆ reset_telegram_()

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

Definition at line 127 of file dsmr.cpp.

◆ set_decryption_key()

void esphome::dsmr::Dsmr::set_decryption_key ( const std::string &  decryption_key)

Definition at line 292 of file dsmr.cpp.

◆ set_max_telegram_length()

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

Definition at line 74 of file dsmr.h.

◆ set_receive_timeout()

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

Definition at line 77 of file dsmr.h.

◆ set_request_interval()

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

Definition at line 76 of file dsmr.h.

◆ set_request_pin()

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

Definition at line 75 of file dsmr.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 15 of file dsmr.cpp.

◆ start_requesting_data_()

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

Definition at line 99 of file dsmr.cpp.

◆ stop_requesting_data_()

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

Definition at line 112 of file dsmr.cpp.

Field Documentation

◆ bytes_read_

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

Definition at line 119 of file dsmr.h.

◆ crc_check_

bool esphome::dsmr::Dsmr::crc_check_

Definition at line 135 of file dsmr.h.

◆ crypt_bytes_read_

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

Definition at line 122 of file dsmr.h.

◆ crypt_telegram_

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

Definition at line 120 of file dsmr.h.

◆ crypt_telegram_len_

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

Definition at line 121 of file dsmr.h.

◆ decryption_key_

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

Definition at line 134 of file dsmr.h.

◆ footer_found_

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

Definition at line 125 of file dsmr.h.

◆ header_found_

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

Definition at line 124 of file dsmr.h.

◆ last_read_time_

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

Definition at line 123 of file dsmr.h.

◆ last_request_time_

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

Definition at line 108 of file dsmr.h.

◆ max_telegram_len_

size_t esphome::dsmr::Dsmr::max_telegram_len_

Definition at line 117 of file dsmr.h.

◆ receive_timeout_

uint32_t esphome::dsmr::Dsmr::receive_timeout_

Definition at line 115 of file dsmr.h.

◆ request_interval_

uint32_t esphome::dsmr::Dsmr::request_interval_

Definition at line 105 of file dsmr.h.

◆ request_pin_

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

Definition at line 107 of file dsmr.h.

◆ requesting_data_

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

Definition at line 109 of file dsmr.h.

◆ telegram_

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

Definition at line 118 of file dsmr.h.

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