#include <dlms_meter.h>

Inheritance diagram for esphome::dlms_meter::DlmsMeterComponent:

Public Member Functions
	DlmsMeterComponent ()=default

void	dump_config () override

void	loop () override

void	set_decryption_key (const std::array< uint8_t, 16 > &key)

void	set_provider (uint32_t provider)

void	publish_sensors (MeterData &data)

	DLMS_METER_SENSOR_LIST (SUB_SENSOR,) DLMS_METER_TEXT_SENSOR_LIST(SUB_TEXT_SENSOR

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

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
bool	parse_mbus_ (std::vector< uint8_t > &mbus_payload)

bool	parse_dlms_ (const std::vector< uint8_t > &mbus_payload, uint16_t &message_length, uint8_t &systitle_length, uint16_t &header_offset)

bool	decrypt_ (std::vector< uint8_t > &mbus_payload, uint16_t message_length, uint8_t systitle_length, uint16_t header_offset)

void	decode_obis_ (uint8_t *plaintext, uint16_t message_length)

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
std::vector< uint8_t >	receive_buffer_

std::vector< uint8_t >	mbus_payload_

uint32_t	last_read_ = 0

uint32_t	read_timeout_ = 1000

uint32_t	provider_ = PROVIDER_GENERIC

std::array< uint8_t, 16 >	decryption_key_

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

Detailed Description

Definition at line 54 of file dlms_meter.h.

Constructor & Destructor Documentation

◆ DlmsMeterComponent()

esphome::dlms_meter::DlmsMeterComponent::DlmsMeterComponent ( )

default

Member Function Documentation

◆ decode_obis_()

void esphome::dlms_meter::DlmsMeterComponent::decode_obis_	(	uint8_t *	plaintext,
		uint16_t	message_length )

protected

Definition at line 270 of file dlms_meter.cpp.

◆ decrypt_()

bool esphome::dlms_meter::DlmsMeterComponent::decrypt_	(	std::vector< uint8_t > &	mbus_payload,
		uint16_t	message_length,
		uint8_t	systitle_length,
		uint16_t	header_offset )

protected

Definition at line 224 of file dlms_meter.cpp.

◆ DLMS_METER_SENSOR_LIST()

esphome::dlms_meter::DlmsMeterComponent::DLMS_METER_SENSOR_LIST ( SUB_SENSOR )

◆ dump_config()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file dlms_meter.cpp.

◆ loop()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file dlms_meter.cpp.

◆ parse_dlms_()

bool esphome::dlms_meter::DlmsMeterComponent::parse_dlms_	(	const std::vector< uint8_t > &	mbus_payload,
		uint16_t &	message_length,
		uint8_t &	systitle_length,
		uint16_t &	header_offset )

protected

Definition at line 155 of file dlms_meter.cpp.

◆ parse_mbus_()

bool esphome::dlms_meter::DlmsMeterComponent::parse_mbus_ ( std::vector< uint8_t > & mbus_payload )

protected

Definition at line 79 of file dlms_meter.cpp.

◆ publish_sensors()

void esphome::dlms_meter::DlmsMeterComponent::publish_sensors ( MeterData & data )

inline

Definition at line 64 of file dlms_meter.h.

◆ set_decryption_key()

void esphome::dlms_meter::DlmsMeterComponent::set_decryption_key ( const std::array< uint8_t, 16 > & key )

inline

Definition at line 61 of file dlms_meter.h.

◆ set_provider()

void esphome::dlms_meter::DlmsMeterComponent::set_provider ( uint32_t provider )

inline

Definition at line 62 of file dlms_meter.h.

Field Documentation

◆ decryption_key_

std::array<uint8_t, 16> esphome::dlms_meter::DlmsMeterComponent::decryption_key_

protected

Definition at line 93 of file dlms_meter.h.

◆ last_read_

uint32_t esphome::dlms_meter::DlmsMeterComponent::last_read_ = 0

protected

Definition at line 89 of file dlms_meter.h.

◆ mbus_payload_

std::vector<uint8_t> esphome::dlms_meter::DlmsMeterComponent::mbus_payload_

protected

Definition at line 88 of file dlms_meter.h.

◆ provider_

uint32_t esphome::dlms_meter::DlmsMeterComponent::provider_ = PROVIDER_GENERIC

protected

Definition at line 92 of file dlms_meter.h.

◆ read_timeout_

uint32_t esphome::dlms_meter::DlmsMeterComponent::read_timeout_ = 1000

protected

Definition at line 90 of file dlms_meter.h.

◆ receive_buffer_

std::vector<uint8_t> esphome::dlms_meter::DlmsMeterComponent::receive_buffer_

protected

Definition at line 87 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

◆ decode_obis_()

◆ decrypt_()

◆ DLMS_METER_SENSOR_LIST()

◆ dump_config()

◆ loop()

◆ parse_dlms_()

◆ parse_mbus_()

◆ publish_sensors()

◆ set_decryption_key()

◆ set_provider()

Field Documentation

◆ decryption_key_

◆ last_read_

◆ mbus_payload_

◆ provider_

◆ read_timeout_

◆ receive_buffer_