Remote commands#
*IDN?#
Description:
Get identification string
Return value:
Identification string
Example:
*IDN?
Return value example:
ATV,MEASMATIC,42,v3.4.1
*OPC?#
Description:
Query operation complete info
Return value:
Operation complete information
Example:
*OPC?
Return value example:
1
CLUSTER:INFO:BIN?#
Description:
Gets binning information for the currently tested cluster
Return value:
Not acknowledge event, cluster info in XML format or error message
Example:
CLUSTER:INFO:BIN?
Return value example:
<ClusterInfos><ClusterInfo><BinCode>0</BinCode><Column>0</Column><Index>0</Index><IsChipPresent>true</IsChipPresent><Row>1</Row></ClusterInfo><ClusterInfo><BinCode>0</BinCode><Column>1</Column><Index>1</Index><IsChipPresent>true</IsChipPresent><Row>1</Row></ClusterInfo></ClusterInfos>
#ERROR: error message
CLUSTER:INFO:SET#
Description:
Set current cluster information that are used to store the measured data.
Parameters:
- Cluster Infos XML: string, e.g. ABC
Return value:
Acknowledge event or error message
Example:
CLUSTER:INFO:SET <ClusterInfos><ClusterInfo><BinCode>0</BinCode><Column>0</Column><Index>0</Index><IsChipPresent>true</IsChipPresent><Row>1</Row></ClusterInfo><ClusterInfo><BinCode>0</BinCode><Column>1</Column><Index>1</Index><IsChipPresent>true</IsChipPresent><Row>1</Row></ClusterInfo></ClusterInfos>
Return value example:
#EVENT: Acknowledge
#ERROR: error message
DATA:EXPORT#
Description:
Exports data using the specified export setting. If none is defined all configured exports will be triggered. This applies to the whole project or to the test specified as parameter.
Parameters:
- Export setting: String : The name of the export setting which should be used. If this parameter is empty, all configured export settings are used.
- Test: String : The name of the test which data should be exported. If this parameter is empty, the project export settings are used.
Return value:
File saved event or error message
Example:
DATA:EXPORT Data export name,test name
Return value example:
#EVENT: FileSaved,Export filter return message
#ERROR: error message
DATA:INFO:ROWLIST?#
Description:
Queries a list of all row infos of the result data table.
Parameters:
- Testname: String : The name of the test where the data table row index shall be queried.
Return value:
List of row infos in XML format
Example:
DATA:INFO:ROWLIST? TestXYZ
Return value example:
<RowInfoList> <RowInfo> ... </RowInfo> </RowInfoList>
#ERROR: error message
DATA:INFO:ROWSITE?#
Description:
Queries the index of the first data row in the result data table with the specified site column, row column and sub site index. (sub site index is optional)
Parameters:
- Testname: String : The name of the test where the data table row index shall be queried.
- Site column: integer, e.g. 42
- Site row: integer, e.g. 42
- Sub site index: integer, e.g. 42 (can be empty)
Return value:
The index of the first data row with the specified site column, row column and sub site index. (Index starts at 0)
Example:
DATA:INFO:ROWSITE? TestXYZ,10,15,1
Return value example:
42
#ERROR: error message if no data row was found in the result data table
DATA:LAST?#
Description:
Get measurement data of the last append measurement as XML
Return value:
Measurement data as XML or error message
Example:
DATA:LAST?
Return value example:
<MeasurementData> ... </MeasurementData>
#ERROR: error message
DATA:LIMIT:MAX?#
Description:
Query an output parameter maximum limit.
Parameters:
- Test name: string, e.g. ABC
- Output parameter: string, e.g. ABC
Return value:
Maximum limit or error message
Example:
DATA:LIMIT:MAX? test_1,param_1
Return value example:
31.5
#ERROR: error message
DATA:LIMIT:MIN?#
Description:
Query an output parameter minimum limit.
Parameters:
- Test name: string, e.g. ABC
- Output parameter: string, e.g. ABC
Return value:
Minimum limit or error message
Example:
DATA:LIMIT:MIN? test_1,param_1
Return value example:
31.5
#ERROR: error message
DATA:SAVE#
Description:
Save measurement data as XML file
Parameters:
- Data file name: Name and path of the file to be saved
Return value:
File saved event or error message
Example:
DATA:SAVE C:\Data\Data1.mmdat
Return value example:
#EVENT: FileSaved
#ERROR: error message
DATA:VALUE:COUNT?#
Description:
Query output parameter result value count.
Parameters:
- Test name: string, e.g. ABC
Return value:
Result value count or error message
Example:
DATA:VALUE:COUNT? test_1
Return value example:
5
#ERROR: error message
DATA:VALUE?#
Description:
Query an output parameter result value.
Parameters:
- Test name: string, e.g. ABC
- Output parameter: string, e.g. ABC
- Value index: integer, e.g. 42
Return value:
Result value or error message
Example:
DATA:VALUE? test_1,param_1,0
Return value example:
31.5
#ERROR: error message
DATA?#
Description:
Get measurement data as XML
Return value:
Measurement data as XML or error message
Example:
DATA?
Return value example:
<MeasurementData> ... </MeasurementData>
#ERROR: error message
DEVICE:INIT#
Description:
Optional initialization all devices
Return value:
Acknowledge event or error message
Example:
DEVICE:INIT
Return value example:
#EVENT: Acknowledge
#ERROR: error message
EVALUATION:LAST?#
Description:
Query the test evaluation for the last measurement (append measurement).
Return value:
Undefined, Pass, Fail or error message
Example:
EVALUATION:LAST?
Return value example:
Pass
#ERROR: error message
EVALUATION?#
Description:
Query the test evaluation for all measurements (including append measurements).
Return value:
Undefined, Pass, Fail or error message
Example:
EVALUATION?
Return value example:
Pass
#ERROR: error message
GUI:VALUE:SET#
Description:
Set GUI input value
Parameters:
- Test name: string, e.g. ABC
- GUI item ID: string, e.g. ABC
- Value: string, e.g. ABC
Return value:
Acknowledge event or error message
Example:
GUI:VALUE:SET continuity_1,CURRENT1,10mA
Return value example:
#EVENT: Acknowledge
#ERROR: error message
GUI:VALUE?#
Description:
Queries a GUI input value
Parameters:
- Test name: string, e.g. ABC
- GUI item ID: string, e.g. ABC
Return value:
GUI item value or error message
Example:
GUI:VALUE? continuity_1,CURRENT1
Return value example:
0.012
#ERROR: error message
MEAS:DESC#
Description:
Change value of measurement info
Parameters:
- Name: string, e.g. ABC
- Value: string, e.g. ABC (can be empty)
Return value:
Acknowledge event or error message
Example:
MEAS:DESC new_value
Return value example:
#EVENT: Acknowledge
#ERROR: error message
MEAS:DESC?#
Description:
Get measurement info
Parameters:
- Name: string, e.g. ABC
Return value:
Value of property or error message
Example:
MEAS:DESC?
Return value example:
ABC123
#ERROR: error message
NUMBER:ADD#
Description:
Example for remote command implementation. Adds two numbers.
Parameters:
- First number: floating point number, e.g. 3.14E-3
- Second number: floating point number, e.g. 3.14E-3
Return value:
Calculation result or error message
Example:
NUMBER:ADD 3.14,2.71
Return value example:
5.85
#ERROR: error message
PROJECT:CLEAR#
Description:
Clear current project
Return value:
Acknowledge event or error message
Example:
PROJECT:CLEAR
Return value example:
#EVENT: Acknowledge
#ERROR: error message
PROJECT:LIST#
Description:
Print list of all projects
Parameters:
- Project directory: Directory which contains the project files.
Return value:
Comma separated list of projects or error message
Example:
PROJECT:LOAD:FILE C:\Projects\Project1.mmprj
Return value example:
C:\Measmatic\Projects\Project1.mmprj,C:\Measmatic\Projects\Project2.mmprj"
#ERROR: error message
PROJECT:LOAD:FILE#
Description:
Load project from file
Parameters:
- Project file name: Name and path of the file to be open
Return value:
Project loaded event or error message
Example:
PROJECT:LOAD:FILE C:\Projects\Project1.mmprj
Return value example:
#EVENT: ProgramLoaded
#ERROR: error message
PROJECT:LOAD:STREAM#
Description:
Load project from stream. Project data must be sent without line feeds.
Parameters:
- Project file data: string, e.g. ABC
Return value:
Project loaded event or error message
Example:
PROJECT:LOAD:STREAM <MeasmaticProject> ... </MeasmaticProject>
Return value example:
#EVENT: ProgramLoaded
#ERROR: error message
PROJECT:SETTINGS:DIR:DATA#
Description:
Changes the data directory in project settings
Parameters:
- Directory path: string, e.g. ABC
Return value:
Acknowledge event or error message
Example:
PROJECT:SETTINGS:DIR:DATA C:\Data
Return value example:
#EVENT: Acknowledge
#ERROR: error message
PROJECT:SETTINGS:DIR:EXPORT#
Description:
Changes the export directory in project settings
Parameters:
- Directory path: string, e.g. ABC
Return value:
Acknowledge event or error message
Example:
PROJECT:SETTINGS:DIR:EXPORT C:\Data
Return value example:
#EVENT: Acknowledge
#ERROR: error message
PROJECT:SETTINGS:PINGROUPS#
Description:
Changes the pin groups file in project settings
Parameters:
- Pingroups file name: Name and path of the file to be open
Return value:
Acknowledge event or error message
Example:
PROJECT:SETTINGS:PINGROUPS C:\PinGroups\PinGroupFile.ptgrp
Return value example:
#EVENT: Acknowledge
#ERROR: error message
PROJECT:SETTINGS:SORTINGTABLES#
Description:
Changes the sorting tables file and name in project settings
Parameters:
- Sorting tables file name: Name and path of the file to be open
- Sorting table name: string, e.g. ABC
Return value:
Acknowledge event or error message
Example:
PROJECT:SETTINGS:SORTINGTABLES C:\SortingTables\SortingTables.xml,Table1
Return value example:
#EVENT: Acknowledge
#ERROR: error message
SETTING:DATA:SEND#
Description:
Enable or disable automatic data sending with test finished event
Parameters:
- State: State ON or OFF
Return value:
Acknowledge event or error message
Example:
SETTING:DATA:SEND OFF
Return value example:
#EVENT: Acknowledge
#ERROR: error message
SETTING:DATA:SEND?#
Description:
Query state for sending data automatically with test finished event
Return value:
State for sending data automatically with test finished event
Example:
SETTING:DATA:SEND?
Return value example:
ON
OFF
SITE:SET#
Description:
Set current site coordinates that are used to store the measured data.
Parameters:
- Site Row: integer, e.g. 42
- Site Column: integer, e.g. 42
- Sub Site Index: integer, e.g. 42
- Sub Site Label: string, e.g. ABC (can be empty)
Return value:
Acknowledge event or error message
Example:
SITE:SET 5,7,1,optional_label
Return value example:
#EVENT: Acknowledge
#ERROR: error message
SITE?#
Description:
Get current site coordinates that are used to store the measured data.
Return value:
Site info (row, column, sub site index) or error message
Example:
SITE?
Return value example:
5,7,1
#ERROR: error message
SORT:BIN?#
Description:
Query the last sorted bin. Return format is: bin number, bin description, is failure bin (0 or 1)
Return value:
Bin number,bin description,is failure bin or error message
Example:
SORT:BIN?
Return value example:
42,bin good,0
#ERROR: error message
SORT:STAT?#
Description:
Query the sorting statistic as XML without line feeds.
Return value:
sorting statistic as XML or error message
Example:
SORT:STAT?
Return value example:
<SortingStatistic> ... </SortingStatistic>
#ERROR: error message
START#
Description:
Start measurement
Return value:
Measurement started event or error message
Example:
START
Return value example:
#EVENT: MeasurementStarted
#ERROR: error message
START:APPEND#
Description:
Start measurement and append measurement data
Return value:
Measurement started event or error message
Example:
START:APPEND
Return value example:
#EVENT: MeasurementStarted
#ERROR: error message
STATE?#
Description:
Query measurement state
Return value:
Current measurement state: Idle or Running
Example:
STATE?
Return value example:
Running
#ERROR: error message
STOP#
Description:
Stop measurement
Return value:
Measurement finished event or error message
Example:
STOP
Return value example:
#EVENT: MeasurementFinished
#ERROR: error message
TEST:ACTIVE#
Description:
Activate or deactivate a test.
Parameters:
- Test name: string, e.g. ABC
- Test is active: State ON or OFF
Return value:
Acknowledge event or error message
Example:
TEST:ACTIVE test_1,ON
Return value example:
#EVENT: Acknowledge
#ERROR: error message
TEST:EXEC#
Description:
Start single test
Parameters:
- Test name: string, e.g. ABC
Return value:
Measurement started event or error message
Example:
TEST:EXEC test_1
Return value example:
#EVENT: MeasurementStarted
#ERROR: error message
TITLE#
Description:
Set additional program title.
Parameters:
- Title: string, e.g. ABC
Return value:
Acknowledge event or error message
Example:
TITLE Foo
Return value example:
#EVENT: Acknowledge
#ERROR: error message
VIEW:DEFAULT#
Description:
Set view settings to default values
Return value:
Acknowledge event or error message
Example:
VIEW:DEFAULT
Return value example:
#EVENT: Acknowledge
#ERROR: error message
VIEW:INFO#
Description:
Enable or disable info view update during measurement. (used to increase measurement speed)
Parameters:
- State: State ON or OFF
Return value:
Acknowledge event or error message
Example:
VIEW:INFO OFF
Return value example:
#EVENT: Acknowledge
#ERROR: error message
VIEW:TEST#
Description:
Enable or disable test view update during measurement. (used to increase measurement speed)
Parameters:
- State: State ON or OFF
Return value:
Acknowledge event or error message
Example:
VIEW:TEST OFF
Return value example:
#EVENT: Acknowledge
#ERROR: error message