Main class for the EmonTx component. More...

#include <emontx.h>

Inheritance diagram for esphome::emontx::EmonTx:

Public Member Functions
	EmonTx ()=default

void	loop () override
	Implements the main loop for parsing data from the serial port.

void	setup () override

void	dump_config () override
	Logs the EmonTx component configuration details.

template<typename F >
void	add_on_json_callback (F &&callback)

template<typename F >
void	add_on_data_callback (F &&callback)

void	send_command (const std::string &command)
	Sends a command string to the emonTx device via UART.

void	init_sensors (size_t count)

void	register_sensor (const char tag_name, sensor::Sensor sensor)
	Registers a sensor to receive updates for a specific JSON tag.

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_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.

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)

void	status_set_error ()

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

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

UARTFlushResult	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
void	parse_json_ (const char *data, 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.

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_

uint16_t	buffer_pos_ {0}

std::array< char, MAX_LINE_LENGTH+1 >	buffer_ {}

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}

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 29 of file emontx.h.

Constructor & Destructor Documentation

◆ EmonTx()

esphome::emontx::EmonTx::EmonTx ( )

default

Member Function Documentation

◆ add_on_data_callback()

template<typename F >

void esphome::emontx::EmonTx::add_on_data_callback ( F && callback )

inline

Definition at line 39 of file emontx.h.

◆ add_on_json_callback()

template<typename F >

void esphome::emontx::EmonTx::add_on_json_callback ( F && callback )

inline

Definition at line 37 of file emontx.h.

◆ dump_config()

void esphome::emontx::EmonTx::dump_config ( )

overridevirtual

Logs the EmonTx component configuration details.

Reimplemented from esphome::Component.

Definition at line 79 of file emontx.cpp.

◆ init_sensors()

void esphome::emontx::EmonTx::init_sensors ( size_t count )

inline

Definition at line 45 of file emontx.h.

◆ loop()

void esphome::emontx::EmonTx::loop ( )

overridevirtual

Implements the main loop for parsing data from the serial port.

Continuously processes incoming UART data line-by-line:

Fire on_data callbacks for all received lines
If line starts with '{', parse as JSON and update sensors/callbacks

Reimplemented from esphome::Component.

Definition at line 18 of file emontx.cpp.

◆ parse_json_()

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

protected

Definition at line 54 of file emontx.cpp.

◆ register_sensor()

void esphome::emontx::EmonTx::register_sensor	(	const char *	tag_name,
		sensor::Sensor *	sensor )

Registers a sensor to receive updates for a specific JSON tag.

Parameters

tag_name	The JSON key to monitor for this sensor (must be a string literal).
sensor	Pointer to the sensor that will receive value updates.

Definition at line 110 of file emontx.cpp.

◆ send_command()

void esphome::emontx::EmonTx::send_command ( const std::string & command )

Sends a command string to the emonTx device via UART.

Parameters

command The command string to send (LF will be appended automatically).

Definition at line 97 of file emontx.cpp.

◆ setup()

void esphome::emontx::EmonTx::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file emontx.cpp.

Field Documentation

◆ buffer_

std::array<char, MAX_LINE_LENGTH + 1> esphome::emontx::EmonTx::buffer_ {}

protected

Definition at line 58 of file emontx.h.

◆ buffer_pos_

uint16_t esphome::emontx::EmonTx::buffer_pos_ {0}

protected

Definition at line 57 of file emontx.h.

◆ data_callbacks_

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

protected

Definition at line 56 of file emontx.h.

◆ json_callbacks_

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

protected

Definition at line 55 of file emontx.h.

◆ sensors_

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

protected

Definition at line 53 of file emontx.h.

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

esphome/components/emontx/emontx.h
esphome/components/emontx/emontx.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EmonTx()

Member Function Documentation

◆ add_on_data_callback()

◆ add_on_json_callback()

◆ dump_config()

◆ init_sensors()

◆ loop()

◆ parse_json_()

◆ register_sensor()

◆ send_command()

◆ setup()

Field Documentation

◆ buffer_

◆ buffer_pos_

◆ data_callbacks_

◆ json_callbacks_

◆ sensors_