mbcoils.h File Reference

Master's coil-related frame building functions. More...

Go to the source code of this file.

Functions
ModbusError	modbusBuildRequest0102 (ModbusMaster *status, uint8_t function, uint8_t address, uint16_t index, uint16_t count)
	Builds request 01 (read multiple coils) or 02 (read multiple discrete inputs) frame. More...
static ModbusError	modbusBuildRequest01 (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t count)
	Builds request 01 (read multiple coils) frame. More...
static ModbusError	modbusBuildRequest02 (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t count)
	Builds request 02 (read multiple discrete inputs) frame. More...
ModbusError	modbusBuildRequest05 (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t value)
	Builds request 05 (write a single coil) frame. More...
ModbusError	modbusBuildRequest15 (ModbusMaster *status, uint8_t address, uint16_t index, uint16_t count, uint8_t *values)
	Builds request 15 (write multiple coils) frame. More...

Detailed Description

Master's coil-related frame building functions.

Function Documentation

modbusBuildRequest01()

static ModbusError modbusBuildRequest01 ( ModbusMaster *  status, uint8_t  address, uint16_t  index, uint16_t  count  )

inlinestatic

Builds request 01 (read multiple coils) frame.

Note

Requires F01M or F02M module (see Building liblightmodbus)

Calls modbusBuildRequest0102 with 1 as the second parameter

Parameters

status	The master structure to load with the request frame
address	Address of slave to be requested
index	Address of the first coil
count	Number of coils to be read

Returns

A ModbusError error code

Here is the call graph for this function:

modbusBuildRequest0102()

ModbusError modbusBuildRequest0102	(	ModbusMaster *	status,
		uint8_t	function,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count
	)

Builds request 01 (read multiple coils) or 02 (read multiple discrete inputs) frame.

Note

Requires F01M or F02M module (see Building liblightmodbus)

modbusParseRequest01 and modbusParseRequest02 macros are aliases of this function

Parameters

status	The master structure to load with the request frame
function	Function to be used in the request (01 or 02)
address	Address of slave to be requested
index	Address of the first discrete input/coil
count	Number of coils to be read

Returns

A ModbusError error code

Here is the call graph for this function:

Here is the caller graph for this function:

modbusBuildRequest02()

static ModbusError modbusBuildRequest02 ( ModbusMaster *  status, uint8_t  address, uint16_t  index, uint16_t  count  )

inlinestatic

Builds request 02 (read multiple discrete inputs) frame.

Note

Requires F01M or F02M module (see Building liblightmodbus)

Calls modbusBuildRequest0102 with 2 as the second parameter

Parameters

status	The master structure to load with the request frame
address	Address of slave to be requested
index	Address of the first discrete input
count	Number of discrete inputs to be read

Returns

A ModbusError error code

Here is the call graph for this function:

modbusBuildRequest05()

ModbusError modbusBuildRequest05	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	value
	)

Builds request 05 (write a single coil) frame.

Note

Requires F01M or F02M module (see Building liblightmodbus)

Parameters

status	The master structure to load with the request frame
address	Address of slave to be requested
index	Address of the coil
value	Coil value to be written

Returns

A ModbusError error code

Here is the call graph for this function:

Here is the caller graph for this function:

modbusBuildRequest15()

ModbusError modbusBuildRequest15	(	ModbusMaster *	status,
		uint8_t	address,
		uint16_t	index,
		uint16_t	count,
		uint8_t *	values
	)

Builds request 15 (write multiple coils) frame.

Note

Requires LIGHTMODBUS_F15M macro to be defined

Requires F05M module (see Building liblightmodbus)

Parameters

status	The master structure to load with the request frame
address	Address of slave to be requested
index	Address of the first coil
count	Number of coils to be written
values	Coil values to be written (each bit corresponds to one coil)

Returns

A ModbusError error code

Here is the call graph for this function:

Here is the caller graph for this function: