MODBUS interface description

• General description
• FC3 functions
• FC16 functions
• FC23 functions
• Exception code description
• S7 compatibility

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.

• FC3 functions read register content from the memory of the remote system
  
• FC16 functions write new register content on the memory of the remote system
  

• FC23 functions read/write registers content from/to the memory of the remote system
  

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

• The default port used by the server is 512 in both UDP/IP and TCP/IP. You can change this via the web server.
• Data are sent in network order, i.e. big endian (Motorola formata). Use the standard C functions
  atons/atonl and ntohs/ntohl to convert values bigger than 1 bytes.
• Datastructures used to describe parameters that are embedded in on-wire frames must be packed.
  How to do that is compiler-dependant.

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

• It is possible to configure the server to accept data sent in little endian (Intel format) (native order)
• In this case, the default port used is 215. You can change this via the web server.

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.

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

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:

[Response frame layout] ReturnValue: The return value of the remote function.

• 0 Always means success
• -100 means you should check Syserrno;
• for other values, check the documentation of the function

[Response frame layout] Syserrno: the value of the libc errno after the call to the remote function

[Response frame layout] Errstr: A nul-terminated string describing the error code Syserrno

Query frame layout

Response frame layout

Exception frame layout

Description

Return the result of the last remote function call

Parameters:

[Response frame layout] ReturnValue: The return value of the remote function.

• 0 Always means success
• -100 means you should check Syserrno;
• for other values, check the documentation of the function

[Response frame layout] Syserrno: the value of the libc errno after the call to the remote function

[Response frame layout] Errstr: A nul-terminated string describing the error code Syserrno

Query frame layout

Response frame layout

Exception frame layout

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:

[Response frame layout] str: A 200-characters string

Query frame layout

Response frame layout

Exception frame layout

Description

Returns the type of the MSX-E Module

Parameters:

[Response frame layout] str: A 200-characters string

Query frame layout

Response frame layout

Exception frame layout

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

Description

Get the time on the module

Parameters:

[Response frame layout] tv_sec: Number of seconds since the Epoch

[Response frame layout] tv_usec: Number of microseconds since the begin of the second

Query frame layout

Response frame layout

Exception frame layout

Description

Get the time on the module

Parameters:

[Response frame layout] tv_sec: Number of seconds since the Epoch

[Response frame layout] tv_usec: Number of microseconds since the begin of the second

Query frame layout

Response frame layout

Exception frame layout

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:

[Response frame layout] bValueArray: non crypted value array [16 bytes of random data]

[Response frame layout] bCryptedValueArray: Crypted value array [16 bytes of the crypted random data]

Query frame layout

Response frame layout

Exception frame layout

Description

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

Parameters:

[Response frame layout] bValueArray: non crypted value array [16 bytes of random data]

[Response frame layout] bCryptedValueArray: Crypted value array [16 bytes of the crypted random data]

Query frame layout

Response frame layout

Exception frame layout

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:

[Response frame layout]ChannelNumber: Number of channels

Query frame layout

Response frame layout

Exception frame layout

Description

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

Parameters:

[Response frame layout]ChannelNumber: Number of channels

Query frame layout

Response frame layout

Exception frame layout

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:

[Response frame layout]Value: Array that contain the counter and channels values (raw or converted, depending of the configuration)

• Values [0]: Auto refresh counter value
  
• Values [1]: Channel 0 value
  
• ...
  
• Values [16]: Channel 15 value
  

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)
• 0 : success
  
• -100 : GetAutoRefreshAllValues kernel function error
  

Query frame layout

Response frame layout

Exception frame layout

Description

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

Parameters:

[Response frame layout]Value: Array that contain the counter and channels values (raw or converted, depending of the configuration)

• Values [0]: Auto refresh counter value
  
• Values [1]: Channel 0 value
  
• ...
  
• Values [16]: Channel 15 value
  

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)
• 0 : success
  
• -100 : GetAutoRefreshAllValues kernel function error
  

Query frame layout

Response frame layout

Exception frame layout

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:

• 0 : success
  
• otherwise : internal error
  

Query frame layout

Response frame layout

Exception frame layout

Description

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

Parameters:

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

Returns:

• 0 : success
  
• otherwise : internal error
  

Query frame layout

Response frame layout

Exception frame layout

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:

• 0 : success
  
• otherwise : internal error
  

Query frame layout

Response frame layout

Exception frame layout

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:

• 0 : success
  
• otherwise : internal error
  

Query frame layout

Response frame layout

Exception frame layout

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:

Returns:

• 0 : success
  
• otherwise : internal error
  

Query frame layout

Response frame layout

Exception frame layout

Description

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

Parameters:

Returns:

• 0 : success
  
• otherwise : internal error
  

Query frame layout

Response frame layout

Exception frame layout

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

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

• [Query frame layout] ulFilterTime Filter time for the hardware trigger input in 250ns step (max value : 65535 ).
  • 0: disable the filter
  • 1: filter of 250ns
  • 2: filter of 500ns
  • ...
  • 65535: filter of 16ms
• [Query frame layout] ulOption Reserved. Set to 0

Returns

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

• 0 The remote function performed OK
• -1 Internal system error occurred. See value of syserrno

Query frame layout

Response frame layout

Exception frame layout

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

• [Query frame layout] ulFilterTime Filter time for the hardware trigger input in 250ns step (max value : 65535 ).
  • 0: disable the filter
  • 1: filter of 250ns
  • 2: filter of 500ns
  • ...
  • 65535: filter of 16ms
• [Query frame layout] ulOption Reserved. Set to 0

Returns

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

• 0 The remote function performed OK
• -1 Internal system error occurred. See value of syserrno

Query frame layout

Response frame layout

Exception frame layout

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:

[Query frame layout] ulTimeBase: Time base of the timer (0 for us, 1 for ms, 2 for s)

[Query frame layout] ulReloadValue: Timer reload value (0 to 0xFFFF), minimum reload time is 5 us

[Query frame layout] ulNbrOfCycle: Number of timer cycle


• 0: continuous
• > 0: defined number of cycle

[Query frame layout] ulGenerateTriggerMode:


• 0: Wait the time overflow to set the synchronisation trigger
• 1: Set the synchronisation trigger by the start of the timer and after each time overflow

[Query frame layout] ulOption01:Define the source of the trigger

• 0 : Trigger disabled
  
• 1 : Enable the hardware figital input trigger

[Query frame layout] ulOption02:Define the edge of the hardware trigger who generates a trigger action

• 1 : rising edge (Only if hardware trigger selected)
• 2 : falling edge (Only if hardware trigger selected)
• 3 : Both front (Only if hardware trigger selected)

[Query frame layout] ulOption03:Define the number of trigger events before the action occur

• 1 : all trigger event start the action
• max value : 65535

[Query frame layout] ulOption04: Reserved

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)
• 0 : means the remote function performed OK
• -1: means an system error occured
• -2: not available time base
• -3: timer reload value can not be greater than 65535
• -4: minimum time reload is 5 us
• -5: Number of cycle can not be greater than 65535
• -6: Generate trigger mode error
• -100: Init timer error
• -101: Start timer error

Query frame layout

Response frame layout

Exception frame layout

Description

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

Parameters:

[Query frame layout] ulTimeBase: Time base of the timer (0 for us, 1 for ms, 2 for s)

[Query frame layout] ulReloadValue: Timer reload value (0 to 0xFFFF), minimum reload time is 5 us

[Query frame layout] ulNbrOfCycle: Number of timer cycle


• 0: continuous
• > 0: defined number of cycle

[Query frame layout] ulGenerateTriggerMode:


• 0: Wait the time overflow to set the synchronisation trigger
• 1: Set the synchronisation trigger by the start of the timer and after each time overflow

[Query frame layout] ulOption01:Define the source of the trigger

• 0 : Trigger disabled
  
• 1 : Enable the hardware figital input trigger

[Query frame layout] ulOption02:Define the edge of the hardware trigger who generates a trigger action

• 1 : rising edge (Only if hardware trigger selected)
• 2 : falling edge (Only if hardware trigger selected)
• 3 : Both front (Only if hardware trigger selected)

[Query frame layout] ulOption03:Define the number of trigger events before the action occur

• 1 : all trigger event start the action
• max value : 65535

[Query frame layout] ulOption04: Reserved

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)
• 0 : means the remote function performed OK
• -1: means an system error occured
• -2: not available time base
• -3: timer reload value can not be greater than 65535
• -4: minimum time reload is 5 us
• -5: Number of cycle can not be greater than 65535
• -6: Generate trigger mode error
• -100: Init timer error
• -101: Start timer error

Query frame layout

Response frame layout

Exception frame layout

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:

[Query frame layout] ulOption01 : Reserved

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)
• 0 : means the remote function performed OK
• -1: means an system error occured
• -100: Start/Stop timer error

Query frame layout

Response frame layout

Exception frame layout

Description

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

Parameters:

[Query frame layout] ulOption01 : Reserved

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)
• 0 : means the remote function performed OK
• -1: means an system error occured
• -100: Start/Stop timer error

Query frame layout

Response frame layout

Exception frame layout

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:

[Query frame layout] Dummy : Reserved

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)
• 0 : means the remote function performed OK
• -1: means an system error occured (probably EPERM)

Query frame layout

Response frame layout

Exception frame layout

Description

Ask the MSX-E module to reboot

Parameters:

[Query frame layout] Dummy : Reserved

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)
• 0 : means the remote function performed OK
• -1: means an system error occured (probably EPERM)

Query frame layout

Response frame layout

Exception frame layout

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

Description

Permit to set the Customer key

Parameters:

[Query frame layout] bKey : Customer key (only writable on the module) [32 bytes containing a AES key]

[Query frame layout] bPublicKey : IV (Initialisation vector) for the AES cryptography [16 bytes containing a AES key]

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)
• 0 : means the remote function performed OK
• -1: means an system error occured (probably EPERM)

Query frame layout

Response frame layout

Exception frame layout

Description

Permit to set the Customer key

Parameters:

[Query frame layout] bKey : Customer key (only writable on the module) [32 bytes containing a AES key]

[Query frame layout] bPublicKey : IV (Initialisation vector) for the AES cryptography [16 bytes containing a AES key]

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)
• 0 : means the remote function performed OK
• -1: means an system error occured (probably EPERM)

Query frame layout

Response frame layout

Exception frame layout

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:

[Query frame layout] ChannelList : Each index of the array is representing a channel. To set a filter on a channel, enter the filter ID. By default the value ist 0 (No filter).

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)
• 0 : means the remote function performed OK
• -1: means a system error occurred (probably EPERM)

Query frame layout

Response frame layout

Exception frame layout

Description

Permit to set a filter per channel

Parameters:

[Query frame layout] ChannelList : Each index of the array is representing a channel. To set a filter on a channel, enter the filter ID. By default the value ist 0 (No filter).

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)
• 0 : means the remote function performed OK
• -1: means a system error occurred (probably EPERM)

Query frame layout

Response frame layout

Exception frame layout

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:

[Query frame layout] TransducerSelection: Transducer type selection

[Query frame layout] ChannelMask: Mask of the channel to acquire by the auto refresh (1 bit = 1 Channel)

[Query frame layout] AverageMode: Set the average mode :


• 0: not used
  
• 1: average per Sequence
  
• 2: average per channel

[Query frame layout] AverageValue: Set the average value (only used, when average is used)


• 0: average not used
  
• max value: 255

[Query frame layout] DivisionFactor: Division factor (min : 5, max 255)

[Query frame layout] TriggerAction: Trigger action :


• Hardware Trigger Start D0 - D7
  Bit 3,2,1,0 : Define the trigger mode
  
  • 0000 : Trigger disabled
    
  • 0001 : One shot trigger : After the software start, the module is waiting for a trigger signal to start the acquisition. After this the trigger signal is ignored.
    
  • 0010 : Sequence trigger : After the software start the module is waiting for the trigger signal and acquires x sequences (also adjustable) and then wait again.
    


Bit 7,6 : define the active front (Only if hardware trigger selected)

• 01 : rising front (Only if hardware trigger selected)
  
• 10 : falling front (Only if hardware trigger selected)
  
• 11 : Both front (Only if hardware trigger selected)
  


• Synchronisation Trigger Start : D8-D15
  Bit 11,10,9,8 : Define the trigger mode
  
  • 0000 : trigger disabled
    
  • 0001 : One shot trigger : After the software start, the module is waiting for a trigger signal to start the acquisition. After this the trigger signal is ignored.
    
  • 0010 : Sequence trigger : After the software start the module is waiting for the trigger signal and acquires x sequences (also adjustable) and then wait again.
    


• Hardware Trigger Stop D16 - D19
  The hardware trigger stop can only be activated when :
  
  • The hardware trigger start is not used.
    
  • The hardware trigger start is used in one shot mode.
    


The stop of the acquisition is really do at the end of a sequence acquisition(to avoid that the acquisition is stop in the middle of a sequence).



Bit 16 : Define the trigger stop is enable or not

• 0 : Stop trigger disabled
  
• 1 : Stop trigger enabled.
  


Bit 18,17 : define the active front (Only if hardware trigger stop selected)

• 01 : rising front (Only if hardware trigger stop selected)
  
• 10 : falling front (Only if hardware trigger stop selected)
  
• 11 : Both front (Only if hardware trigger stop selected)
  


Bit 19 : define if the hardware trigger stop use the ulHardwareTriggerCount (Only if hardware trigger stop selected)

• 0 : ulHardwareTriggerCount not used : First hardware trigger stop will stop the acquisition
  
• 1 : ulHardwareTriggerCount is used : The ulHardwareTriggerCount hardware trigger will stop the acquisition
  



[Query frame layout] HardwareTriggerCount: Define the number of trigger events before the action occur


• 0 or 1: all trigger event start the action
  
• max value: 65535

[Query frame layout] HardwareTriggerFilterTime: filter time for the hardware trigger


• in multiplier from 250 ns step
  
• max value: 65535

[Query frame layout] ByTriggerNbrOfSeqToAcquire: define the number of sequences to acquire by each trigger event

[Query frame layout] Option1: Data format option


• D0: Time stamp information
  
  • 0: no time stamp information
    
  • 1: time stamp information
    
  
  
• D1: Data format
  
  • 0: Digital value
    
  • 1: Analog value (in mm)
    


• D2: invert value
  
  • 0: don't invert the channel value
    
  • 1: invert the channel value (-2 mm -> + 2mm)
    

[Query frame layout] Option2: Reserved

[Query frame layout] Option3: Reserved

[Query frame layout] Option4: Reserved

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)
• 0: success
  
• -1: means an system error occured
  
• -2: Transducer selection error
  
• -3: Channel mask error : can not be null
  
• -4: Channel mask error
  
• -5: Average mode error
  
• -6: Average value error
  
• -7: Division factor error
  
• -8: Incorrect value for Hardware Trigger Mode
  
• -9: Incorrect value for Hardware Trigger front
  
• -10: Incorrect value for Synchro Trigger Mode
  
• -11: Incorrect value for Hardware Trigger count
  
• -12: Incorrect value for Hardware Trigger filter time
  
• -13: Incorrect value for "trigger number of sequences to acquire"
  
• -14: Wrong data format parameter (ulOption1)
  
• -15: A value for Hardware Trigger front was defined but Hardware Trigger Mode is not set
  
• -16: Cannot use both triggers at the same time
  
• -17: Incorrect value for the hardware trigger stop front
  
• -18: Hardware trigger stop can not be used by this configuration of hardware trigger start
  
• -100: TransducerInit kernel function error
  
• -101: InitConvertTimeDivisionFactor kernel function error
  
• -102: SetAutoRefreshAverageValue kernel function error
  
• -103: InitDigitalInputFilter kernel function error
  
• -104: InitEnableDisableHardwareTrigger kernel function error
  
• -105: SynchroTrigger Init/Enable/Disable kernel function error
  
• -106: SetTriggerSequenceCount kernel function error
  
• -107: StartAutoRefresh kernel function error
  

Query frame layout

Response frame layout

Exception frame layout

Description

Initialise and start the transducer auto refresh acquisition mode

Parameters:

[Query frame layout] TransducerSelection: Transducer type selection

[Query frame layout] ChannelMask: Mask of the channel to acquire by the auto refresh (1 bit = 1 Channel)

[Query frame layout] AverageMode: Set the average mode :


• 0: not used
  
• 1: average per Sequence
  
• 2: average per channel

[Query frame layout] AverageValue: Set the average value (only used, when average is used)


• 0: average not used
  
• max value: 255

[Query frame layout] DivisionFactor: Division factor (min : 5, max 255)

[Query frame layout] TriggerAction: Trigger action :


• Hardware Trigger Start D0 - D7
  Bit 3,2,1,0 : Define the trigger mode
  
  • 0000 : Trigger disabled
    
  • 0001 : One shot trigger : After the software start, the module is waiting for a trigger signal to start the acquisition. After this the trigger signal is ignored.
    
  • 0010 : Sequence trigger : After the software start the module is waiting for the trigger signal and acquires x sequences (also adjustable) and then wait again.
    


Bit 7,6 : define the active front (Only if hardware trigger selected)

• 01 : rising front (Only if hardware trigger selected)
  
• 10 : falling front (Only if hardware trigger selected)
  
• 11 : Both front (Only if hardware trigger selected)
  


• Synchronisation Trigger Start : D8-D15
  Bit 11,10,9,8 : Define the trigger mode
  
  • 0000 : trigger disabled
    
  • 0001 : One shot trigger : After the software start, the module is waiting for a trigger signal to start the acquisition. After this the trigger signal is ignored.
    
  • 0010 : Sequence trigger : After the software start the module is waiting for the trigger signal and acquires x sequences (also adjustable) and then wait again.
    


• Hardware Trigger Stop D16 - D19
  The hardware trigger stop can only be activated when :
  
  • The hardware trigger start is not used.
    
  • The hardware trigger start is used in one shot mode.
    


The stop of the acquisition is really do at the end of a sequence acquisition(to avoid that the acquisition is stop in the middle of a sequence).



Bit 16 : Define the trigger stop is enable or not

• 0 : Stop trigger disabled
  
• 1 : Stop trigger enabled.
  


Bit 18,17 : define the active front (Only if hardware trigger stop selected)

• 01 : rising front (Only if hardware trigger stop selected)
  
• 10 : falling front (Only if hardware trigger stop selected)
  
• 11 : Both front (Only if hardware trigger stop selected)
  


Bit 19 : define if the hardware trigger stop use the ulHardwareTriggerCount (Only if hardware trigger stop selected)

• 0 : ulHardwareTriggerCount not used : First hardware trigger stop will stop the acquisition
  
• 1 : ulHardwareTriggerCount is used : The ulHardwareTriggerCount hardware trigger will stop the acquisition
  



[Query frame layout] HardwareTriggerCount: Define the number of trigger events before the action occur


• 0 or 1: all trigger event start the action
  
• max value: 65535

[Query frame layout] HardwareTriggerFilterTime: filter time for the hardware trigger


• in multiplier from 250 ns step
  
• max value: 65535

[Query frame layout] ByTriggerNbrOfSeqToAcquire: define the number of sequences to acquire by each trigger event

[Query frame layout] Option1: Data format option


• D0: Time stamp information
  
  • 0: no time stamp information
    
  • 1: time stamp information
    
  
  
• D1: Data format
  
  • 0: Digital value
    
  • 1: Analog value (in mm)
    


• D2: invert value
  
  • 0: don't invert the channel value
    
  • 1: invert the channel value (-2 mm -> + 2mm)
    

[Query frame layout] Option2: Reserved

[Query frame layout] Option3: Reserved

[Query frame layout] Option4: Reserved

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)
• 0: success
  
• -1: means an system error occured
  
• -2: Transducer selection error
  
• -3: Channel mask error : can not be null
  
• -4: Channel mask error
  
• -5: Average mode error
  
• -6: Average value error
  
• -7: Division factor error
  
• -8: Incorrect value for Hardware Trigger Mode
  
• -9: Incorrect value for Hardware Trigger front
  
• -10: Incorrect value for Synchro Trigger Mode
  
• -11: Incorrect value for Hardware Trigger count
  
• -12: Incorrect value for Hardware Trigger filter time
  
• -13: Incorrect value for "trigger number of sequences to acquire"
  
• -14: Wrong data format parameter (ulOption1)
  
• -15: A value for Hardware Trigger front was defined but Hardware Trigger Mode is not set
  
• -16: Cannot use both triggers at the same time
  
• -17: Incorrect value for the hardware trigger stop front
  
• -18: Hardware trigger stop can not be used by this configuration of hardware trigger start
  
• -100: TransducerInit kernel function error
  
• -101: InitConvertTimeDivisionFactor kernel function error
  
• -102: SetAutoRefreshAverageValue kernel function error
  
• -103: InitDigitalInputFilter kernel function error
  
• -104: InitEnableDisableHardwareTrigger kernel function error
  
• -105: SynchroTrigger Init/Enable/Disable kernel function error
  
• -106: SetTriggerSequenceCount kernel function error
  
• -107: StartAutoRefresh kernel function error
  

Query frame layout

Response frame layout

Exception frame layout

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:

[Query frame layout] Dummy: Is not used

Returns:

Possible return value on the remote system (read them with GetLastCommandStatus)
• 0: success
  
• -1: means an system error occured
  
• -100: StopAutoRefresh kernel function error
  

Query frame layout

Response frame layout

Exception frame layout

Description

Stop and release the transducer auto refresh acquisition mode

Parameters:

[Query frame layout] Dummy: Is not used

Returns:

Possible return value on the remote system (read them with GetLastCommandStatusEx)
• 0: success
  
• -1: means an system error occured
  
• -100: StopAutoRefresh kernel function error
  

Query frame layout

Response frame layout