FB_MBReadCoils (Modbus function 1)

This function is used for reading 1 to 2048 digital outputs (coils). One digital output corresponds to one bit of the read data bytes.

Inputs

VAR_INPUT
    sIPAddr       : STRING(15);
    nTCPPort      : UINT:= MODBUS_TCP_PORT;
    nUnitID       : BYTE:=16#FF;
    nQuantity     : WORD;
    nMBAddr       : WORD;
    cbLength      : UDINT;
    pDestAddr     : POINTER OF BYTE;
    bExecute      : BOOL;
    tTimeout      : TIME;
END_VAR

Name	Type	Description
sIPAddr	STRING (15)	Is a string containing the IP address of the target device.
nTCPPort	UINT	Port number of the target device.
nUnitID	BYTE	Identification number of a serial sub-network device. If a device is addressed directly via TCP/IP, this value must be 16#FF.
nQuantity	WORD	Number of digital inputs (data bits) to be read. The value zero is not permitted.
nMBAddr	WORD	Start address of the digital inputs to be read (bit offset).
cbLength	UDINT	Contains the maximum available byte size of the destination buffer into which the data are to be read. The buffer must have at least the byte size: (nQuantity + 7) / 8.
pDestAdd	POINTER OF BYTE	Contains the address of the destination buffer into which the data are to be read. The buffer can be a single variable, an array or a structure, whose address can be determined with the ADR operator.
bExecute	BOOL	The function block is enabled by a rising edge at this input.
tTimeout	TIME	States the length of the timeout that may not be exceeded by execution of the ADS command.

Outputs

VAR_OUTPUT
    bBUSY      : BOOL;
    bError     : BOOL;
    nErrId     : UDINT;
    cbRead     : UDINT;
END_VAR

Name	Type	Description
bBusy	BOOL	When the function block is enabled, this output is set and remains set until a feedback is received.
bError	BOOL	If an ADS error should occur during the transfer of the command, then this output is set once the bBusy output is reset.
nErrId	UDINT	Returns the ADS error number when the bError output is set.
cbRead	UDINT	Contains the number of bytes currently read.

Sample of calling the function block in FBD

PROGRAM Test
VAR
    fbReadCoils            : FB_MBReadCoils;
    bReadCoils             : BOOL;
    bReadCoilsBusy         : BOOL;
    bReadCoilsError        : BOOL;
    nReadCoilsErrorId      : UDINT;
    nReadCoilsCount        : UDINT;
    nQuantity.             : WORD := 10;
    nMBAddr.               : WORD := 5;
    arrData.               : ARRAY [1..2] OF BYTE;
END_VAR

After a rising edge of "bExecute" and successful execution of the ReadCoils command, the content of digital outputs 6 - 15 is written into the arrData array:

Digital outputs	Array offset	Status
6-13	1	0x54 Status of output 13 is the MSB of this byte (far left) Status of output 6 is the LSB of this byte (far right)
14-15	2	0x02 as only 10 outputs are to be read, the remaining bits (3-8) are set to 0.

Requirements

Development environment	Target system type	PLC libraries to be linked
TwinCAT v3.0.0	PC or CX (x86)	Tc2_ModbusSrv