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

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

1. 子程序的 形参列表 中各个 参数 之间以逗号分隔；

2. 每个 形参变量 都定义为 局部变量 ，只在程序中有效；

3. 子程序的 形参列表 支持定义 输入参数 和 输出参数 。

本章将介绍以下指令：

• 初始化通讯参数

• 启动 Mech-Vision 工程

• 获取视觉结果

• 启动 Mech-Viz 工程

• 获取 Mech-Viz 数据

• 获取视觉点坐标值

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

• 切换 Mech-Vision 配方

• 选择 Mech-Viz 分支

• 设置移动索引

• 获取软件状态

• 向 Mech-Vision 传入物体尺寸

• 获取 DO 信号列表/设置 DO 信号列表

• 设置外部位姿

• 标定

初始化通讯参数

该子程序用于设置 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)

• 参数说明：

  参数	描述
  输入参数
  Job	Mech-Vision 工程在 Mech-Center 中的注册序号。 可以在 Mech-Center 部署设置 ‣ Mech-Vision 中查询和调整。 序号范围[1-99]。
  Pos_Num_Need	希望 Mech-Vision 输出的视觉结果数量。可设置范围[1-20]，0表示获取所有。
  SendPos_Type	机器人发送的拍照位姿类型，可设置范围[0-2]
  	0：不需要拍照位姿，比如 Eye To Hand 可为0。
  	1：拍照位姿是 JPS 关节角形式。
  	2：拍照位姿是法兰位姿。

• 示例：

  MM_Start_Vis(1,1,1)

• 示例说明：

  该示例触发 Mech-Vision 工程1的运行，希望 Mech-Vision 工程1返回1个视觉结果，机器人将触发 Mech-Vision 工程时的 JPS 关节角数据发送给 Mech-Center 。

获取视觉结果

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

• 子程序：

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

• 参数说明：

  参数	描述
  输入参数
  Job	Mech-Vision 工程在 Mech-Center 中的注册序号。 可以在 Mech-Center 部署设置 ‣ Mech-Vision 中查询和调整。 序号范围[1-99]。
  输出参数
  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)

• 参数说明：

  参数	描述
  输入参数
  SendPos_Type	位姿类型，可选范围 [0-1]
  	位姿类型设置为0时， Mech-Viz 中仿真机器人会从关节角 [0,0,0,0,0,0] 位置开始，运动到第一个移动点。
  	位姿类型设置为1时，Mech-Viz 中仿真机器人会从当前机器人关节角位置开始，运动到第一个移动点。
  	当场景中存在碰撞模型，干扰机器人从关节角 [0,0,0,0,0,0] 位置开始运动到第一个移动点时，则位姿类型必须设置为1。

• 示例：

  MM_Start_Viz(1)

• 示例说明：

  该示例触发 Mech-Viz 工程运行，并将当前机器人的关节角发送给 Mech-Center。

获取 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-Center 中的注册序号， 可以在 Mech-Center 部署设置 ‣ Mech-Vision 中查询和调整。 序号范围[1-99]。
  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	分支名字，在运行之前需要在 Mech-Viz 工程中修改对应的分支名字为纯数字格式。 参数范围[1-99]。每个分支的名字不能重复。
  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	索引类任务名称，该任务名必须是正整数，范围[1-99]。同一工程中的任务名称不能重复。
  Index_Num	当前索引值。

• 示例:

  MM_Set_Index (2,10)

• 示例说明：

  该示例设置 Mech-Viz 工程中的任务名称 “2” 的当前索引值为 9 ，当工程运行到该技能，索引值会加1，变成10。

获取软件状态

用于获取 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-Center 中的注册序号， 可以在 Mech-Center 部署设置 ‣ Mech-Vision 中查询和调整。 序号范围[1-99]。
  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。 请参考 位于 XXX\Mech-Center\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 中的 外部移动 使用。 该功能需要配合位于 XXX\Mech-Center\tool\viz_project\outer_move 中的工程使用，并在运行之前把其中的 外部移动 放到合适的位置。 该指令需要在调用 mm_start_viz 程序之前调用。

• 子程序：

  MM_Set_Pos(Out_Pos:IN)

• 参数说明：

  参数	描述
  输入参数
  Out_Pos	位姿变量，保存需要发送给 Mech-Viz 的 TCP 位姿数据。

• 示例：

  MM_Set_Pos(XP50)

• 示例说明：

  该示例将位姿变量 pos 代表的位姿数据发送为 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	等待时间；单位为 s 。
  E1	外部轴数据（当有7轴时）；单位为 mm。

• 示例：

  MM_Calib(2,1,300,0)

• 示例说明：

  该示例执行标定流程，机器人通过走关节的形式进行标定，接收的点位使用关节角的形式，两个点位之间的超时时间设置为 300s，没有外部轴。