TCP ASCII 通信指令
使用TCP ASCII通信时,外部设备应使用以下几类指令触发Mech-MSR工程运行和获取相应结果。
-
trigger指令:用于触发工程运行。
-
return指令:用于获取指定工程的判定结果和测量结果。
-
execute指令:用于触发工程运行并获取工程的判定结果和测量结果。
-
judge指令:用于获取指定工程的整体质量判定结果或单个测量项的质量判定结果。
-
value指令:主要用于获取指定工程的测量值。
-
recipe指令:用于切换指定工程的参数配方。
-
solution指令:用于切换方案。
-
SetNumVar指令:用于给数值类型的全局变量设置值。
-
SetStrVar指令:用于给字符串类型的全局变量设置值。
-
GetNumVar指令:用于读取数值类型全局变量的值。
-
GetStrVar指令:用于读取字符串类型全局变量的值。
|
trigger指令
trigger指令用于触发Mech-MSR工程运行,支持同时触发多个工程。
第二步:发送指令
发送的trigger指令由trigger、工程编号、字符串分隔符三部分组成。
-
trigger:准确指令名称,不可更改大小写。
-
工程编号:需触发的工程在Mech-MSR方案中的编号。
-
字符串分隔符:即分隔trigger和工程编号的符号,默认为英文逗号(,)。可在Mech-MSR的通信配置窗口其他数据格式参数下更改字符串分隔符。
trigger指令的发送格式及示例描述如下表所示。
| 指令格式 | 描述 | 示例 |
|---|---|---|
|
触发一个工程运行。 |
触发编号为1的工程运行:
|
|
触发多个工程运行。 |
触发编号分别为1、2、3的工程运行:
|
return指令
发送trigger指令触发工程运行后,使用return指令获取该工程的运行结果。return指令每次只能获取一个Mech-MSR工程的结果。
第二步:发送指令
发送的return指令由return、工程编号、字符串分隔符三部分组成。
-
return:准确指令名称,不可更改大小写。
-
工程编号:使用trigger指令触发过的工程在Mech-MSR方案中的编号。
-
字符串分隔符:即分隔return和工程编号的符号,默认为英文逗号(,)。
return指令的发送格式及示例描述如下表所示。
| 指令格式 | 描述 | 示例 |
|---|---|---|
|
获取工程运行结果。 |
获取编号为1的工程的运行结果:
|
确保指定的工程需已通过trigger指令触发运行,否则发送return指令后无法正常获取结果。
|
第三步:查看返回结果
以工程编号1为例,外部设备发送return, 1指令后,Mech-MSR将根据通信配置窗口中设置的Return指令数据格式返回结果。
指令执行失败时,会返回错误状态码。查看错误状态码说明了解可能原因和解决方案。
| Return指令数据格式 | 返回结果(示例) | 说明 |
|---|---|---|
|
|
表示工程1的总体质量判定结果为OK。 |
|
|
表示工程1的总体质量判定结果为NG。 |
|
|
表示工程1的总体质量判定结果为OK,且该工程仅指定输出两个测量项,按顺序第一个测量项的值为0.0224,判定为OK,第二个测量项的值为54.0000,判定为NG。 |
|
表示工程1的总体质量判定结果为NG,且该工程仅指定输出一个测量项,测量项无测量结果,返回为invalid(无效值),测量项被判定为NG。 |
|
|
|
表示工程1的总体质量判定结果为OK,测量项2的值和判定结果均无效。 可能原因:
解决方案:
|
|
查看测量值和判定结果了解Mech-MSR返回结果到外部设备的基本条件。 |
execute指令
execute指令结合了trigger和return两个指令的功能,可用于触发工程运行并获取工程的判定结果和测量结果。
第一步:发送指令
发送的execute指令由execute、工程编号、字符串分隔符三部分组成。
-
execute:准确指令名称,不可更改大小写。
-
工程编号:待触发工程在 Mech-MSR 方案中的编号。
-
字符串分隔符:即分隔execute和工程编号的符号,默认为英文逗号(,)。
execute指令的发送格式及示例描述如下表所示。
| 指令格式 | 描述 | 示例 |
|---|---|---|
|
用于触发工程运行并获取工程的判定结果和测量结果。 |
触发编号为1的工程运行,并获取工程的判定结果和测量结果:
|
| execute指令(指令码1)仅可用于触发一个工程运行并获取判定和测量结果。 |
第二步:查看返回结果
以工程编号1为例,外部设备发送execute, 1指令后,Mech-MSR将根据通信配置窗口中设置的Return指令数据格式返回结果。详情可参见return指令返回结果。
指令执行失败时,会返回错误状态码。查看错误状态码说明了解可能原因和解决方案。
judge指令
发送trigger指令触发工程运行后,judge指令用于获取指定Mech-MSR工程的整体或单个测量项的判定结果。
第一步:发送指令
发送的judge指令由judge、工程编号、字符串分隔符三部分组成。
-
judge:准确指令名称,不可更改大小写。
-
工程编号:使用trigger指令触发过的工程在Mech-MSR方案中的编号。
-
字符串分隔符:即分隔judge和工程编号的符号,默认为英文逗号(,)。
judge指令的发送格式及示例描述如下表所示。
| 指令格式 | 描述 | 示例 |
|---|---|---|
|
用于获取指定工程的整体质量判定结果和单个测量项的判定结果。 |
获取编号为1的工程的整体判定结果和单个测量项的判定结果:
|
value指令
发送trigger指令触发工程运行后,value指令用于获取指定工程的测量值。
第一步:发送指令
发送的value指令由value、工程编号、字符串分隔符三部分组成。
-
value:准确指令名称,不可更改大小写。
-
工程编号:使用trigger指令触发过的工程在Mech-MSR方案中的编号。
-
字符串分隔符:即分隔value和工程编号的符号,默认为英文逗号(,)。
value指令的发送格式及示例描述如下表所示。
| 指令格式 | 描述 | 示例 |
|---|---|---|
|
用于获取指定工程的测量值。 |
获取编号为1的工程的测量值:
|
第二步:查看返回结果
指令执行失败时,会返回错误状态码。查看错误状态码说明了解可能原因和解决方案。
| 返回结果 | 说明 |
|---|---|
(示例) |
1表示工程1的整体判定结果为OK,且测量项1的值为54.000,该工程仅指定输出一个测量项。 |
(示例) |
0表示工程1的整体判定结果为NG,且测量项1的值为54.0000,该工程仅指定输出一个测量项。 |
(示例) |
0表示工程1的整体判定结果为NG。该工程仅指定输出一个测量项,但测量项无对应测量结果,返回为invalid(无效值)。 可能原因:该测量项无测量结果。 解决方案:请检查该测量项,确保工程运行后能输出该测量项的有效结果。 |
|
查看测量值和判定结果了解Mech-MSR返回结果到外部设备的基本条件。 |
recipe指令
recipe指令用于切换工程使用的参数配方。查看参数配方,了解如何配置工程的参数配方和查看参数配方编号。
solution指令
solution指令用于切换方案。
第一步:发送指令
发送的solution指令由solution、方案ID、字符串分隔符三部分组成。
-
solution:准确指令名称,不可更改大小写。
-
方案ID:待切换的方案ID。查看调整方案编号了解如何查看和调整方案ID。
-
字符串分隔符:即分隔solution和方案ID的符号,默认为英文逗号(,)。
solution指令的发送格式及示例描述如下表所示。
| 指令格式 | 描述 | 示例 |
|---|---|---|
|
用于切换方案。 |
切换至ID为1的方案:
|
SetNumVar指令
SetNumVar指令用于给数值类型的全局变量设置值。
全局变量是在当前方案下可跨工程共用的变量。查看全局变量管理器,了解如何配置全局变量和查看全局变量编号。
SetStrVar指令
SetStrVar指令用于给字符串类型的全局变量设置值。
全局变量是在当前方案下可跨工程共用的变量。查看全局变量管理器,了解如何配置全局变量和查看全局变量编号。
第一步:发送指令
发送的SetStrVar指令由SetStrVar、全局变量编号、全局变量值、字符串分隔符四部分组成。
-
SetStrVar:准确指令名称,不可更改大小写。
-
全局变量编号:待设置值的字符串类型全局变量编号。
-
全局变量值:待设置的全局变量值。
-
字符串分隔符:即分隔SetStrVar、全局变量编号和全局变量值的符号,默认为英文逗号(,)。
SetStrVar指令的发送格式及示例描述如下表所示。
| 指令格式 | 描述 | 示例 |
|---|---|---|
|
用于给指定字符串类型全局变量设置值。 |
将编号为1的字符串类型全局变量设置为
|
GetNumVar指令
GetNumVar指令用于读取数值类型全局变量的值。
全局变量是在当前方案下可跨工程共用的变量。查看全局变量管理器,了解如何配置全局变量和查看全局变量编号。
GetStrVar指令
GetStrVar指令用于读取字符串类型全局变量的值。
全局变量是在当前方案下可跨工程共用的变量。查看全局变量管理器,了解如何配置全局变量和查看全局变量编号。