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

#include "base.h"
#include "master.h"

Include dependency graph for master_func.h:

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

Macros
#define	LIGHTMODBUS_DEFINE_BUILD_PDU_HEADER(f_suffix, ...)
	Defines a header for a `modbusBuildRequest*PDU()` function.

#define	LIGHTMODBUS_DEFINE_BUILD_PDU_BODY(f_suffix, ...)
	Defines a body for a `modbusBuildRequest*PDU()` function.

#define	LIGHTMODBUS_DEFINE_BUILD_RTU_HEADER(f_suffix, ...)
	Defines a header for a `modbusBuildRequest*RTU()` function.

#define	LIGHTMODBUS_DEFINE_BUILD_RTU_BODY(f_suffix, ...)
	Defines a body for a `modbusBuildRequest*RTU()` function.

#define	LIGHTMODBUS_DEFINE_BUILD_TCP_HEADER(f_suffix, ...)
	Defines a header for a `modbusBuildRequest*TCP()` function.

#define	LIGHTMODBUS_DEFINE_BUILD_TCP_BODY(f_suffix, ...)
	Defines a body for a `modbusBuildRequest*TCP()` function.

Functions
	ModbusErrorInfomodbusParseResponse01020304 (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.

	ModbusErrorInfomodbusParseResponse0506 (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.

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

	ModbusErrorInfomodbusParseResponse22 (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.

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

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

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

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

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

static ModbusErrorInfo	modbusBuildRequest01 (ModbusMaster *status, uint16_t index, uint16_t count)
	Read multiple coils - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest02 (ModbusMaster *status, uint16_t index, uint16_t count)
	Read multiple discrete inputs - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest03 (ModbusMaster *status, uint16_t index, uint16_t count)
	Read multiple holding registers - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest04 (ModbusMaster *status, uint16_t index, uint16_t count)
	Read multiple input registers - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest05 (ModbusMaster *status, uint16_t index, uint16_t count)
	Write single coil - a wrapper for modbusBuildRequest0506()

static ModbusErrorInfo	modbusBuildRequest06 (ModbusMaster *status, uint16_t index, uint16_t count)
	Write single holding register - a wrapper for modbusBuildRequest0506()

static ModbusErrorInfo	modbusBuildRequest01PDU (ModbusMaster *status, uint16_t index, uint16_t count)
	Read multiple coils - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest01RTU (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t count)
	Read multiple coils - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest01TCP (ModbusMaster *status, uint16_t transactionID, uint8_t unitID, uint16_t index, uint16_t count)
	Read multiple coils - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest02PDU (ModbusMaster *status, uint16_t index, uint16_t count)
	Read multiple discrete inputs - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest02RTU (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t count)
	Read multiple discrete inputs - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest02TCP (ModbusMaster *status, uint16_t transactionID, uint8_t unitID, uint16_t index, uint16_t count)
	Read multiple discrete inputs - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest03PDU (ModbusMaster *status, uint16_t index, uint16_t count)
	Read multiple holding registers - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest03RTU (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t count)
	Read multiple holding registers - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest03TCP (ModbusMaster *status, uint16_t transactionID, uint8_t unitID, uint16_t index, uint16_t count)
	Read multiple holding registers - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest04PDU (ModbusMaster *status, uint16_t index, uint16_t count)
	Read multiple input registers - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest04RTU (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t count)
	Read multiple input registers - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest04TCP (ModbusMaster *status, uint16_t transactionID, uint8_t unitID, uint16_t index, uint16_t count)
	Read multiple input registers - a wrapper for modbusBuildRequest01020304()

static ModbusErrorInfo	modbusBuildRequest05PDU (ModbusMaster *status, uint16_t index, uint16_t count)
	Write single coil - a wrapper for modbusBuildRequest0506()

static ModbusErrorInfo	modbusBuildRequest05RTU (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t count)
	Write single coil - a wrapper for modbusBuildRequest0506()

static ModbusErrorInfo	modbusBuildRequest05TCP (ModbusMaster *status, uint16_t transactionID, uint8_t unitID, uint16_t index, uint16_t count)
	Write single coil - a wrapper for modbusBuildRequest0506()

static ModbusErrorInfo	modbusBuildRequest06PDU (ModbusMaster *status, uint16_t index, uint16_t count)
	Write single holding register - a wrapper for modbusBuildRequest0506()

static ModbusErrorInfo	modbusBuildRequest06RTU (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t count)
	Write single holding register - a wrapper for modbusBuildRequest0506()

static ModbusErrorInfo	modbusBuildRequest06TCP (ModbusMaster *status, uint16_t transactionID, uint8_t unitID, uint16_t index, uint16_t count)
	Write single holding register - a wrapper for modbusBuildRequest0506()

static ModbusErrorInfo	modbusBuildRequest15PDU (ModbusMaster status, uint16_t index, uint16_t count, const uint8_t values)

static ModbusErrorInfo	modbusBuildRequest15RTU (ModbusMaster status, uint8_t address, uint16_t index, uint16_t count, const uint8_t values)

static ModbusErrorInfo	modbusBuildRequest15TCP (ModbusMaster status, uint16_t transactionID, uint8_t unitID, uint16_t index, uint16_t count, const uint8_t values)

static ModbusErrorInfo	modbusBuildRequest16PDU (ModbusMaster status, uint16_t index, uint16_t count, const uint16_t values)

static ModbusErrorInfo	modbusBuildRequest16RTU (ModbusMaster status, uint8_t address, uint16_t index, uint16_t count, const uint16_t values)

static ModbusErrorInfo	modbusBuildRequest16TCP (ModbusMaster status, uint16_t transactionID, uint8_t unitID, uint16_t index, uint16_t count, const uint16_t values)

static ModbusErrorInfo	modbusBuildRequest22PDU (ModbusMaster *status, uint16_t index, uint16_t andmask, uint16_t ormask)

static ModbusErrorInfo	modbusBuildRequest22RTU (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t andmask, uint16_t ormask)

static ModbusErrorInfo	modbusBuildRequest22TCP (ModbusMaster *status, uint16_t transactionID, uint8_t unitID, uint16_t index, uint16_t andmask, uint16_t ormask)

Detailed Description

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

Macro Definition Documentation

◆ LIGHTMODBUS_DEFINE_BUILD_PDU_BODY

#define LIGHTMODBUS_DEFINE_BUILD_PDU_BODY	(		f_suffix,
			... )

Value:

    { \
        ModbusErrorInfo err; \
        if (!modbusIsOk(err = modbusBeginRequestPDU(status))) return err; \
        if (!modbusIsOk(err = modbusBuildRequest##f_suffix(status, __VA_ARGS__))) return err; \
        return modbusEndRequestPDU(status); \
    }

Defines a body for a modbusBuildRequest*PDU() function.

◆ LIGHTMODBUS_DEFINE_BUILD_PDU_HEADER

#define LIGHTMODBUS_DEFINE_BUILD_PDU_HEADER	(		f_suffix,
			... )

Value:

LIGHTMODBUS_WARN_UNUSED static inline ModbusErrorInfo modbusBuildRequest##f_suffix##PDU(ModbusMaster *status, __VA_ARGS__)

LIGHTMODBUS_WARN_UNUSED

#define LIGHTMODBUS_WARN_UNUSED

Definition base.h:19

ModbusMaster

Master device status.

Definition master.h:73

Defines a header for a modbusBuildRequest*PDU() function.

◆ LIGHTMODBUS_DEFINE_BUILD_RTU_BODY

#define LIGHTMODBUS_DEFINE_BUILD_RTU_BODY	(		f_suffix,
			... )

Value:

    { \
        ModbusErrorInfo err; \
        if (!modbusIsOk(err = modbusBeginRequestRTU(status))) return err; \
        if (!modbusIsOk(err = modbusBuildRequest##f_suffix(status, __VA_ARGS__))) return err; \
        return modbusEndRequestRTU(status, address); \
    }

Defines a body for a modbusBuildRequest*RTU() function.

◆ LIGHTMODBUS_DEFINE_BUILD_RTU_HEADER

#define LIGHTMODBUS_DEFINE_BUILD_RTU_HEADER	(		f_suffix,
			... )

Value:

LIGHTMODBUS_WARN_UNUSED static inline ModbusErrorInfo modbusBuildRequest##f_suffix##RTU(ModbusMaster *status, uint8_t address, __VA_ARGS__)

Defines a header for a modbusBuildRequest*RTU() function.

◆ LIGHTMODBUS_DEFINE_BUILD_TCP_BODY

#define LIGHTMODBUS_DEFINE_BUILD_TCP_BODY	(		f_suffix,
			... )

Value:

    { \
        ModbusErrorInfo err; \
        if (!modbusIsOk(err = modbusBeginRequestTCP(status))) return err; \
        if (!modbusIsOk(err = modbusBuildRequest##f_suffix(status, __VA_ARGS__))) return err; \
        return modbusEndRequestTCP(status, transactionID, unitID); \
    }

Defines a body for a modbusBuildRequest*TCP() function.

◆ LIGHTMODBUS_DEFINE_BUILD_TCP_HEADER

#define LIGHTMODBUS_DEFINE_BUILD_TCP_HEADER	(		f_suffix,
			... )

Value:

LIGHTMODBUS_WARN_UNUSED static inline ModbusErrorInfo modbusBuildRequest##f_suffix##TCP(ModbusMaster *status, uint16_t transactionID, uint8_t unitID, __VA_ARGS__)

Defines a header for a modbusBuildRequest*TCP() function.

Function Documentation

◆ modbusBuildRequest01()

static ModbusErrorInfo modbusBuildRequest01	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple coils - a wrapper for modbusBuildRequest01020304()

◆ modbusBuildRequest01PDU()

static ModbusErrorInfo modbusBuildRequest01PDU	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple coils - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestPDU() or modbusEndRequestPDU()

◆ modbusBuildRequest01RTU()

static ModbusErrorInfo modbusBuildRequest01RTU	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple coils - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestRTU() or modbusEndRequestRTU()

◆ modbusBuildRequest01TCP()

static ModbusErrorInfo modbusBuildRequest01TCP	(	ModbusMaster *	status,
		uint16_t	transactionID,
		uint8_t	unitID,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple coils - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestTCP() or modbusEndRequestTCP()

◆ modbusBuildRequest02()

static ModbusErrorInfo modbusBuildRequest02	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple discrete inputs - a wrapper for modbusBuildRequest01020304()

◆ modbusBuildRequest02PDU()

static ModbusErrorInfo modbusBuildRequest02PDU	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple discrete inputs - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestPDU() or modbusEndRequestPDU()

◆ modbusBuildRequest02RTU()

static ModbusErrorInfo modbusBuildRequest02RTU	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple discrete inputs - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestRTU() or modbusEndRequestRTU()

◆ modbusBuildRequest02TCP()

static ModbusErrorInfo modbusBuildRequest02TCP	(	ModbusMaster *	status,
		uint16_t	transactionID,
		uint8_t	unitID,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple discrete inputs - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestTCP() or modbusEndRequestTCP()

◆ modbusBuildRequest03()

static ModbusErrorInfo modbusBuildRequest03	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple holding registers - a wrapper for modbusBuildRequest01020304()

◆ modbusBuildRequest03PDU()

static ModbusErrorInfo modbusBuildRequest03PDU	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple holding registers - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestPDU() or modbusEndRequestPDU()

◆ modbusBuildRequest03RTU()

static ModbusErrorInfo modbusBuildRequest03RTU	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple holding registers - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestRTU() or modbusEndRequestRTU()

◆ modbusBuildRequest03TCP()

static ModbusErrorInfo modbusBuildRequest03TCP	(	ModbusMaster *	status,
		uint16_t	transactionID,
		uint8_t	unitID,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple holding registers - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestTCP() or modbusEndRequestTCP()

◆ modbusBuildRequest04()

static ModbusErrorInfo modbusBuildRequest04	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple input registers - a wrapper for modbusBuildRequest01020304()

◆ modbusBuildRequest04PDU()

static ModbusErrorInfo modbusBuildRequest04PDU	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple input registers - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestPDU() or modbusEndRequestPDU()

◆ modbusBuildRequest04RTU()

static ModbusErrorInfo modbusBuildRequest04RTU	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple input registers - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestRTU() or modbusEndRequestRTU()

◆ modbusBuildRequest04TCP()

static ModbusErrorInfo modbusBuildRequest04TCP	(	ModbusMaster *	status,
		uint16_t	transactionID,
		uint8_t	unitID,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Read multiple input registers - a wrapper for modbusBuildRequest01020304()

Returns: Any errors from modbusBeginRequestTCP() or modbusEndRequestTCP()

◆ modbusBuildRequest05()

static ModbusErrorInfo modbusBuildRequest05	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Write single coil - a wrapper for modbusBuildRequest0506()

◆ modbusBuildRequest05PDU()

static ModbusErrorInfo modbusBuildRequest05PDU	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Write single coil - a wrapper for modbusBuildRequest0506()

Returns: Any errors from modbusBeginRequestPDU() or modbusEndRequestPDU()

◆ modbusBuildRequest05RTU()

static ModbusErrorInfo modbusBuildRequest05RTU	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Write single coil - a wrapper for modbusBuildRequest0506()

Returns: Any errors from modbusBeginRequestRTU() or modbusEndRequestRTU()

◆ modbusBuildRequest05TCP()

static ModbusErrorInfo modbusBuildRequest05TCP	(	ModbusMaster *	status,
		uint16_t	transactionID,
		uint8_t	unitID,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Write single coil - a wrapper for modbusBuildRequest0506()

Returns: Any errors from modbusBeginRequestTCP() or modbusEndRequestTCP()

◆ modbusBuildRequest06()

static ModbusErrorInfo modbusBuildRequest06	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Write single holding register - a wrapper for modbusBuildRequest0506()

◆ modbusBuildRequest06PDU()

static ModbusErrorInfo modbusBuildRequest06PDU	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Write single holding register - a wrapper for modbusBuildRequest0506()

Returns: Any errors from modbusBeginRequestPDU() or modbusEndRequestPDU()

◆ modbusBuildRequest06RTU()

static ModbusErrorInfo modbusBuildRequest06RTU	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Write single holding register - a wrapper for modbusBuildRequest0506()

Returns: Any errors from modbusBeginRequestRTU() or modbusEndRequestRTU()

◆ modbusBuildRequest06TCP()

static ModbusErrorInfo modbusBuildRequest06TCP	(	ModbusMaster *	status,
		uint16_t	transactionID,
		uint8_t	unitID,
		uint16_t	index,
		uint16_t	count )

inlinestatic

Write single holding register - a wrapper for modbusBuildRequest0506()

Returns: Any errors from modbusBeginRequestTCP() or modbusEndRequestTCP()

◆ modbusBuildRequest15PDU()

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

inlinestatic

Returns: Any errors from modbusBeginRequestPDU() or modbusEndRequestPDU()

◆ modbusBuildRequest15RTU()

static ModbusErrorInfo modbusBuildRequest15RTU	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count,
		const uint8_t *	values )

inlinestatic

Returns: Any errors from modbusBeginRequestRTU() or modbusEndRequestRTU()

◆ modbusBuildRequest15TCP()

static ModbusErrorInfo modbusBuildRequest15TCP	(	ModbusMaster *	status,
		uint16_t	transactionID,
		uint8_t	unitID,
		uint16_t	index,
		uint16_t	count,
		const uint8_t *	values )

inlinestatic

Returns: Any errors from modbusBeginRequestTCP() or modbusEndRequestTCP()

◆ modbusBuildRequest16PDU()

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

inlinestatic

Returns: Any errors from modbusBeginRequestPDU() or modbusEndRequestPDU()

◆ modbusBuildRequest16RTU()

static ModbusErrorInfo modbusBuildRequest16RTU	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count,
		const uint16_t *	values )

inlinestatic

Returns: Any errors from modbusBeginRequestRTU() or modbusEndRequestRTU()

◆ modbusBuildRequest16TCP()

static ModbusErrorInfo modbusBuildRequest16TCP	(	ModbusMaster *	status,
		uint16_t	transactionID,
		uint8_t	unitID,
		uint16_t	index,
		uint16_t	count,
		const uint16_t *	values )

inlinestatic

Returns: Any errors from modbusBeginRequestTCP() or modbusEndRequestTCP()

◆ modbusBuildRequest22PDU()

static ModbusErrorInfo modbusBuildRequest22PDU	(	ModbusMaster *	status,
		uint16_t	index,
		uint16_t	andmask,
		uint16_t	ormask )

inlinestatic

Returns: Any errors from modbusBeginRequestPDU() or modbusEndRequestPDU()

◆ modbusBuildRequest22RTU()

static ModbusErrorInfo modbusBuildRequest22RTU	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	andmask,
		uint16_t	ormask )

inlinestatic

Returns: Any errors from modbusBeginRequestRTU() or modbusEndRequestRTU()

◆ modbusBuildRequest22TCP()

static ModbusErrorInfo modbusBuildRequest22TCP	(	ModbusMaster *	status,
		uint16_t	transactionID,
		uint8_t	unitID,
		uint16_t	index,
		uint16_t	andmask,
		uint16_t	ormask )

inlinestatic

Returns: Any errors from modbusBeginRequestTCP() or modbusEndRequestTCP()

◆ ModbusErrorInfomodbusBuildRequest01020304()

ModbusErrorInfomodbusBuildRequest01020304	(	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:

◆ ModbusErrorInfomodbusBuildRequest0506()

ModbusErrorInfomodbusBuildRequest0506	(	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:

◆ ModbusErrorInfomodbusBuildRequest15()

ModbusErrorInfomodbusBuildRequest15	(	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:

◆ ModbusErrorInfomodbusBuildRequest16()

ModbusErrorInfomodbusBuildRequest16	(	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:

◆ ModbusErrorInfomodbusBuildRequest22()

ModbusErrorInfomodbusBuildRequest22	(	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:

◆ ModbusErrorInfomodbusParseResponse01020304()

ModbusErrorInfomodbusParseResponse01020304	(	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:

◆ ModbusErrorInfomodbusParseResponse0506()

ModbusErrorInfomodbusParseResponse0506	(	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:

◆ ModbusErrorInfomodbusParseResponse1516()

ModbusErrorInfomodbusParseResponse1516	(	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:

◆ ModbusErrorInfomodbusParseResponse22()

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

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ LIGHTMODBUS_DEFINE_BUILD_PDU_BODY

◆ LIGHTMODBUS_DEFINE_BUILD_PDU_HEADER

◆ LIGHTMODBUS_DEFINE_BUILD_RTU_BODY

◆ LIGHTMODBUS_DEFINE_BUILD_RTU_HEADER

◆ LIGHTMODBUS_DEFINE_BUILD_TCP_BODY

◆ LIGHTMODBUS_DEFINE_BUILD_TCP_HEADER

Function Documentation

◆ modbusBuildRequest01()

◆ modbusBuildRequest01PDU()

◆ modbusBuildRequest01RTU()

◆ modbusBuildRequest01TCP()

◆ modbusBuildRequest02()

◆ modbusBuildRequest02PDU()

◆ modbusBuildRequest02RTU()

◆ modbusBuildRequest02TCP()

◆ modbusBuildRequest03()

◆ modbusBuildRequest03PDU()

◆ modbusBuildRequest03RTU()

◆ modbusBuildRequest03TCP()

◆ modbusBuildRequest04()

◆ modbusBuildRequest04PDU()

◆ modbusBuildRequest04RTU()

◆ modbusBuildRequest04TCP()

◆ modbusBuildRequest05()

◆ modbusBuildRequest05PDU()

◆ modbusBuildRequest05RTU()

◆ modbusBuildRequest05TCP()

◆ modbusBuildRequest06()

◆ modbusBuildRequest06PDU()

◆ modbusBuildRequest06RTU()

◆ modbusBuildRequest06TCP()

◆ modbusBuildRequest15PDU()

◆ modbusBuildRequest15RTU()

◆ modbusBuildRequest15TCP()

◆ modbusBuildRequest16PDU()

◆ modbusBuildRequest16RTU()

◆ modbusBuildRequest16TCP()

◆ modbusBuildRequest22PDU()

◆ modbusBuildRequest22RTU()

◆ modbusBuildRequest22TCP()

◆ ModbusErrorInfomodbusBuildRequest01020304()

◆ ModbusErrorInfomodbusBuildRequest0506()

◆ ModbusErrorInfomodbusBuildRequest15()

◆ ModbusErrorInfomodbusBuildRequest16()

◆ ModbusErrorInfomodbusBuildRequest22()

◆ ModbusErrorInfomodbusParseResponse01020304()

◆ ModbusErrorInfomodbusParseResponse0506()

◆ ModbusErrorInfomodbusParseResponse1516()

◆ ModbusErrorInfomodbusParseResponse22()