#include <dlms_meter.h>

Inheritance diagram for esphome::dlms_meter::DlmsMeterComponent:

Public Member Functions
	DlmsMeterComponent (uint32_t receive_timeout_ms, bool skip_crc_check, std::optional< std::array< uint8_t, 16 > > decryption_key, std::optional< std::array< uint8_t, 16 > > authentication_key, std::vector< CustomPattern > custom_patterns)

void	setup () override

void	dump_config () override

void	loop () override

void	register_sensor (const std::string &obis_code, sensor::Sensor *sensor)

void	register_text_sensor (const std::string &obis_code, text_sensor::TextSensor *sensor)

void	register_binary_sensor (const std::string &obis_code, binary_sensor::BinarySensor *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)

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.

void	mark_failed ()
	Mark this component as failed.

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 ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

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

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::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 ()

UARTFlushResult	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	read_rx_buffer_ ()

void	flush_rx_buffer_ ()

void	process_frame_ ()

void	on_data_ (const char obis_code, float float_val, const char str_val, bool is_numeric)

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.

virtual void	call_setup ()

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.

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)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
std::array< uint8_t, 2048 >	rx_buffer_

size_t	bytes_accumulated_ {0}

uint32_t	last_rx_char_time_ {0}

uint32_t	receive_timeout_ms_ {1000}

bool	skip_crc_check_ {false}

std::vector< CustomPattern >	custom_patterns_

Aes128GcmDecryptorImpl	decryptor_

dlms_parser::DlmsParser	parser_

StaticVector< SensorItem, DLMS_MAX_SENSORS >	sensors_

StaticVector< TextSensorItem, DLMS_MAX_TEXT_SENSORS >	text_sensors_

StaticVector< BinarySensorItem, DLMS_MAX_BINARY_SENSORS >	binary_sensors_

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.

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::uart::UARTDevice
UARTComponent *	parent_ {nullptr}

Detailed Description

Definition at line 101 of file dlms_meter.h.

Constructor & Destructor Documentation

◆ DlmsMeterComponent()

esphome::dlms_meter::DlmsMeterComponent::DlmsMeterComponent	(	uint32_t	receive_timeout_ms,
		bool	skip_crc_check,
		std::optional< std::array< uint8_t, 16 > >	decryption_key,
		std::optional< std::array< uint8_t, 16 > >	authentication_key,
		std::vector< CustomPattern >	custom_patterns )

Definition at line 34 of file dlms_meter.cpp.

Member Function Documentation

◆ dump_config()

void esphome::dlms_meter::DlmsMeterComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 87 of file dlms_meter.cpp.

◆ flush_rx_buffer_()

void esphome::dlms_meter::DlmsMeterComponent::flush_rx_buffer_ ( )

protected

Definition at line 134 of file dlms_meter.cpp.

◆ loop()

void esphome::dlms_meter::DlmsMeterComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 126 of file dlms_meter.cpp.

◆ on_data_()

void esphome::dlms_meter::DlmsMeterComponent::on_data_	(	const char *	obis_code,
		float	float_val,
		const char *	str_val,
		bool	is_numeric )

protected

Definition at line 178 of file dlms_meter.cpp.

◆ process_frame_()

void esphome::dlms_meter::DlmsMeterComponent::process_frame_ ( )

protected

Definition at line 166 of file dlms_meter.cpp.

◆ read_rx_buffer_()

void esphome::dlms_meter::DlmsMeterComponent::read_rx_buffer_ ( )

protected

Definition at line 140 of file dlms_meter.cpp.

◆ register_binary_sensor()

void esphome::dlms_meter::DlmsMeterComponent::register_binary_sensor	(	const std::string &	obis_code,
		binary_sensor::BinarySensor *	sensor )

Definition at line 231 of file dlms_meter.cpp.

◆ register_sensor()

void esphome::dlms_meter::DlmsMeterComponent::register_sensor	(	const std::string &	obis_code,
		sensor::Sensor *	sensor )

Definition at line 221 of file dlms_meter.cpp.

◆ register_text_sensor()

void esphome::dlms_meter::DlmsMeterComponent::register_text_sensor	(	const std::string &	obis_code,
		text_sensor::TextSensor *	sensor )

Definition at line 226 of file dlms_meter.cpp.

◆ setup()

void esphome::dlms_meter::DlmsMeterComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 85 of file dlms_meter.cpp.

Field Documentation

◆ binary_sensors_

StaticVector<BinarySensorItem, DLMS_MAX_BINARY_SENSORS> esphome::dlms_meter::DlmsMeterComponent::binary_sensors_

protected

Definition at line 147 of file dlms_meter.h.

◆ bytes_accumulated_

size_t esphome::dlms_meter::DlmsMeterComponent::bytes_accumulated_ {0}

protected

Definition at line 129 of file dlms_meter.h.

◆ custom_patterns_

std::vector<CustomPattern> esphome::dlms_meter::DlmsMeterComponent::custom_patterns_

protected

Definition at line 135 of file dlms_meter.h.

◆ decryptor_

Aes128GcmDecryptorImpl esphome::dlms_meter::DlmsMeterComponent::decryptor_

protected

Definition at line 137 of file dlms_meter.h.

◆ last_rx_char_time_

uint32_t esphome::dlms_meter::DlmsMeterComponent::last_rx_char_time_ {0}

protected

Definition at line 130 of file dlms_meter.h.

◆ parser_

dlms_parser::DlmsParser esphome::dlms_meter::DlmsMeterComponent::parser_

protected

Definition at line 138 of file dlms_meter.h.

◆ receive_timeout_ms_

uint32_t esphome::dlms_meter::DlmsMeterComponent::receive_timeout_ms_ {1000}

protected

Definition at line 132 of file dlms_meter.h.

◆ rx_buffer_

std::array<uint8_t, 2048> esphome::dlms_meter::DlmsMeterComponent::rx_buffer_

protected

Definition at line 128 of file dlms_meter.h.

◆ sensors_

StaticVector<SensorItem, DLMS_MAX_SENSORS> esphome::dlms_meter::DlmsMeterComponent::sensors_

protected

Definition at line 141 of file dlms_meter.h.

◆ skip_crc_check_

bool esphome::dlms_meter::DlmsMeterComponent::skip_crc_check_ {false}

protected

Definition at line 133 of file dlms_meter.h.

◆ text_sensors_

StaticVector<TextSensorItem, DLMS_MAX_TEXT_SENSORS> esphome::dlms_meter::DlmsMeterComponent::text_sensors_

protected

Definition at line 144 of file dlms_meter.h.

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

esphome/components/dlms_meter/dlms_meter.h
esphome/components/dlms_meter/dlms_meter.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DlmsMeterComponent()

Member Function Documentation

◆ dump_config()

◆ flush_rx_buffer_()

◆ loop()

◆ on_data_()

◆ process_frame_()

◆ read_rx_buffer_()

◆ register_binary_sensor()

◆ register_sensor()

◆ register_text_sensor()

◆ setup()

Field Documentation

◆ binary_sensors_

◆ bytes_accumulated_

◆ custom_patterns_

◆ decryptor_

◆ last_rx_char_time_

◆ parser_

◆ receive_timeout_ms_

◆ rx_buffer_

◆ sensors_

◆ skip_crc_check_

◆ text_sensors_