#include <modbus_server.h>

Inheritance diagram for esphome::modbus_server::ModbusServer:

Public Member Functions
void	dump_config () override

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

modbus::ResponseStatus	on_read_registers (uint16_t start_address, uint16_t number_of_registers, modbus::RegisterValues &registers) final
	called when a modbus request (function code 0x03 or 0x04) was parsed without errors

modbus::ResponseStatus	on_write_registers (uint16_t start_address, const modbus::RegisterValues &registers) final
	called when a modbus request (function code 0x06 or 0x10) was parsed without errors

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::Component
virtual void	setup ()
	Where the component's initialization should happen.

virtual void	loop ()
	This method will be called repeatedly.

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::modbus::ModbusServerDevice
virtual	~ModbusServerDevice ()=default

	ModbusServerDevice ()=default

	ModbusServerDevice (const ModbusServerDevice &)=delete

ModbusServerDevice &	operator= (const ModbusServerDevice &)=delete

	ModbusServerDevice (ModbusServerDevice &&)=delete

ModbusServerDevice &	operator= (ModbusServerDevice &&)=delete

void	set_address (uint8_t address)

uint8_t	get_address () const

virtual ResponseStatus	on_read_input_registers (uint16_t start_address, uint16_t number_of_registers, RegisterValues &registers)

virtual ResponseStatus	on_read_holding_registers (uint16_t start_address, uint16_t number_of_registers, RegisterValues &registers)

Protected Member Functions
ServerRegister *	find_containing_register_ (uint32_t address) const
	Find the registered value whose register span contains address, or nullptr if none does.

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
std::vector< ServerRegister * >	server_registers_ {}
	Collection of all server registers for this component.

ServerCourtesyResponse	server_courtesy_response_
	Server courtesy response.

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::modbus::ModbusServerDevice
uint8_t	address_ {0}

Detailed Description

Definition at line 98 of file modbus_server.h.

Member Function Documentation

◆ add_server_register()

void esphome::modbus_server::ModbusServer::add_server_register ( ServerRegister * server_register )

inline

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

Definition at line 103 of file modbus_server.h.

◆ dump_config()

void esphome::modbus_server::ModbusServer::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 168 of file modbus_server.cpp.

◆ find_containing_register_()

ServerRegister * esphome::modbus_server::ModbusServer::find_containing_register_ ( uint32_t address ) const

protected

Find the registered value whose register span contains address, or nullptr if none does.

Definition at line 20 of file modbus_server.cpp.

◆ get_server_courtesy_response()

ServerCourtesyResponse esphome::modbus_server::ModbusServer::get_server_courtesy_response ( ) const

inline

Get the server courtesy response object.

Definition at line 114 of file modbus_server.h.

◆ on_read_registers()

modbus::ResponseStatus esphome::modbus_server::ModbusServer::on_read_registers	(	uint16_t	start_address,
		uint16_t	number_of_registers,
		modbus::RegisterValues &	registers )

finalvirtual

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

Reimplemented from esphome::modbus::ModbusServerDevice.

Definition at line 30 of file modbus_server.cpp.

◆ on_write_registers()

modbus::ResponseStatus esphome::modbus_server::ModbusServer::on_write_registers	(	uint16_t	start_address,
		const modbus::RegisterValues &	registers )

finalvirtual

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

Reimplemented from esphome::modbus::ModbusServerDevice.

Definition at line 103 of file modbus_server.cpp.

◆ set_server_courtesy_response()

void esphome::modbus_server::ModbusServer::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 110 of file modbus_server.h.

Field Documentation

◆ server_courtesy_response_

ServerCourtesyResponse esphome::modbus_server::ModbusServer::server_courtesy_response_

protected

Initial value:

{

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

Server courtesy response.

Definition at line 122 of file modbus_server.h.

◆ server_registers_

std::vector<ServerRegister *> esphome::modbus_server::ModbusServer::server_registers_ {}

protected

Collection of all server registers for this component.

Definition at line 120 of file modbus_server.h.

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

esphome/components/modbus_server/modbus_server.h
esphome/components/modbus_server/modbus_server.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_server_register()

◆ dump_config()

◆ find_containing_register_()

◆ get_server_courtesy_response()

◆ on_read_registers()

◆ on_write_registers()

◆ set_server_courtesy_response()

Field Documentation

◆ server_courtesy_response_

◆ server_registers_