#include <modbus.h>

Inheritance diagram for esphome::modbus::Modbus:

Public Member Functions
	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 ()

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
virtual void	dump_config ()

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

bool	timeout_ ()

virtual int32_t	tx_delay_remaining ()

virtual void	parse_modbus_frames ()=0

bool	parse_modbus_server_frame_ ()

virtual void	process_modbus_server_frame (uint8_t address, uint8_t function_code, const uint8_t *data, uint16_t len)=0

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
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 44 of file modbus.h.

Constructor & Destructor Documentation

◆ Modbus()

esphome::modbus::Modbus::Modbus ( )

default

Member Function Documentation

◆ clear_rx_buffer_()

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

protected

Definition at line 682 of file modbus.cpp.

◆ find_custom_frame_end_()

uint16_t esphome::modbus::Modbus::find_custom_frame_end_ ( uint16_t min_length ) const

protected

Definition at line 183 of file modbus.cpp.

◆ get_setup_priority()

float esphome::modbus::Modbus::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 536 of file modbus.cpp.

◆ loop()

void esphome::modbus::Modbus::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::modbus::ModbusClientHub.

Definition at line 39 of file modbus.cpp.

◆ parse_modbus_frames()

virtual void esphome::modbus::Modbus::parse_modbus_frames ( )

protectedpure virtual

Implemented in esphome::modbus::ModbusClientHub, and esphome::modbus::ModbusServerHub.

◆ parse_modbus_server_frame_()

bool esphome::modbus::Modbus::parse_modbus_server_frame_ ( )

protected

Definition at line 195 of file modbus.cpp.

◆ process_modbus_server_frame()

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

protectedpure virtual

Implemented in esphome::modbus::ModbusClientHub, and esphome::modbus::ModbusServerHub.

◆ receive_bytes_()

void esphome::modbus::Modbus::receive_bytes_ ( )

protected

Definition at line 120 of file modbus.cpp.

◆ send_frame_()

bool esphome::modbus::Modbus::send_frame_ ( const ModbusFrame & frame )

protected

Definition at line 454 of file modbus.cpp.

◆ set_flow_control_pin()

void esphome::modbus::Modbus::set_flow_control_pin ( GPIOPin * flow_control_pin )

inline

Definition at line 54 of file modbus.h.

◆ setup()

void esphome::modbus::Modbus::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file modbus.cpp.

◆ timeout_()

bool esphome::modbus::Modbus::timeout_ ( )

protected

Definition at line 68 of file modbus.cpp.

◆ tx_blocked()

bool esphome::modbus::Modbus::tx_blocked ( )

virtual

Reimplemented in esphome::modbus::ModbusClientHub.

Definition at line 100 of file modbus.cpp.

◆ tx_delay_remaining()

int32_t esphome::modbus::Modbus::tx_delay_remaining ( )

protectedvirtual

Reimplemented in esphome::modbus::ModbusClientHub.

Definition at line 80 of file modbus.cpp.

Field Documentation

◆ flow_control_pin_

GPIOPin* esphome::modbus::Modbus::flow_control_pin_ {nullptr}

protected

Definition at line 77 of file modbus.h.

◆ frame_delay_ms_

uint16_t esphome::modbus::Modbus::frame_delay_ms_ {5}

protected

Definition at line 74 of file modbus.h.

◆ last_modbus_byte_

uint32_t esphome::modbus::Modbus::last_modbus_byte_ {0}

protected

Definition at line 70 of file modbus.h.

◆ last_receive_check_

uint32_t esphome::modbus::Modbus::last_receive_check_ {0}

protected

Definition at line 71 of file modbus.h.

◆ last_send_

uint32_t esphome::modbus::Modbus::last_send_ {0}

protected

Definition at line 72 of file modbus.h.

◆ last_send_tx_offset_

uint32_t esphome::modbus::Modbus::last_send_tx_offset_ {0}

protected

Definition at line 73 of file modbus.h.

◆ long_rx_buffer_delay_ms_

uint16_t esphome::modbus::Modbus::long_rx_buffer_delay_ms_ {0}

protected

Definition at line 75 of file modbus.h.

◆ rx_buffer_

std::vector<uint8_t> esphome::modbus::Modbus::rx_buffer_

protected

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

Detailed Description

Constructor & Destructor Documentation

◆ Modbus()

Member Function Documentation

◆ clear_rx_buffer_()

◆ find_custom_frame_end_()

◆ get_setup_priority()

◆ loop()

◆ parse_modbus_frames()

◆ parse_modbus_server_frame_()

◆ process_modbus_server_frame()

◆ receive_bytes_()

◆ send_frame_()

◆ set_flow_control_pin()

◆ setup()

◆ timeout_()

◆ tx_blocked()

◆ tx_delay_remaining()

Field Documentation

◆ flow_control_pin_

◆ frame_delay_ms_

◆ last_modbus_byte_

◆ last_receive_check_

◆ last_send_

◆ last_send_tx_offset_

◆ long_rx_buffer_delay_ms_

◆ rx_buffer_