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 。
示例:
MM_Init_Socket(“XML_Kuka_MMIND”,873,871,60)
示例说明:
该示例指定网络配置文件名为:“XML_Kuka_MMIND”,XML 文件中是否通信成功的 FLAG 号为 873,XML 文件是否接收到数据的 FLAG 号为 871,超时时间为 60s 。
启动 Mech-Vision 工程¶
用于只有 Mech-Vision,而不用 Mech-Viz 的场景。该指令用来触发 Mech-Vision 工程的运行,执行相机拍照和视觉处理。
子程序:
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]。 |
|
|
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,Last_Data:OUT,Pos_Num:OUT,MM_Status:OUT)
参数说明:
参数
描述
输入参数
Job
Mech-Vision 工程编号,可在 Mech-Vision 工程列表窗口中查看,工程名称前的数字表示工程编号。
输出参数
Last_Data
变量,用于表示点位是否发送完毕,返回值为 0 代表未发送完毕,返回值为 1 代表发送完毕。
Pos_Num
变量,用于保存返回的位姿数量。
MM_Status
变量,用于保存指令状态码。可参考 标准接口状态码及错误排查 。
示例:
MM_Get_VisData(1,Last,Pose_Num,Status)
示例说明:
该示例用于获取 Mech-Vision 工程1的视觉结果。是否还有视觉点保存在变量 Last 里,返回的视觉点数量保存在变量 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]。 |
|
|
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,Last_Data:OUT,Pos_Num:OUT,VisPos_Num:OUT,MM_Status:OUT)
参数说明:
参数
描述
输入参数
Jps_Pos
要获取的路径上点的位姿类型。
1:Mech-Viz返回的位姿类型为机器人关节角。
2:Mech-Viz返回的位姿类型为机器人 TCP。
输出参数:
Last_Data
点位是否发送完毕,返回值为 0 代表未发送完毕,返回值为 1 代表发送完毕。
Pos_Num
变量,用于保存接收到的位姿数量。
VisPos_Num
变量,用于保存第一个视觉移动在路径中的位置编号。 例如路径是:移动-1,移动-2,视觉移动-1,移动-3,则视觉移动的位置是3。 若路径中无视觉移动,则返回值为零。
MM_Status
变量,用于保存指令状态码。可参考 标准接口状态码及错误排查 。
示例:
MM_Get_VizData(2,Last,Pose_Num,VisPos_Num,Status)
示例说明:
该示例用于接收 Mech-Viz 返回的机器人移动路径,移动点数据类型为 TCP,点位是否发送完毕保存在变量 Last 中,位姿的数量保存在变量 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
变量,用于保存和指定位姿数据相对应的移动速度。
示例:
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
变量,用于保存和指定位姿数据相对应的移动速度。
示例:
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] 。
示例:
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] 。
示例:
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,成为该参数的值。
示例:
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_Get_Status(Status)
示例说明:
该示例将检查系统状态的状态码保存到变量 Status 中。
向 Mech-Vision 传入物体尺寸¶
Mech-Vision 工程中动态传入物体尺寸。需要在执行 MM_Start_Vis 之前调用。
子程序:
MM_Set_BoxSize(Job:IN, Lenght:IN, Width:IN, Height:IN)
参数说明:
参数
描述
输入参数
Job
Mech-Vision 工程编号,可在 Mech-Vision 工程列表窗口中查看,工程名称前的数字表示工程编号。
Lenght
箱子长度,单位mm。
Width
箱子宽度,单位mm。
Height
箱子高度,单位mm。
示例:
MM_Set_BoxSize(1,500,300,200)
示例说明:
该示例将设置 Mech-Vision 工程中的读取物体尺寸步骤的物体尺寸为 500*300*200mm。
获取 DO 信号列表/设置 DO 信号列表¶
当需要使用 Mech-Viz 中的吸盘分区/多抓功能时,可通过该指令来获取规划的分区 DO 信号列表。调用该指令之前需要先 MM_Get_VizData。
请参考位于 XXXX/Mech-Center-xxx/tool/viz_project/suction_zone
中的 Mech-Viz 模板工程使用,并在运行之前在工程中设置对应的吸盘配置文件。
子程序:
MM_Get_DoList() 获取 DO 信号。
MM_Set_DoList() 设置 DO 信号。
示例:
MM_Get_DoList()
MM_Set_DoList()
示例说明:
执行该程序会将 Mech-Viz 计算的 DO 列表保存到 Do_Port[i] 数组内,然后将值写入到相应的 DO 信号里。
设置外部位姿¶
动态传入位姿点数据。配合 Mech-Viz 中的 外部移动 使用。
该功能需要配合位于 XXXX/Mech-Center-xxx/tool/viz_project/outer_move
中的工程使用,并在运行之前把其中的 外部移动 放到合适的位置。 该指令需要在调用 MM_Start_Viz 程序之前调用。
子程序:
MM_Set_Pos(Out_Pos:IN)
参数说明:
参数
描述
输入参数
Out_Pos
位姿变量,保存需要发送给 Mech-Viz 的 TCP 数据。
示例:
MM_Set_Pos(XP50)
示例说明:
该示例将位姿变量 XP50 代表的位姿数据发送给 Mech-Viz 的外部移动步骤。
标定¶
该前台程序用于相机外参的自动标定。该程序配合 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。
示例:
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 变量,用于保存该指令返回的状态码。
示例:
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
INT 变量,用于保存指定视觉点的标签数据。
MM_UserData
已定义的全局数组变量,用于保存指定视觉点的用户自定义数据,目前数组长度为 50。
示例:
MM_GET_DYPOSE (1,XP1,Label)
示例说明:
该示例表示将接收到的第一个视觉点的位姿数据保存到位置变量 XP1 中,将相应标签数据保存到变量 Label 中,将相应的自定义输出数据保存到数组变量 MM_UserData 中。
从 Mech-Viz 获取路径点¶
该指令用于从 Mech-Viz 获取路径规划结果。其中,路径点可以是一般移动路径点,也可以是视觉移动路径点。路径点可能包含位姿、速度、工具信息、工件信息等。
执行该指令得到的路径点可以是以下三种之一。
子程序:
MM_GET_PLANDATA (Jps_Pos:IN,Pos_Num:OUT,VisPos_Num:out,MM_Status:OUT)
参数说明:
参数
描述
输入参数
Jps_Pos
预期的返回数据格式,取值范围为 1~4,详情参见下表。
输出参数
Pos_Num
变量,用于保存接收到的路径点个数。
VisPos_Num
变量,用于保存第一个视觉移动在规划路径中的位置编号。
MM_Status
变量,用于保存该指令返回的状态码。
以下是四种预期的返回数据格式说明。
预期的返回数据格式 参数值
预期的返回数据 说明(每个字段的具体解释参见下文)
1
位姿(JPs 形式), 运动类型, 工具编号, 速度, 自定义数据项个数, 自定义数据项 1, …, 自定义数据项 N
2
位姿(TCP 形式), 运动类型, 工具编号, 速度, 自定义数据项个数, 自定义数据项 1, …, 自定义数据项 N
3
位姿(JPs 形式), 运动类型, 工具编号, 速度, 视觉规划结果, 自定义数据项个数, 自定义数据项 1, …, 自定义数据项 N
4
位姿(TCP 形式), 运动类型, 工具编号, 速度, 视觉规划结果, 自定义数据项个数, 自定义数据项 1, …, 自定义数据项 N
位姿
路径点的位姿可以是机器人关节角(JPs,单位为度)或工具位姿(TCP,其中三维坐标单位为毫米,欧拉角单位为度),其形式取决于发送的指令参数。
运动类型
1
:关节运动,MOVEJ2
:直线运动,MOVEL
工具编号
路径点的工具编号。 -1 表示不使用工具。
速度
路径点的速度百分比值,其值为 Mech-Viz 工程中该路径点对应移动类步骤的参数中设置的速度乘以 Mech-Viz 中设置的全局速度,单位为 %。
视觉规划结果
路径中的规划结果信息(如果路径点对应移动步骤为 视觉移动)。通常用于纸箱多拣、卸垛等。信息包括:
标签:由 10 个正整数组成,默认为 10 个 0。
已抓取的工件总数。
本次抓取的工件数量。
吸盘边角号:用于指定工件靠近吸盘的哪个边角。在 Mech-Viz 的“工程资源”中双击对应的末端工具名称,然后单击 控制逻辑配置窗口 ,便可查看吸盘边角号。
工具位姿(TCP)偏移量:从对应工件中心的 TCP 到 实际 TCP 的偏移量。
工件朝向:工件坐标系 X 轴相对于 TCP X 轴的方向。
工件组尺寸。
自定义数据项个数
当 Mech-Vision 工程中 输出 步骤的端口类型为“自定义”时,除 poses 和 labels 之外其他端口的数量。
自定义数据项
当 Mech-Vision 工程中 输出 步骤的端口类型为“自定义”时,除 poses 和 labels 之外其他端口的数据。
各自定义数据按照端口名称的字母顺序(A—Z)排列。
示例:
MM_GET_PLANDATA (2,Pose_Num,VisPos_Num,Status)
示例说明:
该示例表示接收 Mech-Viz 返回的路径规划,预期的返回数据格式参数为 2,路径点个数保存在变量 Pos_Num 中,视觉移动路径点在路径中的位置编号保存在变量 VisPos_Num 中,该指令执行的状态码保存在变量 Status 中。
将从 Mech-Viz 获取的路径点数据保存至变量¶
该指令用在 从 Mech-Viz 获取路径点 后,用于将从 Mech-Viz 获取的路径点数据转存到指定的变量中。
子程序:
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
与 从 Mech-Viz 获取路径点 中的 Jps_Pos 所选值一致。
输出参数
MM_P
位姿变量,用于保存指定路径点对应的 TCP 数据。
MM_J
关节角变量,用于保存指定路径点对应的关节角数据。
MM_MoveType
变量,用于保存指定路径点对应的运动类型。1 表示 MOVEJ,2 表示 MOVEL。
MM_ToolNum
变量,用于保存指定路径点对应的工具编号。-1 表示空工具。
MM_Speed
变量,用于保存指定路径点对应的移动速度。
MM_UserData
已定义的全局数组变量,用于保存指定路径点对应的自定义输出数据。目前数组长度为 50。
MM_Plan_Results
已定义的全局数组变量,用于保存指定路径点对应的视觉规划结果。目前数组长度为 20。
示例 1:
MM_Get_PlanPose (1,4,XP1,MoveType, ToolNum, Pose_Speed)
示例 1 说明:
该示例表示将收到的第一个路径点的 TCP 数据保存到位置变量 XP1 中,将运动类型保存到变量 MoveType 中,将工具编号保存到变量 ToolNum 中,将移动速度保存到变量 Pose_Speed 中,将自定义输出数据保存到数组变量 MM_UserData 中,将视觉规划结果数据保存到数组变量 MM_Plan_Results 中。
示例 2:
MM_Get_PlanJps (1,3,JP1,MoveType, ToolNum, Pose_Speed)
示例 2 说明:
该示例表示将收到的第一个路径点的关节角数据保存到位置变量 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,Last_Data:OUT,Pos_Num:OUT,VisPos_Num:OUT,MM_Status:OUT)
参数说明:
参数
描述
输入参数
Job
Mech-Vision 工程编号,可在 Mech-Vision 工程列表窗口中查看,工程名称前的数字表示工程编号。
Jps_Pos
指定“路径规划”步骤返回的路径点的位姿类型。
1
:路径点的位姿将以机器人关节角(JPs)的形式返回。2
:路径点的位姿将以机器人工具位姿(TCP)的形式返回。输出参数
Last_Data
变量,用于表示路径点是否发送完成。
0
:未发送完路径中的全部路径点。1
:已发送完路径中全部路径点。Pos_Num
变量,用于保存该指令返回的路径点个数。
VisPos_Num
变量,用于保存路径规划工具中设置的“视觉移动”路径点在整个路径中的位置。 例如,如果规划路径由以下组成:“定点移动_1”,“定点移动_2”,“视觉移动”,“定点移动_3”,则“视觉移动”位置为 3。 如果路径中无“视觉移动”,则该参数值为 0。
MM_Status
变量,用于保存该指令返回的状态码。
示例:
MM_GET_VISPATH (1,1,Last,Pose_Num,VisPos_Num,Status)
示例说明:
该示例表示接收 Mech-Vision 工程 1 返回的机器人规划路径,路径点位姿类型为关节角,路径点是否发送完成保存在变量 Last_Data 中,路径点个数保存在变量 Pos_Num 中,视觉移动路径点在路径中的位置编号保存在变量 VisPos_Num 中,该指令执行的状态码保存在变量 Status 中。