Master's functions for building requests and parsing responses (implementation) More...

#include "master_func.h"
#include "master.h"

Include dependency graph for master_func.impl.h:

This graph shows which files directly or indirectly include this file:

Functions
ModbusErrorInfo	modbusParseResponse01020304 (ModbusMaster status, uint8_t address, uint8_t function, const uint8_t requestPDU, uint8_t requestLength, const uint8_t *responsePDU, uint8_t responseLength)
	Parses response to requests 01, 02, 03 and 04.

ModbusErrorInfo	modbusParseResponse0506 (ModbusMaster status, uint8_t address, uint8_t function, const uint8_t requestPDU, uint8_t requestLength, const uint8_t *responsePDU, uint8_t responseLength)
	Parses response to requests 05 and 06.

ModbusErrorInfo	modbusParseResponse1516 (ModbusMaster status, uint8_t address, uint8_t function, const uint8_t requestPDU, uint8_t requestLength, const uint8_t *responsePDU, uint8_t responseLength)
	Parses response to requests 15 and 16 (write mutliple regsiters/coils)

ModbusErrorInfo	modbusParseResponse22 (ModbusMaster status, uint8_t address, uint8_t function, const uint8_t requestPDU, uint8_t requestLength, const uint8_t *responsePDU, uint8_t responseLength)
	Parses response to request 22.

ModbusErrorInfo	modbusBuildRequest01020304 (ModbusMaster *status, uint8_t function, uint16_t index, uint16_t count)
	Read mutiple coils/discrete inputs/holding registers/input registers.

ModbusErrorInfo	modbusBuildRequest0506 (ModbusMaster *status, uint8_t function, uint16_t index, uint16_t value)
	Write single coil/holding register.

ModbusErrorInfo	modbusBuildRequest15 (ModbusMaster status, uint16_t index, uint16_t count, const uint8_t values)
	Write multiple coils.

ModbusErrorInfo	modbusBuildRequest16 (ModbusMaster status, uint16_t index, uint16_t count, const uint16_t values)
	Write multiple holding registers.

ModbusErrorInfo	modbusBuildRequest22 (ModbusMaster *status, uint16_t index, uint16_t andmask, uint16_t ormask)
	Mask write register request.

Detailed Description

Master's functions for building requests and parsing responses (implementation)

Function Documentation

◆ modbusBuildRequest01020304()

ModbusErrorInfo modbusBuildRequest01020304	(	ModbusMaster *	status,
		uint8_t	function,
		uint16_t	index,
		uint16_t	count
	)

Read mutiple coils/discrete inputs/holding registers/input registers.

Parameters

function	1 to read coils, 2 to read discrete inputs, 3 to read holding registers, 4 to read input registers
index	Index of the register to be read
count	Number of registers to be read
value	New value for the register/coil

Returns: MODBUS_GENERAL_ERROR(FUNCTION) if function is not 1, 2, 3 or 4; MODBUS_GENERAL_ERROR(COUNT) if count is zero or too large; MODBUS_GENERAL_ERROR(RANGE) if the register range wraps aroudthe register space; MODBUS_GENERAL_ERROR(ALLOC) on memory allocation error; MODBUS_NO_ERROR() on success

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modbusBuildRequest0506()

ModbusErrorInfo modbusBuildRequest0506	(	ModbusMaster *	status,
		uint8_t	function,
		uint16_t	index,
		uint16_t	value
	)

Write single coil/holding register.

Parameters

function	5 to write a coil, 6 to write a holding register
index	Index of the register/coil to be written
value	New value for the register/coil

Returns: MODBUS_GENERAL_ERROR(FUNCTION) if function is not 5 or 6; MODBUS_GENERAL_ERROR(ALLOC) on memory allocation error; MODBUS_NO_ERROR() on success

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modbusBuildRequest15()

ModbusErrorInfo modbusBuildRequest15	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count,
		const uint8_t *	values
	)

Write multiple coils.

Parameters

index	Index of the first coil to be written
count	Number of coils to be written
values	Pointer to array containing `count` coil values (each bit corresponds to one coil value)

Returns: MODBUS_GENERAL_ERROR(COUNT) if count is zero or too large; MODBUS_GENERAL_ERROR(RANGE) if the register range wraps around the register space; MODBUS_GENERAL_ERROR(ALLOC) on memory allocation error; MODBUS_NO_ERROR() on success

Here is the call graph for this function:

◆ modbusBuildRequest16()

ModbusErrorInfo modbusBuildRequest16	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count,
		const uint16_t *	values
	)

Write multiple holding registers.

Parameters

index	Index of the first register to be written
count	Number of registers to be written
values	Pointer to array containing `count` register values. Each 16-bit word corresponds to one register value

Returns: MODBUS_GENERAL_ERROR(COUNT) if count is zero or too large; MODBUS_GENERAL_ERROR(RANGE) if the register range wraps around the register space; MODBUS_GENERAL_ERROR(ALLOC) on memory allocation error; MODBUS_NO_ERROR() on success

Here is the call graph for this function:

◆ modbusBuildRequest22()

ModbusErrorInfo modbusBuildRequest22	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	andmask,
		uint16_t	ormask
	)

Mask write register request.

Parameters

index	Register ID
andmax	AND mask
ormask	OR mask

Returns: MODBUS_GENERAL_ERROR(ALLOC) on memory allocation error; MODBUS_NO_ERROR() on success

Here is the call graph for this function:

◆ modbusParseResponse01020304()

ModbusErrorInfo modbusParseResponse01020304	(	ModbusMaster *	status,
		uint8_t	address,
		uint8_t	function,
		const uint8_t *	requestPDU,
		uint8_t	requestLength,
		const uint8_t *	responsePDU,
		uint8_t	responseLength
	)

Parses response to requests 01, 02, 03 and 04.

Parameters

address	Address of the slave
function	Response function code
requestPDU	pointer to the PDU section of the request frame
requestLength	request PDU section length
responsePDU	pointer to the PDU section of the response frame
responseLength	response PDU section length

Returns: MODBUS_REQUEST_ERROR(LENGTH) if request frame has invalid length; MODBUS_RESPONSE_ERROR(LENGTH) if response frame has invalid length; MODBUS_GENERAL_ERROR(FUNCTION) if function is not one of: 01, 02, 03, 04; MODBUS_REQUEST_ERROR(COUNT) if the declared register count is invalid; MODBUS_REQUEST_ERROR(RANGE) if the declared register range wraps around address space; MODBUS_RESPONSE_ERROR(LENGTH) if the response length is not as expected; MODBUS_NO_ERROR() on success

Here is the call graph for this function:

◆ modbusParseResponse0506()

ModbusErrorInfo modbusParseResponse0506	(	ModbusMaster *	status,
		uint8_t	address,
		uint8_t	function,
		const uint8_t *	requestPDU,
		uint8_t	requestLength,
		const uint8_t *	responsePDU,
		uint8_t	responseLength
	)

Parses response to requests 05 and 06.

Parameters

address	Address of the slave
function	Response function code
requestPDU	pointer to the PDU section of the request frame
requestLength	request PDU section length
responsePDU	pointer to the PDU section of the response frame
responseLength	response PDU section length

Returns: MODBUS_REQUEST_ERROR(LENGTH) if request frame has invalid length; MODBUS_RESPONSE_ERROR(LENGTH) if response frame has invalid length; MODBUS_RESPONSE_ERROR(INDEX) if the register index is different in request and response; MODBUS_RESPONSE_ERROR(VALUE) if the register value is different in request and response; MODBUS_NO_ERROR() on success

Here is the call graph for this function:

◆ modbusParseResponse1516()

ModbusErrorInfo modbusParseResponse1516	(	ModbusMaster *	status,
		uint8_t	address,
		uint8_t	function,
		const uint8_t *	requestPDU,
		uint8_t	requestLength,
		const uint8_t *	responsePDU,
		uint8_t	responseLength
	)

Parses response to requests 15 and 16 (write mutliple regsiters/coils)

Parameters

address	Address of the slave
function	Response function code
requestPDU	pointer to the PDU section of the request frame
requestLength	request PDU section length
responsePDU	pointer to the PDU section of the response frame
responseLength	response PDU section length

Returns: MODBUS_REQUEST_ERROR(LENGTH) if request frame has invalid length; MODBUS_RESPONSE_ERROR(LENGTH) if response frame has invalid length; MODBUS_REQUEST_ERROR(COUNT) if the declared register count is invalid; MODBUS_REQUEST_ERROR(RANGE) if the declared register range wraps around address space; MODBUS_RESPONSE_ERROR(INDEX) if the index differs between the request and response; MODBUS_RESPONSE_ERROR(COUNT) if the count differs between the request and response; MODBUS_NO_ERROR() on success

Here is the call graph for this function:

◆ modbusParseResponse22()

ModbusErrorInfo modbusParseResponse22	(	ModbusMaster *	status,
		uint8_t	address,
		uint8_t	function,
		const uint8_t *	requestPDU,
		uint8_t	requestLength,
		const uint8_t *	responsePDU,
		uint8_t	responseLength
	)

Parses response to request 22.

Parameters

address	Address of the slave
function	Response function code
requestPDU	pointer to the PDU section of the request frame
requestLength	request PDU section length
responsePDU	pointer to the PDU section of the response frame
responseLength	response PDU section length

Returns: MODBUS_REQUEST_ERROR(LENGTH) if request frame has invalid length; MODBUS_RESPONSE_ERROR(LENGTH) if response frame has invalid length; MODBUS_RESPONSE_ERROR(OTHER) if the response is different from the request; MODBUS_NO_ERROR() on success

Functions

Detailed Description

Function Documentation

◆ modbusBuildRequest01020304()

◆ modbusBuildRequest0506()

◆ modbusBuildRequest15()

◆ modbusBuildRequest16()

◆ modbusBuildRequest22()

◆ modbusParseResponse01020304()

◆ modbusParseResponse0506()

◆ modbusParseResponse1516()

◆ modbusParseResponse22()