启动 Communicator 和插件

可通过多种方法启动 Communicator、Communicator 插件和 MERLIC 流程集成模式（即 MERLIC RTE）。您可以单独启动 Communicator，也可以与 Communicator 插件一起启动。还可以一步启动 Communicator 和 MERLIC RTE。

要启动 Communicator 插件，Communicator 本身必须已在运行。因此，如果单独从 Communicator 启动插件，则必须确保 Communicator 已在运行。否则将无法启动插件。如果 Communicator 正在运行，则可以随时启动和停止插件，而无论 MERLIC RTE 是否正在运行，插件中另有指定的情况除外。如果 Communicator 正在运行，还可以在 MERLIC RTE Setup 中访问插件的配置。有关 MERLIC RTE Setup 中的配置选项的更多信息，请参阅主题 配置 Communicator 插件。除 Communicator 插件的配置外，还可以在 MERLIC RTE Setup 中启动和停止插件。

以下部分介绍启动和停止 Communicator、Communicator 插件以及处于流程集成模式的 MERLIC 的不同方法。

启动 Communicator

以下部分介绍启动 Communicator 的不同方法。最简单的方法是使用 Windows 开始菜单。但是，在某些情况下，通过命令行启动 Communicator 并结合使用可用的命令行选项可能更方便。

如果想要使用特定设置（例如，使用的端口）启动 Communicator，可以在 .ini 文件中或使用命令行选项进行设置。请参阅更改 Communicator 和插件设置主题，了解更多信息。

通过 Windows 开始菜单启动 Communicator
  1. 打开 Windows 开始菜单。
  2. 导航到“MVTec MERLIC 5.6 > MERLIC 5.6 Communicator”以启动 Communicator。
通过命令行启动 Communicator

要通过命令行启动 Communicator，转到 MERLIC 安装中的“bin\x64-win64”目录并使用以下命令：

复制 
merlic_communicator.exe

此命令会启动 Communicator，但不启动任何插件。要随 Communicator 启动插件，可以使用“--plugin”选项，如从命令行启动插件部分所述。

还有一些其他命令行选项可供您设置 Communicator 的特定设置。详见下面的下拉菜单。另请参阅 更改 Communicator 和插件设置 主题，了解有关如何定义 Communicator 的特定设置的更多信息

命令行选项

描述

--help, -h

显示 MERLIC Communicator 命令行选项。

--ini

设置用于配置 Communicator .ini 文件的完整路径和文件名称。

--version, -v

显示 MERLIC Communicator 版本。

--available_plugins, -l

显示在插件目录中找到的文件名中包含前缀 pMV 的兼容插件的名称，例如，pMVevent-logger.dll → event-logger。插件目录中的所有动态库会接受兼容性检查。启用日志等级“debug”，详细了解有关文件夹中的其他 .dll 文件未被接受为插件的原因。只提供名称而未提供绝对路径的插件将相对于插件目录进行解释。

--log-level, -d

定义插件所使用的日志等级和来自 Communicator 的消息。默认日志等级为“info”。使用此选项，您可以为每个插件设置全局日志等级和单个日志等级。而如果在选项“--plugin”后使用标记“d:”，则只能为单个插件设置日志等级。请参阅更改 Communicator 和插件设置主题中的定义日志等级部分，了解更多信息。

--plugin, -p

为要启动的插件定义以下选项。使用此选项启动插件时，应考虑可能发生的一些副作用和限制。请参阅副作用和限制部分了解更多信息。

  • 名称

    插件名称是要加载的动态库的名称，没有前缀。必须在插件的任何其他选项之前输入和提供该名称。

    示例：

    复制 
    merlic_communicator.exe --plugin event-logger

    merlic_communicator.exe --plugin event-logger

  • 日志等级，d:

    要定义全局日志等级，使用选项“--log-level”或“-d”，后跟所需的值。默认日志等级为“info”。可用的选项为“debug”、“info”、“warning”、“error”和“critical”。要为插件指定不同的日志等级，可以提供所需的等级加上前缀“d:”。

    示例：

    复制 
    merlic_communicator.exe --plugin event-logger d:debug

    merlic_communicator.exe --plugin event-logger d:debug

    请参阅更改 Communicator 和插件设置主题中的定义日志等级部分，了解更多信息。

  • 访问，a:

    访问等级与函数 MVInfo 中为插件定义的功能相关。如果已为插件设置功能 eMVCapabilities_MonitorAndControl（“monitor and control”），则可以使用此标记将插件的访问等级限制为“monitor”或“control”。

    示例：

    复制 
    merlic_communicator.exe --plugin OPC_UA a:monitor

    merlic_communicator.exe --plugin OPC_UA a:monitor

--plugin_dir

定义插件目录。此目录用于存储插件文件。如果以管理员权限安装 MERLIC，则默认的插件目录为“%PROGRAMFILES%\MVTec\MERLIC-5.6\bin\x64-win64”，否则为“%LOCALAPPDATA%\Programs\MVTec\MERLIC-5.6\bin\x64-win64”。还可以将多个插件目录定义为以分号分隔的列表。请参阅更改 Communicator 和插件设置主题中的更改插件目录部分，了解更多信息。

--config_dir

定义配置目录。此目录用于存储插件的 JSON 配置文件。

默认配置目录是系统的标准配置位置，例如，在 Windows 上为“%AppData%/MVTec/Communicator/conf”。

请参阅更改 Communicator 和插件设置主题中的更改配置目录部分，了解更多信息。

--command_timeout

定义命令超时的时间。在定义的时间后，视觉系统的挂起命令将超时。默认时间为 5000 毫秒。如果要禁用超时，请输入负数。

--command_port

定义用于命令（例如“操作”）的端口。请参阅更改 Communicator 和插件设置主题中的定义端口部分，了解更多信息。

--event_port

定义用于“事件”的端口。请参阅更改 Communicator 和插件设置主题中的定义端口部分，了解更多信息。

--plugin_config_ports

定义由 Communicator 打开以允许配置插件的端口。如果使用此选项，则只能启动 Communicator 的一个实例。有关更多信息，请参阅相应配置属性 PluginConfigurationPorts 的描述。

结合 Communicator 在流程集成模式下启动

流程集成模式（即 MERLIC RTE）和 Communicator 也可通过 Windows 开始菜单或命令行一步启动。在某些情况下，例如，如果要使用特定端口，通过命令行启动并结合使用可用的命令行选项可能更方便。

通过 Windows 开始菜单一步启动 MERLIC RTE 和 Communicator
  1. 打开 Windows 开始菜单。
  2. 导航到“MVTecMERLIC5.6 > MERLIC 5.6 RTE with Frontend + Communicator”以启动 MERLIC RTE、相应的 Frontend 以及 Communicator。
通过命令行一步启动 MERLIC RTE 和 Communicator

要通过命令行一步启动 MERLIC RTE 和 Communicator，请切换到 MERLIC 安装的“bin\x64-win64”目录，然后使用命令行选项“--communicator”或“-c”启动 MERLIC RTE（即“merlic_rte.exe”）。

复制 
merlic_rte.exe --communicator

如果还要启动相应的 Frontend，您可以添加命令行选项“--frontend”或“-f”。其作用等同于 Windows 开始菜单。

有关如何启动 MERLIC RTE 和可用命令行选项的更多信息，请参阅 MERLIC 手册中的在流程集成模式下启动主题。

如果想要更改 MERLIC RTE 的默认设置，例如，使用的端口，可以使用 MERLIC （MERLIC5.ini）的 .ini 文件设置所需的值。通过开始菜单启动 MERLIC 流程集成时，将使用 MERLIC5.ini 文件中的设置。有关 MERLIC5.ini 文件的更多信息，请参阅 MERLIC 手册中的 MERLIC.ini 文件主题。

如果通过命令行启动 Communicator 和 MERLIC RTE，并使用命令行选项“--event_port”和“--command_port”为“事件”和命令定义端口，则必须确保“merlic_rte.exe”和“merlic_communicator.exe”的端口设置匹配才能建立连接。

启动和停止 Communicator 插件

您可以在 MERLIC RTE Setup 的“通讯”选项卡中或通过命令行启动 Communicator 插件。在 MERLIC RTE Setup 中，还可以访问插件实例的配置。更改配置后，可以立即从 MERLIC RTE Setup 启动插件。

在 MERLIC RTE Setup 中启动插件
  • 从左侧插件实例列表中选择所需的插件，然后单击 MERLIC RTE Setup 底部的按钮“ 启动插件”。
  • 此外，可以使用相应插件实例的菜单。

要获取有关如何在 MERLIC 中启动和停止 Communicator 插件的更多详细信息，请参阅 MERLIC 手册中的启动和停止 Communicator 插件主题。

从命令行启动插件

要通过 Communicator 启动一个或多个插件，转到 MERLIC 安装路径中的“bin\x64-win64”目录并使用以下命令：

复制 
merlic_communicator.exe --plugin <NAME1> [--plugin <NAME2> ...]

Communicator 将启动，插件将自动加载并启动。有关“merlic_communicator.exe”的可用命令行选项的更多信息，请参阅从命令行启动 Communicator 部分。

通过命令行启动插件时，需要考虑一些副作用和限制。因此，我们建议在 MERLIC RTE Setup 的“通讯”选项卡中启动插件。

  • 配置：
    • 插件将使用其默认配置加载和启动。
    • 对插件配置的所有更改都将丢失。更改不会保存到插件的相应 JSON 配置文件中。
    • 如果想要保存配置的更改，则需要使用命令行选项“--config_dir”为此特定插件实例定义配置文件的位置。但是，建议指定与现有位置不同的位置，以免覆盖插件的原有配置。
  • 插件状态：
    • 即使使用了“--config_dir”选项且相应插件的最后状态为“未在运行”，插件也会自动启动。
停止 Communicator 插件

可以通过以下方法在“通讯”选项卡中停止插件实例：

  • 从左侧插件实例列表中选择所需的插件，然后单击 MERLIC RTE Setup 底部的按钮“ 停止插件”。
  • 此外，可以使用相应插件实例的菜单。

结果格式

要获取有关返回结果的格式的信息，请参阅 Communicator API 参考文档中的Result Format 主题。

停止 Communicator

要停止 Communicator，请打开相应的命令 shell 并按“Ctrl+C”。您可以随时终止并重新启动 MERLIC 或 Communicator。

在 Communicator 运行时停止 MERLIC

如果在 Communicator 仍在运行时安全终止了 MERLIC，则相应的插件会收到有关 MERLIC 已切换为“Halted”状态的信息。MERLIC 再次启动时，有关 MERLIC 状态变化的信息将通过事件转发到插件。与插件的连接便会恢复。

在 MERLIC 运行时停止 Communicator

如果在 MERLIC 仍在运行时停止 Communicator，则仅会关闭插件。MERLIC 会继续运行。当 Communicator 再次启动时，它会自动重新连接 MERLIC。插件将重新打开并且会准备就绪以接收事件。

Communicator 未连接时所发送的所有事件都将丢失。系统不会以任何方式存储它们。