指令说明

本文介绍西门子 PLC 使用 TIA Portal 软件与梅卡曼德视觉系统进行 Modbus TCP 通信的指令。寄存器映射表参考 此处。

指令说明

启动 Mech-Vision 工程

该指令用于只有 Mech-Vision 工程，没有 Mech-Viz 的场景。使用该指令触发 Mech-Vision 工程运行，执行相机拍照和视觉识别。

start mech vision 1

参数说明

输入参数：

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

  • Robot_Pose_Type：机器人位姿类型，指定真实机器人的位姿将以何种形式传 Mech-Vision，其取值范围为 0~3；

  • Robot_Pose：机器人位姿，其值取决于 Robot_Pose_Type 参数值，数据类型为二维数组 Array[0..1, 0..5] of Real，其中 Array[0] 为机器人当前关节角，Array[1] 为机器人当前法兰位姿；

下表为 Robot_Pose_Type 与 Robot_Pose 参数取值的关系及说明。

Robot_Pose_Type 参数值 Robot_Pose 参数值 说明 适用场景

0

0, 0, 0, 0, 0, 0

无需向 Mech-Vision 传入机器人位姿

工程为 Eye To Hand 模式。若 Mech-Vision 工程中使用“路径规划”步骤，则路径规划的起始点为路径规划工具中设置的 Home 点。

1

机器人当前关节角+当前法兰位姿

需要将机器人的关节角和法兰位姿传入 Mech-Vision

工程为 Eye In Hand 模式，除桁架机器人外的大多数机器人适用该设定。

2

机器人的当前法兰位姿

需要将机器人的当前法兰位姿传入 Mech-Vision

工程为 Eye In Hand 模式，机器人无关节角数据，仅有法兰位姿数据（如桁架机器人）。

3

机器人路径规划起始点的关节角

需要将机器人路径规划起始点的关节角传入 Mech-Vision

工程为 Eye To Hand 模式，并且 Mech-Vision 工程中存在“路径规划”步骤，且需要从机器人端设置“路径规划”步骤的起始点。

  • Start_Vision：触发 Mech-Vision 工程运行，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 1102（触发成功），否则返回对应的错误码。

示例

start mech vision 2

示例说明

在该示例中，当变量 “Camera_User”.Start_Vis 出现上升沿时，会触发 Mech-Vision 工程 1 的运行，并希望 Mech-Vision 工程 1 返回视觉结果，同时 PLC 将启动 Mech-Vision 工程时的关节角数据发送给视觉系统。

获取视觉结果

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

get mech vision data 1

参数说明

输入参数：

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

  • Get_VisData：获取 Mech-Vision 工程的视觉识别结果，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 1100（成功获取视觉点）；否则返回对应的错误码；

  • Status of Pose Sent：1 表示写入的位姿数据为新数据，在 PLC 读取位姿数据之后，请启动一次 “MM_Empty_Target” 功能块，视觉系统会将该寄存器置为 0；

  • Number of Pose Sent：Mech-Vision 返回的视觉识别结果个数，范围[1-20]；

  • Target Pose：Mech-Vision 返回的机器人位姿数据，类型为 TCP；

  • Target Label：标签是 Mech-Vision 识别的物体标签信息，返回的标签值为整数。

示例

get mech vision data 2

示例说明

在该示例中，当变量 “Camera_User”.Get_VisData 出现上升沿时，用于获取 Mech-Vision 工程 1 的视觉结果。

切换 Mech-Vision 配方

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

set formula 1

参数说明

输入参数：

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

  • Vision_Recipe_Num：Mech-Vision 工程中配方的编号，编号范围[1-99]；

  • Switch_Recipe：切换 Mech-Vision 工程的配方，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 1107（配方切换成功）；否则返回对应的错误码。

示例

set formula 2

示例说明

在该示例中，当变量 “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，则每次调用该指令只会返回一个路径点，只有多次调用该指令才能接收全部路径点。
get planned visdate 1

参数说明

输入参数：

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

  • Request_Pose_Type: 该参数用于指定“路径规划”步骤返回的路径点类型；

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

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

此处 Request_Pose_Type 和功能函数 MM_Start_Vis、MM_Start_Viz 中 Robot_Pose_Type 对应 MM Modbus TCP Interface 数据块同一 “Pose Type” 变量，若需设定的值不同，则无法同时生效。

  • Get_VisData：获取 Mech-Vision “路径规划”步骤的结果，上升沿有效；

  • Set_Edge：保存触发动作上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若指令执行正常，则返回 1103 状态码；否则返回对应的错误码；

  • Status of Pose Sent：1 表示写入的位姿数据为新数据；在 PLC 读取位姿数据之后，请启动一次 MM_Empty_Target 功能块，将该寄存器置为 0；

  • Number of Pose Sent：Mech-Vision 规划路径上路径点的个数，范围[1-20]；

  • Index of Vision Move：视觉移动路径点在路径中的位置；

  • Target Pose：数据格式为关节角或者 XYZ 欧拉角，取决于输入参数 Request_Pose_Type；

  • Target Label：Mech-Vision 识别的该物体标签信息，返回的标签值为整数；

  • Target Tool ID：路径规划工具中设置的末端工具编号。

示例

get planned visdate 2

示例说明

在该示例中，当变量 “Camera_User”.Get_VisData 出现上升沿时，用于接收 Mech-Vision 工程 1 返回的机器人移动路径，移动路径点数据类型为 JPs 类型。

启动 Mech-Viz 工程

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

start mech viz 1

参数说明

输入参数：

  • Robot_Pose_Type: 机器人位姿类型，指定真实机器人的位姿将以何种形式传 Mech-Viz，其取值范围为 0~2；

  • Robot_Pose：机器人位姿，其值取决于 Robot_Pose_Type 参数值，数据类型为二维数组 Array[0..1, 0..5] of Real，其中 Array[0] 为机器人当前关节角，Array[1] 为机器人当前法兰位姿；

下表为 Robot_Pose_Type 与 Robot_Pose 参数取值的关系及说明。

Robot_Pose_Type 参数值 Robot_Pose 参数值 说明 适用场景

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

机器人端自定义的关节角

需要将机器人的一个示教点（非当前关节角）传入 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。

robot example

  • Start_Viz：触发 Mech-Viz 工程运行，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 2103（Mech-Viz 启动成功）；否则返回对应的错误码。

示例

start mech viz 2

示例说明

在该示例中，当变量 “Camera_User”.Start_Viz 出现上升沿时，触发 Mech-Viz 工程运行，并将当前机器人的关节角发送给视觉系统。

停止 Mech-Viz 工程

停止运行 Mech-Viz 工程。如果 Mech-Viz 工程不是死循环，或可以正常停止，则不需要使用该指令。

stop mech viz 1

参数说明

输入参数：

  • Stop_Viz：停止运行 Mech-Viz，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 2104（Mech-Viz 停止成功）；否则返回对应的错误码。

示例

stop mech viz 2

示例说明

在该示例中，当变量 “Camera_User”.Stop_Viz 出现上升沿时，停止运行 Mech-Viz 工程。

选择 Mech-Viz 分支

当 Mech-Viz 工程中有“消息分支”步骤时，该指令可控制 Mech-Viz 工程中的“消息分支”步骤走指定的出口。在调用该指令之前，需要先调用 MM_Start_Viz。 Mech-Viz 运行到“消息分支”步骤时会等待 203 指令发送该分支的分支出口。

set branch 2

参数说明

输入参数：

  • Branch_Name：分支步骤编号，该参数为正整数，即“消息分支”的步骤编号。

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

    出口号为 Mech-Viz 显示的端口号加 1，即端口 0 为 1 号出口。

  • Set_Branch：设置某个消息分支执行某个出口，上升沿有效。

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 2105（分支设置成功）；否则返回对应的错误码。

示例

set branch 3

示例说明

在该示例中，当变量 “Camera_User”.Set_Branch 出现上升沿时，会指定 Mech-Viz 工程执行到分支名称为 1 的步骤时，走第 1 出口。

设置移动索引

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

set index 2

参数说明

输入参数：

  • Index_Name: 移动索引步骤编号，该参数为正整数。

  • Index_Counter: 下次执行此步骤时应设置的索引值。 发送该指令时，Mech-Viz 中的当前索引值将变为该参数值减 1。 当 Mech-Viz 工程运行到该指令指定的步骤时，Mech-Viz 中的当前索引值将增加 1，成为该参数的值。

  • Set_Index：触发信号，用于设置索引，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 2106（索引设置成功）；否则返回对应的错误码。

示例

set index 3

示例说明

在该示例中，当变量 “Camera_User”.Set_Index 出现上升沿时，设置 Mech-Viz 工程中的步骤名称 5 的当前索引值为 3。

获取规划路径

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

get mech viz date 1

参数说明

输入参数：

  • Request_Pose_Type: 要获取的路径上点的位姿类型；

    • 1：Mech-Viz 返回的位姿类型为机器人关节角；

    • 2：Mech-Viz 返回的位姿类型为机器人 TCP。

此处 Request_Pose_Type 和功能函数 MM_Start_Vis、MM_Start_Viz 中 Robot_Pose_Type 对应 MM Modbus TCP Interface 数据块同一 “Pose Type” 变量，若需设定的值不同，则无法同时生效。

  • Get_VizData：获取 Mech-Viz 工程规划的抓取路径，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 2100（获取成功）；否则返回对应的错误码；

  • Status of Pose Sent：1 表示写入的位姿数据为新数据。在 PLC 读取位姿数据之后，请启动一次 MM_Empty_Target 功能块，视觉系统将该寄存器置为 0；

  • Number of Pose Sent：Mech-Viz 规划路径上目标点的个数，范围[1-20]；

  • Index of Vision Move：视觉点位（即工程中的视觉移动）在路径中的位置；

  • Target Pose：数据格式为关节角或者 XYZ 欧拉角，取决于 205 发送指令中设置的位姿类型；

  • Target Label：Mech-Vision 识别的该物体标签信息，返回的标签值为整数；

  • Target Tool ID：Mech-Viz 工程中设置的末端工具编号。

示例

get mech viz date 2

示例说明

在该示例中，当变量 “Camera_User”.Get_VizData 出现上升沿时，用于接收 Mech-Viz 返回的机器人移动路径，移动点数据类型为 TCP 类型。

获取 DO 信号列表

该指令用于获取Mech-Vision或Mech-Viz工程规划的多分区吸盘的控制信号。在执行该指令前，请先执行 MM_Get_Planned_VisData 或 MM_Get_VizData 。

get do list 1

使用该指令前，用户需提前配置DO信号。

  • 配置Mech-Vision工程中的DO信号

    在“路径规划”步骤参数中，单击打开编辑器，双击末端工具名称，工具类型选择拆垛吸盘，单击拆垛吸盘配置，根据需求配置DO信号。

    sucker vis

  • 配置Mech-Viz工程中的DO信号和“设置DO”步骤

    在Mech-Viz软件中，双击末端工具名称，工具类型选择拆垛吸盘，单击拆垛吸盘配置，根据需求配置DO信号。

    sucker viz

参数说明

输入参数：

  • Vision_Proj_Num：该参数指定DO信号列表的来源，取值为0或正整数，具体说明如下。

    • 0：从Mech-Viz获取DO信号列表。

    • 正整数：从Mech-Vision获取DO信号列表。此处设置的正整数就是Mech-Vision工程编号。

  • Depalletize_Tool_Section_Count：该参数表示吸盘分区数量。

  • Get_DoList：触发获取 DO 信号列表，上升沿有效。

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

输出参数：

  • Vision_Proj_Num_O：DO信号列表的来源。

  • Depalletize_Tool_Section_Count_O：吸盘分区数量。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 2102（获取 DO 列表正常）；否则返回对应的错误码。

  • DO_LIST：该指令返回 64 个 DO 端口值。

根据所搭建工程的不同，该指令返回的DO信号会有所不同，具体如下。

  • Mech-Vision工程规划的吸盘DO信号

    • 在路径规划的全局配置中，若规划全部视觉结果开关处于关闭状态，则该指令返回64个DO信号，表示本轮规划的吸盘DO信号，其中有效的DO信号为非负整数，范围为 0~999；无效的DO信号为-1（作为占位值）。

      plan all vis off

      例如，在下表中，返回的有效DO信号为1、3、5、6，即表示机器人需将上述DO信号对应的值设为ON。

      第1个

      第2个

      第3个

      第4个

      第5个

      第6个

      第7个

      第8个

      …

      第63个

      第64个

      1

      3

      5

      6

      -1

      -1

      -1

      -1

      …

      -1

      -1

    • 在路径规划的全局配置中，若规划全部视觉结果开关处于打开状态，则Mech-Vision可以根据同一视觉结果进行多轮规划。该指令返回的64个DO信号是所有轮规划的吸盘DO信号。此时使用吸盘分区数量，即可区分每轮规划的吸盘DO信号。

      plan all vis on

      例如，吸盘分区数量为4，该指令共返回64个DO信号，其中，每4个DO信号为一轮规划的多分区吸盘控制信号。

      第1轮规划

      第2轮规划

      …

      第16轮规划

      第1个

      第2个

      第3个

      第4个

      第5个

      第6个

      第7个

      第8个

      …

      第61个

      第62个

      第63个

      第64个

      1

      3

      4

      -1

      1

      4

      -1

      -1

      …

      -1

      -1

      -1

      -1

  • Mech-Viz工程规划的吸盘DO信号

    • 若“视觉移动”步骤未勾选“复用视觉结果”，则该指令返回64个DO信号，表示本轮规划的吸盘DO信号，其中有效的DO信号为非负整数，范围为 0~999；无效的DO信号为-1（作为占位值）。

      vision move off

      例如，在下表中，返回的有效DO信号为1、3、5、6，即表示机器人需将上述DO信号对应的值设为ON。

      第1个

      第2个

      第3个

      第4个

      第5个

      第6个

      第7个

      第8个

      …

      第63个

      第64个

      1

      3

      5

      6

      -1

      -1

      -1

      -1

      …

      -1

      -1

    • 若“视觉移动”步骤勾选“复用视觉结果”，且“视觉移动”步骤在循环流程中，则Mech-Viz可以根据同一视觉结果进行多轮规划。该指令返回的64个DO信号是所有轮规划的吸盘DO信号。此时使用吸盘分区数量，即可区分每轮规划的吸盘DO信号。

      vision move on

      例如，吸盘分区数量为4，该指令共返回64个DO信号，其中，每4个DO信号为一轮规划的多分区吸盘控制信号。

      第1轮规划

      第2轮规划

      …

      第16轮规划

      第1个

      第2个

      第3个

      第4个

      第5个

      第6个

      第7个

      第8个

      …

      第61个

      第62个

      第63个

      第64个

      1

      3

      4

      -1

      1

      4

      -1

      -1

      …

      -1

      -1

      -1

      -1

示例

get do list 2

示例说明

在该示例中，当变量 “Camera_User”.Get_DoList 出现上升沿时，若 Vision_Proj_Num 为 0，Depalletize_Tool_Section_Count 为 3，则 Mech-Viz 返回的 DO 列表将保存到 DO 数组内。

向 Mech-Vision 传入物体尺寸

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

read object dimensions 2

参数说明

输入参数：

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

  • External_Input_Box_Dimension：单位是毫米，比如箱子尺寸，长宽高；

  • Set_Box_Dimension：动态传入 Mech-Vision 工程中的物体尺寸，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 1108（物体尺寸设置成功）；否则返回对应的错误码。

示例

read object dimensions 3

示例说明

在该示例中，当变量 “Camera_User”.Set_Box_Dimension 出现上升沿时，将设置 Mech-Vision 工程中读取物体尺寸步骤中的的物体尺寸为 External_Input_Box_Dimension[0-2] 变量值。

获取软件状态

该指令用于获取软件运行状态（目前该指令只支持检测 Mech-Vision 是否注册就绪）。

get software state 1

参数说明

输入参数：

  • Get_Status：检测 Mech-Vision 是否注册就绪，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：系统自检状态。

示例

get software state 2

示例说明

在该示例中，当变量 “Camera_User”.Get_Status 出现上升沿时，将检查系统状态的状态码，并保存到变量 Status Code 中。

清空目标数据

该指令用于清空已经获取的 Target Pose、Target Label、Target Tool ID 变量的数据。

clear target data 1

参数说明

输入参数：

  • Start_Empty：触发清空已经获取的 Target Pose、Target Label、Target Tool ID 的数据，置位有效；

  • Target_Pose：已获取的目标位姿数据；

  • Target_Label：已获取的目标标签；

  • Target_Tool_ID：已获取的末端工具编号。

MM Modbus TCP Interface 数据块返回数据：

  • Status Code：若无错误，则返回 3103（成功清空 Modbus TCP 数据）；否则返回对应的错误码。

示例

clear target data 2

示例说明

在该示例中，当变量 “Camera_User”.Start_Empty 置位时，将清空已经获取的 Target Pose、Target Label、Target Tool ID 变量的数据。

获取通知的消息

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

当Mech-Vision或Mech-Viz工程运行至“通知”步骤时，设置的消息只会在视觉系统中缓存1秒，因此用户在使用该指令时需要控制好调用时间才能获取到消息内容。另外，在下次运行Mech-Vision或Mech-Viz工程时，保存消息的寄存器会被自动清除。
get notify 1

参数说明

输入参数：

  • Get_Notify：获取“通知”步骤的消息，上升沿有效；

  • Set_Edge：保存 触发动作 上一扫描周期的状态。

MM Modbus TCP Interface 数据块返回数据：

  • Notify：“通知”步骤的消息，为整数。

示例

假设“通知”步骤中设置的消息为777，PLC在自动模式获取消息的示例如下。

get notify 2

示例说明

在该示例中，在自动模式下将"Camera_User".Step_Num设置为3，此时"MM Modbus TCP Interface".Notify不等于777，使能"MM_Get_Custom_Notify"功能；当变量"Camera_User".Get_Notify出现上升沿时，获取“通知”步骤中预先设置的消息。 若成功获取到消息，则"MM Modbus TCP Interface".Notify等于777；否则"MM Modbus TCP Interface".Notify不等于777，PLC在3秒后提示对应报警信息。

附录

状态码（含错误码）定义

请参考 标准接口状态码及错误排查 。

我们重视您的隐私

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

  • Preference
  • 同意
  • 不同意