KUKA标准接口指令
本文介绍KUKA机器人与梅卡曼德在线测量系统之间进行TCP协议通信的标准接口指令。其中，机器人（客户端）发送指令给梅卡曼德在线测量系统（服务端），梅卡曼德在线测量系统将处理后的数据返回给机器人。
指令总览
| 指令名 | 是否必须调用 | 描述 |
|---|---|---|
是 |
设置与机器人通信的工控机IP地址、端口号，以及通信超时等待时间。 |
|
否 |
机器人告知Mech-Metrics开始切换工程。 |
|
是 |
机器人告知Mech-Metrics开始测量新工件，并将工件名称，工件SN，以及其他工件信息发送给Mech-Metrics。 |
|
是 |
触发对应测量特征的Mech-MSR工程运行。如需进行多次测量，可调用本指令多次。 |
|
是 |
机器人告知Mech-Metrics结束测量，询问工件测量结果。 |
|
否 |
部分场景中工件SN码无法在测量开始时获得，例如需要在测量过程中扫码获得。本指令用于在工件测量过程中传入工件SN。 |
|
否 |
通过传入工件SN，将Mech-Metrics软件主界面切换为对应工件的数据视图。 |
|
是（自动标定程序） |
用于机器人的手眼标定（外参标定） |
注意事项
在开始前，请注意以下事项：
-
KUKA机器人指令调用说明：
-
指令的形参列表中各个参数间以英文逗号分隔。
-
每个形参变量都定义为局部变量，只在指令中有效。
-
指令的形参列表支持定义输入参数和输出参数。
-
对于KUKA机器人，除初始化通信）外，其他指令内部已包含建立和断开TCP协议通信连接的逻辑，会在执行前后自动建立和断开连接。
-
-
指令的数据单位：
-
关节角的单位是度（°）。
-
机器人法兰位姿或机器人工具位姿由位置和姿态组成，位置（XYZ坐标值）单位为毫米（mm）；姿态使用欧拉角表示，单位为度（°）。
-
初始化通信
该指令用于建立在线测量系统与机器人之间的TCP协议通信连接。
指令格式
MM_Init_Socket(XML_Name,Alive_Flag,Recv_Flag,Time_Out)输入参数
XML_Name该参数表示网络配置文件名，使用字符串表示，且区分大小写。此处网络配置文件指XML_Kuka_MSR.xml。该文件已在通信配置时烧录至机器人中，文件的具体内容如下。
<ETHERNETKRL>
<CONFIGURATION>
<EXTERNAL>
<IP>192.168.174.1</IP>
<PORT>4000</PORT>
</EXTERNAL>
<INTERNAL>
<ALIVE Set_Flag="20"/>
<BUFFERING Mode="FIFO" Limit="256"/>
<BUFFSIZE Limit="65534"/>
<TIMEOUT Connect="2000" Receive="5000"/>
<MESSAGES Display="enable" Logging="warning"/>
</INTERNAL>
</CONFIGURATION>
<RECEIVE>
<RAW>
<ELEMENT Tag="Buffer" Type="STREAM" Set_Flag="30" EOS="13,10|13|10"/>
</RAW>
</RECEIVE>
</ETHERNETKRL>在此文件中，用户需确保<IP>中的值为工控机的IP地址，<PORT>中的值为机器人通信配置（在Mech-MSR软件的工具栏中）中设置的主机端口号。
Alive_Flag该参数表示XML_Kuka_MSR.xml文件中<ALIVE>中Set_Flag值。以上述文件为例，则该参数值应设置为20。该参数值对应的信号为ON，表示在线测量系统与机器人通信成功。
Recv_Flag该参数表示XML_Kuka_MSR.xml文件中<RECEIVE>中Set_Flag值。以上述文件为例，则该参数值应设置为30。该参数值对应的信号为ON，表示机器人接收到在线测量系统发送的数据。
Time_Out该参数表示通信超时等待时间，单位为秒。
示例
MM_Init_Socket("XML_Kuka_MSR",20,30,60)上述示例表示，根据XML_Kuka_MSR.xml文件中的配置信息，建立在线测量系统与机器人之间的TCP协议通信连接。
切换工程
机器人告知Mech-Metrics开始切换工程。
调用时机
开始切换工程前。
指令格式
MSR_SW_PROJ(Robot_Id:IN,Job:IN,MSR_Status:OUT)输入参数
Robot_Id该参数表示工件编号。工件编号为1到99之间的整数。指定的工件编号必须已经在配置工件编号界面配置。数据类型为num。
Job该参数表示工程编号。指定的工程编号必须已经通过工程切换规则配置。数据类型为num。
输出参数
MSR_Status该参数用于保存指令状态码。
8105：指令执行成功。
-99：机器人通信异常。
示例
MSR_SW_PROJ(1,1,MSR_Status)上述示例表示，切换到工件编号为1，工程编号为1的工程，保存指令状态码至MSR_Status中。
开始测量任务
机器人告知Mech-Metrics开始测量新工件，并将工件名称，工件SN，以及其他工件信息发送给Mech-Metrics。
调用时机
新工件测量开始时。
指令格式
MSR_Start_Measure(RobotID:IN,Piece_Name:IN,Piece_SN:IN,Qc_Mode:IN,Custom_int1:IN,Custom_int2:IN,Custom_int3:IN,Custom_int4:IN,Custom_int5:IN,Custom_int6:IN,Custom_int7:IN,Custom_int8:IN,MSR_Continuous_Mode:OUT,MSR_Status:OUT)输入参数
RobotID该参数表示工件编号。工件编号为1到99之间的整数。指定的工件编号必须已经在配置工件编号界面配置。数据类型为num。
Piece_Name该参数表示需测量的工件的名称。工件名可包括字母和数字，长度不超过20字符。数据类型为string。
Piece_SN该参数表示工件SN。工件SN又称工件序列号或工件ID，是该工件的唯一标识。工件SN可包括字母和数字，长度不超过30字符。数据类型为string。
Qc_Mode该参数表示工件的质量检测模式。数据类型为num。各参数值含义如下：
-
1：全检。
-
2：半检。
-
其他：使用现有设置。
Custom_int1-Custom_int8该参数为可选参数，用于提供工件的自定义信息。数据类型为num。自定义参数仅在需要为Mech-Metrics提供更多工件信息时使用。本指令最多支持8个自定义参数，每个自定义参数的值为1到8之间的整数。
如需使用自定义参数：
-
在Mech-Metrics软件配置界面上方功能区选择，为指定自定义参数（例如自定义参数1）配置其参数值（1到8）的含义。
-
在该指令中设置指定自定义参数。
输出参数
MSR_Continuous_Mode该参数代表此次运行是连续运行还是单次运行。数据类型为num。
0：单次运行。
1：连续运行。
如指定的是单次运行，机器人端单次执行如下指令：开始测量任务→运行特征测量→结束测量任务。如需测量多个特征，请运行多次运行特征测量指令。例如，用户需测量两个特征，则单次运行时，需在机器人端单次执行如下指令：程序开始→开始测量任务→运行特征测量→运行特征测量→结束测量任务→程序结束。
|
MSR_Status该参数用于保存指令状态码。
8100：指令运行成功。
-99：机器人通信异常。
示例
MSR_Start_Measure(1,"zcl","ABC",2,10,20,30,40,50,60,70,80,MSR_Continuous_Mode,MSR_Status)上述示例表示，开始对工件编号为1、名称为zcl、SN码为ABC的工件进行测量，并指定8个自定义参数。
运行特征测量
触发对应测量特征的Mech-MSR工程运行。
调用时机
机器人到达测量特征拍照位置。
指令格式
MSR_Measure_Feature("RobotID:IN","Index_Num:IN","MSR_Status:OUT")输入参数
RobotID该参数表示工件编号。工件编号为1到99之间的整数。指定的工件编号必须已经在配置工件编号界面配置。数据类型为num。
Index_Num该参数表示待测量特征的测量编号。数据类型为num。测量编号为该特征的唯一标识。测量特征编号为1到999之间的整数。
输出参数
MSR_Status该参数用于保存指令状态码。
8101：指令执行成功。
-99：机器人通信异常。
示例
MSR_Measure_Feature(1,1,MSR_Status)该示例表示，机器人侧将触发工件编号1、测量特征的测量编号为1的Mech-MSR工程运行，保存状态码至MSR_Status。
结束测量任务
机器人告知Mech-Metrics结束测量，询问工件测量结果。
调用时机
最后一个测量特征拍照完成，工件测量完成。
指令格式
MSR_End_Measure(Robot_ID:IN,Judge:OUT,Failed_Count[]:OUT,MSR_Status:OUT)输入参数
Robot_ID该参数表示工件编号。工件编号为1到99之间的整数。指定的工件编号必须已经在配置工件编号界面配置。数据类型为num。
输出参数
Judge该参数保存工件判定结果。1表示OK，0表示NG。数据类型为num。
Failed_Count[]该参数表示数值寄存器编号，用于保存工件的测量项数量。数据类型为num。具体如下：
-
Failed_Count[1]保存工件超出一级公差带的测量项数量。
-
Failed_Count[2]保存工件超出二级公差带的测量项数量。
-
Failed_Count[3]保存工件超出三级公差带的测量项数量。
MSR_Status该参数用于保存指令状态码。
8102：指令执行成功。
-99：机器人通信异常。
示例
MSR_End_Measure(1,MSR_Judge,Failed_Count[],MSR_Status)上述示例表示，机器人告知Mech-Metrics结束测量（工件编号为1），同时保存工件的判定结果于Measure_Result，保存测量项数量于Failed_Count[]，保存指令状态码至MSR_Status。
测量中传入工件SN
部分场景中工件SN码无法在测量开始时获得，例如需要在测量过程中扫码获得。本指令用于在工件测量过程中传入工件SN。
调用时机
当前工件测量过程中任意时机。
指令格式
MSR_Set_Piece_Info(Robot_Id:IN,Piece_Sn:IN,MSR_Status:OUT)输入参数
Robot_Id该参数表示工件编号。工件编号为1到99之间的整数。指定的工件编号必须已经在配置工件编号界面配置。数据类型为num。
Piece_Sn该参数表示工件SN。工件SN又称工件序列号或工件ID，是该工件的唯一标识。工件SN可包括字母和数字，长度不超过30字符。数据类型为string。
输出参数
MSR_Status该参数用于保存指令状态码。
8103：指令执行成功。
-99：机器人通信异常。
示例
MSR_Set_Piece_Info(1,"ert",MSR_Status)该示例表示，机器人向Mech-Metrics中传入SN码为ert的工件（工件编号为1）。
查询工件历史数据
通过外部传入工件SN，将Mech-Metrics软件主界面切换为传入编号的工件。
调用时机
非测量中任意时刻。
指令格式
MSR_View_Piece_Data(Robot_Id,Piece_Sn:IN,MSR_Status:OUT)输入参数
Robot_Id该参数表示工件编号。工件编号为1到99之间的整数。数据类型为num。
Piece_Sn该参数表示工件SN。工件SN又称工件序列号或工件ID，是该工件的唯一标识。工件SN可包括字母和数字，长度不超过30字符。数据类型为string。
输出参数
MSR_Status该参数用于保存指令状态码。
8104：指令执行成功。
-99：机器人通信异常。
示例
MSR_View_Piece_Data(1,"ert",MSR_Status)上述示例表示，机器人将工件SN传入Mech-Metrics（工件编号为1），并将Mech-Metrics软件主界面切换至该工件的数据视图，保存指令状态码至MSR_Status。
标定
该指令用于机器人的手眼标定（外参标定）。该指令需要与Mech-MSR相机菜单栏中的3D相机标定工具结合使用。
调用顺序
在正式测量前，需要调用该指令进行机器人的手眼标定。
指令格式
MM_Calib(Move_Type,PosJps,WaitTime,E1)输入参数
{Move_Type}
该参数表示机器人移动类型，取值为1或2。
-
1：直线移动。
-
2：关节移动。
{Pos_Jps}
该参数用于指定标定点的位姿形式，取值为1或2。
-
1：工具位姿。
-
2：关节角。
{Wait_time}
该参数表示机器人移动到标定点后的等待时间（防止机器人发生抖动），单位为秒，默认为2秒。数据类型为num。
{Ext}
该参数表示外部轴数据，单位为毫米。若现场有第7轴导轨，且机器人控制导轨运动，则该参数需设置为具体外部轴数据，否则该参数需设置为0。
输出参数
TOP_Status
用于保存指令状态码。
示例
MM_Calib(2,1,2,0)上述示例表示，标定点的位姿形式为工具位姿，机器人按关节角形式移动到标定点后的等待时间为2秒。