KUKA （库卡）接口程序指令说明

您正在查看旧版本的文档。点击页面右上角可切换到最新版本的文档。

KUKA 机器人子程序调用说明：

子程序的 形参列表 中各个参数之间以逗号分隔；
每个 形参变量 都定义为 局部变量 ，只在程序中有效；
子程序的 形参列表 支持定义 输入参数 和 输出参数 。

本章将介绍以下指令。

初始化通信参数

该子程序用于设置 TCP/IP 通信的 XML 网络配置文件名，通信成功的 FLAG 号，接收数据成功的 FLAG 号，以及通信超时等待时间。

子程序

MM_Init_Socket(XML_Name[]:IN,Alive_Flag:IN,Recv_Flag:IN,Time_Out:IN)

参数说明

参数	描述
输入参数
XML_Name[]	XML文件名；字符串区分大小写。
Alive_Flag	XML中Alive Flag号；Flag置 ON 表示通信连接成功。
Recv_Flag	XML中 Receive Flag号；Flag置 ON 表示接收到数据。
Time_Out	等待时间；单位为 s 。

参数

描述

输入参数

XML_Name[]

XML文件名；字符串区分大小写。

Alive_Flag

XML中Alive Flag号；Flag置 ON 表示通信连接成功。

Recv_Flag

XML中 Receive Flag号；Flag置 ON 表示接收到数据。

Time_Out

等待时间；单位为 s 。

示例

MM_Init_Socket(“XML_Kuka_MMIND”,873,871,60)

该示例指定网络配置文件名为：“XML_Kuka_MMIND”，XML 文件中是否通信成功的 FLAG 号为 873，XML 文件是否接收到数据的 FLAG 号为 871，超时时间为 60s 。

启动 Mech-Vision 工程

该子程序用于触发 Mech-Vision 工程的运行，执行相机拍照和视觉处理。用于只使用 Mech-Vision 而不使用 Mech-Viz 的场景。

子程序

MM_Start_Vis(Job:IN,Pos_Num_Need:IN,SendPos_Type:IN,MM_J:IN)

参数说明

参数描述

参数	描述
输入参数
Job	Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。
Pos_Num_Need	预期视觉点数量，即期望从 Mech-Vision 得到的视觉点数量。可设置范围 [0~20]，0 表示获取所有。
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	E6AXIS 类型变量，用于保存机器人预定义的关节角数据，仅当 SendPos_Type=3 时才会使用此关节角数据。

输入参数

Job

Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。

Pos_Num_Need

预期视觉点数量，即期望从 Mech-Vision 得到的视觉点数量。可设置范围 [0~20]，0 表示获取所有。

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

E6AXIS 类型变量，用于保存机器人预定义的关节角数据，仅当 SendPos_Type=3 时才会使用此关节角数据。

示例

MM_Start_Vis(1,1,1,MM_J)

该示例触发 Mech-Vision 工程 1 的运行，希望 Mech-Vision 工程 1 返回 1 个视觉结果，机器人将当前关节角和法兰数据传入 Mech-Vision。

获取视觉目标点

用于只有 Mech-Vision，不用 Mech-Viz 的场景。该指令用于在启动 Mech-Vision 之后，获取视觉识别结果。

子程序

MM_Get_VisData(Job:IN,Pos_Num:OUT,MM_Status:OUT)

参数说明

参数	描述
输入参数
Job	Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。
输出参数
Pos_Num	变量，用于保存返回的位姿数量。
MM_Status	变量，用于保存指令状态码，具体可参考《标准接口状态码及错误排查》。

参数

描述

输入参数

Job

Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。

输出参数

Pos_Num

变量，用于保存返回的位姿数量。

MM_Status

变量，用于保存指令状态码，具体可参考《标准接口状态码及错误排查》。

示例

MM_Get_VisData(1,Pose_Num,Status)

该示例用于获取 Mech-Vision 工程1的视觉结果。返回的视觉点数量保存在变量 Pos_Num 里，指令执行的状态码保存在变量 Status 里。

启动 Mech-Viz 工程

用于既有 Mech-Vision 又有 Mech-Viz 的场景。该指令用于启动 Mech-Viz 工程，调用相应的 Mech-Vision 工程，并规划抓取路径。

子程序

MM_Start_Viz(SendPos_Type:IN,MM_J:IN)

参数说明

参数描述

参数	描述
输入参数
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 软件中仿真机器人将会从当前机器人预定义关节角的位置开始，运动到第一个路径点。
MM_J	E6AXIS 类型变量，用于保存机器人预定义的关节角数据，仅当 SendPos_Type=2 时才会使用此关节角数据。

输入参数

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 软件中仿真机器人将会从当前机器人预定义关节角的位置开始，运动到第一个路径点。

MM_J

E6AXIS 类型变量，用于保存机器人预定义的关节角数据，仅当 SendPos_Type=2 时才会使用此关节角数据。

示例

MM_Start_Viz(1,MM_J)

该示例触发 Mech-Viz 工程运行，将当前机器人的关节角和法兰位姿传入 Mech-Viz。

获取 Mech-Viz 数据

用于获取 Mech-Viz 工程规划的抓取路径。

子程序

MM_Get_VizData(Jps_Pos:IN,Pos_Num:OUT,VisPos_Num:OUT,MM_Status:OUT)

参数说明

参数	描述
输入参数
Jps_Pos	要获取的路径上点的位姿类型。 1：Mech-Viz返回的位姿类型为机器人关节角。 2：Mech-Viz返回的位姿类型为机器人 TCP。
输出参数
Pos_Num	变量，用于保存接收到的位姿数量。
VisPos_Num	变量，用于保存第一个视觉移动在路径中的位置编号。例如路径是：定点移动-1，定点移动-2，视觉移动-1，定点移动-3，则视觉移动的位置是3。若路径中无视觉移动，则返回值为零。
MM_Status	变量，用于保存指令状态码，具体可参考《标准接口状态码及错误排查》。

参数

描述

输入参数

Jps_Pos

要获取的路径上点的位姿类型。
1：Mech-Viz返回的位姿类型为机器人关节角。
2：Mech-Viz返回的位姿类型为机器人 TCP。

输出参数

Pos_Num

变量，用于保存接收到的位姿数量。

VisPos_Num

变量，用于保存第一个视觉移动在路径中的位置编号。例如路径是：定点移动-1，定点移动-2，视觉移动-1，定点移动-3，则视觉移动的位置是3。若路径中无视觉移动，则返回值为零。

MM_Status

变量，用于保存指令状态码，具体可参考《标准接口状态码及错误排查》。

示例

MM_Get_VizData(2,Pose_Num,VisPos_Num,Status)

该示例用于接收 Mech-Viz 返回的机器人移动路径，移动点数据类型为 TCP，位姿的数量保存在变量 Pos_Num 中，视觉移动点在路径中的编号保存在变量 VisPos_Num 中，指令执行的状态码保存在变量 Status 中。

获取视觉点坐标值

用于将 Mech-Vision 返回的视觉结果或 Mech-Viz 返回的移动路径里的某个 TCP 数据转存到指定位姿变量中。

子程序

MM_Get_Pose(Serial:IN,MM_P:OUT,MM_Label:OUT,MM_Speed:OUT)

参数说明

参数	描述
输入参数
Serial	指定要转存的是第几个位姿。
输出参数
MM_P	位姿变量，用于保存指定的位姿数据。
MM_Label	变量，用于保存和指定位姿数据相对应的标签数据。
MM_Speed	变量，用于保存和指定位姿数据相对应的移动速度。

参数

描述

输入参数

Serial

指定要转存的是第几个位姿。

输出参数

MM_P

位姿变量，用于保存指定的位姿数据。

MM_Label

变量，用于保存和指定位姿数据相对应的标签数据。

MM_Speed

变量，用于保存和指定位姿数据相对应的移动速度。

示例

MM_Get_Pose(1,XP1,Label,Pose_Speed)

该示例用于将收到的第一个位姿点保存到位置变量 XP1 中，将标签保存到变量 Label 中，将移动速度保存到变量 Pose_Speed 中。

获取视觉点关节角（用 Mech-Viz 规划时有效）

用于将 Mech-Vision 返回的视觉结果或 Mech-Viz 返回的移动路径里的某个 JPS 关节角数据转存到指定位姿变量中。

子程序

MM_Get_Jps(Serial:IN,MM_J:OUT,MM_Label:OUT,MM_Speed:OUT)

参数说明

参数	描述
输入参数
Serial	指定要转存的是第几个位姿。
输出参数
MM_J	关节角变量，用于保存指定的关节角数据。
MM_Label	变量，用于保存和指定位姿数据相对应的标签数据。
MM_Speed	变量，用于保存和指定位姿数据相对应的移动速度。

参数

描述

输入参数

Serial

指定要转存的是第几个位姿。

输出参数

MM_J

关节角变量，用于保存指定的关节角数据。

MM_Label

变量，用于保存和指定位姿数据相对应的标签数据。

MM_Speed

变量，用于保存和指定位姿数据相对应的移动速度。

示例

MM_Get_Jps(1,JP1,Label,Pose_Speed)

该示例用于将收到的第一个位姿点保存到位置变量 JP1 中，将标签保存到变量 Label 中，将移动速度保存到变量 Pose_Speed 中。

切换 Mech-Vision 配方

Mech-Vision 的配方功能，用于不同工件识别时，修改 Mech-Vision 工程各模块的参数，包括图像匹配模板，ROI，置信阈值等。该指令需要在 MM_Start_Vis 程序之前使用。

子程序

MM_Switch_Model(Job:IN,Model_Number:IN)

参数说明

参数	描述
输入参数
Job	Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。
Model_Number	Mech-Vision 工程中配方模板的编号。编号范围[1-99] 。

参数

描述

输入参数

Job

Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。

Model_Number

Mech-Vision 工程中配方模板的编号。编号范围[1-99] 。

示例

MM_Switch_Model(2,2)

该示例会将 Mech-Vision 工程2的配方切换成配方2。

选择 Mech-Viz 分支

用于 Mech-Viz 工程中有 分支（按服务消息） 步骤时，控制 Mech-Viz 工程中的分支步骤由指定的端口输出。在调用该指令之前，需要先调用 MM_Start_Viz。Mech-Viz 运行到分支步骤会等待 203 指令发送该分支的分支出口。

子程序

MM_Set_Branch(Branch_Num:IN,Export_Num:IN)

参数说明

参数	描述
输入参数
Branch_Num	分支步骤编号，该参数应为正整数，即消息分支的步骤编号。步骤编号可在步骤参数中读取。
Export_Num	给定分支的出口号，Mech-Viz 工程将沿该出口继续执行。参数范围[1-99] 。

参数

描述

输入参数

Branch_Num

分支步骤编号，该参数应为正整数，即消息分支的步骤编号。步骤编号可在步骤参数中读取。

Export_Num

给定分支的出口号，Mech-Viz 工程将沿该出口继续执行。参数范围[1-99] 。

示例

MM_Set_Branch(1,3)

该示例会指定 Mech-Viz 工程执行遇到分支名称为1的步骤，走第3出口。

设置移动索引

包含索引参数的移动类步骤，比如按序列移动，按阵列移动，自定义垛型，预设垛型等。可以调用该指令设置索引类参数中的索引序号。在调用该指令之前，需要先执行 MM_Start_Viz。

子程序

MM_Set_Index(Skill_Num:IN,Index_Num:IN)

参数说明

参数	描述
输入参数
Skill_Num	移动索引步骤编号，该参数应为正整数。步骤编号可在步骤参数中读取。
Index_Num	下次执行此步骤时应设置的索引值。发送该指令时，Mech-Viz 中的当前索引值将变为该参数值减 1。当 Mech-Viz 工程运行到该指令指定的步骤时，Mech-Viz 中的当前索引值将增加 1，成为该参数的值。

参数

描述

输入参数

Skill_Num

移动索引步骤编号，该参数应为正整数。步骤编号可在步骤参数中读取。

Index_Num

下次执行此步骤时应设置的索引值。

发送该指令时，Mech-Viz 中的当前索引值将变为该参数值减 1。

当 Mech-Viz 工程运行到该指令指定的步骤时，Mech-Viz 中的当前索引值将增加 1，成为该参数的值。

示例

MM_Set_Index(2,10)

该示例设置 Mech-Viz 工程中的步骤名称 “2” 的当前索引值为 9。

获取软件状态

用于获取 Mech-Vision，Mech-Viz，Mech-Center 的软件运行状态。目前只支持检测 Mech-Vision 是否注册就绪。

子程序

MM_Get_Status(MM_Status:OUT)

参数说明

参数	描述
输出参数
MM_Status	变量，用于保存指令状态码，具体可参考《标准接口状态码及错误排查》。

参数

描述

输出参数

MM_Status

变量，用于保存指令状态码，具体可参考《标准接口状态码及错误排查》。

示例

MM_Get_Status(Status)

该示例将检查系统状态的状态码保存到变量 Status 中。

向 Mech-Vision 传入物体尺寸

Mech-Vision 工程中动态传入物体尺寸。需要在执行 MM_Start_Vis 之前调用。

子程序

MM_Set_BoxSize(Job:IN,Length:IN,Width:IN,Height:IN)

参数说明

参数	描述
输入参数
Job	Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。
Length	箱子长度，单位mm。
Width	箱子宽度，单位mm。
Height	箱子高度，单位mm。

参数

描述

输入参数

Job

Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。

Length

箱子长度，单位mm。

Width

箱子宽度，单位mm。

Height

箱子高度，单位mm。

示例

MM_Set_BoxSize(1,500,300,200)

该示例将设置 Mech-Vision 工程中的读取物体尺寸步骤的物体尺寸为 500 × 300 × 200mm。

获取吸盘DO信号

该指令用于获取Mech-Vision或Mech-Viz规划的吸盘DO信号。机器人通过MM_Set_DoList将获取的吸盘DO信号作用于末端工具。

子程序

MM_Get_DoList(Resource:IN)

参数说明

参数	描述
输入参数
Resource	该参数指定吸盘DO信号的来源。 0：从Mech-Viz获取吸盘DO信号。正整数：从Mech-Vision获取吸盘DO信号。此处设置的正整数就是Mech-Vision工程编号。

参数

描述

输入参数

Resource

该参数指定吸盘DO信号的来源。

0：从Mech-Viz获取吸盘DO信号。
正整数：从Mech-Vision获取吸盘DO信号。此处设置的正整数就是Mech-Vision工程编号。

示例

MM_Get_DoList(0)

该示例表示将从Mech-Viz获取的DO信号列表保存到Do_Port[i]数组内。

设置吸盘DO信号

该指令用于将机器人获取的吸盘DO信号作用于末端工具。

该指令需在 MM_Get_DoList 之后被调用。

子程序

MM_Set_DoList()

示例

MM_Get_DoList(0)
MM_Set_DoList()

该示例表示将从Mech-Viz获取的DO信号列表保存到Do_Port[i]数组内，然后将Do_Port[i]值写入到相应的DO信号里。

标定

该前台程序用于相机外参的自动标定。该程序配合 Mech-Vision 的相机标定工具，可以实现自动标定。

子程序

MM_CALIB(Move_Type:IN,PosJps:IN,WaitTime:IN,E1:IN)

参数说明

参数	描述
输入参数
Move_Type	移动方式；1为 MoveL ，2为 MoveJ 。
PosJps	使用坐标点位或关节角数据；1 为坐标点，2为关节角。
WaitTime	机器人移动到标定点后的等待时间（防止机器人发生抖动）；默认为 2 秒；单位为 s（秒）
E1	外部轴数据（当有7轴时）；单位为 mm。

参数

描述

输入参数

Move_Type

移动方式；1为 MoveL ，2为 MoveJ 。

PosJps

使用坐标点位或关节角数据；1 为坐标点，2为关节角。

WaitTime

机器人移动到标定点后的等待时间（防止机器人发生抖动）；默认为 2 秒；单位为 s（秒）

外部轴数据（当有7轴时）；单位为 mm。

示例

MM_CALIB(2,2,2,0)

该示例执行标定流程，机器人通过走关节的形式进行标定，接收的点位使用关节角的形式，机器人移动到标定点后的等待时间为 2 秒，没有外部轴。

获取 Mech-Vision 自定义数据

该指令用于从 Mech-Vision 中的“输出”步骤接收自定义数据，即除 poses 和 labels 之外其他端口的数据（“输出”步骤参数“端口类型”设置为“自定义”）。

子程序

MM_GET_DY_DATA(Job:IN,Pos_Num:OUT,MM_Status:OUT)

参数说明

参数	描述
输入参数
Job	Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。
输出参数
Pos_Num	INT 变量，用于保存返回的视觉点个数。
MM_Status	INT 变量，用于保存该指令返回的状态码。

参数

描述

输入参数

Job

Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。

输出参数

Pos_Num

INT 变量，用于保存返回的视觉点个数。

MM_Status

INT 变量，用于保存该指令返回的状态码。

示例

MM_GET_DY_DATA(1,Pose_Num,Status)

该示例表示接收 Mech-Vision 工程 1 的自定义输出结果，视觉点的数量保存在变量 Pose_Num 中，指令执行的状态码保存在变量 Status 中。

将获取的 Mech-Vision 自定义输出数据保存至变量

该指令用于将 Mech-Vision 返回的自定义输出数据结果转存到机器人指定的变量中，在触发获取 Mech-Vision 自定义数据指令之后使用。

子程序

MM_GET_DYPOSE(Serial:IN,MM_P:OUT,MM_Label:OUT)

参数说明

参数	描述
输入参数
Serial	指定获取第几个视觉点中的自定义数据。
输出参数
MM_P	位姿变量，用于保存指定视觉点的位姿数据。
MM_Label	REAL 变量，用于保存指定视觉点的标签数据。
MM_UserData	已定义的全局数组变量，用于保存指定视觉点的用户自定义数据，目前数组长度为 50。

参数

描述

输入参数

Serial

指定获取第几个视觉点中的自定义数据。

输出参数

MM_P

位姿变量，用于保存指定视觉点的位姿数据。

MM_Label

REAL 变量，用于保存指定视觉点的标签数据。

MM_UserData

已定义的全局数组变量，用于保存指定视觉点的用户自定义数据，目前数组长度为 50。

示例

MM_GET_DYPOSE(1,XP1,Label)

该示例表示将接收到的第一个视觉点的位姿数据保存到位置变量 XP1 中，将相应标签数据保存到变量 Label 中，将相应的自定义输出数据保存到数组变量 MM_UserData 中。

获取视觉移动规划数据或自定义数据

该指令用于获取Mech-Vision工程的视觉移动规划数据，或者获取Mech-Viz工程的视觉移动规划数据或自定义数据。MM_Get_PlanPose或MM_Get_PlanJps可将获取的数据分配至各变量中。

子程序

MM_GET_PLANDATA(Resource:IN,Jps_Pos:IN,Pos_Num:OUT,VisPos_Num:out,MM_Status:OUT)

参数说明

参数	描述
输入参数
Resource	该参数指定视觉移动规划数据的来源。 0：从Mech-Viz获取视觉移动规划数据。正整数：从Mech-Vision获取视觉移动规划数据。此处设置的正整数就是Mech-Vision工程编号。
Jps_Pos	预期的返回数据格式，详情参见以下说明。
输出参数
Pos_Num	变量，用于保存接收到的路径点个数。
VisPos_Num	变量，用于保存第一个视觉移动在规划路径中的位置编号。
MM_Status	变量，用于保存该指令返回的状态码。

参数

描述

输入参数

Resource

该参数指定视觉移动规划数据的来源。

0：从Mech-Viz获取视觉移动规划数据。
正整数：从Mech-Vision获取视觉移动规划数据。此处设置的正整数就是Mech-Vision工程编号。

Jps_Pos

预期的返回数据格式，详情参见以下说明。

输出参数

Pos_Num

变量，用于保存接收到的路径点个数。

VisPos_Num

变量，用于保存第一个视觉移动在规划路径中的位置编号。

MM_Status

变量，用于保存该指令返回的状态码。

当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_Pos 参数值

预期的返回数据 说明（每个字段的具体解释参见下文）

位姿（JPs 形式）, 移动类型, 末端工具编号, 速度, Mech-Vision视觉移动规划数据

位姿（TCP 形式）, 移动类型, 末端工具编号, 速度, Mech-Vision视觉移动规划数据

位姿

路径点的位姿可以是机器人关节角（JPs，单位为度）或工具位姿（TCP，其中三维坐标单位为毫米，欧拉角单位为度），其形式取决于发送的指令参数。

移动类型

1：关节移动。
2：直线移动。

末端工具编号

路径点的末端工具编号。若值为-1，表示不使用末端工具。

速度

路径点的速度值。

视觉移动规划数据

Mech-Vision或Mech-Viz中“视觉移动”步骤规划的数据，包括被抓取工件的标签、已抓取的工件总数、本次抓取的工件数量、吸盘边角号、TCP偏移量、工件组朝向、单个工件朝向、工件组尺寸。

自定义数据项

当 Mech-Vision 工程中“输出”步骤的端口类型为“自定义”时，除 poses 和 labels 等之外其他自定义端口的数据。各自定义数据按照端口名称的字母顺序（A—Z）排列。

示例

MM_GET_PLANDATA(0,2,Pose_Num,VisPos_Num,Status)

该示例表示接收 Mech-Viz 返回的路径规划，预期的返回数据格式参数为 2，路径点个数保存在变量 Pos_Num 中，视觉移动路径点在路径中的位置编号保存在变量 VisPos_Num 中，该指令执行的状态码保存在变量 Status 中。

将从MM_GET_PLANDATA获取的数据保存至各变量

该指令用在获取视觉移动规划数据或自定义数据指令后，用于将获取的数据存放到不同变量中。根据获取视觉移动规划数据或自定义数据指令中指定的Jps_Pos参数值，选择不同的程序。

子程序

MM_Get_PlanPose(Serial:IN,Jps_Pos:IN,MM_P:OUT,MM_MoveType:OUT,MM_ToolNum:OUT,MM_Speed:OUT)  （当 Jps_Pos=2 或者 4 时）
MM_Get_PlanJps(Serial:IN,Jps_Pos:IN,MM_J:OUT,MM_MoveType:OUT,MM_ToolNum:OUT,MM_Speed:OUT)  （当 Jps_Pos=1 或者 3 时）

参数说明

参数	描述
输入参数
Serial	指定要转存第几个路径点。
Jps_Pos	与获取视觉移动规划数据或自定义数据指令中的 Jps_Pos 所选值一致。
输出参数
MM_P	位姿变量，用于保存指定路径点对应的 TCP 数据。
MM_J	关节角变量，用于保存指定路径点对应的关节角数据。
MM_MoveType	变量，用于保存指定路径点对应的移动类型。1表示关节移动，2表示直线移动。
MM_ToolNum	变量，用于保存指定路径点对应的末端工具编号。若值为-1，表示不使用末端工具。
MM_Speed	变量，用于保存指定路径点对应的移动速度。
MM_UserData	已定义的全局数组变量，用于保存指定路径点对应的自定义输出数据。目前数组大小为 50。
MM_Plan_Results	已定义的全局数组变量，用于保存指定路径点对应的视觉移动规划数据。目前数组大小为 21。

参数

描述

输入参数

Serial

指定要转存第几个路径点。

Jps_Pos

与获取视觉移动规划数据或自定义数据指令中的 Jps_Pos 所选值一致。

输出参数

MM_P

位姿变量，用于保存指定路径点对应的 TCP 数据。

MM_J

关节角变量，用于保存指定路径点对应的关节角数据。

MM_MoveType

变量，用于保存指定路径点对应的移动类型。1表示关节移动，2表示直线移动。

MM_ToolNum

变量，用于保存指定路径点对应的末端工具编号。若值为-1，表示不使用末端工具。

MM_Speed

变量，用于保存指定路径点对应的移动速度。

MM_UserData

已定义的全局数组变量，用于保存指定路径点对应的自定义输出数据。目前数组大小为 50。

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]

数据

说明

变量

被抓取工件的标签

由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(1,4,XP1,MoveType,ToolNum,Pose_Speed)
```
该示例表示将收到的第一个路径点的 TCP 数据保存到位置变量 XP1 中，将移动类型保存到变量 MoveType 中，将末端工具编号保存到变量 ToolNum 中，将移动速度保存到变量 Pose_Speed 中，将自定义输出数据保存到数组变量 MM_UserData 中，将视觉移动规划数据保存到数组变量 MM_Plan_Results 中。
示例 2
```
MM_Get_PlanJps(1,3,JP1,MoveType,ToolNum,Pose_Speed)
```
该示例表示将收到的第一个路径点的关节角数据保存到位置变量 P1 中，将移动类型保存到变量 MoveType 中，将末端工具编号保存到变量 ToolNum 中，将移动速度保存到变量 Pose_Speed 中，将自定义输出数据保存到数组变量 MM_UserData 中，将视觉移动规划数据保存到数组变量 MM_Plan_Results 中。

获取 Mech-Vision “路径规划”步骤的结果

在启动 Mech-Vision 工程后，该指令用于获取 Mech-Vision 中“路径规划”步骤输出的免碰撞抓取路径。

在使用该指令时，Mech-Vision “输出”步骤的 端口类型 参数需要设置为“预定义（机器人路径）”。

子程序

MM_GET_VISPATH(Job:IN,Jps_Pos:IN,Pos_Num:OUT,VisPos_Num:OUT,MM_Status:OUT)

参数说明

参数描述

参数	描述
输入参数
Job	Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。
Jps_Pos	指定“路径规划”步骤返回的路径点的位姿类型。 `1`：路径点的位姿将以机器人关节角（JPs）的形式返回。 `2`：路径点的位姿将以机器人工具位姿（TCP）的形式返回。
输出参数
Pos_Num	变量，用于保存该指令返回的路径点个数。
VisPos_Num	变量，用于保存路径规划工具中设置的“视觉移动”路径点在整个路径中的位置。例如，如果规划路径由以下组成：“定点移动_1”，“定点移动_2”，“视觉移动”，“定点移动_3”，则“视觉移动”位置为 3。如果路径中无“视觉移动”，则该参数值为 0。
MM_Status	变量，用于保存该指令返回的状态码。

输入参数

Job

Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号。

Jps_Pos

指定“路径规划”步骤返回的路径点的位姿类型。

1：路径点的位姿将以机器人关节角（JPs）的形式返回。

2：路径点的位姿将以机器人工具位姿（TCP）的形式返回。

输出参数

Pos_Num

变量，用于保存该指令返回的路径点个数。

VisPos_Num

变量，用于保存路径规划工具中设置的“视觉移动”路径点在整个路径中的位置。例如，如果规划路径由以下组成：“定点移动_1”，“定点移动_2”，“视觉移动”，“定点移动_3”，则“视觉移动”位置为 3。如果路径中无“视觉移动”，则该参数值为 0。

MM_Status

变量，用于保存该指令返回的状态码。

示例

MM_GET_VISPATH(1,1,Pose_Num,VisPos_Num,Status)

该示例表示接收 Mech-Vision 工程 1 返回的机器人规划路径，路径点位姿类型为关节角，路径点个数保存在变量 Pos_Num 中，视觉移动路径点在路径中的位置编号保存在变量 VisPos_Num 中，该指令执行的状态码保存在变量 Status 中。

读取Mech-Viz步骤参数值

该指令用于读取Mech-Viz工程中指定的步骤参数值。

子程序

mm_get_property(Get_id:IN,MM_Status:OUT,Viz_Prop:OUT)

参数说明

参数	描述
输入参数
Get_id	该参数为property_config文件中指定的配置编号字段。
输出参数
MM_Status	整型变量，用于保存该指令返回的状态码。
Viz_Prop	整型变量，用于保存返回的指定步骤的参数值，目前只支持返回INT整型值。

参数

描述

输入参数

Get_id

该参数为property_config文件中指定的 配置编号 字段。

输出参数

MM_Status

整型变量，用于保存该指令返回的状态码。

Viz_Prop

整型变量，用于保存返回的指定步骤的参数值，目前只支持返回INT整型值。

在Mech-Vision工具栏的 机器人通信配置 下一步 高级设置 下，单击 属性配置，即可打开property_config文件。

在使用该指令前，用户需提前在property_config文件中指定步骤编号和参数名称对应的key名称，具体格式如下所示。

read, 配置编号, 步骤编号, key名称

read

指定该行用于读取步骤参数值。

配置编号

指定一个唯一的编号，为正整数。一个配置编号只能用于读取一个步骤参数值。如果读取多个步骤参数值，请使用不同的配置编号。

步骤编号

指定将要读取的参数所属步骤的编号。

key名称

指定将要读取的参数名称对应的key名称。

key名称 可通过 Keys查询工具 获取。单击Mech-Viz菜单栏的工具 Keys查询工具，即可打开该工具。单击具体步骤图标，中间区域就是选中步骤的所有参数名称对应的key名称。设置的key名称必须是下图区域中出现的名称。
property_config文件中以“#”为开头的内容为注释行，指令在执行代码时会忽略注释，不做任何处理。
对property_config文件编辑完后，注意保存文件，并重启Mech-Vision工具栏中的接口服务。

property_config文件中可以设置多条read指令，但每条read指令的配置编号必须唯一。

示例

例如，在property_config文件中添加如下内容，5表示配置编号，3表示步骤编号，xCount表示key名称。

read, 5, 3, xCount

机器人发送如下指令后，将会获取到xCount对应的参数值。

mm_get_property(5,MM_Status,Viz_Prop)

该示例表示将Mech-Viz工程中步骤编号3的xCount对应参数值保存到Viz_Prop变量中，并将返回的状态码保存在MM_Status变量中。

设置Mech-Viz步骤参数值

该指令用于设置Mech-Viz工程中指定的步骤参数值。

子程序

mm_set_property(Set_id:IN,MM_Status:OUT)

参数说明

参数	描述
输入参数
Set_id	该参数为property_config文件中指定的配置编号字段。
输出参数
MM_Status	整型变量，用于保存该指令返回的状态码。

参数

描述

输入参数

Set_id

该参数为property_config文件中指定的 配置编号 字段。

输出参数

MM_Status

整型变量，用于保存该指令返回的状态码。

在Mech-Vision工具栏的 机器人通信配置 下一步 高级设置 下，单击 属性配置，即可打开property_config文件。

在使用该指令前，用户需提前在property_config文件中指定步骤编号、参数名称对应的key名称和参数值，具体格式如下所示。

write, 配置编号, 步骤编号, key名称, 参数值

write

指定该行用于设置步骤参数值。

配置编号

指定一个编号（非唯一），为正整数。

步骤编号

指定将要设置的参数所属步骤的编号。

key名称

指定将要设置的参数名称对应的key名称。

参数值

指定将要设置的参数值。

property_config文件中可以设置多条write指令，且配置编号允许重复，即使用一个配置编号设置多个参数值。
key名称 可通过 Keys查询工具 获取。单击Mech-Viz菜单栏的工具 Keys查询工具，即可打开该工具。单击具体步骤图标，中间区域就是选中步骤的所有参数名称对应的key名称。设置的key名称必须是下图区域中出现的名称。
property_config文件中以“#”为开头的内容为注释行，指令在执行代码时会忽略注释，不做任何处理。
对property_config文件编辑完后，注意保存文件，并重启Mech-Vision工具栏中的接口服务。

示例

例如，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变量中。

获取通知的消息

在触发Mech-Vision或Mech-Viz工程运行后，该指令用于获取“通知”步骤中预先设置的消息。

子程序

MM_Get_Notify(MM_NotifyMsg:OUT)

参数说明

参数	描述
输出参数
MM_NotifyMsg	INT变量，用于保存通知的消息（暂时只支持整数）。

参数

描述

输出参数

MM_NotifyMsg

INT变量，用于保存通知的消息（暂时只支持整数）。

示例

MM_Get_Notify(MM_NotifyMsg)

该示例表示将从“通知”步骤获取的消息保存至变量MM_NotifyMsg中。

停止Mech-Viz工程

该指令用于停止正在运行的Mech-Viz工程。

子程序

MM_Stop_Viz()

示例

MM_Stop_Viz()

该示例表示停止正在运行的Mech-Viz工程。

我们重视您的隐私

我们使用 cookie 为您在我们的网站上提供最佳体验。继续使用该网站即表示您同意使用 cookie。如果您拒绝，将使用一个单独的 cookie 来确保您在访问本网站时不会被跟踪或记住。

同意

不同意