Kawasaki （川崎）接口程序指令说明¶
Kawasaki 机器人程序调用说明:
程序的形参列表中各个参数之间以逗号分隔；
每个形参变量都定义为局部变量，只在程序中有效；
程序的形参列表支持定义输入参数和输出参数；
调用程序时的实参：输入实参可以是常量、全局变量，或局部变量；输出实参可以是全局变量，或局部变量。
初始化通信指令¶
该指令用于设置 TCP/IP 通信的主机 IP 地址、端口号，以及通信超时等待时间。
程序
mm_init_skt(.ip1,.ip2,.ip3,.ip4,.port,.time_out)
参数说明
输入参数
描述
.ip1 - .ip4
主机的 IP 地址。
.port
TCP/IP 通信端口号（端口号默认为 50000 ）。
.time_out
超时等待时间（单位为 s ）。
示例
CALL mm_init_skt(192,168,1,1,50000,60)
示例说明
执行该示例程序，将需要连接的主机 IP 地址设为 192.168.1.1 ，端口号为 50000 ，超时时间为 60s 。
启动 Mech-Vision 工程¶
该指令用于只用到 Mech-Vision 工程，而无需用到 Mech-Viz 工程的场景。该指令用来启动 Mech-Vision 工程的运行，执行相机拍照和视觉处理。
程序
mm_start_vis(.job,.pos_num_need,.sendpos_type)
参数说明
输入参数
描述
.job
Mech-Vision 工程在 Mech-Center 软件中的注册序号。可以在 Mech-Center 软件 界面查询和调整。序号范围[1-99]。
.pos_num_need
希望 Mech-Vision 软件输出的视觉结果数量。可设置范围[1-20]，0 表示获取所有。
.sendpos_type
机器人发送的拍照位姿类型，可设置范围[0-2]。 0：不需要拍照位姿，比如 Eye To Hand 方式可设置为 0 ； 1：拍照位姿是关节角形式； 2：拍照位姿是法兰位姿。
示例
CALL mm_start_vis(1,1,1)
示例说明
该示例触发 Mech-Vision 工程 1 的运行，希望 Mech-Vision 工程 1 返回 1 个视觉结果，此时机器人将调用此指令时的关节角数据发送给 Mech-Center 软件。
获取视觉目标点¶
该指令用于只用到 Mech-Vision 软件，无需用到 Mech-Viz 软件的场景。用于启动 Mech-Vision 软件之后，获取视觉识别结果。
程序
mm_get_visdata(.job,.pos_num,.ret)
参数说明
输入参数
描述
.job
Mech-Vision 工程在 Mech-Center 中的注册序号。可以在 Mech-Center 软件 界面查询和调整。序号范围[1-99]。
输出参数
描述
.pos_num
变量，用于保存返回的位姿数量。
.ret
变量，用于保存指令状态码。可参考 标准接口状态码及错误排查 。
示例
CALL mm_get_visdata(1,posnum, statuscode)
示例说明
该示例用于获取 Mech-Vision 工程 1 的视觉结果。返回的视觉点数量保存在变量 posnum 里，指令执行的状态码保存在变量 statuscode 里。
启动 Mech-Viz 工程¶
该指令用于既有 Mech-Vision 工程又有 Mech-Viz 工程的场景。用于启动 Mech-Viz 工程，调用相应的 Mech-Vision 工程，并设置 Mech-Viz 中仿真机器人的初始位姿。
程序
mm_start_viz(.sendpos_type)
参数说明
输入参数
描述
.sendpos_type
位姿类型，可选范围 [0-1] 。
注解
位姿类型设置为 0 时，Mech-Viz中的仿真机器人的初始位姿为 [0,0,0,0,0,0] ；
位姿类型设置为 1 时，Mech-Viz中的仿真机器人的初始位姿为当前机器人关节角位姿；
当场景中存在碰撞模型，干扰机器人从关节角[0,0,0,0,0,0] 位置开始运动到第一个移动点时，则位姿类型必须设置为 1 。
示例
CALL mm_start_viz(1)
示例说明
该示例触发 Mech-Viz 工程运行，并将当前机器人的关节角发送给 Mech-Center 软件。
获取 Mech-Viz 数据¶
该指令用于获取 Mech-Viz 工程规划的抓取路径。
程序
mm_get_vizdata(.getpos_type,.pos_num,.vispos_num,.ret)
参数说明
输入参数
描述
.getpos_type
要获取的路径上点的位姿类型。
输出参数
描述
.pos_num
变量，用于保存接收到的位姿数量。
.vispos_num
变量，用于保存第一个视觉移动在路径中的位置编号。例如路径是：移动-1，移动-2，视觉移动-1，移动-3，则视觉移动的位置是 3 。若路径中无视觉移动，则返回值为零。
.ret
变量，用于保存指令状态码。可参考 标准接口状态码及错误排查 。
注解
Mech-Viz 软件返回的位姿类型为机器人关节角。
Mech-Viz 软件返回的位姿类型为机器人工具中心点位姿。
示例
CALL mm_get_vizdata(2,posnum,vis_index,statuscode)
示例说明
该示例用于接收 Mech-Viz 软件返回的机器人移动路径，移动点数据类型为工具中心点位姿，位姿的数量保存在变量 posnum 中，视觉移动点在路径中的编号保存在变量 vis_index 中，指令执行的状态码保存在变量 statuscode 中。
获取视觉结果¶
该指令用于将 Mech-Vision 软件返回的视觉结果或 Mech-Viz 返回的移动路径里某个工具中心点位姿数据转存到指定位姿变量中。
程序
mm_get_pose(.index,.&targetpos,.label,.speed)
参数说明
输入参数
描述
.index
指定要转存的是第几个位姿。
输出参数
描述
&targetpos
位姿变量，用于保存指定的位姿数据。使用时形参前面需要加 “&” 符号，表示变量类型为 POINT 类型。
.label
变量，用于保存和指定位姿数据相对应的标签数据。
.speed
变量，用于保存和指定位姿数据相对应的移动速度。
示例
CALL mm_get_pose(1,.&pt[1],pt_label[1],pt_speed[1])
示例说明
该示例用于将接收到的第一个位姿保存到位姿变量 pt[1] 中，将标签保存到变量 pt_label[1] 中，将移动速度保存到变量 pt_speed[1] 中。
获取视觉点关节角（使用 Mech-Viz 软件规划时有效）¶
该指令用于将 Mech-Viz 软件返回的移动路径里的某个关节角数据转存到指定位置变量中。
程序
mm_get_jps(.index,.#targetpos,.label,.speed)
参数说明
输入参数
描述
.index
指定要转存的是第几个位姿。
输出参数
描述
#targetpos
关节角变量，用于保存指定的关节角数据。使用时形参前面需要加 “#” 符号表示变量类型为关节角变量。
.label
变量，用于保存和指定位姿数据相对应的标签数据。
.speed
变量，用于保存和指定位姿数据相对应的移动速度。
示例
CALL mm_get_jps(1,.#pt[1],pt_label[1],pt_speed[1])
示例说明
该示例用于将接收到的第一个位姿保存到位置变量 #pt[1] 中，将标签保存到变量 pt_label[1] 中，将移动速度保存到变量 pt_speed[1] 中。
切换 Mech-Vision 配方¶
配置参数配方 ，需要在 Mech-Vision 中已配置并保存了参数配方。该指令需要在 mm_start_vis 程序之前使用。
程序
mm_switch_model(.job,.model_number)
参数说明
输入参数
描述
.job
Mech-Vision 工程在 Mech-Center 软件中的注册序号，可以在 Mech-Center 界面查询和调整。序号范围[1-99]。
.model_number
Mech-Vision 工程中配方模板的编号。编号范围[1-99]。
示例
CALL 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,.exit_num)
参数说明
输入参数
描述
.branch_num
分支任务编号，该参数应为正整数，即 消息分支 的任务编号。任务编号可在任务参数中读取。
.exit_num
给定分支的出口号，Mech-Viz 程序将沿该出口继续执行。参数范围[1-99] 。
示例
CALL mm_set_branch(1,3)
示例说明
该示例是用来设置当 Mech-Viz 工程执行到名字是 1 的分支时走任务的第 3 出口。
设置移动索引¶
对于属性中带有索引的移动类任务，比如按序列移动、按阵列移动、自定义垛型、预设垛型等，可以调用该指令设置属性中的当前索引。 在调用该指令之前，需要先执行 mm_start_viz 程序。
程序
mm_set_index(.skill_num,.index_num)
参数说明
.skill_num
移动索引任务编号，该参数应为正整数。任务编号可在任务参数中读取
.index_num
下次执行此任务时应设置的索引值。
发送该指令时，Mech-Viz 中的当前索引值将变为该参数值减 1。
当 Mech-Viz 项目运行到该指令指定的任务时，Mech-Viz 中的当前索引值将增加 1，成为该参数的值。
示例
CALL mm_set_index(2,10)
示例说明
该示例设置 Mech-Viz 工程中的任务名称 “2” 的当前索引值为 9。
获取软件状态¶
该指令用于获取 Mech-Vision，Mech-Viz，Mech-Center 的软件运行状态。目前只支持检测 Mech-Vision 软件是否注册就绪。
程序
mm_get_status(.ret)
参数说明
输出参数
描述
.ret
变量，用于保存指令状态码。可参考 状态码列表 。
示例
CALL mm_get_status(statuscode)
示例说明
该示例将检查系统状态的状态码保存到变量 statuscode 中。
向 Mech-Vision 传入物体尺寸¶
该指令用于向 Mech-vision 工程中动态传入物体尺寸。需要在执行 mm_start_vis 之前调用。
程序
mm_set_boxsize(.job,.length,.width,.height)
参数说明
输入参数
描述
.job
Mech-Vision 工程在 Mech-Center 软件中的注册序号，可以在 Mech-Center 界面查询和调整。序号范围[1-99]。
.length
箱子长度，单位 mm 。
.width
箱子宽度，单位 mm 。
.height
箱子高度，单位 mm 。
示例
CALL mm_set_boxsize(1,500,300,200)
示例说明
该示例将设置 Mech-Vision 工程中的读取物体尺寸步骤的物体尺寸为 500*300*200mm 。
获取 DO 信号列表¶
当需要使用 Mech-Viz 软件中的吸盘分区/多抓功能时，可通过该指令来获取规划的分区 DO 信号列表。调用该指令之前需要先 mm_get_vizdata 。
提示
请参考 XXXX/Mech-Center-xxx/tool/viz_project/suction_zone 目录下的 Mech-Viz 模板工程使用，并在运行之前在工程中设置对应的吸盘配置文件。
程序
mm_get_dolist()
示例
CALL mm_getdolist
示例说明
执行该程序会将 Mech-Viz 软件计算的 DO 列表保存到 setdo[] 数组内。有效数据从 setdo[0] 开始，到 setdo[io_index-1] 。
设置外部位姿¶
该指令用于动态传入位姿数据，配合 Mech-Viz 软件中的 外部移动 使用。该功能需要配合 XXXX/Mech-Center-xxx/tool/viz_project/outer_move 工程使用，并在运行之前把其中的 外部移动 放到合适的位置。
该指令需要在调用 mm_start_viz 程序之前调用。
程序
mm_set_pos(.&pos)
参数说明
输入参数
描述
.&pos
位姿变量，保存需要发送给 Mech-Viz 软件的工具中心点位姿数据。变量前加“&”表示该变量是位姿变量。
示例
call mm_set_pos(&pos)
示例说明
该示例将位姿变量 pos 代表的位姿数据发送为 Mech-Viz 软件的外部移动任务。