MODBUS interface description

General description

Top

Introduction

This document describes the protocol used by the MODBUS server of the module.
The OPEN MODBUS protocol is based on the widely known MODBUS protocol.
OPEN MODBUS is an open protocol and is not manufacturer dependent.
It is mainly used to connect PLC and I/O devices.

Why a MODBUS Server on the MSX-E modules?

Thanks to the MODBUS server, it is possible to manage an MSX-E module with e.g.: a Siemens S7 PLC.
The S7 PLC can start acquisitions and read data from the MSX-E module!

Technical details

Please note that only MODBUS over TCP is standardized. Nonetheless in this present
version the server implements OPEN MODBUS/TCP class 0 and one function of the class 2 even on UDP sockets.

The MODBUS/TCP class 0 defines two types of query: FC3 and FC16.

The MODBUS/TCP server implement the following query of the class 2 : FC23.
The MODBUS server offer a virtual memory organisation: registers (functions)
are mapped to be equivalent to SOAP functions.

Characteristics of this communication channel as the standardisation document describes it are:

The ADDI-DATA MSX-E Modbus server offers the following extension to the standard:

As answer to query a client may receive an acknowledgement (named standard response onward) or an exception.
If an exception or an error occured, you can use the GetLastCommandStatus command to get the real error number (from the remote server).
Real error numbers are described for each command in the "Returns" field.

The chapter below describes the available functions and their parameters.
It also contains the precise description of all frames implied in a given action.

FC3 (read multiple register) Functions

Top

Functions in this group are used to read values on the module.

    Register: 0
    Register: 10000
    Register: 1
    Register: 10200
    Register: 2
    Register: 10500
    Register: 3
    Register: 10550
    Register: 100
    Register: 1000
    Register: 101
    Register: 1050
    Register: 102
    Register: 1594
    Register: 103
    Register: 1598
    Register: 104
    Register: 1602

Function GetLastCommandStatus

For new application(s) or automate communication it is recommended to use the function GetLastCommandStatusEx.

Description

Return the result of the last remote function call

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer00x00000x0000
word count216-bit integer540x36000x0036

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer1120x70000x0070
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer1080x6C000x006C
ReturnValue432-bit integerSee the description above0x????????0x????????
Syserrno432-bit integerSee the description above0x????????0x????????
Errstr1008-bit integer arraySee the description above0x??[100]0x??[100]

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function GetLastCommandStatusEx

Description

Return the result of the last remote function call

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer100000x10270x2710
word count216-bit integer540x36000x0036

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer1110x6F000x006F
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer1080x6C0x6C
ReturnValue432-bit integerSee the description above0x????????0x????????
Syserrno432-bit integerSee the description above0x????????0x????????
Errstr1008-bit integer arraySee the description above0x??[100]0x??[100]

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MXCommon__GetModuleType

For new application(s) or automate communication it is recommended to use the function MXCommon__GetModuleTypeEx.

Description

Returns the type of the MSX-E Module

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer10x01000x0001
word count216-bit integer1000x64000x0064

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer2040xCC000x00CC
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer2000xC8000x00C8
str2008-bit integer arraySee the description above0x??[200]0x??[200]

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MXCommon__GetModuleTypeEx

Description

Returns the type of the MSX-E Module

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer102000xD8270x27D8
word count216-bit integer1000x64000x0064

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer2030xCB000x00CB
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer2000xC80xC8
str2008-bit integer arraySee the description above0x??[200]0x??[200]

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MXCommon__GetTime

For new application(s) or automate communication it is recommended to use the function MXCommon__GetTimeEx.

Description

Get the time on the module

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer20x02000x0002
word count216-bit integer40x04000x0004

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer120x0C000x000C
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer80x08000x0008
tv_sec432-bit integerSee the description above0x????????0x????????
tv_usec432-bit integerSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MXCommon__GetTimeEx

Description

Get the time on the module

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer105000x04290x2904
word count216-bit integer40x04000x0004

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer110x0B000x000B
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer80x080x08
tv_sec432-bit integerSee the description above0x????????0x????????
tv_usec432-bit integerSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MXCommon__TestCustomerID

For new application(s) or automate communication it is recommended to use the function MXCommon__TestCustomerIDEx.

Description

Permit to test the Customer ID (if the module has the right customer Key )

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer30x03000x0003
word count216-bit integer160x10000x0010

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer360x24000x0024
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer320x20000x0020
bValueArray168-bit integer arraySee the description above0x??[16]0x??[16]
bCryptedValueArray168-bit integer arraySee the description above0x??[16]0x??[16]

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MXCommon__TestCustomerIDEx

Description

Permit to test the Customer ID (if the module has the right customer Key )

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer105500x36290x2936
word count216-bit integer160x10000x0010

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer350x23000x0023
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer320x200x20
bValueArray168-bit integer arraySee the description above0x??[16]0x??[16]
bCryptedValueArray168-bit integer arraySee the description above0x??[16]0x??[16]

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__getNumberOfChannels

For new application(s) or automate communication it is recommended to use the function MX370x__getNumberOfChannelsEx.

Description

Return the number of transducer channels on the module (4,8 or 16)

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer1000x64000x0064
word count216-bit integer20x02000x0002

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer80x08000x0008
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer40x04000x0004
ChannelNumber432-bit integerSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__getNumberOfChannelsEx

Description

Return the number of transducer channels on the module (4,8 or 16)

Parameters:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer10000xE8030x03E8
word count216-bit integer20x02000x0002

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer70x07000x0007
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer40x040x04
ChannelNumber432-bit integerSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__TransducerGetAutoRefreshValues

For new application(s) or automate communication it is recommended to use the function MX370x__TransducerGetAutoRefreshValuesEx.

Description

This function get the auto refresh counter value an the channels values

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer1010x65000x0065
word count216-bit integer340x22000x0022

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer720x48000x0048
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer680x44000x0044
Value6832-bit integer arraySee the description above0x????????[17]0x????????[17]

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__TransducerGetAutoRefreshValuesEx

Description

This function get the auto refresh counter value an the channels values

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer10500x1A040x041A
word count216-bit integer340x22000x0022

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer710x47000x0047
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer680x440x44
Value6832-bit integer arraySee the description above0x????????[17]0x????????[17]

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__TransducerGetNbrOfType

For new application(s) or automate communication it is recommended to use the function MX370x__TransducerGetNbrOfTypeEx.

Description

Returns the number of transducer types currently defined in the database.

Parameters:

[Query frame layout] NumberOfTransducerTypes: number of transducer types currently defined.

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer1020x66000x0066
word count216-bit integer20x02000x0002

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer80x08000x0008
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer40x04000x0004
NumberOfTransducerTypes432-bit integerSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__TransducerGetNbrOfTypeEx

Description

Returns the number of transducer types currently defined in the database.

Parameters:

[Query frame layout] NumberOfTransducerTypes: number of transducer types currently defined.

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer15940x3A060x063A
word count216-bit integer20x02000x0002

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer70x07000x0007
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer40x040x04
NumberOfTransducerTypes432-bit integerSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__GetTransducerDatabaseCursor

For new application(s) or automate communication it is recommended to use the function MX370x__GetTransducerDatabaseCursorEx.

Description

Returns the current cursor of the transducer database.

Parameters:

[Query frame layout] TransducerDatabaseCursor: Current cursor. This is an integer from 0 .. (NumberOfTransducerTypes-1)

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer1030x67000x0067
word count216-bit integer20x02000x0002

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer80x08000x0008
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer40x04000x0004
TransducerDatabaseCursor432-bit integerSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__GetTransducerDatabaseCursorEx

Description

Returns the current cursor of the transducer database.

Parameters:

[Query frame layout] TransducerDatabaseCursor: Current cursor. This is an integer from 0 .. (NumberOfTransducerTypes-1)

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer15980x3E060x063E
word count216-bit integer20x02000x0002

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer70x07000x0007
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer40x040x04
TransducerDatabaseCursor432-bit integerSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__TransducerGetTypeInformation

For new application(s) or automate communication it is recommended to use the function MX370x__TransducerGetTypeInformationEx.

Description

Returns the information stored in the database about the type selected by the current TransducerDatabaseCursor.

Parameters:

SelectionIndex : Identifier. Value to use for the transducer type selection in the other SOAP functions.
Name : Name of the transducer type
CalibrationStatus : Calibration status \li 0 : Transducer type is not calibrated
\li 1 : Transducer type is calibrated
Type : Type (0: HB 1: LVDT 2:Knaebel 3:HB-Mahr 4:LVDT-Mahr) Frequency : Frequency (Hz)
Impedance : Impedance (Ohm)
Veff : Nominal voltage (Vrms)
Sensibility : Sensibility (mv/V/mm)
Range : Range (mm)

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer1040x68000x0068
word count216-bit integer650x41000x0041

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer1330x85000x0085
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer1290x81000x0081
SelectionIndex432-bit integerSee the description above0x????????0x????????
Name1008-bit integer arraySee the description above0x??[100]0x??[100]
CalibrationStatus18-bit integerSee the description above0x??0x??
Type432-bit integerSee the description above0x????????0x????????
Frequency432-bit integerSee the description above0x????????0x????????
Impedance432-bit integerSee the description above0x????????0x????????
NominalVoltage432-bit floating pointSee the description above0x????????0x????????
Sensibility432-bit floating pointSee the description above0x????????0x????????
Range432-bit floating pointSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

Function MX370x__TransducerGetTypeInformationEx

Description

Returns the information stored in the database about the type selected by the current TransducerDatabaseCursor.

Parameters:

SelectionIndex : Identifier. Value to use for the transducer type selection in the other SOAP functions.
Name : Name of the transducer type
CalibrationStatus : Calibration status \li 0 : Transducer type is not calibrated
\li 1 : Transducer type is calibrated
Type : Type (0: HB 1: LVDT 2:Knaebel 3:HB-Mahr 4:LVDT-Mahr) Frequency : Frequency (Hz)
Impedance : Impedance (Ohm)
Veff : Nominal voltage (Vrms)
Sensibility : Sensibility (mv/V/mm)
Range : Range (mm)

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Reference number (=register)216-bit integer16020x42060x0642
word count216-bit integer650x41000x0041

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer1320x84000x0084
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer1290x810x81
SelectionIndex432-bit integerSee the description above0x????????0x????????
Name1008-bit integer arraySee the description above0x??[100]0x??[100]
CalibrationStatus18-bit integerSee the description above0x??0x??
Type432-bit integerSee the description above0x????????0x????????
Frequency432-bit integerSee the description above0x????????0x????????
Impedance432-bit integerSee the description above0x????????0x????????
NominalVoltage432-bit floating pointSee the description above0x????????0x????????
Sensibility432-bit floating pointSee the description above0x????????0x????????
Range432-bit floating pointSee the description above0x????????0x????????

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x830x830x83
Exception code18-bit integerSee corresponding chapter????

FC16 (write multiple register) Functions

Top

Functions in this group are used to set value on the module.

    Register: 100
    Register: 11000
    Register: 101
    Register: 11050
    Register: 102
    Register: 11100
    Register: 103
    Register: 11150
    Register: 104
    Register: 11200
    Register: 105
    Register: 11250
    Register: 1
    Register: 1200
    Register: 2
    Register: 1250
    Register: 3
    Register: 1300
    Register: 4
    Register: 1350
    Register: 5
    Register: 1354
    Register: 6
    Register: 1356

Function MXCommon__SetHardwareTriggerFilterTime

For new application(s) or automate communication it is recommended to use the function MXCommon__SetHardwareTriggerFilterTimeEx.

Description

Sets the filter time for the hardware trigger input in 250ns step (max value : 65535 ).

On the MSX-E3011 system, the step of the hardware trigger filter is 622ns.

Parameters

Returns

Possible return value on the remote system (read them with GetLastCommandStatus).

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer160x10000x0010
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1000x64000x0064
word count216-bit integer40x04000x0004
byte count216-bit integer80x08000x0008
ulFilterTime432-bit integerSee the description above0x????????0x????????
Reserved432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1000x64000x0064
word count216-bit integer40x04000x0004

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__SetHardwareTriggerFilterTimeEx

Description

Sets the filter time for the hardware trigger input in 250ns step (max value : 65535 ).

On the MSX-E3011 system, the step of the hardware trigger filter is 622ns.

Parameters

Returns

Possible return value on the remote system (read them with GetLastCommandStatusEx).

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer150x0F000x000F
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer110000xF82A0x2AF8
word count216-bit integer40x04000x0004
byte count18-bit integer80x080x08
ulFilterTime432-bit integerSee the description above0x????????0x????????
Reserved432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer110000xF82A0x2AF8
word count216-bit integer40x04000x0004

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__InitAndStartSynchroTimer

For new application(s) or automate communication it is recommended to use the function MXCommon__InitAndStartSynchroTimerEx.

Description

Init and start the synchronisation timer of the module (not already available on all module)

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer400x28000x0028
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1010x65000x0065
word count216-bit integer160x10000x0010
byte count216-bit integer320x20000x0020
ulTimeBase432-bit integerSee the description above0x????????0x????????
ulReloadValue432-bit integerSee the description above0x????????0x????????
ulNbrOfCycle432-bit integerSee the description above0x????????0x????????
ulGenerateTriggerMode432-bit integerSee the description above0x????????0x????????
ulOption01432-bit integerSee the description above0x????????0x????????
ulOption02432-bit integerSee the description above0x????????0x????????
ulOption03432-bit integerSee the description above0x????????0x????????
ulOption04432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1010x65000x0065
word count216-bit integer160x10000x0010

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__InitAndStartSynchroTimerEx

Description

Init and start the synchronisation timer of the module (not already available on all module)

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer390x27000x0027
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer110500x2A2B0x2B2A
word count216-bit integer160x10000x0010
byte count18-bit integer320x200x20
ulTimeBase432-bit integerSee the description above0x????????0x????????
ulReloadValue432-bit integerSee the description above0x????????0x????????
ulNbrOfCycle432-bit integerSee the description above0x????????0x????????
ulGenerateTriggerMode432-bit integerSee the description above0x????????0x????????
ulOption01432-bit integerSee the description above0x????????0x????????
ulOption02432-bit integerSee the description above0x????????0x????????
ulOption03432-bit integerSee the description above0x????????0x????????
ulOption04432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer110500x2A2B0x2B2A
word count216-bit integer160x10000x0010

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__StopAndReleaseSynchroTimer

For new application(s) or automate communication it is recommended to use the function MXCommon__StopAndReleaseSynchroTimerEx.

Description

stop the synchronisation timer (not already available on all module)

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer120x0C000x000C
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1020x66000x0066
word count216-bit integer20x02000x0002
byte count216-bit integer40x04000x0004
ulOption01432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1020x66000x0066
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__StopAndReleaseSynchroTimerEx

Description

stop the synchronisation timer (not already available on all module)

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer110x0B000x000B
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer111000x5C2B0x2B5C
word count216-bit integer20x02000x0002
byte count18-bit integer40x040x04
ulOption01432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer111000x5C2B0x2B5C
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__Reboot

For new application(s) or automate communication it is recommended to use the function MXCommon__RebootEx.

Description

Ask the MSX-E module to reboot

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer120x0C000x000C
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1030x67000x0067
word count216-bit integer20x02000x0002
byte count216-bit integer40x04000x0004
Dummy432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1030x67000x0067
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__RebootEx

Description

Ask the MSX-E module to reboot

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer110x0B000x000B
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer111500x8E2B0x2B8E
word count216-bit integer20x02000x0002
byte count18-bit integer40x040x04
Dummy432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer111500x8E2B0x2B8E
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__SetCustomerKey

For new application(s) or automate communication it is recommended to use the function MXCommon__SetCustomerKeyEx.

Description

Permit to set the Customer key

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer560x38000x0038
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1040x68000x0068
word count216-bit integer240x18000x0018
byte count216-bit integer480x30000x0030
bKey328-bit integer arraySee the description above0x??[32]0x??[32]
bPublicKey168-bit integer arraySee the description above0x??[16]0x??[16]

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1040x68000x0068
word count216-bit integer240x18000x0018

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__SetCustomerKeyEx

Description

Permit to set the Customer key

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer550x37000x0037
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer112000xC02B0x2BC0
word count216-bit integer240x18000x0018
byte count18-bit integer480x300x30
bKey328-bit integer arraySee the description above0x??[32]0x??[32]
bPublicKey168-bit integer arraySee the description above0x??[16]0x??[16]

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer112000xC02B0x2BC0
word count216-bit integer240x18000x0018

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__SetFilterChannels

For new application(s) or automate communication it is recommended to use the function MXCommon__SetFilterChannelsEx.

Description

Permit to set a filter per channel

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer240x18000x0018
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1050x69000x0069
word count216-bit integer80x08000x0008
byte count216-bit integer160x10000x0010
ChannelList168-bit integer arraySee the description above0x??[16]0x??[16]

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer1050x69000x0069
word count216-bit integer80x08000x0008

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MXCommon__SetFilterChannelsEx

Description

Permit to set a filter per channel

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer230x17000x0017
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer112500xF22B0x2BF2
word count216-bit integer80x08000x0008
byte count18-bit integer160x100x10
ChannelList168-bit integer arraySee the description above0x??[16]0x??[16]

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer112500xF22B0x2BF2
word count216-bit integer80x08000x0008

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerInitAndStartAutoRefresh

For new application(s) or automate communication it is recommended to use the function MX370x__TransducerInitAndStartAutoRefreshEx.

Description

Initialise and start the transducer auto refresh acquisition mode

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer560x38000x0038
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer10x01000x0001
word count216-bit integer240x18000x0018
byte count216-bit integer480x30000x0030
TransducerSelection432-bit integerSee the description above0x????????0x????????
ChannelMask432-bit integerSee the description above0x????????0x????????
AverageMode432-bit integerSee the description above0x????????0x????????
AverageValue432-bit integerSee the description above0x????????0x????????
DivisionFactor432-bit integerSee the description above0x????????0x????????
TriggerAction432-bit integerSee the description above0x????????0x????????
HardwareTriggerCount216-bit integerSee the description above0x????0x????
HardwareTriggerFilterTime216-bit integerSee the description above0x????0x????
ByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
Option1432-bit integerSee the description above0x????????0x????????
Option2432-bit integerSee the description above0x????????0x????????
Option3432-bit integerSee the description above0x????????0x????????
Option4432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer10x01000x0001
word count216-bit integer240x18000x0018

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerInitAndStartAutoRefreshEx

Description

Initialise and start the transducer auto refresh acquisition mode

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer550x37000x0037
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer12000xB0040x04B0
word count216-bit integer240x18000x0018
byte count18-bit integer480x300x30
TransducerSelection432-bit integerSee the description above0x????????0x????????
ChannelMask432-bit integerSee the description above0x????????0x????????
AverageMode432-bit integerSee the description above0x????????0x????????
AverageValue432-bit integerSee the description above0x????????0x????????
DivisionFactor432-bit integerSee the description above0x????????0x????????
TriggerAction432-bit integerSee the description above0x????????0x????????
HardwareTriggerCount216-bit integerSee the description above0x????0x????
HardwareTriggerFilterTime216-bit integerSee the description above0x????0x????
ByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
Option1432-bit integerSee the description above0x????????0x????????
Option2432-bit integerSee the description above0x????????0x????????
Option3432-bit integerSee the description above0x????????0x????????
Option4432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer12000xB0040x04B0
word count216-bit integer240x18000x0018

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerStopAndReleaseAutoRefresh

For new application(s) or automate communication it is recommended to use the function MX370x__TransducerStopAndReleaseAutoRefreshEx.

Description

Stop and release the transducer auto refresh acquisition mode

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer120x0C000x000C
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer20x02000x0002
word count216-bit integer20x02000x0002
byte count216-bit integer40x04000x0004
Dummy432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer20x02000x0002
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerStopAndReleaseAutoRefreshEx

Description

Stop and release the transducer auto refresh acquisition mode

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer110x0B000x000B
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer12500xE2040x04E2
word count216-bit integer20x02000x0002
byte count18-bit integer40x040x04
Dummy432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer12500xE2040x04E2
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerInitAndStartSequence

For new application(s) or automate communication it is recommended to use the function MX370x__TransducerInitAndStartSequenceEx.

Description

Initialise and start the transducer sequence acquisition mode

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer1360x88000x0088
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer30x03000x0003
word count216-bit integer640x40000x0040
byte count216-bit integer1280x80000x0080
TransducerSelection432-bit integerSee the description above0x????????0x????????
NbrOfChannel432-bit integerSee the description above0x????????0x????????
ChannelList6432-bit integer arraySee the description above0x????????[16]0x????????[16]
DivisionFactor432-bit integerSee the description above0x????????0x????????
NbrOfSequence432-bit integerSee the description above0x????????0x????????
NbrMaxSequenceToTransfer432-bit integerSee the description above0x????????0x????????
DelayMode432-bit integerSee the description above0x????????0x????????
DelayTimeUnit432-bit integerSee the description above0x????????0x????????
DelayValue432-bit integerSee the description above0x????????0x????????
TriggerAction432-bit integerSee the description above0x????????0x????????
HardwareTriggerCount432-bit integerSee the description above0x????????0x????????
HardwareTriggerFilterTime432-bit integerSee the description above0x????????0x????????
ByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
Option1432-bit integerSee the description above0x????????0x????????
Option2432-bit integerSee the description above0x????????0x????????
Option3432-bit integerSee the description above0x????????0x????????
Option4432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer30x03000x0003
word count216-bit integer640x40000x0040

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerInitAndStartSequenceEx

Description

Initialise and start the transducer sequence acquisition mode

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer1350x87000x0087
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer13000x14050x0514
word count216-bit integer640x40000x0040
byte count18-bit integer1280x800x80
TransducerSelection432-bit integerSee the description above0x????????0x????????
NbrOfChannel432-bit integerSee the description above0x????????0x????????
ChannelList6432-bit integer arraySee the description above0x????????[16]0x????????[16]
DivisionFactor432-bit integerSee the description above0x????????0x????????
NbrOfSequence432-bit integerSee the description above0x????????0x????????
NbrMaxSequenceToTransfer432-bit integerSee the description above0x????????0x????????
DelayMode432-bit integerSee the description above0x????????0x????????
DelayTimeUnit432-bit integerSee the description above0x????????0x????????
DelayValue432-bit integerSee the description above0x????????0x????????
TriggerAction432-bit integerSee the description above0x????????0x????????
HardwareTriggerCount432-bit integerSee the description above0x????????0x????????
HardwareTriggerFilterTime432-bit integerSee the description above0x????????0x????????
ByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
Option1432-bit integerSee the description above0x????????0x????????
Option2432-bit integerSee the description above0x????????0x????????
Option3432-bit integerSee the description above0x????????0x????????
Option4432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer13000x14050x0514
word count216-bit integer640x40000x0040

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerStopAndReleaseSequence

For new application(s) or automate communication it is recommended to use the function MX370x__TransducerStopAndReleaseSequenceEx.

Description

Stop and release the transducer sequence acquisition mode

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer120x0C000x000C
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer40x04000x0004
word count216-bit integer20x02000x0002
byte count216-bit integer40x04000x0004
Dummy432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer40x04000x0004
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerStopAndReleaseSequenceEx

Description

Stop and release the transducer sequence acquisition mode

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer110x0B000x000B
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer13500x46050x0546
word count216-bit integer20x02000x0002
byte count18-bit integer40x040x04
Dummy432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer13500x46050x0546
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__SetTransducerDatabaseCursor

For new application(s) or automate communication it is recommended to use the function MX370x__SetTransducerDatabaseCursorEx.

Description

Change the active transducer database cursor

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer120x0C000x000C
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer50x05000x0005
word count216-bit integer20x02000x0002
byte count216-bit integer40x04000x0004
TransducerDatabaseCursor432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer50x05000x0005
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__SetTransducerDatabaseCursorEx

Description

Change the active transducer database cursor

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer110x0B000x000B
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer13540x4A050x054A
word count216-bit integer20x02000x0002
byte count18-bit integer40x040x04
TransducerDatabaseCursor432-bit integerSee the description above0x????????0x????????

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer13540x4A050x054A
word count216-bit integer20x02000x0002

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerSetOffset

For new application(s) or automate communication it is recommended to use the function MX370x__TransducerSetOffsetEx.

Description

Set the offset for each transducer.

Set / Reset an offset on transducer channels.

Example: To set a reference point to a transducer in a particular position:

For more information see SetOffset sample.

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer720x48000x0048
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer60x06000x0006
word count216-bit integer320x20000x0020
byte count216-bit integer640x40000x0040
fOffsetArrayPointer6432-bit floating point arraySee the description above0x????????[16]0x????????[16]

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer60x06000x0006
word count216-bit integer320x20000x0020

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

Function MX370x__TransducerSetOffsetEx

Description

Set the offset for each transducer.

Set / Reset an offset on transducer channels.

Example: To set a reference point to a transducer in a particular position:

For more information see SetOffset sample.

Parameters:

Returns:

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer710x47000x0047
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer13560x4C050x054C
word count216-bit integer320x20000x0020
byte count18-bit integer640x400x40
fOffsetArrayPointer6432-bit floating point arraySee the description above0x????????[16]0x????????[16]

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer60x06000x0006
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer13560x4C050x054C
word count216-bit integer320x20000x0020

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Intel)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x900x900x90
Exception code18-bit integerSee corresponding chapter0x??0x??

FC23 (read/write registers) Functions

Top

Functions in this group are used to read/write values on the module.
This functions permits to call a write (FC16) and then a read(FC3) function in one command.

Query frame layout

FieldSize (Bytes)TypeValuelittle endian (Motorola)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integerDepends to the FC16 function called??
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x170x170x17
Reference number for read (=register)216-bit integerFC3 reference??
Word count for read216-bit integerSee the corresponding FC3 function??
Reference number for write (=register)216-bit integerFC16 reference??
Word count for write216-bit integerSee the corresponding FC16 function??
Byte count18-bit integer(= 2xWord count for write)??
Register values??See the corresponding FC16 function??

Response frame layout

FieldSize (Bytes)TypeValuelittle endian (Motorola)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integerDepends to the FC3 function called??
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x170x170x17
Byte count18-bit integer(= 2x word count for read)??
Register values??See the corresponding FC3 function??

Exception frame layout

FieldSize (Bytes)TypeValuelittle endian (Motorola)big endian (Motorola)
transaction identifier216-bit integerUser defined - copied by server - usually 00x00000x0000
protocol identifier216-bit integer00x00000x0000
length216-bit integer30x03000x0003
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x970x970x97
Exception code18-bit integerSee corresponding chapter????

Exception code description

Top
NameValueDescription
MODBUS_ILLEGAL_FUNCTION 0x1 function code is not allowable action for the slave
MODBUS_ILLEGAL_DATA_ADDRESS 0x2 data address received in query is not allowable
MODBUS_ILLEGAL_DATA_VALUE 0x3 incorrect value int the query data field or the length is incorrect
MODBUS_ILLEGAL_DATA_RESPONSE_LENGTH 0x4 the request as framed would generate a response whose size exceeds the available MODBUS datasize.
MODBUS_ACKNOWLEDGE 0x5 specialized use in conjunction with programming commands
MODBUS_DSLAVE_DEVICE_BUSY 0x6 specialized use in conjunction with programming commands
MODBUS_NEGATIVE_ACKNOWLEDGE 0x07 specialized use in conjunction with programming commands
MODBUS_MEMORY_PARITY_ERROR 0x08 the extended file area failed to pass a consistency check
MODBUS_REMOTE_EXECUTION_ERROR 0x09 the remote function performed incorrectly (use function GetLastCommandStatus to know why)
MODBUS_GATEWAY_PATH_UNAVAILABLE 0x0A used with modbus plus gateway
MODBUS_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND 0x0B used with modbus plus gateway

Siemens Step 7 compatibility information (AWL/SDF code)

Top

Due to limitations of the S7 platform, some names of function and parameter have been shortened in the AWL and S7 code. This table summarizes the changes against the standard version as described above.

Function/ParameterRenamed as
MXCommon__GetModuleTypeGetModuleType
MXCommon__GetTimeGetTime
MXCommon__TestCustomerIDTestCustomerID
MX370x__getNumberOfChannels370x_GetNbrOfChannels
MX370x__TransducerGetAutoRefreshValues370x_GetAutoRefVal
MX370x__TransducerGetNbrOfType370x_GetNbrOfType
MX370x__GetTransducerDatabaseCursor370x_GetDataBaseCursor
    TransducerDatabaseCursor    TransducerDBCursor
MX370x__TransducerGetTypeInformation370x_GetTypeInfo
    Type    TransducerType
MXCommon__SetHardwareTriggerFilterTimeSetHwTrigFiltTime
MXCommon__InitAndStartSynchroTimerInitStartSyncTimer
MXCommon__StopAndReleaseSynchroTimerStopRelSyncTimer
MXCommon__RebootReboot
MXCommon__SetCustomerKeySetCustomerKey
MXCommon__SetFilterChannelsSetFilterChannels
MX370x__TransducerInitAndStartAutoRefresh370x_InitStartAutoRef
    HardwareTriggerCount    HwTrigCount
    HardwareTriggerFilterTime    HwTrigFilterTime
    ByTriggerNbrOfSeqToAcquire    ByTrigNbrOfSeqToAcq
MX370x__TransducerStopAndReleaseAutoRefresh370x_StopRelAutoRef
MX370x__TransducerInitAndStartSequence370x_InitStartSeq
    HardwareTriggerCount    HwTrigCount
    NbrMaxSequenceToTransfer    NbrMaxSeqToTransfer
    HardwareTriggerFilterTime    HwTrigFilterTime
    ByTriggerNbrOfSeqToAcquire    ByTrigNbrOfSeqToAcq
MX370x__TransducerStopAndReleaseSequence370x_StopRelSeq
MX370x__SetTransducerDatabaseCursor370x_SetDataBaseCursor
    TransducerDatabaseCursor    TransducerDBCursor
MX370x__TransducerSetOffset370xTrsducerSetOff
    fOffsetArrayPointer    TransducerSetOffset