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

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 MSXE301x__AnalogInputGetAutoRefreshValues

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

Description

Returns the values acquired in auto refresh 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 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 integer380x26000x0026

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 integer800x50000x0050
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count216-bit integer760x4C000x004C
ulTimeStampLow432-bit integerSee the description above0x????????0x????????
ulTimeStampHigh432-bit integerSee the description above0x????????0x????????
ulCounterValue432-bit integerSee the description above0x????????0x????????
ulValue6432-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 MSXE301x__AnalogInputGetAutoRefreshValuesEx

Description

Returns the values acquired in auto refresh 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 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 integer380x26000x0026

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 integer790x4F000x004F
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x030x030x03
Byte count18-bit integer760x4C0x4C
ulTimeStampLow432-bit integerSee the description above0x????????0x????????
ulTimeStampHigh432-bit integerSee the description above0x????????0x????????
ulCounterValue432-bit integerSee the description above0x????????0x????????
ulValue6432-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 MSXE301x__AnalogInputGetChannelType

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

Description

Return the type of the analog input channels

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
ulOption01432-bit integerSee the description above0x????????0x????????
ulType6432-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 MSXE301x__AnalogInputGetChannelTypeEx

Description

Return the type of the analog input channels

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
ulOption01432-bit integerSee the description above0x????????0x????????
ulType6432-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????

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: 1100
    Register: 2
    Register: 1150
    Register: 3
    Register: 1200
    Register: 4
    Register: 1250
    Register: 5
    Register: 1254

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 MSXE301x__AnalogInputInitAndStartAutoRefresh

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

Description

Starts an autorefresh acquisition using provided configuration.

In the auto refresh mode the measurement value is updated automatically after each acquisition. The analog acquisition is initialised and the values of each channels are stored in memory on the Ethernet E/A module MSX-E301x.

The client reads the data asynchronously to the acquisition via the data socket or a SOAP/MODBUS function.
You can define a mask of all channels that should be acquired.

In the auto refresh mode you can activate the channel average value computation on the module:

You can start the acquisition by a hardware trigger or a synchro trigger.

The hardware trigger can react to a rising wave, falling wave or both edges.

You have the following possibility:

There are two trigger modes:(for the hardware or synchro trigger)

One shot:
After the software start, the module is waiting for a trigger signal to start the
acquisition. After this the trigger signal is ignored.
Sequence:
After the software start the module is waiting for the trigger signal and acquires x
sequences (also adjustable) and then wait again.

Parameters:

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 integer1920xC0000x00C0
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer10x01000x0001
word count216-bit integer920x5C000x005C
byte count216-bit integer1840xB8000x00B8
ulChannelMask432-bit integerSee the description above0x????????0x????????
pulGainArray6432-bit integer arraySee the description above0x????????[16]0x????????[16]
pulPolarityArray6432-bit integer arraySee the description above0x????????[16]0x????????[16]
ulAverageMode432-bit integerSee the description above0x????????0x????????
ulAverageValue432-bit integerSee the description above0x????????0x????????
ulConversionTime432-bit integerSee the description above0x????????0x????????
ulConversionTimeUnit432-bit integerSee the description above0x????????0x????????
ulTriggerMask432-bit integerSee the description above0x????????0x????????
ulTriggerMode432-bit integerSee the description above0x????????0x????????
ulHardwareTriggerEdge432-bit integerSee the description above0x????????0x????????
ulHardwareTriggerCount432-bit integerSee the description above0x????????0x????????
ulByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
ulDataFormat432-bit integerSee the description above0x????????0x????????
ulOption1432-bit integerSee the description above0x????????0x????????
ulOption2432-bit integerSee the description above0x????????0x????????
ulOption3432-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 integer920x5C000x005C

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 MSXE301x__AnalogInputInitAndStartAutoRefreshEx

Description

Starts an autorefresh acquisition using provided configuration.

In the auto refresh mode the measurement value is updated automatically after each acquisition. The analog acquisition is initialised and the values of each channels are stored in memory on the Ethernet E/A module MSX-E301x.

The client reads the data asynchronously to the acquisition via the data socket or a SOAP/MODBUS function.
You can define a mask of all channels that should be acquired.

In the auto refresh mode you can activate the channel average value computation on the module:

You can start the acquisition by a hardware trigger or a synchro trigger.

The hardware trigger can react to a rising wave, falling wave or both edges.

You have the following possibility:

There are two trigger modes:(for the hardware or synchro trigger)

One shot:
After the software start, the module is waiting for a trigger signal to start the
acquisition. After this the trigger signal is ignored.
Sequence:
After the software start the module is waiting for the trigger signal and acquires x
sequences (also adjustable) and then wait again.

Parameters:

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 integer1910xBF000x00BF
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer11000x4C040x044C
word count216-bit integer920x5C000x005C
byte count18-bit integer1840xB80xB8
ulChannelMask432-bit integerSee the description above0x????????0x????????
pulGainArray6432-bit integer arraySee the description above0x????????[16]0x????????[16]
pulPolarityArray6432-bit integer arraySee the description above0x????????[16]0x????????[16]
ulAverageMode432-bit integerSee the description above0x????????0x????????
ulAverageValue432-bit integerSee the description above0x????????0x????????
ulConversionTime432-bit integerSee the description above0x????????0x????????
ulConversionTimeUnit432-bit integerSee the description above0x????????0x????????
ulTriggerMask432-bit integerSee the description above0x????????0x????????
ulTriggerMode432-bit integerSee the description above0x????????0x????????
ulHardwareTriggerEdge432-bit integerSee the description above0x????????0x????????
ulHardwareTriggerCount432-bit integerSee the description above0x????????0x????????
ulByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
ulDataFormat432-bit integerSee the description above0x????????0x????????
ulOption1432-bit integerSee the description above0x????????0x????????
ulOption2432-bit integerSee the description above0x????????0x????????
ulOption3432-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 integer11000x4C040x044C
word count216-bit integer920x5C000x005C

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 MSXE301x__AnalogInputStopAndReleaseAutoRefresh

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

Description

Stops the current autorefresh acquisition.

Must be called before any another call to MSXE301x__AnalogInputInitAndStartAutoRefresh.

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 MSXE301x__AnalogInputStopAndReleaseAutoRefreshEx

Description

Stops the current autorefresh acquisition.

Must be called before any another call to MSXE301x__AnalogInputInitAndStartAutoRefresh.

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 integer11500x7E040x047E
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 integer11500x7E040x047E
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 MSXE301x__AnalogInputInitAndStartSequence

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

Description

Initialise and start the analog input sequence acquisition mode

This function is not available for the S7. See function MSXE301x__AnalogInputInitAndStartSequenceTrimed.

A sequence is a list of channels (max 16) that are acquired. It can be any order of the channels in this list.

There are different sequence modes

Limited number of sequences
After the acquisition of the defined number of sequences, the acquisition is stopped automatically.
Continuous:
The sequences are acquired continuously until a software-stop-command occurs.
Without delay
There is no waiting time between the acquisitions of 2 sequences.
With delay
A delay between 2 sequences can be configured:
For this there are 2 delay types:

You can start the acquisition by a hardware or synchro trigger.

The hardware trigger can react to a rising, falling or both edges.

You have the following possibility:

There are two trigger modes:(for the hardware or synchro trigger)

One shot:
After the software start, the module is waiting for a trigger signal to start the
acquisition. After this the trigger signal is ignored.
Sequence:
After the software start the module is waiting for the trigger signal and acquires x
sequences (also adjustable) and then wait again.

Initialise and start the analog input 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 integer2600x04010x0104
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer30x03000x0003
word count216-bit integer1260x7E000x007E
byte count216-bit integer2520xFC000x00FC
ulNbrOfChannel432-bit integerSee the description above0x????????0x????????
pulChannelList6432-bit integer arraySee the description above0x????????[16]0x????????[16]
pulGainArray6432-bit integer arraySee the description above0x????????[16]0x????????[16]
pulPolarityArray6432-bit integer arraySee the description above0x????????[16]0x????????[16]
ulConversionTime432-bit integerSee the description above0x????????0x????????
ulConversionTimeUnit432-bit integerSee the description above0x????????0x????????
ulNbrOfSequence432-bit integerSee the description above0x????????0x????????
ulNbrMaxSequenceToTransfer432-bit integerSee the description above0x????????0x????????
ulDelayMode432-bit integerSee the description above0x????????0x????????
ulDelayTimeUnit432-bit integerSee the description above0x????????0x????????
ulDelayValue432-bit integerSee the description above0x????????0x????????
ulTriggerMask432-bit integerSee the description above0x????????0x????????
ulTriggerMode432-bit integerSee the description above0x????????0x????????
ulHardwareTriggerEdge432-bit integerSee the description above0x????????0x????????
ulHardwareTriggerCount432-bit integerSee the description above0x????????0x????????
ulByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
ulDataFormat432-bit integerSee the description above0x????????0x????????
ulOption1432-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 integer1260x7E000x007E

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 MSXE301x__AnalogInputInitAndStartSequenceEx

Description

Initialise and start the analog input sequence acquisition mode

This function is not available for the S7. See function MSXE301x__AnalogInputInitAndStartSequenceTrimed.

A sequence is a list of channels (max 16) that are acquired. It can be any order of the channels in this list.

There are different sequence modes

Limited number of sequences
After the acquisition of the defined number of sequences, the acquisition is stopped automatically.
Continuous:
The sequences are acquired continuously until a software-stop-command occurs.
Without delay
There is no waiting time between the acquisitions of 2 sequences.
With delay
A delay between 2 sequences can be configured:
For this there are 2 delay types:
  • Mode 1: The delay time defines the time between 2 sequence beginnings.
  • Mode 2: The delay time defines the time between the end of a sequence until the beginning of the next sequence.

You can start the acquisition by a hardware or synchro trigger.

The hardware trigger can react to a rising, falling or both edges.

You have the following possibility:

There are two trigger modes:(for the hardware or synchro trigger)

One shot:
After the software start, the module is waiting for a trigger signal to start the
acquisition. After this the trigger signal is ignored.
Sequence:
After the software start the module is waiting for the trigger signal and acquires x
sequences (also adjustable) and then wait again.

Initialise and start the analog input 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 integer2590x03010x0103
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer12000xB0040x04B0
word count216-bit integer1260x7E000x007E
byte count18-bit integer2520xFC0xFC
ulNbrOfChannel432-bit integerSee the description above0x????????0x????????
pulChannelList6432-bit integer arraySee the description above0x????????[16]0x????????[16]
pulGainArray6432-bit integer arraySee the description above0x????????[16]0x????????[16]
pulPolarityArray6432-bit integer arraySee the description above0x????????[16]0x????????[16]
ulConversionTime432-bit integerSee the description above0x????????0x????????
ulConversionTimeUnit432-bit integerSee the description above0x????????0x????????
ulNbrOfSequence432-bit integerSee the description above0x????????0x????????
ulNbrMaxSequenceToTransfer432-bit integerSee the description above0x????????0x????????
ulDelayMode432-bit integerSee the description above0x????????0x????????
ulDelayTimeUnit432-bit integerSee the description above0x????????0x????????
ulDelayValue432-bit integerSee the description above0x????????0x????????
ulTriggerMask432-bit integerSee the description above0x????????0x????????
ulTriggerMode432-bit integerSee the description above0x????????0x????????
ulHardwareTriggerEdge432-bit integerSee the description above0x????????0x????????
ulHardwareTriggerCount432-bit integerSee the description above0x????????0x????????
ulByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
ulDataFormat432-bit integerSee the description above0x????????0x????????
ulOption1432-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 integer1260x7E000x007E

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 MSXE301x__AnalogInputStopAndReleaseSequence

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

Description

Stop and release the analog input sequence acquisition mode [Query frame layout] _ : no input parameter [Response frame layout] Response :
iReturnValue :

Stops the current sequence acquisition.

Must be called before any another call to MSXE301x__AnalogInputInitAndStartSequence.

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 MSXE301x__AnalogInputStopAndReleaseSequenceEx

Description

Stop and release the analog input sequence acquisition mode [Query frame layout] _ : no input parameter [Response frame layout] Response :
iReturnValue :

Stops the current sequence acquisition.

Must be called before any another call to MSXE301x__AnalogInputInitAndStartSequence.

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 MSXE301x__AnalogInputInitAndStartSequenceTrimed

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

Description

Initialise and start the analog input sequence acquisition mode

This function performs the same as MSXE301x__AnalogInputInitAndStartSequence, but has parameters with smaller types that allows it to be compliant with Schneider Electric MODBUS standard.

Available from OS revision 5492.

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 integer920x5C000x005C
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer50x05000x0005
word count216-bit integer420x2A000x002A
byte count216-bit integer840x54000x0054
ulNbrOfChannel18-bit integerSee the description above0x??0x??
pulChannelList168-bit integer arraySee the description above0x??[16]0x??[16]
pulGainArray168-bit integer arraySee the description above0x??[16]0x??[16]
pulPolarityArray168-bit integer arraySee the description above0x??[16]0x??[16]
ulConversionTime432-bit integerSee the description above0x????????0x????????
ulConversionTimeUnit18-bit integerSee the description above0x??0x??
ulNbrOfSequence432-bit integerSee the description above0x????????0x????????
ulNbrMaxSequenceToTransfer432-bit integerSee the description above0x????????0x????????
ulDelayMode216-bit integerSee the description above0x????0x????
ulDelayTimeUnit18-bit integerSee the description above0x??0x??
ulDelayValue216-bit integerSee the description above0x????0x????
ulTriggerMask18-bit integerSee the description above0x??0x??
ulTriggerMode18-bit integerSee the description above0x??0x??
ulHardwareTriggerEdge18-bit integerSee the description above0x??0x??
ulHardwareTriggerCount216-bit integerSee the description above0x????0x????
ulByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
ulDataFormat432-bit integerSee the description above0x????????0x????????
ulOption1432-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 integer420x2A000x002A

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 MSXE301x__AnalogInputInitAndStartSequenceTrimedEx

Description

Initialise and start the analog input sequence acquisition mode

This function performs the same as MSXE301x__AnalogInputInitAndStartSequence, but has parameters with smaller types that allows it to be compliant with Schneider Electric MODBUS standard.

Available from OS revision 5492.

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 integer910x5B000x005B
unit identifier18-bit integer0 or 10x00 or 0x010x00 or 0x01
MODBUS Function code18-bit integer0x100x100x10
Reference number (=register)216-bit integer12540xE6040x04E6
word count216-bit integer420x2A000x002A
byte count18-bit integer840x540x54
ulNbrOfChannel18-bit integerSee the description above0x??0x??
pulChannelList168-bit integer arraySee the description above0x??[16]0x??[16]
pulGainArray168-bit integer arraySee the description above0x??[16]0x??[16]
pulPolarityArray168-bit integer arraySee the description above0x??[16]0x??[16]
ulConversionTime432-bit integerSee the description above0x????????0x????????
ulConversionTimeUnit18-bit integerSee the description above0x??0x??
ulNbrOfSequence432-bit integerSee the description above0x????????0x????????
ulNbrMaxSequenceToTransfer432-bit integerSee the description above0x????????0x????????
ulDelayMode216-bit integerSee the description above0x????0x????
ulDelayTimeUnit18-bit integerSee the description above0x??0x??
ulDelayValue216-bit integerSee the description above0x????0x????
ulTriggerMask18-bit integerSee the description above0x??0x??
ulTriggerMode18-bit integerSee the description above0x??0x??
ulHardwareTriggerEdge18-bit integerSee the description above0x??0x??
ulHardwareTriggerCount216-bit integerSee the description above0x????0x????
ulByTriggerNbrOfSeqToAcquire432-bit integerSee the description above0x????????0x????????
ulDataFormat432-bit integerSee the description above0x????????0x????????
ulOption1432-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 integer12540xE6040x04E6
word count216-bit integer420x2A000x002A

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
MSXE301x__AnalogInputGetAutoRefreshValues301x_AIGetAutoRefVal
MSXE301x__AnalogInputGetChannelType301x_AIGetChannelType
MXCommon__SetHardwareTriggerFilterTimeSetHwTrigFiltTime
MXCommon__InitAndStartSynchroTimerInitStartSyncTimer
MXCommon__StopAndReleaseSynchroTimerStopRelSyncTimer
MXCommon__RebootReboot
MXCommon__SetCustomerKeySetCustomerKey
MXCommon__SetFilterChannelsSetFilterChannels
MSXE301x__AnalogInputInitAndStartAutoRefresh301x_AIIniStaAutoRef
    ulByTriggerNbrOfSeqToAcquire    ulByTrigNbrOfSeqToAcq
MSXE301x__AnalogInputStopAndReleaseAutoRefresh301x_AIStopRelAutoRef
MSXE301x__AnalogInputInitAndStartSequencenot available
MSXE301x__AnalogInputStopAndReleaseSequence301x_AIStopRelSeq
MSXE301x__AnalogInputInitAndStartSequenceTrimed301x_AIInitStartSeq
    ulNbrMaxSequenceToTransfer    ulNbrMaxSeqToTransf
    ulByTriggerNbrOfSeqToAcquire    ulByTrigNbrOfSeqToAcq