ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::emontx::EmonTx Class Referencefinal

Main class for the EmonTx component. More...

#include <emontx.h>

Inheritance diagram for esphome::emontx::EmonTx:
esphome::Component esphome::uart::UARTDevice

Protected Member Functions

void parse_json_ (const char *data, size_t len)
 
void unlock_ ()
 
bool wants_version_ () const
 
void request_version_ ()
 
void send_version_request_ ()
 
void parse_msg_number_ (const char *line, size_t len)
 
void parse_version_line_ (const char *line, size_t len)
 
- 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.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
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 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 (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
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 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 (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
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.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Protected Attributes

FixedVector< std::pair< const char *, sensor::Sensor * > > sensors_ {}
 
LazyCallbackManager< void(JsonObject, StringRef)> json_callbacks_
 
LazyCallbackManager< void(StringRef)> data_callbacks_
 
std::atomic< bool > paused_ {false}
 
bool was_paused_ {false}
 
LockOnReboot lock_on_reboot_ {LockOnReboot::LOCK_ON_REBOOT_NEVER}
 
bool lock_supported_ {false}
 
bool unlock_sent_ {false}
 
uint8_t version_frames_left_ {0}
 
uint32_t last_msg_number_ {0}
 
LineReader< MAX_LINE_LENGTH+1 > line_reader_
 
- Protected Attributes inherited from esphome::Component
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}
 

Additional Inherited Members

- 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_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)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
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_progmem (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 ()
 
template<size_t N = 64, typename F >
bool read_available_chunks (F &&on_chunk)
 Pass the bytes available now to on_chunk(data, len) in N byte chunks; returning false stops.
 
template<size_t N = 64, typename F >
bool read_available_chunks (F &&on_chunk, size_t count)
 Same, reading exactly count bytes; count must not exceed available().
 
template<size_t N = 64, typename F >
bool read_available (F &&on_byte)
 Same as read_available_chunks(), calling on_byte(uint8_t) once per byte.
 
template<size_t N = 64, typename F >
bool read_available (F &&on_byte, size_t count)
 
void discard_available ()
 Read and drop every byte waiting in the receive buffer.
 
UARTFlushResult flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
 ESPDEPRECATED ("Use uart.final_validate_device_schema() in Python instead. Removed in 2027.3.0", "2026.9.0") void check_uart_settings(uint32_t baud_rate
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning.
 
- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 
- Data Fields inherited from esphome::uart::UARTDevice
uint8_t stop_bits = 1
 
uint8_t UARTParityOptions parity = UART_CONFIG_PARITY_NONE
 
uint8_t UARTParityOptions uint8_t data_bits = 8)
 
- Static Protected Member Functions inherited from esphome::uart::UARTDevice
template<typename F , typename... A>
static bool continue_after (F &f, A... args)
 Call f(args...) and return its result; a void callback always continues.
 

Detailed Description

Main class for the EmonTx component.

The EmonTx processes incoming data frames via UART, extracts tags and values, and publishes them to registered sensors.

Definition at line 38 of file emontx.h.

Member Function Documentation

◆ parse_json_()

void esphome::emontx::EmonTx::parse_json_ ( const char * data,
size_t len )
protected

Definition at line 150 of file emontx.cpp.

◆ parse_msg_number_()

void esphome::emontx::EmonTx::parse_msg_number_ ( const char * line,
size_t len )
protected

Definition at line 188 of file emontx.cpp.

◆ parse_version_line_()

void esphome::emontx::EmonTx::parse_version_line_ ( const char * line,
size_t len )
protected

Definition at line 214 of file emontx.cpp.

◆ request_version_()

void esphome::emontx::EmonTx::request_version_ ( )
protected

Definition at line 173 of file emontx.cpp.

◆ send_version_request_()

void esphome::emontx::EmonTx::send_version_request_ ( )
protected

Definition at line 181 of file emontx.cpp.

◆ unlock_()

void esphome::emontx::EmonTx::unlock_ ( )
protected

Definition at line 77 of file emontx.cpp.

◆ wants_version_()

bool esphome::emontx::EmonTx::wants_version_ ( ) const
inlineprotected

Definition at line 77 of file emontx.h.

Field Documentation

◆ data_callbacks_

LazyCallbackManager<void(StringRef)> esphome::emontx::EmonTx::data_callbacks_
protected

Definition at line 94 of file emontx.h.

◆ json_callbacks_

LazyCallbackManager<void(JsonObject, StringRef)> esphome::emontx::EmonTx::json_callbacks_
protected

Definition at line 93 of file emontx.h.

◆ last_msg_number_

uint32_t esphome::emontx::EmonTx::last_msg_number_ {0}
protected

Definition at line 102 of file emontx.h.

◆ line_reader_

LineReader<MAX_LINE_LENGTH + 1> esphome::emontx::EmonTx::line_reader_
protected

Definition at line 104 of file emontx.h.

◆ lock_on_reboot_

LockOnReboot esphome::emontx::EmonTx::lock_on_reboot_ {LockOnReboot::LOCK_ON_REBOOT_NEVER}
protected

Definition at line 97 of file emontx.h.

◆ lock_supported_

bool esphome::emontx::EmonTx::lock_supported_ {false}
protected

Definition at line 99 of file emontx.h.

◆ paused_

std::atomic<bool> esphome::emontx::EmonTx::paused_ {false}
protected

Definition at line 95 of file emontx.h.

◆ sensors_

FixedVector<std::pair<const char *, sensor::Sensor *> > esphome::emontx::EmonTx::sensors_ {}
protected

Definition at line 91 of file emontx.h.

◆ unlock_sent_

bool esphome::emontx::EmonTx::unlock_sent_ {false}
protected

Definition at line 100 of file emontx.h.

◆ version_frames_left_

uint8_t esphome::emontx::EmonTx::version_frames_left_ {0}
protected

Definition at line 101 of file emontx.h.

◆ was_paused_

bool esphome::emontx::EmonTx::was_paused_ {false}
protected

Definition at line 96 of file emontx.h.


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