ESPHome  2024.6.1
Public Member Functions | Data Fields | Protected Types | Protected Member Functions | Protected Attributes
esphome::teleinfo::TeleInfo Class Reference

#include <teleinfo.h>

Inheritance diagram for esphome::teleinfo::TeleInfo:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Public Member Functions

 TeleInfo (bool historical_mode)
void register_teleinfo_listener (TeleInfoListener *listener)
void loop () override
void setup () override
void update () override
void dump_config () override
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
void call_setup () override
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
void start_poller ()
void stop_poller ()
- 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 () 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="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...

Data Fields

std::vector< TeleInfoListener * > teleinfo_listeners_ {}

Protected Types


Protected Member Functions

bool read_chars_until_ (bool drop, uint8_t c)
bool check_crc_ (const char *grp, const char *grp_end)
void publish_value_ (const std::string &tag, const std::string &val)
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
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 baud_rate_
int checksum_area_end_
int separator_
char buf_ [MAX_BUF_SIZE]
uint32_t buf_index_ {0}
char tag_ [MAX_TAG_SIZE]
char val_ [MAX_VAL_SIZE]
char timestamp_ [MAX_TIMESTAMP_SIZE]
enum esphome::teleinfo::TeleInfo::State OFF
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
- 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 24 of file teleinfo.h.

Member Enumeration Documentation

◆ State


Definition at line 43 of file teleinfo.h.

Constructor & Destructor Documentation

◆ TeleInfo()

esphome::teleinfo::TeleInfo::TeleInfo ( bool  historical_mode)

Definition at line 192 of file teleinfo.cpp.

Member Function Documentation

◆ check_crc_()

bool esphome::teleinfo::TeleInfo::check_crc_ ( const char *  grp,
const char *  grp_end 

Definition at line 26 of file teleinfo.cpp.

◆ dump_config()

void esphome::teleinfo::TeleInfo::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 188 of file teleinfo.cpp.

◆ loop()

void esphome::teleinfo::TeleInfo::loop ( )

Reimplemented from esphome::Component.

Definition at line 76 of file teleinfo.cpp.

◆ publish_value_()

void esphome::teleinfo::TeleInfo::publish_value_ ( const std::string &  tag,
const std::string &  val 

Definition at line 181 of file teleinfo.cpp.

◆ read_chars_until_()

bool esphome::teleinfo::TeleInfo::read_chars_until_ ( bool  drop,
uint8_t  c 

Definition at line 44 of file teleinfo.cpp.

◆ register_teleinfo_listener()

void esphome::teleinfo::TeleInfo::register_teleinfo_listener ( TeleInfoListener listener)

Definition at line 206 of file teleinfo.cpp.

◆ setup()

void esphome::teleinfo::TeleInfo::setup ( )

Reimplemented from esphome::Component.

Definition at line 69 of file teleinfo.cpp.

◆ update()

void esphome::teleinfo::TeleInfo::update ( )

Implements esphome::PollingComponent.

Definition at line 70 of file teleinfo.cpp.

Field Documentation

◆ baud_rate_

uint32_t esphome::teleinfo::TeleInfo::baud_rate_

Definition at line 35 of file teleinfo.h.

◆ buf_

char esphome::teleinfo::TeleInfo::buf_[MAX_BUF_SIZE]

Definition at line 38 of file teleinfo.h.

◆ buf_index_

uint32_t esphome::teleinfo::TeleInfo::buf_index_ {0}

Definition at line 39 of file teleinfo.h.

◆ checksum_area_end_

int esphome::teleinfo::TeleInfo::checksum_area_end_

Definition at line 36 of file teleinfo.h.


enum esphome::teleinfo::TeleInfo::State esphome::teleinfo::TeleInfo::OFF

◆ separator_

int esphome::teleinfo::TeleInfo::separator_

Definition at line 37 of file teleinfo.h.

◆ tag_

char esphome::teleinfo::TeleInfo::tag_[MAX_TAG_SIZE]

Definition at line 40 of file teleinfo.h.

◆ teleinfo_listeners_

std::vector<TeleInfoListener *> esphome::teleinfo::TeleInfo::teleinfo_listeners_ {}

Definition at line 32 of file teleinfo.h.

◆ timestamp_

char esphome::teleinfo::TeleInfo::timestamp_[MAX_TIMESTAMP_SIZE]

Definition at line 42 of file teleinfo.h.

◆ val_

char esphome::teleinfo::TeleInfo::val_[MAX_VAL_SIZE]

Definition at line 41 of file teleinfo.h.

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