#include <modbus.h>

Inheritance diagram for esphome::modbus::ModbusClientHub:

Public Member Functions
	ModbusClientHub ()=default

void	dump_config () override

void	loop () override

void	set_send_wait_time (uint16_t time_in_ms)

void	set_turnaround_time (uint16_t time_in_ms)

bool	tx_buffer_empty ()

bool	tx_blocked () override

	ESPDEPRECATED ("Use send_pdu() with create_client_pdu() instead. Removed in 2026.10.0", "2026.4.0") void send(uint8_t address

void	send_pdu (uint8_t address, std::span< const uint8_t > pdu, ModbusClientDevice *device=nullptr)

void	send_raw (const std::vector< uint8_t > &payload, ModbusClientDevice *device=nullptr)

void	clear_tx_queue_for_address (uint8_t address, bool clear_sent=true)

void	clear_tx_queue_for_device (ModbusClientDevice *device)

Public Member Functions inherited from esphome::modbus::Modbus
	Modbus ()=default

void	setup () override

float	get_setup_priority () const override

void	set_flow_control_pin (GPIOPin *flow_control_pin)

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.

Public Member Functions inherited from esphome::Component
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)

Data Fields
uint8_t	function_code

uint8_t uint16_t	start_address

uint8_t uint16_t uint16_t	number_of_entities

uint8_t uint16_t uint16_t uint8_t	payload_len = 0

uint8_t uint16_t uint16_t uint8_t const uint8_t *	payload = nullptr

uint8_t uint16_t uint16_t uint8_t const uint8_t ModbusClientDevice *	device

Protected Member Functions
int32_t	tx_delay_remaining () override

void	parse_modbus_frames () override

void	process_modbus_server_frame (uint8_t address, uint8_t function_code, const uint8_t *data, uint16_t len) override

void	send_next_frame_ ()

void	notify_no_response_ (ModbusDeviceCommand &wfr)

void	requeue_waiting_frame_ (ModbusDeviceCommand &wfr)

void	queue_raw_ (uint8_t address, const uint8_t pdu, uint16_t pdu_len, ModbusClientDevice device=nullptr)

Protected Member Functions inherited from esphome::modbus::Modbus
void	receive_bytes_ ()

bool	timeout_ ()

bool	parse_modbus_server_frame_ ()

void	clear_rx_buffer_ (const LogString *reason, bool warn=false, size_t bytes_to_clear=0)

bool	send_frame_ (const ModbusFrame &frame)

uint16_t	find_custom_frame_end_ (uint16_t min_length) const

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
uint16_t	send_wait_time_ {2000}

uint16_t	turnaround_delay_ms_ {0}

std::optional< ModbusDeviceCommand >	waiting_for_response_

std::deque< ModbusDeviceCommand >	tx_buffer_

Protected Attributes inherited from esphome::modbus::Modbus
uint32_t	last_modbus_byte_ {0}

uint32_t	last_receive_check_ {0}

uint32_t	last_send_ {0}

uint32_t	last_send_tx_offset_ {0}

uint16_t	frame_delay_ms_ {5}

uint16_t	long_rx_buffer_delay_ms_ {0}

GPIOPin *	flow_control_pin_ {nullptr}

std::vector< uint8_t >	rx_buffer_

Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent *	parent_ {nullptr}

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_

Detailed Description

Definition at line 94 of file modbus.h.

Constructor & Destructor Documentation

◆ ModbusClientHub()

esphome::modbus::ModbusClientHub::ModbusClientHub ( )

default

Member Function Documentation

◆ clear_tx_queue_for_address()

void esphome::modbus::ModbusClientHub::clear_tx_queue_for_address	(	uint8_t	address,
		bool	clear_sent = true )

Definition at line 612 of file modbus.cpp.

◆ clear_tx_queue_for_device()

void esphome::modbus::ModbusClientHub::clear_tx_queue_for_device ( ModbusClientDevice * device )

Definition at line 628 of file modbus.cpp.

◆ dump_config()

void esphome::modbus::ModbusClientHub::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 516 of file modbus.cpp.

◆ ESPDEPRECATED()

esphome::modbus::ModbusClientHub::ESPDEPRECATED	(	"Use send_pdu() with create_client_pdu() instead. Removed in 2026.10.0"	,
		"2026.4.0"	)

◆ loop()

void esphome::modbus::ModbusClientHub::loop ( )

overridevirtual

Reimplemented from esphome::modbus::Modbus.

Definition at line 47 of file modbus.cpp.

◆ notify_no_response_()

void esphome::modbus::ModbusClientHub::notify_no_response_ ( ModbusDeviceCommand & wfr )

protected

Definition at line 565 of file modbus.cpp.

◆ parse_modbus_frames()

void esphome::modbus::ModbusClientHub::parse_modbus_frames ( )

overrideprotectedvirtual

Implements esphome::modbus::Modbus.

Definition at line 139 of file modbus.cpp.

◆ process_modbus_server_frame()

void esphome::modbus::ModbusClientHub::process_modbus_server_frame	(	uint8_t	address,
		uint8_t	function_code,
		const uint8_t *	data,
		uint16_t	len )

overrideprotectedvirtual

Implements esphome::modbus::Modbus.

Definition at line 261 of file modbus.cpp.

◆ queue_raw_()

void esphome::modbus::ModbusClientHub::queue_raw_	(	uint8_t	address,
		const uint8_t *	pdu,
		uint16_t	pdu_len,
		ModbusClientDevice *	device = nullptr )

protected

Definition at line 589 of file modbus.cpp.

◆ requeue_waiting_frame_()

void esphome::modbus::ModbusClientHub::requeue_waiting_frame_ ( ModbusDeviceCommand & wfr )

protected

Definition at line 577 of file modbus.cpp.

◆ send_next_frame_()

void esphome::modbus::ModbusClientHub::send_next_frame_ ( )

protected

Definition at line 491 of file modbus.cpp.

◆ send_pdu()

void esphome::modbus::ModbusClientHub::send_pdu	(	uint8_t	address,
		std::span< const uint8_t >	pdu,
		ModbusClientDevice *	device = nullptr )

inline

Definition at line 111 of file modbus.h.

◆ send_raw()

void esphome::modbus::ModbusClientHub::send_raw	(	const std::vector< uint8_t > &	payload,
		ModbusClientDevice *	device = nullptr )

Definition at line 644 of file modbus.cpp.

◆ set_send_wait_time()

void esphome::modbus::ModbusClientHub::set_send_wait_time ( uint16_t time_in_ms )

inline

Definition at line 99 of file modbus.h.

◆ set_turnaround_time()

void esphome::modbus::ModbusClientHub::set_turnaround_time ( uint16_t time_in_ms )

inline

Definition at line 100 of file modbus.h.

◆ tx_blocked()

bool esphome::modbus::ModbusClientHub::tx_blocked ( )

overridevirtual

Reimplemented from esphome::modbus::Modbus.

Definition at line 111 of file modbus.cpp.

◆ tx_buffer_empty()

bool esphome::modbus::ModbusClientHub::tx_buffer_empty ( )

Definition at line 118 of file modbus.cpp.

◆ tx_delay_remaining()

int32_t esphome::modbus::ModbusClientHub::tx_delay_remaining ( )

overrideprotectedvirtual

Reimplemented from esphome::modbus::Modbus.

Definition at line 92 of file modbus.cpp.

Field Documentation

◆ device

uint8_t uint16_t uint16_t uint8_t const uint8_t ModbusClientDevice* esphome::modbus::ModbusClientHub::device

Initial value:

= nullptr) {
    this->send_pdu(address,
                   helpers::create_client_pdu((ModbusFunctionCode) function_code, start_address, number_of_entities,
                                              payload, payload_len),
                   device);
  }

Definition at line 105 of file modbus.h.

◆ function_code

uint8_t esphome::modbus::ModbusClientHub::function_code

Definition at line 104 of file modbus.h.

◆ number_of_entities

uint8_t uint16_t uint16_t esphome::modbus::ModbusClientHub::number_of_entities

Definition at line 104 of file modbus.h.

◆ payload

uint8_t uint16_t uint16_t uint8_t const uint8_t* esphome::modbus::ModbusClientHub::payload = nullptr

Definition at line 105 of file modbus.h.

◆ payload_len

uint8_t uint16_t uint16_t uint8_t esphome::modbus::ModbusClientHub::payload_len = 0

Definition at line 105 of file modbus.h.

◆ send_wait_time_

uint16_t esphome::modbus::ModbusClientHub::send_wait_time_ {2000}

protected

Definition at line 130 of file modbus.h.

◆ start_address

uint8_t uint16_t esphome::modbus::ModbusClientHub::start_address

Definition at line 104 of file modbus.h.

◆ turnaround_delay_ms_

uint16_t esphome::modbus::ModbusClientHub::turnaround_delay_ms_ {0}

protected

Definition at line 131 of file modbus.h.

◆ tx_buffer_

std::deque<ModbusDeviceCommand> esphome::modbus::ModbusClientHub::tx_buffer_

protected

Definition at line 137 of file modbus.h.

◆ waiting_for_response_

std::optional<ModbusDeviceCommand> esphome::modbus::ModbusClientHub::waiting_for_response_

protected

Definition at line 132 of file modbus.h.

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

esphome/components/modbus/modbus.h
esphome/components/modbus/modbus.cpp

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ModbusClientHub()

Member Function Documentation

◆ clear_tx_queue_for_address()

◆ clear_tx_queue_for_device()

◆ dump_config()

◆ ESPDEPRECATED()

◆ loop()

◆ notify_no_response_()

◆ parse_modbus_frames()

◆ process_modbus_server_frame()

◆ queue_raw_()

◆ requeue_waiting_frame_()

◆ send_next_frame_()

◆ send_pdu()

◆ send_raw()

◆ set_send_wait_time()

◆ set_turnaround_time()

◆ tx_blocked()

◆ tx_buffer_empty()

◆ tx_delay_remaining()

Field Documentation

◆ device

◆ function_code

◆ number_of_entities

◆ payload

◆ payload_len

◆ send_wait_time_

◆ start_address

◆ turnaround_delay_ms_

◆ tx_buffer_

◆ waiting_for_response_