#include <sml.h>

Inheritance diagram for esphome::sml::Sml:

Public Member Functions
void	register_sml_listener (SmlListener *listener)

void	loop () override

void	dump_config () override

void	add_on_data_callback (std::function< void(std::vector< uint8_t >, bool)> &&callback)

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

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

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.

Data Fields
std::vector< SmlListener * >	sml_listeners_ {}

Protected Member Functions
void	process_sml_file_ (const BytesView &sml_data)

void	log_obis_info_ (const std::vector< ObisInfo > &obis_info_vec)

void	publish_obis_info_ (const std::vector< ObisInfo > &obis_info_vec)

char	check_start_end_bytes_ (uint8_t byte)

void	publish_value_ (const ObisInfo &obis_info)

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 (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
bool	record_ = false

uint16_t	incoming_mask_ = 0

bytes	sml_data_

CallbackManager< void(const std::vector< uint8_t > &, bool)>	data_callbacks_ {}

Protected Attributes inherited from esphome::Component
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 21 of file sml.h.

Member Function Documentation

◆ add_on_data_callback()

void esphome::sml::Sml::add_on_data_callback ( std::function< void(std::vector< uint8_t >, bool)> && callback )

Definition at line 64 of file sml.cpp.

◆ check_start_end_bytes_()

char esphome::sml::Sml::check_start_end_bytes_ ( uint8_t byte )

protected

Definition at line 17 of file sml.cpp.

◆ dump_config()

void esphome::sml::Sml::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 106 of file sml.cpp.

◆ log_obis_info_()

void esphome::sml::Sml::log_obis_info_ ( const std::vector< ObisInfo > & obis_info_vec )

protected

Definition at line 76 of file sml.cpp.

◆ loop()

void esphome::sml::Sml::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 27 of file sml.cpp.

◆ process_sml_file_()

void esphome::sml::Sml::process_sml_file_ ( const BytesView & sml_data )

protected

Definition at line 68 of file sml.cpp.

◆ publish_obis_info_()

void esphome::sml::Sml::publish_obis_info_ ( const std::vector< ObisInfo > & obis_info_vec )

protected

Definition at line 89 of file sml.cpp.

◆ publish_value_()

void esphome::sml::Sml::publish_value_ ( const ObisInfo & obis_info )

protected

Definition at line 95 of file sml.cpp.

◆ register_sml_listener()

void esphome::sml::Sml::register_sml_listener ( SmlListener * listener )

Definition at line 108 of file sml.cpp.

Field Documentation

◆ data_callbacks_

CallbackManager<void(const std::vector<uint8_t> &, bool)> esphome::sml::Sml::data_callbacks_ {}

protected

Definition at line 41 of file sml.h.

◆ incoming_mask_

uint16_t esphome::sml::Sml::incoming_mask_ = 0

protected

Definition at line 38 of file sml.h.

◆ record_

bool esphome::sml::Sml::record_ = false

protected

Definition at line 37 of file sml.h.

◆ sml_data_

bytes esphome::sml::Sml::sml_data_

protected

Definition at line 39 of file sml.h.

◆ sml_listeners_

std::vector<SmlListener *> esphome::sml::Sml::sml_listeners_ {}

Definition at line 26 of file sml.h.

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

esphome/components/sml/sml.h
esphome/components/sml/sml.cpp

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_on_data_callback()

◆ check_start_end_bytes_()

◆ dump_config()

◆ log_obis_info_()

◆ loop()

◆ process_sml_file_()

◆ publish_obis_info_()

◆ publish_value_()

◆ register_sml_listener()

Field Documentation

◆ data_callbacks_

◆ incoming_mask_

◆ record_

◆ sml_data_

◆ sml_listeners_