ABB 接口程序指令说明
ABB 机器人程序调用说明：
-
程序的 形参列表 中各个 参数 之间以逗号分隔。
-
每个 形参变量 都定义为 局部变量 ，只在程序中有效。
-
程序的 形参列表 支持定义 输入参数 和 输出参数 。
-
调用程序时的实参：输入实参可以是常量、全局变量或局部变量，输出实参可以是全局变量，或局部变量。
|
本节将介绍以下指令。
初始化通信参数
该指令用于设置 TCP/IP 通信的主机IP地址、端口号，以及通信超时等待时间。在调用该指令后，调用建立TCP/IP通信连接指令可以建立机器人与视觉系统之间的TCP/IP通信连接。
建立TCP/IP通信连接
该指令用于建立机器人与视觉系统之间的TCP/IP通信连接。该指令需要在初始化通信参数指令之后被调用。
启动 Mech-Vision 工程
该指令用于只有 Mech-Vision 工程，没有 Mech-Viz 的场景。使用该指令触发 Mech-Vision 工程运行，执行相机拍照和视觉识别。
输入参数
Job
Mech-Vision 工程编号可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。
Pos_Num_Need
预期视觉点数量，即期望从 Mech-Vision 得到的视觉点数量。视觉点信息包括视觉位姿及对应点云、标签、缩放等。
-
0：从 Mech-Vision 工程取得识别结果中所有的视觉点。 -
大于0的整数：从 Mech-Vision 工程取得识别结果中指定数量的视觉点。-
如果视觉点总数小于该参数值，则取得识别结果中所有视觉点。
-
如果视觉点总数大于等于该参数值，则取得该参数指定数量的视觉点。
-
|
SendPos_Type
机器人位姿类型，该参数指定真实机器人的位姿将以何种形式传入 Mech-Vision。参数范围：0~3。
-
0：该指令不需向视觉系统传入机器人位姿。若工程为 Eye To Hand 模式，则拍照与机器人位姿无关，Mech-Vision 不需要机器人的位姿。 -
1：该指令以“机器人当前关节角+当前法兰”形式向视觉系统传入机器人位姿。若工程为 Eye In Hand 模式，则推荐使用该参数。在使用时，Mech-Vision 工程中存在的“路径规划”步骤将使用机器人发送关节角。如果法兰位姿为全零，则忽略法兰数据。 -
2：该指令以当前法兰位姿形式向视觉系统传入机器人位姿，适用于工程为 Eye In Hand 模式，且机器人无关节角数据，仅有法兰位姿数据（如桁架机器人）的场景中。 -
3：该指令以预定义关节角（读取用户设置的关节角变量）形式向视觉系统传入机器人位姿。若工程为 Eye To Hand 模式，则推荐使用该参数。在使用时，Mech-Vision 工程中存在的“路径规划”步骤将使用机器人发送的关节角作为初始位姿。
MM_J
用户自己定义的关节角。在 SendPos_Type 参数值为 3 时，该关节角数据将发送给 Mech-Vision 工程的“路径规划”步骤作为第一个路径点进行规划。若 SendPos_Type 参数值为 3 以外的其他参数值，此处的关节角无实际用处，但必须设定该关节角。
获取视觉目标点
用在“启动 Mech-Vision 工程”指令之后，使用该指令获取 Mech-Vision 的识别结果（视觉点）对应的机器人位姿及标签，机器人位姿形式为工具位姿（TCP）。
Mech-Center 会自动将视觉点信息转换为对应的机器人 TCP，其过程为：
-
将视觉点包含的位姿绕 X 轴旋转 180°。
-
识别对应机器人型号的参考坐标系定义是否涉及机器人基座高度，并相应增加垂直方向的偏置。
| 102 指令单次接收 TCP 数量上限默认为 20。如需要获取的 TCP 数量大于 20，需多次执行该指令来获取所有所需 TCP。 |
输出参数
Pos_Num
执行该指令获得的 TCP 数量。
-
如果请求 TCP 数量大于等于 Mech-Vision 识别的视觉点数量，按照 Mech-Vision 识别的视觉点数量发送。
-
如果请求 TCP 数量小于 Mech-Vision 识别视觉点数量，按照请求数量发送。
默认范围：0~20。
变量类型：num
MM_Status
若指令执行正常，则返回 1100 状态码；否则返回对应的错误码。
调用该指令时，若 Mech-Vision 结果还未返回，则视觉系统会等待 Mech-Vision 结果返回后再给机器人返回。默认等待 10 秒超时，若发生超时，返回超时错误状态码。
变量类型：num
启动 Mech-Viz 工程
用于既使用 Mech-Vision 又使用 Mech-Viz 的场景。该指令用于运行 Mech-Viz 工程，启动对应的 Mech-Vision 工程，Mech-Viz 基于 Mech-Vision 的视觉结果规划机器人的运动路径。
请在需要启动 Mech-Viz 工程中勾选 自动加载。
Mech-Vision和Mech-Viz软件安装目录下 Mech-Center/tool/viz_project 文件夹内有一些典型应用工程模板，用户可以在模板的基础上进行修改。
输入参数
SendPos_Type
机器人的位姿类型。参数范围：0~2。
0：无需向 Mech-Viz 传入机器人位姿，Mech-Viz 软件中仿真机器人将会从关节角 [0,0,0,0,0,0] 位置开始，运动到第一个路径点。
1：将机器人的当前关节角和法兰位姿传入 Mech-Viz，Mech-Viz 软件中仿真机器人将会从当前机器人关节角位置开始，运动到第一个路径点。
2：将机器人的一个预定义关节角传入 Mech-Viz，Mech-Viz 软件中仿真机器人将会从当前机器人关节变量设定的位置开始，运动到第一个路径点。
| 若场景中的碰撞模型干扰机器人从关节角 [0, 0, 0, 0, 0, 0] 移动到第一个路径点时，则位姿类型必须设置为 1。 |
MM_J
用户自定义的关节角数据。仅当 SendPos_Type 为 2 时，该关节角数据将发送给 Mech-Viz 作为第一个路径点进行规划；当 SendPos_Type 为其他值时，该关节角数据无实际意义，但必须设定其值。
获取 Mech-Viz 数据
该指令用于获取 Mech-Viz 规划的路径，需在执行“启动 Mech-Viz 工程”指令之后调用。使用该指令后，调用 转存获取的机器人工具位姿（TCP）数据 或 转存获取的关节角数据 才可访问位姿数据。
限制：默认设置下，该指令每次最多只能获取 20 个规划路径的路径点，所以该指令可能需要调用多次。
| 如果工程中某个移动类步骤的路径点不应发给机器人，请取消勾选该步骤参数中的“发送移动目标”选项。 |
输入参数
Jps_Pos
路径点的位姿类型，该参数用于指定 Mech-Viz 将返回何种形式的位姿。
-
1：路径点的位姿将以机器人关节角（JPs）的形式返回，调用 转存获取的关节角数据 后才可访问关节角数据。 -
2：路径点的位姿将以机器人工具位姿（TCP）的形式返回，调用 转存获取的机器人工具位姿（TCP）数据 后才可访问 TCP 位姿数据。
输出参数
Pos_Num
路径点数量。该参数用于显示此次执行该指令返回了多少路径路径点（[位姿、标签、速度]）。
如果路径中含有 20 个以上路径点，请多次执行该指令。
默认范围：0~20。
VisPos_Num
“视觉移动”步骤位置，即“视觉移动”步骤路径点在整个路径中的位置。“视觉移动”步骤即移动至视觉点（抓取物体的点）的移动步骤。
比如，如果规划路径由以下步骤组成：“定点移动_1”，“定点移动_2”，“视觉移动”，“定点移动_3”，则“视觉移动”步骤位置为3。
如果路径中无“视觉移动”步骤，则该参数值为 0。
MM_Status
状态码。
若指令执行正常，则返回 2100 状态码；否则返回对应的错误码。
| 调用该指令时，若 Mech-Viz 结果还未返回（正在运行中），视觉系统会等待 Mech-Viz 结果返回后再给机器人返回，默认等待 10s 超时，若发生超时，则给机器人返回超时错误。 |
转存获取的机器人工具位姿（TCP）数据
转存获取的关节角数据
切换 Mech-Vision 配方
选择 Mech-Viz 分支
设置移动索引
向 Mech-Vision 中传入物体尺寸
获取吸盘DO信号
该指令用于获取 Mech-Vision 或 Mech-Viz 规划的 DO 信号列表。机器人通过 MM_Set_DoList 将获取到的 DO 信号列表作用于末端工具。
设置吸盘DO信号
该指令用于将 Mech-Vision 或 Mech-Viz 软件返回的 DO 列表设置到 GO 信号中，最多支持4组 GO 信号，一组 GO 信号为 16 位。 如需设置多组 GO 信号，请多次使用此指令。
| 该指令需在 MM_Get_DoList 之后使用。 |
标定
获取 Mech-Vision 自定义数据
该指令用于从 Mech-Vision 中的“输出”步骤接收自定义数据，即除 poses 和 labels 之外其他端口的数据（“输出”步骤参数“端口类型”设置为“自定义”）。
该指令调用一次获取全部数据到机器人内存。
将 MM_GET_DY_DATA 获取的自定义数据分配至各变量中
该指令用于将一组自定义数据按指定索引从内存存放到不同变量中，在触发 获取 Mech-Vision 自定义数据 指令之后使用。
获取视觉移动规划数据或自定义数据
该指令用于获取Mech-Vision工程的视觉移动规划数据，或者获取Mech-Viz工程的视觉移动规划数据或自定义数据。 MM_Get_PlanPose或MM_Get_PlanJps可将获取的数据分配至各变量中。
输入参数
Resource
num类型变量。该参数指定视觉移动规划数据的来源。
-
0：从Mech-Viz获取视觉移动规划数据。
-
正整数：从Mech-Vision获取视觉移动规划数据。此处设置的正整数就是Mech-Vision工程编号。
Jps_Pos
num 类型变量。预期的返回数据格式。
-
当Resource为0时，Jps_Pos 参数取值范围为 1~4，具体说明如下。
Jps_Pos 参数值 预期的返回数据 说明（每个字段的具体解释参见下文） 1
位姿（JPs 形式）, 移动类型, 末端工具编号, 速度, 自定义数据项 1, …, 自定义数据项 N
2
位姿（TCP 形式）, 移动类型, 末端工具编号, 速度, 自定义数据项 1, …, 自定义数据项 N
3
位姿（JPs 形式）, 移动类型, 末端工具编号, 速度, Mech-Viz视觉移动规划数据, 自定义数据项 1, …, 自定义数据项 N
4
位姿（TCP 形式）, 移动类型, 末端工具编号, 速度, Mech-Viz视觉移动规划数据, 自定义数据项 1, …, 自定义数据项 N
-
当Resource为正整数时，Jps_Pos 参数取值范围为 1~2，具体说明如下。
Jps_Pos 参数值 预期的返回数据 说明（每个字段的具体解释参见下文） 1
位姿（JPs 形式）, 移动类型, 末端工具编号, 速度, Mech-Vision视觉移动规划数据
2
位姿（TCP 形式）, 移动类型, 末端工具编号, 速度, Mech-Vision视觉移动规划数据
位姿
路径点的位姿可以是机器人关节角（JPs，单位为度）或工具位姿（TCP，其中三维坐标单位为毫米，欧拉角单位为度），其形式取决于发送的指令参数。
移动类型
-
1：关节移动。
-
2：直线移动。
末端工具编号
路径点的末端工具编号。若值为-1，表示不使用末端工具。
速度
路径点的速度值。
视觉移动规划数据
Mech-Vision或Mech-Viz中“视觉移动”步骤规划的数据，包括被抓取工件的标签、已抓取的工件总数、本次抓取的工件数量、吸盘边角号、TCP偏移量、工件组朝向、单个工件朝向、工件组尺寸。
自定义数据项
当 Mech-Vision 工程中“输出”步骤的端口类型为“自定义”时，除 poses 和 labels 等之外其他自定义端口的数据。
各自定义数据按照端口名称的字母顺序（A—Z）排列。
将从MM_GET_PLANDATA获取的数据保存至各变量
该指令用在获取视觉移动规划数据或自定义数据指令后，用于将获取的数据存放到不同变量中。根据获取视觉移动规划数据或自定义数据指令中指定的Jps_Pos参数值，选择不同的程序。
程序
MM_Get_PlanPose Serial,Jps_Pos,MM_P,MM_MoveType,MM_ToolNum,MM_Speed; （当 Jps_Pos=2 或者 4 时）
MM_Get_PlanJps Serial,Jps_Pos,MM_J,MM_MoveType,MM_ToolNum,MM_Speed; （当 Jps_Pos=1 或者 3 时）输入参数
Serial
num 类型变量。指定获取全局数组中的第几组路径点数据（数据顺序按照 Mech-Viz 输出的路径点顺序排列）。
Jps_Pos
num 类型变量。需要与 MM_GET_PLANDATA 中的 Jps_Pos 所选值一致。
输出参数
MM_P
robtarget 类型变量。保存指定路径点对应的 TCP 数据（程序 1 使用）。
MM_J
Jointtarget 类型变量。保存指定路径点对应的关节角数据（程序 2 使用）。
MM_MoveType
num 类型变量。保存指定路径点对应的移动类型。
MM_ToolNum
num 类型变量。保存指定路径点对应的末端工具编号。
MM_Speed
num 类型变量。保存指定路径点对应的速度。
MM_UserData
已定义的全局数组变量（用户不需要传递该参数，直接读取该数组即可）。保存指定路径点对应的用户自定义数据。
MM_Plan_Results
已定义的全局数组变量（用户不需要传递该参数，直接读取该数组即可）。保存指定路径点对应的视觉移动规划数据。数组大小为21。
MM_Plan_Results数组变量的具体内容如下表所示。
| 数据 | 说明 | 变量 |
|---|---|---|
被抓取工件的标签 |
由10个整数组成，默认为10个0 |
MM_Plan_Results[1] ~ MM_Plan_Results[10] |
已抓取的工件总数 |
累计已抓取的工件数量 |
MM_Plan_Results[11] |
本次抓取的工件数量 |
本次抓取的工件数量 |
MM_Plan_Results[12] |
吸盘边角号 |
本次吸盘所使用的边角号 |
MM_Plan_Results[13] |
TCP偏移量 |
工件组中心相对于末端工具中心的XYZ偏移量 |
MM_Plan_Results[14] ~ MM_Plan_Results[16] |
工件组朝向 |
工件组与吸盘长边的朝向关系，0表示平行，1表示垂直 |
MM_Plan_Results[17] |
单个工件朝向 |
单个工件长边与吸盘长边的朝向关系，0表示平行，1表示垂直 |
MM_Plan_Results[18] |
工件组尺寸 |
本次抓取的工件组的长宽高 |
MM_Plan_Results[19] ~ MM_Plan_Results[21] |
示例
-
示例1：
MM_Get_PlanPose 2,4,P10,MoveType,ToolNum,Speed;该示例在 MM_GET_PLANDATA 运行后，将 Mech-Viz 规划的第二个路径点的 TCP 数据存放在 P10 变量中，移动类型、末端工具编号、速度分别存放在 MoveType、ToolNum、Speed 变量中。如果该路径点不是视觉移动路径点，则无后续信息；如果是视觉移动路径点，则将视觉移动规划数据保存到 MM_Plan_Results 全局数组中，将自定义数据保存到 MM_UserData 全局数组中。
-
示例2：
MM_Get_PlanJps 1,3,jpose1,MoveType,ToolNum,Speed;该示例在 MM_GET_PLANDATA 运行后，将 Mech-Viz 规划的第一个路径点的关节角数据存放在 jpose1 变量中，移动类型、末端工具编号、速度分别存放在 MoveType、ToolNum、Speed 变量中。如果该路径点不是视觉移动路径点，则无后续信息；如果是视觉移动路径点，则将视觉移动规划数据保存到 MM_Plan_Results 全局数组中， 将自定义数据保存到 MM_UserData 全局数组中。
获取 Mech-Vision “路径规划”步骤的结果
在启动 Mech-Vision 工程后，该指令用于获取 Mech-Vision 中“路径规划”步骤输出的免碰撞抓取路径。
在使用该指令时，Mech-Vision “输出”步骤的 端口类型 参数需要设置为“预定义（机器人路径）”。
输入参数
Job
num 类型变量。Mech-Vision 工程编号可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。
Jps_Pos
num 类型变量。指定“路径规划”步骤返回的路径点的位姿类型。
-
1：路径点的位姿将以机器人关节角（JPs）的形式返回。 -
2：路径点的位姿将以机器人工具位姿（TCP）的形式返回。
运行Mech-Vision工程并获取结果
该指令先设置Mech-Vision工程所使用的参数配方（工程中无参数配方，可跳过），然后触发Mech-Vision工程运行，最终返回视觉系统输出的结果（视觉点、路径点或自定义数据）。该指令相等于将 切换 Mech-Vision 配方、启动 Mech-Vision 工程、获取视觉目标点、获取 Mech-Vision “路径规划”步骤的结果 和 获取 Mech-Vision 自定义数据 指令合并。
| 该指令最多返回20个位姿数据。如果获取的位姿个数大于20，请勿使用该指令，而是使用 切换 Mech-Vision 配方、启动 Mech-Vision 工程、获取视觉目标点、获取 Mech-Vision “路径规划”步骤的结果 和 获取 Mech-Vision 自定义数据 指令。 |
输入参数
Job
num类型变量。Mech-Vision工程编号可在Mech-Vision工程列表窗口中查看，工程名称前的数字表示工程编号。
Model_Number
num类型变量。Mech-Vision工程中参数配方的编号，取值范围为0~99。0表示Mech-Vision工程不使用配方参数。
Recv_Data_Type
num类型变量。该参数用于指定视觉系统返回的数据类型，取值范围为1~4。
-
1：视觉系统返回视觉点（无自定义数据）。用户后续需调用MM_Get_Pose将视觉点的位姿保存至指定变量中。 -
2：视觉系统返回视觉点（携带自定义数据）。用户后续需调用MM_Get_DyPose将视觉点的自定义数据保存至指定变量中。 -
3：视觉系统返回路径点（位姿形式为关节角）。用户后续需调用MM_Get_Jps将路径点的位姿数据保存至指定变量中。 -
4：视觉系统返回路径点（位姿形式为TCP）。用户后续需调用MM_Get_Pose将路径点的位姿数据保存至指定变量中。
运行Mech-Viz工程并获取规划路径
该指令先触发Mech-Viz工程运行，然后设置消息分支出口（工程中无分支，可跳过），最后返回Mech-Viz工程规划的移动路径。该指令相等于将 启动 Mech-Viz 工程、选择 Mech-Viz 分支 和 获取 Mech-Viz 数据 指令合并。
| 该指令最多返回20个位姿数据。如果获取的位姿个数大于20，请勿使用该指令，而是使用 启动 Mech-Viz 工程、选择 Mech-Viz 分支 和 获取 Mech-Viz 数据 指令。 |
输入参数
Branch_Num
num类型变量。该参数用于指定消息分支的步骤编号，取值范围为0~99。0表示Mech-Viz工程不使用“消息分支”步骤。
Export_Num
num类型变量。该参数用于指定“消息分支”步骤的出口号，其值为正整数。若将该参数值设置为N，则Mech-Viz工程将沿“消息分支”步骤的N-1出口继续执行。
Recv_Data_Type
num类型变量。该参数用于指定视觉系统返回的数据类型，取值范围为1~2。
-
1：视觉系统返回路径点（位姿形式为关节角）。用户后续需调用MM_Get_Jps将路径点的位姿数据保存至指定变量中。 -
2：视觉系统返回路径点（位姿形式为TCP）。用户后续需调用MM_Get_Pose将路径点的位姿数据保存至指定变量中。
读取Mech-Viz步骤参数值
该指令用于读取Mech-Viz工程中指定的步骤参数值。
输入参数
Get_Id
该参数为property_config文件中指定的 配置编号 字段。
|
在Mech-Vision工具栏的 下，单击 属性配置，即可打开property_config文件。 
|
在使用该指令前，用户需提前在property_config文件中指定步骤编号和参数名称对应的key名称，具体格式如下所示。
read, 配置编号, 步骤编号, key名称
read |
指定该行用于读取步骤参数值。 |
配置编号 |
指定一个唯一的编号，为正整数。一个配置编号只能用于读取一个步骤参数值。如果读取多个步骤参数值，请使用不同的配置编号。 |
步骤编号 |
指定将要读取的参数所属步骤的编号。 |
key名称 |
指定将要读取的参数名称对应的key名称。 |
|
|
property_config文件中可以设置多条read指令，但每条read指令的配置编号必须唯一。 |
设置Mech-Viz步骤参数值
该指令用于设置Mech-Viz工程中指定的步骤参数值。
输入参数
Set_Id
该参数为property_config文件中指定的 配置编号 字段。
|
在Mech-Vision工具栏的 下，单击 属性配置，即可打开property_config文件。
|
在使用该指令前，用户需提前在property_config文件中指定步骤编号、参数名称对应的key名称和参数值，具体格式如下所示。
write, 配置编号, 步骤编号, key名称, 参数值
write |
指定该行用于设置步骤参数值。 |
配置编号 |
指定一个编号（非唯一），为正整数。 |
步骤编号 |
指定将要设置的参数所属步骤的编号。 |
key名称 |
指定将要设置的参数名称对应的key名称。 |
参数值 |
指定将要设置的参数值。 |
|
示例
例如，property_config文件内容如下，1表示配置编号，3表示步骤编号，xOffset、yOffset和zOffset表示key名称，10表示xOffset对应的参数值，20表示yOffset对应的参数值，30表示zOffset对应的参数值。
write, 1, 3, xOffset, 10
write, 1, 3, yOffset, 20
write, 1, 3, zOffset, 30机器人发送如下指令后，Mech-Viz会将xOffset、yOffset和zOffset对应的参数值分别设置为10、20和30。
MM_Set_Property 1,MM_Status;该示例表示将xOffset、yOffset和zOffset对应的参数值分别设置为10、20和30，并将返回的状态码保存在MM_Status变量中。