#include <modbus.h>

Inheritance diagram for esphome::modbus::ModbusServerHub:

Public Member Functions
	ModbusServerHub ()=default

void	dump_config () override

void	register_device (ModbusServerDevice *device)

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

void	setup () override

void	loop () override

float	get_setup_priority () const override

virtual bool	tx_blocked ()

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

	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.

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)

Protected Member Functions
void	parse_modbus_frames () override

bool	parse_modbus_client_frame_ ()

void	process_modbus_server_frame (uint8_t address, std::span< const uint8_t > pdu) override

void	process_modbus_client_frame_ (uint8_t address, uint8_t function_code, std::span< const uint8_t > data)

void	process_broadcast_frame_ (uint8_t function_code, std::span< const uint8_t > data)

ResponseStatus	parse_write_single_ (std::span< const uint8_t > data, uint16_t &start_address, RegisterValues &registers)

ResponseStatus	parse_write_multiple_ (std::span< const uint8_t > data, uint16_t &start_address, RegisterValues &registers)

void	assemble_registers_ (std::span< const uint8_t > values, RegisterValues &registers)

ModbusServerDevice *	find_device_ (uint8_t address)

ResponseStatus	check_address_range_ (uint16_t start_address, uint16_t count)

ResponseStatus	parse_read_request_ (std::span< const uint8_t > data, uint16_t max_entities, const LogString *entity_name, uint16_t &start_address, uint16_t &count)

ResponseStatus	parse_write_single_coil_ (std::span< const uint8_t > data, uint16_t &start_address, bool &value)

ResponseStatus	parse_write_multiple_coils_ (std::span< const uint8_t > data, uint16_t &start_address, uint16_t &count, std::span< const uint8_t > &packed_bytes)

bool	build_or_reject_read_response_ (uint8_t address, uint8_t function_code, ResponseStatus status, uint16_t number_of_registers, const RegisterValues &registers, std::span< uint8_t > response_buffer, uint16_t &response_len)

void	send_raw_ (const uint8_t *payload, uint16_t len)

bool	rejected_ (uint8_t address, uint8_t function_code, ResponseStatus status)

void	send_exception_ (uint8_t address, uint8_t function_code, ExceptionCode exception_code)

void	send_response_ (uint8_t address, uint8_t function_code, const uint8_t *payload, uint16_t payload_len)

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

bool	timeout_ ()

virtual int32_t	tx_delay_remaining ()

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_frame_end_by_crc_ (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
uint8_t	expecting_peer_response_ {0}

std::vector< ModbusServerDevice * >	devices_

std::array< uint8_t, MAX_RAW_SIZE >	deferred_payload_

uint16_t	deferred_payload_len_ {0}

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}

uint32_t	frame_delay_us_ {5000}

uint32_t	long_rx_buffer_delay_us_ {0}

uint32_t	rx_detect_latency_us_ {0}

uint8_t	bits_per_char_ {11}

bool	exceeded_rx_full_threshold_ {false}

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_

Additional Inherited Members
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)

Detailed Description

Definition at line 316 of file modbus.h.

Constructor & Destructor Documentation

◆ ModbusServerHub()

esphome::modbus::ModbusServerHub::ModbusServerHub ( )

default

Member Function Documentation

◆ assemble_registers_()

void esphome::modbus::ModbusServerHub::assemble_registers_	(	std::span< const uint8_t >	values,
		RegisterValues &	registers )

protected

Definition at line 503 of file modbus.cpp.

◆ build_or_reject_read_response_()

bool esphome::modbus::ModbusServerHub::build_or_reject_read_response_	(	uint8_t	address,
		uint8_t	function_code,
		ResponseStatus	status,
		uint16_t	number_of_registers,
		const RegisterValues &	registers,
		std::span< uint8_t >	response_buffer,
		uint16_t &	response_len )

protected

Definition at line 564 of file modbus.cpp.

◆ check_address_range_()

ResponseStatus esphome::modbus::ModbusServerHub::check_address_range_	(	uint16_t	start_address,
		uint16_t	count )

protected

Definition at line 411 of file modbus.cpp.

◆ dump_config()

void esphome::modbus::ModbusServerHub::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 861 of file modbus.cpp.

◆ find_device_()

ModbusServerDevice * esphome::modbus::ModbusServerHub::find_device_ ( uint8_t address )

protected

Definition at line 402 of file modbus.cpp.

◆ parse_modbus_client_frame_()

bool esphome::modbus::ModbusServerHub::parse_modbus_client_frame_ ( )

protected

Definition at line 292 of file modbus.cpp.

◆ parse_modbus_frames()

void esphome::modbus::ModbusServerHub::parse_modbus_frames ( )

overrideprotectedvirtual

Implements esphome::modbus::Modbus.

Definition at line 204 of file modbus.cpp.

◆ parse_read_request_()

ResponseStatus esphome::modbus::ModbusServerHub::parse_read_request_	(	std::span< const uint8_t >	data,
		uint16_t	max_entities,
		const LogString *	entity_name,
		uint16_t &	start_address,
		uint16_t &	count )

protected

Definition at line 457 of file modbus.cpp.

◆ parse_write_multiple_()

ResponseStatus esphome::modbus::ModbusServerHub::parse_write_multiple_	(	std::span< const uint8_t >	data,
		uint16_t &	start_address,
		RegisterValues &	registers )

protected

Definition at line 440 of file modbus.cpp.

◆ parse_write_multiple_coils_()

ResponseStatus esphome::modbus::ModbusServerHub::parse_write_multiple_coils_	(	std::span< const uint8_t >	data,
		uint16_t &	start_address,
		uint16_t &	count,
		std::span< const uint8_t > &	packed_bytes )

protected

Definition at line 484 of file modbus.cpp.

◆ parse_write_single_()

ResponseStatus esphome::modbus::ModbusServerHub::parse_write_single_	(	std::span< const uint8_t >	data,
		uint16_t &	start_address,
		RegisterValues &	registers )

protected

Definition at line 432 of file modbus.cpp.

◆ parse_write_single_coil_()

ResponseStatus esphome::modbus::ModbusServerHub::parse_write_single_coil_	(	std::span< const uint8_t >	data,
		uint16_t &	start_address,
		bool &	value )

protected

Definition at line 471 of file modbus.cpp.

◆ process_broadcast_frame_()

void esphome::modbus::ModbusServerHub::process_broadcast_frame_	(	uint8_t	function_code,
		std::span< const uint8_t >	data )

protected

Definition at line 509 of file modbus.cpp.

◆ process_modbus_client_frame_()

void esphome::modbus::ModbusServerHub::process_modbus_client_frame_	(	uint8_t	address,
		uint8_t	function_code,
		std::span< const uint8_t >	data )

protected

Definition at line 607 of file modbus.cpp.

◆ process_modbus_server_frame()

void esphome::modbus::ModbusServerHub::process_modbus_server_frame	(	uint8_t	address,
		std::span< const uint8_t >	pdu )

overrideprotectedvirtual

Implements esphome::modbus::Modbus.

Definition at line 386 of file modbus.cpp.

◆ register_device()

void esphome::modbus::ModbusServerHub::register_device ( ModbusServerDevice * device )

inline

Definition at line 320 of file modbus.h.

◆ rejected_()

bool esphome::modbus::ModbusServerHub::rejected_	(	uint8_t	address,
		uint8_t	function_code,
		ResponseStatus	status )

protected

Definition at line 893 of file modbus.cpp.

◆ send_exception_()

void esphome::modbus::ModbusServerHub::send_exception_	(	uint8_t	address,
		uint8_t	function_code,
		ExceptionCode	exception_code )

protected

Definition at line 906 of file modbus.cpp.

◆ send_raw_()

void esphome::modbus::ModbusServerHub::send_raw_	(	const uint8_t *	payload,
		uint16_t	len )

protected

Definition at line 1181 of file modbus.cpp.

◆ send_response_()

void esphome::modbus::ModbusServerHub::send_response_	(	uint8_t	address,
		uint8_t	function_code,
		const uint8_t *	payload,
		uint16_t	payload_len )

protected

Definition at line 878 of file modbus.cpp.

Field Documentation

◆ deferred_payload_

std::array<uint8_t, MAX_RAW_SIZE> esphome::modbus::ModbusServerHub::deferred_payload_

protected

Definition at line 371 of file modbus.h.

◆ deferred_payload_len_

uint16_t esphome::modbus::ModbusServerHub::deferred_payload_len_ {0}

protected

Definition at line 372 of file modbus.h.

◆ devices_

std::vector<ModbusServerDevice *> esphome::modbus::ModbusServerHub::devices_

protected

Definition at line 367 of file modbus.h.

◆ expecting_peer_response_

uint8_t esphome::modbus::ModbusServerHub::expecting_peer_response_ {0}

protected

Definition at line 366 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

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ModbusServerHub()

Member Function Documentation

◆ assemble_registers_()

◆ build_or_reject_read_response_()

◆ check_address_range_()

◆ dump_config()

◆ find_device_()

◆ parse_modbus_client_frame_()

◆ parse_modbus_frames()

◆ parse_read_request_()

◆ parse_write_multiple_()

◆ parse_write_multiple_coils_()

◆ parse_write_single_()

◆ parse_write_single_coil_()

◆ process_broadcast_frame_()

◆ process_modbus_client_frame_()

◆ process_modbus_server_frame()

◆ register_device()

◆ rejected_()

◆ send_exception_()

◆ send_raw_()

◆ send_response_()

Field Documentation

◆ deferred_payload_

◆ deferred_payload_len_

◆ devices_

◆ expecting_peer_response_