writeRead

Perform write and read operation on groups of holding registers in single Modbus transaction

Syntax

moddata = writeRead(m,writeAddress,values,readAddress,readCount)

moddata = writeRead(m,writeAddress,values,writePrecision,readAddress,readCount,readPrecision)

moddata = writeRead(___,serverId)

Description

moddata = writeRead(m,writeAddress,values,readAddress,readCount) writes data to Modbus object m at the starting address writeAddress using the values to write values, and then reads data at the starting address readAddress using the number of values to read readCount.

This function performs a combination of one write operation and one read operation on groups of holding registers in a single Modbus transaction. The write operation is always performed before the read. The range of addresses to read must be contiguous, and the range of addresses to write must be contiguous, but write and read addresses are specified independently and need not overlap.

moddata = writeRead(m,writeAddress,values,writePrecision,readAddress,readCount,readPrecision) adds optional precisions for the write and read operations. The writePrecision and readPrecision arguments specify the data format of the register being written to and read from on the Modbus server.

moddata = writeRead(___,serverId) additionally uses the serverId as the address of the server to send the command to.

Examples

Write and Read Holding Registers

The writeRead function is used to perform a combination of one write operation and one read operation on groups of holding registers in a single Modbus transaction. The write operation is always performed before the read. The range of addresses to read must be contiguous, and the range of addresses to write must be contiguous, but each is specified independently and may or may not overlap.

Write 2 holding registers starting at address 300, and read 4 holding registers starting at address 17250.

moddata = writeRead(m,300,[500 1000],17250,4)

moddata = 

   35647   48923   50873   60892

If the operation is successful, it returns an array of doubles, each representing a 16-bit register value, where the first value in the vector corresponds to the register value at the address specified in readAddress.

You can optionally create variables for the values to be written, instead of including the array of values in the function syntax. The example could be written this way, using a variable for the values:

values = [500 1000];
moddata = writeRead(m,300,values,17250,4)

moddata =  

   35647   58923   50873   60892

Write and Read Holding Registers, and Specify Server ID

Use the serverId argument to specify the address of the server to send the command to.

Write 3 holding registers starting at address 400, and read 4 holding registers starting at address 52008 from server ID 6.

moddata = writeRead(m,400,[1024 512 680],52008,4,6)

moddata =  

   38629   24735   29456   39470

Write and Read Holding Registers, and Specify Precisions

Use the writePrecision and readPrecision arguments to specify the data format of the register being read from or written to on the Modbus server.

Write 3 holding registers starting at address 500, and read 6 holding registers starting at address 52008 from server ID 6. Specify a writePrecision of 'uint64' and a readPrecision of 'uint32'.

moddata = writeRead(m,500,[1024 512 680],'uint64',52008,6,'uint32',6)

moddata =  

   38629   24735   29456   39470   33434   29484

Input Arguments

writeAddress — Starting address of the registers to write

double

Starting address to write to, specified as a double. writeAddress must be the first argument after the object name. This example writes 2 holding registers starting at address 501 and reads 4 holding registers starting at address 11250. The writeAddress is 501.

Example: writeRead(m,501,[1024 512],11250,4)

Data Types: double

values — Array of values to write

double | array of doubles

Array of values to write, specified as a double or array of doubles. Values must be the second argument after the object name. Each value must be in the range 0–65535. This example writes 2 holding registers starting at address 501 and reads 4 holding registers starting at address 11250. The values are [1024 512].

Example: writeRead(m,501,[1024 512],11250,4)

Data Types: double

readAddress — Starting address of the holding registers to read

double

Starting address of the holding registers to read, specified as a double. readAddress must be the third argument after the object name. This example writes 2 holding registers starting at address 501 and reads 4 holding registers starting at address 11250. The readAddress is 11250.

Example: writeRead(m,501,[1024 512],11250,4)

Data Types: double

readCount — Number of holding registers to read

double

Number of holding registers to read, specified as a double. readCount must be the fourth argument after the object name. This example writes 2 holding registers starting at address 501 and reads 4 holding registers starting at address 11250. The readCount is 4.

Example: writeRead(m,501,[1024 512],11250,4)

Data Types: double

serverId — Address of the server to send the command to

double

Address of the server to send the command to, specified as a double. Server ID must be specified after the object name, write address, values, read address, and read count. If you do not specify a serverId, the default of 1 is used. Valid values are 0–255, with 0 being the broadcast address. This example writes 3 holding registers starting at address 400 and reads 4 holding registers starting at address 52008 from server ID 6.

Example: writeRead(m,400,[1024 512 680],52008,4,6)

Data Types: double

writePrecision — Data format of the holding register being written to on the Modbus server

character vector | string

Data format of the holding register being written to on the Modbus server, specified as a character vector or string. writePrecision must be specified after the write address and values. Valid values are 'uint16', 'int16', 'uint32', 'int32', 'uint64', 'int64', 'single', and 'double'. This argument is optional, and the default is 'uint16'.

Note that writePrecision does not refer to the return type, which is always 'double'. It specifies how to interpret the register data.

This example writes 3 holding registers starting at address 400 and reads 4 holding registers starting at address 52008 from server ID 6. It also specifies a writePrecision of 'uint64'.

Example: writeRead(m,400,[1024 512 680],'uint64',52008,4,'uint32',6)

Data Types: char

readPrecision — Data format of the holding register being read from on the Modbus server

character vector | string

Data format of the holding register being read from on the Modbus server, specified as a character vector or string. readPrecision must be specified after the read address, and read count. Valid values are 'uint16', 'int16', 'uint32', 'int32', 'uint64', 'int64', 'single', and 'double'. This argument is optional, and the default is 'uint16'.

Note that readPrecision does not refer to the return type, which is always 'double'. It specifies how to interpret the register data.

This example writes 3 holding registers starting at address 400 and reads 4 holding registers starting at address 52008 from server ID 6. It also specifies a readPrecision of 'uint32'.

Example: writeRead(m,400,[1024 512 680],'uint64',52008,4,'uint32',6)

Data Types: char

Output Arguments

moddata — Value of read data

double

Read data values, returned as a double or array of doubles.

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

Version History

Introduced in R2017a

R2022a: Moved to Industrial Communication Toolbox from Instrument Control Toolbox

Before R2022a, the Modbus functionality, including this function, was part of the Instrument Control Toolbox™ product.