ESPHome  2022.11.3
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::sml::Sml Class Reference

#include <sml.h>

Inheritance diagram for esphome::sml::Sml:
esphome::Component esphome::uart::UARTDevice

Public Member Functions

void register_sml_listener (SmlListener *listener)
 
void loop () override
 
void dump_config () override
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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...
 

Data Fields

std::vector< SmlListener * > sml_listeners_ {}
 

Protected Member Functions

void process_sml_file_ (const bytes &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_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()> &&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()> &&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

bool record_ = false
 
uint16_t incoming_mask_ = 0
 
bytes sml_data_
 
- 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 20 of file sml.h.

Member Function Documentation

◆ check_start_end_bytes_()

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

Definition at line 16 of file sml.cpp.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 91 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 64 of file sml.cpp.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 26 of file sml.cpp.

◆ process_sml_file_()

void esphome::sml::Sml::process_sml_file_ ( const bytes sml_data)
protected

Definition at line 56 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 75 of file sml.cpp.

◆ publish_value_()

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

Definition at line 81 of file sml.cpp.

◆ register_sml_listener()

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

Definition at line 93 of file sml.cpp.

Field Documentation

◆ incoming_mask_

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

Definition at line 36 of file sml.h.

◆ record_

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

Definition at line 35 of file sml.h.

◆ sml_data_

bytes esphome::sml::Sml::sml_data_
protected

Definition at line 37 of file sml.h.

◆ sml_listeners_

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

Definition at line 25 of file sml.h.


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