Communicator und Plugins starten

Es gibt verschiedene Möglichkeiten, um den Communicator, ein Communicator-Plugin und den Prozessintegrationsmodus von MERLIC, d. h. das MERLIC RTE, zu starten. Sie können den Communicator für sich allein oder zusammen mit einem Communicator-Plugin starten. Es ist auch möglich, den Communicator und das MERLIC RTE in einem Schritt zu starten.

Um ein Communicator-Plugin zu starten, muss der Communicator selbst bereits ausgeführt werden. Wenn Sie ein Plugin getrennt vom Communicator starten möchten, müssen Sie daher sicherstellen, dass der Communicator bereits ausgeführt wird. Andernfalls kann das Plugin nicht gestartet werden. Wenn der Communicator ausgeführt wird, kann ein Plugin unabhängig davon, ob das MERLIC RTE ausgeführt wird, jederzeit gestartet und beendet werden (sofern das Plugin keine andere anderen Angaben macht). Wenn der Communicator ausgeführt wird, können Sie im MERLIC RTE Setup auch auf die Konfiguration eines Plugins zugreifen. Weitere Informationen zur Konfiguration im MERLIC RTE Setup finden Sie unter Communicator-Plugins konfigurieren. Neben dem Konfigurieren von Communicator-Plugins können Sie Plugins im MERLIC RTE Setup auch starten und beenden.

In den folgenden Abschnitten werden die verschiedenen Möglichkeiten zum Starten und Beenden des Communicators, von Communicator-Plugins und von MERLIC im Prozessintegrationsmodus beschrieben.

Den Communicator starten

In den folgenden Abschnitten werden die verschiedenen Möglichkeiten zum Starten des Communicators beschrieben. Die einfachste Möglichkeit ist das Windows-Startmenü. In einigen Fällen kann es jedoch sinnvoll sein, den Communicator über die Kommandozeile zu starten und die verfügbaren Kommandozeilenoptionen zu verwenden.

Wenn Sie den Communicator mit bestimmten Einstellungen, z. B. verwendete Ports, starten möchten, können Sie diese in einer .ini-Datei oder mit Kommandozeilenoptionen festlegen. Weitere Informationen finden Sie auf der Seite Communicator- und Plugin-Einstellungen ändern.

Den Communicator über das Windows-Startmenü starten

1. Öffnen Sie das Windows-Startmenü.
2. Navigieren Sie zu „MVTec MERLIC 5.6 > MERLIC 5.6 Communicator“, um den Communicator zu starten.

Den Communicator über die Kommandozeile starten

Um den Communicator über die Kommandozeile zu starten, wechseln Sie in das Verzeichnis „bin\x64-win64“ in der MERLIC-Installation, und geben Sie den folgenden Befehl ein:

merlic_communicator.exe

Dieser Befehl startet den Communicator ohne Plugin. Um ein Plugin zusammen mit dem Communicator zu starten, können Sie die Option „--plugin“ verwenden (siehe Beschreibung im Abschnitt Starten des Plugins über die Kommandozeile).

Darüber hinaus gibt es weitere Kommandozeilenoptionen, mit denen Sie bestimmte Einstellungen für den Communicator festlegen können. Diese werden ausführlich im folgenden Dropdown-Menü beschrieben. Weitere Informationen zum Definieren bestimmter Einstellungen für den Communicator finden Sie auch unter Communicator- und Plugin-Einstellungen ändern.

Liste der verfügbaren Kommandozeilenoptionen

Kommandozeilenoption	Beschreibung
--help, -h	Zeigt die MERLIC Communicator-Kommandozeilenoptionen an.
--ini	Gibt den vollständigen Pfad und den Dateinamen der .ini-Datei an, die für die Communicator-Konfiguration verwendet wird.
--version, -v	Zeigt die MERLIC Communicator-Version an.
--available_plugins, -l	Zeigt die Namen von kompatiblen Plugins im Plugin-Verzeichnis mit dem Präfix pMV im Dateinamen an, z. B. pMVevent-logger.dll → event-logger. Alle dynamischen Bibliotheken im Plugin-Verzeichnis werden auf Kompatibilität überprüft. Aktivieren Sie die Log-Ebene „debug“, um weitere Informationen zu den Gründen zu erhalten, warum weitere .dll-Dateien im Ordner nicht als Plugins akzeptiert werden. Plugins-Angaben, die nur den Namen ohne absoluten Pfad enthalten, werden relativ zum Plugin-Verzeichnis interpretiert.
--log-level, -d	Definiert die verwendete Log-Ebene für das Plugin und die Meldungen vom Communicator. Die Standardeinstellung für die Log-Ebene ist „info“. Mit dieser Option können Sie eine globale Log-Ebene und individuelle Log-Ebenen für die einzelnen Plugins festlegen. Im Gegensatz dazu können Sie mit dem Flag „d:“ hinter der Option „--plugin“ nur die Log-Ebene für ein einzelnes Plugin festlegen. Weitere Informationen finden Sie im Abschnitt Definieren der Log-Ebene auf der Seite Communicator- und Plugin-Einstellungen ändern.
--plugin, -p	Definiert die folgenden Optionen für das zu startende Plugin. Wenn Sie diese Option zum Starten eines Plugins verwenden, gibt es einige Nebeneffekte und Einschränkungen, die beachtet werden müssen. Weitere Informationen finden Sie im Abschnitt Nebeneffekte und Einschränkungen. Name Der Plugin-Name ist der Name der dynamischen Bibliothek, die geladen werden soll, ohne Präfix. Er muss vor allen anderen Optionen des Plugins angegeben werden. Beispiel: Kopieren merlic_communicator.exe --plugin event-logger merlic_communicator.exe --plugin event-logger Log-Ebene, d: Verwenden Sie die Option „--log-level“ oder „-d“ mit dem gewünschten Wert dahinter, um die globale Log-Ebene zu definieren. Die Standardeinstellung für die Log-Ebene ist „info“. Die verfügbaren Optionen sind „debug“, „info“, „warning“, „error“ und „critical“. Um eine andere Log-Ebene für ein Plugin anzugeben, können Sie die gewünschte Ebene mit „d:“ davor angeben. Beispiel: Kopieren merlic_communicator.exe --plugin event-logger d:debug merlic_communicator.exe --plugin event-logger d:debug Weitere Informationen finden Sie im Abschnitt Definieren der Log-Ebene auf der Seite Communicator- und Plugin-Einstellungen ändern. Zugriff, a: Die Zugriffsebene bestimmt die Berechtigungen, die für das Plugin in der Funktion MVInfo definiert werden. Wenn die Berechtigung eMVCapabilities_MonitorAndControl („monitor and control“) für ein Plugin festgelegt wurde, haben Sie die Möglichkeit, die Zugriffsebene des Plugins mit diesem Flag auf „monitor“ oder „control“ festzulegen. Beispiel: Kopieren merlic_communicator.exe --plugin OPC_UA a:monitor merlic_communicator.exe --plugin OPC_UA a:monitor
--plugin_dir	Definiert das Plugin-Verzeichnis. In diesem Verzeichnis werden die Plugin-Dateien gespeichert. Das Standardverzeichnis für Plugins ist „%PROGRAMFILES%\MVTec\MERLIC-5.6\bin\x64-win64“, wenn MERLIC mit Administratorrechten installiert wurde, sonst „%LOCALAPPDATA%\Programs\MVTec\MERLIC-5.6\bin\x64-win64“. Es ist möglich, mehrere Plugin-Verzeichnisse in einer Liste mit Semikolons als Trennzeichen zu definieren. Weitere Informationen finden Sie im Abschnitt Ändern des Plugin-Verzeichnisses auf der Seite Communicator- und Plugin-Einstellungen ändern.
--config_dir	Definiert das Konfigurationsverzeichnis. In diesem Verzeichnis werden die JSON-Konfigurationsdateien für die Plugins gespeichert. Das Standardkonfigurationsverzeichnis ist der Standardkonfigurationsspeicherort Ihres Systems, z. B. „%AppData%/MVTec/Communicator/conf“ unter Windows. Weitere Informationen finden Sie im Abschnitt Ändern des Konfigurationsverzeichnisses auf der Seite Communicator- und Plugin-Einstellungen ändern.
--command_timeout	Definiert die Timeout-Dauer für Befehle. Nach der definierten Dauer erfolgt ein Timeout für ausstehende Befehle an das Bildverarbeitungssystem. Das Standarddauer beträgt 5000 Millisekunden. Um das Timeout zu deaktivieren, geben Sie eine negative Zahl ein.
--command_port	Definiert den Port, der für Befehle („Aktionen“) verwendet wird. Weitere Informationen finden Sie im Abschnitt Definieren der Ports auf der Seite Communicator- und Plugin-Einstellungen ändern.
--event_port	Definiert den Port, der für „Ereignisse“ verwendet wird. Weitere Informationen finden Sie im Abschnitt Definieren der Ports auf der Seite Communicator- und Plugin-Einstellungen ändern.
--plugin_config_ports	Definiert die Ports, die vom Communicator geöffnet werden, um die Konfiguration von Plugins zu ermöglichen. Wenn diese Option verwendet wird, kann nur eine Communicator-Instanz gestartet werden. Weitere Informationen finden Sie in der Beschreibung der entsprechenden Konfigurationseigenschaft PluginConfigurationPorts.

Prozessintegrationsmodus zusammen mit dem Communicator starten

Sie können den Prozessintegrationsmodus, d. h. das MERLIC RTE, und den Communicator über das Windows-Startmenü oder die Kommandozeile auch in einem Schritt zusammen starten. In einigen Fällen kann es nützlich sein, die Kommandozeile und die verfügbaren Kommandozeilenoptionen zu verwenden, wenn z. B. bestimmte Ports verwendet werden sollen.

MERLIC RTE und Communicator in einem Schritt über das Windows-Startmenü starten

1. Öffnen Sie das Windows-Startmenü.
2. Navigieren Sie zu „MVTec MERLIC 5.6 > MERLIC 5.6 RTE with Frontend + Communicator“, um das MERLIC RTE, das entsprechende Frontend und den Communicator zu starten.

MERLIC RTE und Communicator in einem Schritt über die Kommandozeile starten

Um das MERLIC RTE und den Communicator über die Kommandozeile zu starten, wechseln Sie in das Verzeichnis „bin\x64-win64“ der MERLIC-Installation, und starten Sie das MERLIC RTE („merlic_rte.exe“) mit der Kommandozeilenoption „--communicator“ oder „-c“.

merlic_rte.exe --communicator

Wenn Sie auch das jeweilige Frontend starten möchten, können Sie die Kommandozeilenoption „--frontend“ oder „-f“ hinzufügen. Dies entspricht der Option über das Windows-Startmenü.

Weitere Informationen zum Starten des MERLIC RTEs und den verfügbaren Kommandozeilenoptionen finden Sie auf der Seite Starten des Prozessintegrationsmodus im MERLIC-Handbuch.

Wenn Sie die Standardeinstellungen für das MERLIC RTE, z. B. die verwendeten Ports, ändern möchten, können Sie die .ini-Datei für MERLIC (MERLIC5.ini) verwenden, um die gewünschten Werte festzulegen. Beim Starten der MERLIC-Prozessintegration über das Startmenü werden die Einstellungen in der MERLIC5.ini-Datei verwendet. Weitere Informationen zur MERLIC5.ini-Datei finden Sie unter Die .ini-Datei für MERLIC im MERLIC-Handbuch.

Ein Communicator-Plugin starten und beenden

Sie können ein Communicator-Plugin auf der Registerkarte „Kommunikation“ des MERLIC RTE Setups und über die Kommandozeile starten. Im MERLIC RTE Setup können Sie auch auf die Konfiguration einer Plugin-Instanz zugreifen. Wenn Sie die Konfiguration ändern, können Sie das Plugin sofort im MERLIC RTE Setup starten.

Plugin im MERLIC RTE Setup starten

• Wählen Sie das gewünschte Plugin in der Liste der Plugin-Instanzen auf der linken Seite aus, und klicken Sie auf die Schaltfläche „ Plugin starten“ unten im MERLIC RTE Setup.
• Alternativ können Sie das Menü der betreffenden Plugin-Instanz verwenden.

Informationen zu den verschiedenen Möglichkeiten zum Starten und Beenden eines Communicator-Plugins im MERLIC RTE Setup finden Sie unter Starten und Beenden von Communicator-Plugins im MERLIC-Handbuch.

Plugin über die Kommandozeile starten

Um ein Plugin oder mehrere Plugins zusammen mit dem Communicator zu starten, wechseln Sie in das Verzeichnis „bin\x64-win64“ in der MERLIC-Installation, und geben Sie den folgenden Befehl ein:

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

Der Communicator wird gestartet, und die Plugins werden automatisch geladen und gestartet. Weitere Informationen zu den verfügbaren Kommandozeilenoptionen für „merlic_communicator.exe“ finden Sie im Abschnitt Den Communicator über die Kommandozeile starten.

Beim Starten des Plugins über die Kommandozeile müssen einige Nebeneffekte und Einschränkungen berücksichtigt werden. Daher wird empfohlen, das Plugin auf der Registerkarte „Kommunikation“ des MERLIC RTE Setups zu starten.

Nebeneffekte und Einschränkungen

• Konfiguration:
  • Das Plugin wird mit der jeweiligen Standardkonfiguration geladen und gestartet.
  • Alle Änderungen der Plugin-Konfiguration gehen verloren. Die Änderungen werden nicht in der jeweiligen JSON-Konfigurationsdatei des Plugins gespeichert.
  • Wenn Sie die Änderungen in Ihrer Konfiguration speichern möchten, müssen Sie die Kommandozeilenoption „--config_dir“ verwenden, um den Speicherort der Konfigurationsdatei für die betreffende Plugin-Instanz anzugeben. Es wird jedoch empfohlen, einen anderen Speicherort als den derzeit verwendeten Speicherort anzugeben, um ein Überschreiben von vorherigen Konfigurationen des Plugins zu vermeiden.
• Plugin-Status:
  • Das Plugin wird auch dann automatisch gestartet, wenn die Option „--config_dir“ verwendet wird und der letzte Status des betreffenden Plugins „nicht ausgeführt“ war.

Ein Communicator-Plugin beenden

Sie haben folgende Möglichkeiten, um eine Plugin-Instanz auf der Registerkarte „Kommunikation“ zu beenden:

• Wählen Sie das gewünschte Plugin in der Liste der Plugin-Instanzen auf der linken Seite aus, und klicken Sie auf die Schaltfläche „ Plugin stoppen“ unten im MERLIC RTE Setup.
• Alternativ können Sie das Menü der betreffenden Plugin-Instanz verwenden.

Ergebnisformat

Weitere Informationen zum Format, in dem Ergebnisse zurückgegeben werden, finden Sie auf der Seite Result Format in der Referenzdokumentation der Communicator-API.

Den Communicator beenden

Öffnen Sie zum Beenden des Communicators die jeweilige Befehlsshell, und drücken Sie „Strg+C“. Sie können MERLIC oder den Communicator jederzeit beenden und neu starten.

MERLIC beenden, während der Communicator ausgeführt wird

Wenn MERLIC ordnungsgemäß beendet wird, während der Communicator noch ausgeführt wird, werden die betreffenden Plugins benachrichtigt, dass der Zustand von MERLIC zu „Halted“ geändert wurde. Wenn MERLIC wieder gestartet wird, werden die Plugins durch Ereignisse über den geänderten MERLIC-Zustand benachrichtigt. Die Verbindung zu den Plugins wird wiederhergestellt.

Den Communicator beenden, während MERLIC ausgeführt wird

Wenn der Communicator beendet wird, während MERLIC noch ausgeführt wird, werden nur die Plugins geschlossen. MERLIC wird weiterhin ausgeführt. Wird der Communicator wieder gestartet, wird die Verbindung zu MERLIC automatisch wiederhergestellt. Die Plugins werden wieder geöffnet und können Ereignisse empfangen.