Modbus controller class. More...

#include <modbus_controller.h>

Inheritance diagram for esphome::modbus_controller::ModbusController:

Public Member Functions
void	dump_config () override

void	loop () override

void	setup () override

void	update () override

void	queue_command (const ModbusCommandItem &command)
	queues a modbus command in the send queue

void	add_sensor_item (SensorItem *item)
	Registers a sensor with the controller. Called by esphomes code generator.

void	add_server_register (ServerRegister *server_register)
	Registers a server register with the controller. Called by esphomes code generator.

void	on_modbus_data (const std::vector< uint8_t > &data) override
	called when a modbus response was parsed without errors

void	on_modbus_error (uint8_t function_code, uint8_t exception_code) override
	called when a modbus error response was received

void	on_modbus_read_registers (uint8_t function_code, uint16_t start_address, uint16_t number_of_registers) final
	called when a modbus request (function code 0x03 or 0x04) was parsed without errors

void	on_modbus_write_registers (uint8_t function_code, const std::vector< uint8_t > &data) final
	called when a modbus request (function code 0x06 or 0x10) was parsed without errors

void	on_register_data (ModbusRegisterType register_type, uint16_t start_address, const std::vector< uint8_t > &data)
	default delegate called by process_modbus_data when a response has retrieved from the incoming queue

void	on_write_register_response (ModbusRegisterType register_type, uint16_t start_address, const std::vector< uint8_t > &data)
	default delegate called by process_modbus_data when a response for a write response has retrieved from the incoming queue

void	set_allow_duplicate_commands (bool allow_duplicate_commands)
	Allow a duplicate command to be sent.

bool	get_allow_duplicate_commands ()
	get if a duplicate command can be sent

void	set_command_throttle (uint16_t command_throttle)
	called by esphome generated code to set the command_throttle period

void	set_offline_skip_updates (uint16_t offline_skip_updates)
	called by esphome generated code to set the offline_skip_updates

size_t	get_command_queue_length ()
	get the number of queued modbus commands (should be mostly empty)

bool	get_module_offline ()
	get if the module is offline, didn't respond the last command

void	add_on_command_sent_callback (std::function< void(int, int)> &&callback)
	Set callback for commands.

void	add_on_online_callback (std::function< void(int, int)> &&callback)
	Set callback for online changes.

void	add_on_offline_callback (std::function< void(int, int)> &&callback)
	Set callback for offline changes.

void	set_max_cmd_retries (uint8_t max_cmd_retries)
	called by esphome generated code to set the max_cmd_retries.

uint8_t	get_max_cmd_retries ()
	get how many times a command will be (re)sent if no response is received

void	set_server_courtesy_response (const ServerCourtesyResponse &server_courtesy_response)
	Called by esphome generated code to set the server courtesy response object.

ServerCourtesyResponse	get_server_courtesy_response () const
	Get the server courtesy response object.

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

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)

virtual float	get_loop_priority () const
	priority of loop().

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Public Member Functions inherited from esphome::modbus::ModbusDevice
void	set_parent (Modbus *parent)

void	set_address (uint8_t address)

void	send (uint8_t function, uint16_t start_address, uint16_t number_of_entities, uint8_t payload_len=0, const uint8_t *payload=nullptr)

void	send_raw (const std::vector< uint8_t > &payload)

void	send_error (uint8_t function_code, ModbusExceptionCode exception_code)

bool	waiting_for_response ()

Protected Member Functions
size_t	create_register_ranges_ ()
	parse sensormap_ and create range of sequential addresses

SensorSet	find_sensors_ (ModbusRegisterType register_type, uint16_t start_address) const

void	update_range_ (RegisterRange &r)
	submit the read command for the address range to the send queue

void	process_modbus_data_ (const ModbusCommandItem *response)
	parse incoming modbus data

bool	send_next_command_ ()
	send the next modbus command from the send queue

void	dump_sensors_ ()
	dump the parsed sensormap for diagnostics

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
SensorSet	sensorset_
	Collection of all sensors for this component.

std::vector< ServerRegister * >	server_registers_ {}
	Collection of all server registers for this component.

std::vector< RegisterRange >	register_ranges_ {}
	Continuous range of modbus registers.

std::list< std::unique_ptr< ModbusCommandItem > >	command_queue_
	Hold the pending requests to be sent.

std::queue< std::unique_ptr< ModbusCommandItem > >	incoming_queue_
	modbus response data waiting to get processed

bool	allow_duplicate_commands_ {false}
	if duplicate commands can be sent

uint32_t	last_command_timestamp_ {0}
	when was the last send operation

uint16_t	command_throttle_ {0}
	min time in ms between sending modbus commands

bool	module_offline_ {false}
	if module didn't respond the last command

uint16_t	offline_skip_updates_ {0}
	how many updates to skip if module is offline

uint8_t	max_cmd_retries_ {4}
	How many times we will retry a command if we get no response.

CallbackManager< void(int, int)>	command_sent_callback_ {}
	Command sent callback.

CallbackManager< void(int, int)>	online_callback_ {}
	Server online callback.

CallbackManager< void(int, int)>	offline_callback_ {}
	Server offline callback.

ServerCourtesyResponse	server_courtesy_response_
	Server courtesy response.

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Protected Attributes inherited from esphome::modbus::ModbusDevice
friend	Modbus

Modbus *	parent_

uint8_t	address_

Detailed Description

Modbus controller class.

Each instance handles the modbus commuinication for all sensors with the same modbus address

all sensor items (sensors, switches, binarysensor ...) are parsed in modbus address ranges. when esphome calls ModbusController::Update the commands for each range are created and sent Responses for the commands are dispatched to the modbus sensor items.

Definition at line 462 of file modbus_controller.h.

Member Function Documentation

◆ add_on_command_sent_callback()

void esphome::modbus_controller::ModbusController::add_on_command_sent_callback ( std::function< void(int, int)> && callback )

Set callback for commands.

Definition at line 817 of file modbus_controller.cpp.

◆ add_on_offline_callback()

void esphome::modbus_controller::ModbusController::add_on_offline_callback ( std::function< void(int, int)> && callback )

Set callback for offline changes.

Definition at line 825 of file modbus_controller.cpp.

◆ add_on_online_callback()

void esphome::modbus_controller::ModbusController::add_on_online_callback ( std::function< void(int, int)> && callback )

Set callback for online changes.

Definition at line 821 of file modbus_controller.cpp.

◆ add_sensor_item()

void esphome::modbus_controller::ModbusController::add_sensor_item ( SensorItem * item )

inline

Registers a sensor with the controller. Called by esphomes code generator.

Definition at line 472 of file modbus_controller.h.

◆ add_server_register()

void esphome::modbus_controller::ModbusController::add_server_register ( ServerRegister * server_register )

inline

Registers a server register with the controller. Called by esphomes code generator.

Definition at line 474 of file modbus_controller.h.

◆ create_register_ranges_()

size_t esphome::modbus_controller::ModbusController::create_register_ranges_ ( )

protected

parse sensormap_ and create range of sequential addresses

Definition at line 341 of file modbus_controller.cpp.

◆ dump_config()

void esphome::modbus_controller::ModbusController::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 447 of file modbus_controller.cpp.

◆ dump_sensors_()

void esphome::modbus_controller::ModbusController::dump_sensors_ ( )

protected

dump the parsed sensormap for diagnostics

Definition at line 500 of file modbus_controller.cpp.

◆ find_sensors_()

SensorSet esphome::modbus_controller::ModbusController::find_sensors_	(	ModbusRegisterType	register_type,
		uint16_t	start_address ) const

protected

Definition at line 253 of file modbus_controller.cpp.

◆ get_allow_duplicate_commands()

bool esphome::modbus_controller::ModbusController::get_allow_duplicate_commands ( )

inline

get if a duplicate command can be sent

Definition at line 494 of file modbus_controller.h.

◆ get_command_queue_length()

size_t esphome::modbus_controller::ModbusController::get_command_queue_length ( )

inline

get the number of queued modbus commands (should be mostly empty)

Definition at line 500 of file modbus_controller.h.

◆ get_max_cmd_retries()

uint8_t esphome::modbus_controller::ModbusController::get_max_cmd_retries ( )

inline

get how many times a command will be (re)sent if no response is received

Definition at line 512 of file modbus_controller.h.

◆ get_module_offline()

bool esphome::modbus_controller::ModbusController::get_module_offline ( )

inline

get if the module is offline, didn't respond the last command

Definition at line 502 of file modbus_controller.h.

◆ get_server_courtesy_response()

ServerCourtesyResponse esphome::modbus_controller::ModbusController::get_server_courtesy_response ( ) const

inline

Get the server courtesy response object.

Definition at line 518 of file modbus_controller.h.

◆ loop()

void esphome::modbus_controller::ModbusController::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 481 of file modbus_controller.cpp.

◆ on_modbus_data()

void esphome::modbus_controller::ModbusController::on_modbus_data ( const std::vector< uint8_t > & data )

overridevirtual

called when a modbus response was parsed without errors

Implements esphome::modbus::ModbusDevice.

Definition at line 61 of file modbus_controller.cpp.

◆ on_modbus_error()

void esphome::modbus_controller::ModbusController::on_modbus_error	(	uint8_t	function_code,
		uint8_t	exception_code )

overridevirtual

called when a modbus error response was received

Reimplemented from esphome::modbus::ModbusDevice.

Definition at line 93 of file modbus_controller.cpp.

◆ on_modbus_read_registers()

void esphome::modbus_controller::ModbusController::on_modbus_read_registers	(	uint8_t	function_code,
		uint16_t	start_address,
		uint16_t	number_of_registers )

finalvirtual

called when a modbus request (function code 0x03 or 0x04) was parsed without errors

Reimplemented from esphome::modbus::ModbusDevice.

Definition at line 108 of file modbus_controller.cpp.

◆ on_modbus_write_registers()

void esphome::modbus_controller::ModbusController::on_modbus_write_registers	(	uint8_t	function_code,
		const std::vector< uint8_t > &	data )

finalvirtual

called when a modbus request (function code 0x06 or 0x10) was parsed without errors

Reimplemented from esphome::modbus::ModbusDevice.

Definition at line 173 of file modbus_controller.cpp.

◆ on_register_data()

void esphome::modbus_controller::ModbusController::on_register_data	(	ModbusRegisterType	register_type,
		uint16_t	start_address,
		const std::vector< uint8_t > &	data )

default delegate called by process_modbus_data when a response has retrieved from the incoming queue

Definition at line 267 of file modbus_controller.cpp.

◆ on_write_register_response()

void esphome::modbus_controller::ModbusController::on_write_register_response	(	ModbusRegisterType	register_type,
		uint16_t	start_address,
		const std::vector< uint8_t > &	data )

default delegate called by process_modbus_data when a response for a write response has retrieved from the incoming queue

Definition at line 495 of file modbus_controller.cpp.

◆ process_modbus_data_()

void esphome::modbus_controller::ModbusController::process_modbus_data_ ( const ModbusCommandItem * response )

protected

parse incoming modbus data

Definition at line 87 of file modbus_controller.cpp.

◆ queue_command()

void esphome::modbus_controller::ModbusController::queue_command ( const ModbusCommandItem & command )

queues a modbus command in the send queue

Definition at line 278 of file modbus_controller.cpp.

◆ send_next_command_()

bool esphome::modbus_controller::ModbusController::send_next_command_ ( )

protected

send the next modbus command from the send queue

Definition at line 18 of file modbus_controller.cpp.

◆ set_allow_duplicate_commands()

void esphome::modbus_controller::ModbusController::set_allow_duplicate_commands ( bool allow_duplicate_commands )

inline

Allow a duplicate command to be sent.

Definition at line 490 of file modbus_controller.h.

◆ set_command_throttle()

void esphome::modbus_controller::ModbusController::set_command_throttle ( uint16_t command_throttle )

inline

called by esphome generated code to set the command_throttle period

Definition at line 496 of file modbus_controller.h.

◆ set_max_cmd_retries()

void esphome::modbus_controller::ModbusController::set_max_cmd_retries ( uint8_t max_cmd_retries )

inline

called by esphome generated code to set the max_cmd_retries.

Definition at line 510 of file modbus_controller.h.

◆ set_offline_skip_updates()

void esphome::modbus_controller::ModbusController::set_offline_skip_updates ( uint16_t offline_skip_updates )

inline

called by esphome generated code to set the offline_skip_updates

Definition at line 498 of file modbus_controller.h.

◆ set_server_courtesy_response()

void esphome::modbus_controller::ModbusController::set_server_courtesy_response ( const ServerCourtesyResponse & server_courtesy_response )

inline

Called by esphome generated code to set the server courtesy response object.

Definition at line 514 of file modbus_controller.h.

◆ setup()

void esphome::modbus_controller::ModbusController::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file modbus_controller.cpp.

◆ update()

void esphome::modbus_controller::ModbusController::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 327 of file modbus_controller.cpp.

◆ update_range_()

void esphome::modbus_controller::ModbusController::update_range_ ( RegisterRange & r )

protected

submit the read command for the address range to the send queue

Definition at line 296 of file modbus_controller.cpp.

Field Documentation

◆ allow_duplicate_commands_

bool esphome::modbus_controller::ModbusController::allow_duplicate_commands_ {false}

protected

if duplicate commands can be sent

Definition at line 544 of file modbus_controller.h.

◆ command_queue_

std::list<std::unique_ptr<ModbusCommandItem> > esphome::modbus_controller::ModbusController::command_queue_

protected

Hold the pending requests to be sent.

Definition at line 540 of file modbus_controller.h.

◆ command_sent_callback_

CallbackManager<void(int, int)> esphome::modbus_controller::ModbusController::command_sent_callback_ {}

protected

Command sent callback.

Definition at line 556 of file modbus_controller.h.

◆ command_throttle_

uint16_t esphome::modbus_controller::ModbusController::command_throttle_ {0}

protected

min time in ms between sending modbus commands

Definition at line 548 of file modbus_controller.h.

◆ incoming_queue_

std::queue<std::unique_ptr<ModbusCommandItem> > esphome::modbus_controller::ModbusController::incoming_queue_

protected

modbus response data waiting to get processed

Definition at line 542 of file modbus_controller.h.

◆ last_command_timestamp_

uint32_t esphome::modbus_controller::ModbusController::last_command_timestamp_ {0}

protected

when was the last send operation

Definition at line 546 of file modbus_controller.h.

◆ max_cmd_retries_

uint8_t esphome::modbus_controller::ModbusController::max_cmd_retries_ {4}

protected

How many times we will retry a command if we get no response.

Definition at line 554 of file modbus_controller.h.

◆ module_offline_

bool esphome::modbus_controller::ModbusController::module_offline_ {false}

protected

if module didn't respond the last command

Definition at line 550 of file modbus_controller.h.

◆ offline_callback_

CallbackManager<void(int, int)> esphome::modbus_controller::ModbusController::offline_callback_ {}

protected

Server offline callback.

Definition at line 560 of file modbus_controller.h.

◆ offline_skip_updates_

uint16_t esphome::modbus_controller::ModbusController::offline_skip_updates_ {0}

protected

how many updates to skip if module is offline

Definition at line 552 of file modbus_controller.h.

◆ online_callback_

CallbackManager<void(int, int)> esphome::modbus_controller::ModbusController::online_callback_ {}

protected

Server online callback.

Definition at line 558 of file modbus_controller.h.

◆ register_ranges_

std::vector<RegisterRange> esphome::modbus_controller::ModbusController::register_ranges_ {}

protected

Continuous range of modbus registers.

Definition at line 538 of file modbus_controller.h.

◆ sensorset_

SensorSet esphome::modbus_controller::ModbusController::sensorset_

protected

Collection of all sensors for this component.

Definition at line 534 of file modbus_controller.h.

◆ server_courtesy_response_

ServerCourtesyResponse esphome::modbus_controller::ModbusController::server_courtesy_response_

protected

Initial value:

{

.enabled = false, .register_last_address = 0xFFFF, .register_value = 0}

Server courtesy response.

Definition at line 562 of file modbus_controller.h.

◆ server_registers_

std::vector<ServerRegister *> esphome::modbus_controller::ModbusController::server_registers_ {}

protected

Collection of all server registers for this component.

Definition at line 536 of file modbus_controller.h.

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

esphome/components/modbus_controller/modbus_controller.h
esphome/components/modbus_controller/modbus_controller.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_on_command_sent_callback()

◆ add_on_offline_callback()

◆ add_on_online_callback()

◆ add_sensor_item()

◆ add_server_register()

◆ create_register_ranges_()

◆ dump_config()

◆ dump_sensors_()

◆ find_sensors_()

◆ get_allow_duplicate_commands()

◆ get_command_queue_length()

◆ get_max_cmd_retries()

◆ get_module_offline()

◆ get_server_courtesy_response()

◆ loop()

◆ on_modbus_data()

◆ on_modbus_error()

◆ on_modbus_read_registers()

◆ on_modbus_write_registers()

◆ on_register_data()

◆ on_write_register_response()

◆ process_modbus_data_()

◆ queue_command()

◆ send_next_command_()

◆ set_allow_duplicate_commands()

◆ set_command_throttle()

◆ set_max_cmd_retries()

◆ set_offline_skip_updates()

◆ set_server_courtesy_response()

◆ setup()

◆ update()

◆ update_range_()

Field Documentation

◆ allow_duplicate_commands_

◆ command_queue_

◆ command_sent_callback_

◆ command_throttle_

◆ incoming_queue_

◆ last_command_timestamp_

◆ max_cmd_retries_

◆ module_offline_

◆ offline_callback_

◆ offline_skip_updates_

◆ online_callback_

◆ register_ranges_

◆ sensorset_

◆ server_courtesy_response_

◆ server_registers_