指令说明
本文介绍欧姆龙 PLC 与梅卡曼德视觉系统系统进行 EtherNet/IP 通信的指令。
指令说明
启动 Mech-Vision 工程
该指令用于只有 Mech-Vision 工程，没有 Mech-Viz 的场景。使用该指令触发 Mech-Vision 工程运行，执行相机拍照和视觉识别。
参量说明
INPUT：
-
Vision_Proj_Num：Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号；
-
Req_Pose_Num: 希望 Mech-Vision 输出的视觉结果数量，可设置范围[1-20]，0 表示获取所有结果；
-
Robot_Pose_Type：机器人位姿类型，指定真实机器人的位姿将以何种形式传 Mech-Vision，其取值范围为 0~3；
-
Camera_User.Robot_Pose_JPS：机器人当前关节角，数据类型为一维数组Array[0..5] of DInt；
-
Camera_User.Robot_Pose_Flange：机器人当前法兰位姿，数据类型为一维数组Array[0..5] of DInt；
下表为 Robot_Pose_Type 与 Camera_User.Robot_Pose_JPS 和 Camera_User.Robot_Pose_Flange 参数取值的关系及说明。
| Robot_Pose_Type | Camera_User.Robot_Pose_JPS | Camera_User.Robot_Pose_Flange | 说明 | 适用场景 |
|---|---|---|---|---|
0 |
0, 0, 0, 0, 0, 0 |
0, 0, 0, 0, 0, 0 |
无需向 Mech-Vision 传入机器人位姿 |
工程为 Eye To Hand 模式。若 Mech-Vision 工程中使用“路径规划”步骤，则路径规划的起始点为路径规划工具中设置的 Home 点。 |
1 |
机器人当前关节角 |
机器人的当前法兰位姿 |
需要将机器人的关节角和法兰位姿传入 Mech-Vision |
工程为 Eye In Hand 模式，除桁架机器人外的大多数机器人适用该设定。 |
2 |
0, 0, 0, 0, 0, 0 |
机器人的当前法兰位姿 |
需要将机器人的当前法兰位姿传入 Mech-Vision |
工程为 Eye In Hand 模式，机器人无关节角数据，仅有法兰位姿数据（如桁架机器人）。 |
3 |
机器人路径规划起始点的关节角 |
0, 0, 0, 0, 0, 0 |
需要将机器人路径规划起始点的关节角传入 Mech-Vision |
工程为 Eye To Hand 模式，并且 Mech-Vision 工程中存在“路径规划”步骤，且需要从机器人端设置“路径规划”步骤的起始点。 |
| 关节角和法兰位姿的浮点数数据需乘 10000 转化为 32 位有符号整数，再设置到 Camera_User.Robot_Pose_JPS 或 Camera_User.Robot_Pose_Flange 数组。 |
-
Start_Vision：触发 Mech-Vision 工程运行，上升沿有效。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 1102（触发成功），否则返回对应的错误码。
示例
示例说明
在该示例中，当 Camera_User.Start_Vis 出现上升沿时，会触发 Mech-Vision 工程 1 的运行，并希望 Mech-Vision 工程 1 返回视觉结果，同时 PLC 将触发 Mech-Vision 工程时的关节角数据发送给视觉系统。
获取视觉目标点
该指令用于只有 Mech-Vision 工程，没有 Mech-Viz 的场景。该指令用于启动 Mech-Vision 工程之后，获取视觉识别结果。
参量说明
INPUT：
-
Vision_Proj_Num：Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号；
-
Get_VisData：获取 Mech-Vision 工程的视觉识别结果，上升沿有效；
-
Data_Ready：专用于接收多组机器人位姿数据时，该信号用于指示位姿数据可读；
-
Send_Pose_Num：发送的位姿数量，即视觉返回的识别结果个数，范围[0,20]；
-
Start_Empty：触发清空已经获取的 Camera_User.Target_Pose 与 Camera_User.Target_Label 的数据，置位有效。
OUTPUT：
-
Camera_User.Target_Pose：目标抓取点的 TCP，数据类型为 Array[0..19, 0..5] of DInt。用户需将该数组数据除以 10000，然后使用；
-
Camera_User.Target_Label：Mech-Vision 识别的该物体标签信息，数据类型为 Array[0..19] of UDInt。返回的标签值为整数。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 1100（成功获取视觉点）；否则返回对应的错误码；
-
FromCamera.SEND_POSE_TYPE：Mech-Vision 通过 102 指令返回的位姿类型固定为 2（表示 TCP 类型）。
示例
示例说明
在该示例中，当 Camera_User.Get_VisData 出现上升沿时，用于获取 Mech-Vision 工程 1 的视觉结果。 当 Camera_User.Start_Empty 置位时，将清空已经获取的 Camera_User.Target_Pose 与 Camera_User.Target_Label 的数据。
切换 Mech-Vision 配方
Mech-Vision 软件的配方功能，用于不同工件识别时，修改 Mech-Vision 工程各模块的参数，包括图像匹配模板、ROI、置信阈值等。该指令需要在 MM_Start_Vis 程序之前使用。
参量说明
INPUT：
-
Vision_Proj_Num：Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号；
-
Vision_Recipe_Num：Mech-Vision 工程中配方的编号，编号范围[1-99]；
-
Switch_Recipe：切换 Mech-Vision 工程的配方，上升沿有效。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 1107（配方切换成功）；否则返回对应的错误码。
示例
示例说明
在该示例中，当 Camera_User.Switch_Recipe 出现上升沿时，会将 Mech-Vision 工程 1 的配方切换成配方 2。
获取 Mech-Vision “路径规划”步骤的结果
在调用 MM_Start_Vis 之后，使用该指令获取 Mech-Vision 中“路径规划”步骤输出的免碰撞抓取路径。
在使用该指令时，Mech-Vision “输出”步骤的 端口类型 参数需要设置为“预定义（机器人路径）”。
| 在调用该指令前，请务必将 MM_Start_Vis 的 Req_Pose_Num 设置为 0，以减少调用该指令的次数。若 MM_Start_Vis 的 Req_Pose_Num 设置为 1，则每次调用该指令只会返回一个路径点，只有多次调用该指令才能接收全部路径点。 |
参数说明
INPUT：
-
Vision_Proj_Num：Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号；
-
Request_Pose_Type: 该参数用于指定“路径规划”步骤返回的路径点类型；
-
1：路径点将以机器人关节角（JPs）的形式返回。 -
2：路径点将以机器人工具位姿（TCP）的形式返回。
-
-
Get_VisData：获取 Mech-Vision “路径规划”步骤的结果，上升沿有效；
-
Data_Ready：该信号用于指示位姿数据可读，专用于接收多组机器人位姿数据；
-
Send_Pose_Num：发送的位姿数量，即视觉返回的识别结果个数，范围[0,20]；
-
Start_Empty：触发清空已经获取的 Camera_User.Target_Pose、Camera_User.Target_Label 与 Camera_User.Target_Tool_ID 的数据，置位有效。
OUTPUT：
-
Camera_User.Target_Pose：路径点的 TCP，数据类型为 Array[0..19, 0..5] of DInt，用户需将该数组数据除以 10000，然后使用；
-
Camera_User.Target_Label：Mech-Vision 识别的该物体标签信息，数据类型为 Array[0..19] of UDInt，返回的标签值为整数；
-
Camera_User.Target_Tool_ID：路径规划工具中设置的末端工具编号。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若指令执行正常，则返回 1103 状态码；否则返回对应的错误码；
-
FromCamera.SEND_POSE_TYPE：路径点的位姿类型，与 INPUT 中 Request_Pose_Type 请求位姿类型一致，1 表示 JPS 类型，2 表示 TCP 类型。
-
FromCamera.VISUAL_POINT_INDEX：视觉移动路径点在路径中的位置。
示例
示例说明
在该示例中，当 Camera_User.Get_VisData 出现上升沿时，用于接收 Mech-Vision 工程 1 返回的机器人规划路径，路径点数据类型为 JPs。 当 Camera_User.Start_Empty 置位时，将清空已经获取的 Camera_User.Target_Pose、Camera_User.Target_Label 与 Camera_User.Target_Tool_ID 的数据。
启动 Mech-Viz 工程
该指令用于既有 Mech-Vision 又有 Mech-Viz 的场景，用于启动 Mech-Viz 工程，调用相应的 Mech-Vision 工程，并规划抓取路径。
参量说明
INPUT：
-
Robot_Pose_Type: 机器人位姿类型，指定真实机器人的位姿将以何种形式传 Mech-Viz，其取值范围为 0~2；
-
Camera_User.Robot_Pose_JPS：机器人当前关节角，数据类型为一维数组 Array[0..5] of DInt；
-
Camera_User.Robot_Pose_Flange：机器人当前法兰位姿，数据类型为一维数组 Array[0..5] of DInt；
下表为 Robot_Pose_Type 与 Camera_User.Robot_Pose_JPS 和 Camera_User.Robot_Pose_Flange 参数取值的关系及说明。
| Robot_Pose_Type | Camera_User.Robot_Pose_JPS | Camera_User.Robot_Pose_Flange | 说明 | 适用场景 |
|---|---|---|---|---|
0 |
0, 0, 0, 0, 0, 0 |
0, 0, 0, 0, 0, 0 |
无需向 Mech-Viz 传入机器人位姿，Mech-Viz 中仿真机器人将从初始位姿 JPs = [0, 0, 0, 0, 0, 0] 开始移动到第一个路径点。 |
工程为 Eye To Hand 模式。不推荐使用该设定。 |
1 |
机器人当前关节角 |
机器人的当前法兰位姿 |
需要将机器人的当前关节角和法兰位姿传入 Mech-Viz，Mech-Viz 中仿真机器人将从传入的关节角开始移动到第一个路径点。 |
工程为 Eye In Hand 模式时，推荐使用该设定。 |
2 |
机器人端自定义的关节角 |
0, 0, 0, 0, 0, 0 |
需要将机器人的一个示教点（非当前关节角）传入 Mech-Viz，用于在机器人处于拍照区域外时，提前触发 Mech-Viz 工程规划下一轮路径（如下图），Mech-Viz 中仿真机器人将从传入的示教点开始运动到第一个路径点。 |
工程为 Eye To Hand 模式时，推荐使用该设定。 |
|
Eye To Hand 模式下应将 Robot_Pose_Type 设为 2 的原因：
Eye To Hand 模式下，相机可在机器人回到拍照及抓取区域之前拍照，用于提前规划下一轮抓取路径，从而缩短节拍。 若此时将 Robot_Pose_Type 设为 1，即将机器人当前位姿发送给 Mech-Viz 仿真机器人，可能导致仿真机器人与真实机器人轨迹不一致，发生未预知的碰撞，造成危险。 即仿真机器人将直接从当前位姿移动至 Mech-Viz 中第一个移动步骤中设置的位姿，而真实机器人可能在移动至其他位姿后才移动至上述位姿。 所以应将 Robot_Pose_Type 参数设为 2。 
|
| JPS 和法兰位姿的浮点数数据需乘 10000 转化为 32 位有符号整数，再设置到 Robot_Pose 数组。 |
-
Start_Viz：触发 Mech-Viz 工程运行，上升沿有效。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 2103（Mech-Viz 启动成功）；否则返回对应的错误码。
示例
示例说明
在该示例中，当 Camera_User.Start_Viz 出现上升沿时，触发 Mech-Viz 工程运行，并将当前机器人的关节角数据发送给视觉系统。
停止 Mech-Viz 工程
停止运行 Mech-Viz 工程。如果 Mech-Viz 工程不是死循环，或可以正常停止，则不需要使用该指令。
参量说明
INPUT：
-
Stop_Viz：停止运行 Mech-Viz，上升沿有效。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 2104（Mech-Viz 停止成功）；否则返回对应的错误码。
示例
示例说明
在该示例中，当 Camera_User.Stop_Viz 出现上升沿时，停止运行 Mech-Viz 工程。
选择 Mech-Viz 分支
当 Mech-Viz 工程中有“消息分支”步骤时，该指令可控制 Mech-Viz 工程中的“消息分支”步骤走指定的出口。在调用该指令之前，需要先调用 MM_Start_Viz。 Mech-Viz 运行到分支步骤时会等待 203 指令发送该分支的分支出口。
参量说明
INPUT：
-
Branch_Name：消息分支步骤编号，该参数为正整数，即“消息分支”的步骤编号。
-
Branch_Exit_Port：给定分支的出口号，Mech-Viz 程序将沿该出口继续执行，参数范围[1-99] 。 NOTE:
-
出口号为 Mech-Viz 显示的端口号加 1。即端口 0 为 1 号出口。
-
此处 Branch_Name、Branch_Exit_Port 和功能函数 MM_Set_Index 中 Index_Name、Index_Counter 分别对应 ToCamera 同一 VIZ_TASK_NAME、VIZ_TASK_VALUE，若需设定的值不同，则无法同时生效。
-
-
Set_Branch：设置某个消息分支执行某个出口。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 2105（分支设置成功）；否则返回对应的错误码。
示例
示例说明
在该示例中，当 Camera_User.Set_Branch 出现上升沿时，会指定 Mech-Viz 工程执行到分支名称为 1 的步骤时，走第 1 出口。
设置移动索引
索引类的移动步骤，比如按序列移动、按阵列移动、自定义垛型、预设垛型等，可调用该指令设置索引类移动步骤属性中的索引序号。在调用该指令之前，需要先执行 MM_Start_Viz 。
参量说明
INPUT：
-
Index_Name: 移动索引步骤编号，该参数应为正整数。
-
Index_Counter: 下次执行此步骤时应设置的索引值。 发送该指令时，Mech-Viz 中的当前索引值将变为该参数值减 1。 当 Mech-Viz 工程运行到该指令指定的步骤时，Mech-Viz 中的当前索引值将增加 1，成为该参数的值。
此处 Index_Name、Index_Counter 和功能函数 MM_Set_Branch 中 Branch_Name、Branch_Exit_Port 分别对应结构体 ToCamera 数据块同一 VIZ_TASK_NAME、VIZ_TASK_VALUE，若需设定的值不同，则无法同时生效。 -
Set_Index：触发信号，用于设置索引。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 2106（索引设置成功）；否则返回对应的错误码。
示例
示例说明
在该示例中，当 Camera_User.Set_Index 出现上升沿时，设置 Mech-Viz 工程中的步骤名称 5 的当前索引值为 4 。
获取规划路径
该指令用于获取 Mech-Viz 工程规划的抓取路径。
参量说明
INPUT：
-
Request_Pose_Type: 要获取的路径上点的位姿类型；
-
1：Mech-Viz 返回的位姿类型为机器人 JPS ；
-
2：Mech-Viz 返回的位姿类型为机器人 TCP。
-
-
Get_VizData：获取 Mech-Viz 工程规划的抓取路径，上升沿有效；
-
Data_Ready：专用于接收多组机器人位姿数据时，该信号用于指示位姿数据可读；
-
Send_Pose_Num：Mech-Viz 规划路径上目标点的个数，范围[0,20]；
-
Start_Empty：触发清空已经获取的 Camera_User.Target_Pose、Camera_User.Target_Label 与 Camera_User.Target_Tool_ID 的数据，置位有效。
OUTPUT：
-
Camera_User.Target_Pose：目标抓取点的 TCP，数据类型为 Array[0..19, 0..5] of DInt。用户需将该数组数据除以 10000，然后使用；
-
Camera_User.Target_Label：Mech-Vision 识别的该物体标签信息，数据类型为 Array[0..19] of UDInt。返回的标签值为整数；
-
Camera_User.Target_Tool_ID：Mech-Viz 工程中设置的末端工具编号。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 2100（获取成功）；否则返回对应的错误码；
-
FromCamera.SEND_POSE_TYPE：目标抓取点的位姿类型，与 INPUT 中 Request_Pose_Type 请求位姿类型一致，1 表示 JPS 类型，2 表示 TCP 类型。
-
FromCamera.VISUAL_POINT_INDEX：视觉点位（即工程中的视觉移动）在路径中的位置。
示例
示例说明
在该示例中，当 Camera_User.Get_VizData 出现上升沿时，用于接收 Mech-Viz 返回的机器人移动路径，移动点数据类型为 TCP。 当 Camera_User.Start_Empty 置位时，将清空已经获取的 Camera_User.Target_Pose、Camera_User.Target_Label 与 Camera_User.Target_Tool_ID 的数据。
获取 DO 信号列表
当需要使用 Mech-Viz 中的吸盘分区/多抓功能时，可通过该指令来获取规划的分区 DO 信号列表。调用该指令之前需要先运行 MM_Get_VizData。
NOTE:
请参考 XXXX/Communication Component-xxx/tool/viz_project/suction_zone 中的 suction_zone.viz 模板工程，并在运行之前在工程中设置对应的吸盘配置文件。
参量说明
INPUT：
-
Get_DoList：获取 Mech-Viz 工程规划的分区 DO 信号列表，上升沿有效。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 2102（获取 DO 列表正常）；否则返回对应的错误码；
-
FromCamera.DO_LIST：Mech-Viz返回的DO信号。FromCamera.DO_LIST由8个（0~7）字节构成，每个字节由8位（0~7）构成。因此，FromCamera.DO_LIST的0~63位分别对应0~63个DO信号。例如，DO List第0位表示DO 0信号，如果该位对应的值为True，则表示该DO信号有效，如果该位对应的值为False，则表示该DO信号无效。
示例
示例说明
在该示例中，当 Camera_User.Get_DoList 出现上升沿时，会将 Mech-Viz 计算得到的 DO 列表保存到 DO 数组内。
向 Mech-Vision 传入物体尺寸
该指令用于向 Mech-Vision 工程中动态传入物体尺寸，需要在执行 MM_Start_Vis 之前调用。
参量说明
INPUT：
-
Vision_Proj_Num:Mech-Vision 工程编号，可在 Mech-Vision 工程列表窗口中查看，工程名称前的数字表示工程编号；
-
Camera_User.External_Input_Box_Dimension：单位是毫米，比如箱子尺寸，长宽高，先乘 10000，再给到 External_Input_Box_Dimension[0-2]；
此处 External_Input_Box_Dimension 和功能函数 MM_Set_Pose 中 External_Input_Pose，对应结构体 ToCamera 同一 EXT_INPUT_DATA，若需设定的值不同，则无法同时生效。 -
Set_Box_Dimension：动态传入 Mech-Vision 工程中的物体尺寸，上升沿有效。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：若无错误，则返回 1108（物体尺寸设置成功）；否则返回对应的错误码。
示例
示例说明
在该示例中，当 Camera_User.Set_Box_Dimension 出现上升沿时，将设置 Mech-Vision 工程中读取物体尺寸步骤中的的物体尺寸为 External_Input_Box_Dimension[0-2] 值。
获取软件状态
该指令用于获取软件运行状态（目前该指令只支持检测 Mech-Vision 是否注册就绪）。
参量说明
INPUT：
-
Get_Status：检测 Mech-Vision 是否注册就绪，上升沿有效。
FromCamera 返回数据：
-
FromCamera.STATUS_CODE：系统自检状态。
示例
示例说明
在该示例中，当 Camera_User.Get_Status 出现上升沿时，将检查系统状态的状态码，并保存到 FromCamera.STATUS_CODE 中。
获取通知的消息
在触发Mech-Vision或Mech-Viz工程运行后，该指令用于获取“通知”步骤中预先设置的消息（暂时只支持整数）。
| 当Mech-Vision或Mech-Viz工程运行至“通知”步骤时，设置的消息只会在视觉系统中缓存1秒，因此用户在使用该指令时需要控制好调用时间才能获取到消息内容。另外，PLC在使用该消息后，需要触发变量ToCamera.CLEAR_NOTIFY，以产生一个信号交互周期的脉冲，用于清除该寄存器数据。 |
参量说明
INPUT：
-
Get_Notify：获取“通知”步骤的消息，上升沿有效。
FromCamera 返回数据：
-
NOTIFY_MSG：“通知”步骤的消息，为整数。
示例
假设“通知”步骤中设置的消息为777，PLC在自动模式获取消息的示例如下。
示例说明
在该示例中，在自动模式下将Camera_User.Step_Num设置为3，此时FromCamera.NOTIFY_MSG不等于777，使能MM_Get_Custom_Notify功能；当变量Camera_User.Get_Notify出现上升沿时，获取“通知”步骤中预先设置的消息。 若成功获取到消息，则FromCamera.NOTIFY_MSG等于777；否则FromCamera.NOTIFY_MSG不等于777，PLC在3秒后提示对应报警信息。
附录
状态码（含错误码）定义
请参考 标准接口状态码及错误排查 。