Die .ini-Datei des Communicators

Auf dieser Seite wird die Verwendung der Communicator-Konfigurationsdatei zum Konfigurieren der Protokollierung und der Porteinstellungen für eine zusätzliche Communicator-Instanz beschrieben.

Diese Konfigurationsdatei sollte nur verwendet werden, wenn manuell eine zusätzliche Communicator-Instanz im Prozessintegrationsmodus von MERLIC gestartet werden soll, ohne jedes Mal die gewünschten Kommandozeilenargumente manuell zu „merlic_rte.exe“ hinzufügen zu müssen.

Normalerweise wird nur eine Instanz des Communicators mit einem konfigurierten Plugin im MERLIC RTE Setup gestartet. In diesem Fall können Sie den Abschnitt [Communicator] zur .ini-Datei von MERLIC (standardmäßig „MERLIC5.ini“) hinzufügen, die mit „merlic_rte.exe“ verwendet wird, anstatt die Ports in der Kommandozeile zu definieren.

Weitere Informationen finden Sie unter Communicator auf der Seite zur .ini-Datei im MERLIC-Handbuch.

Eine Communicator.ini-Datei erstellen

Die Communicator-Konfigurationsdatei muss manuell erstellt und bearbeitet werden, da der Communicator keine Einstellungen ändert oder speichert. Die Communicator.ini-Datei wird daher nicht automatisch erstellt. Der Communicator lädt beim Start jedoch eine Datei namens „Communicator.ini“ im Standardverzeichnis, sofern diese vorhanden ist. Zeilen, die mit „#“ beginnen, werden vom MERLIC Communicator ignoriert und können für Kommentare verwendet werden.

Weitere Informationen zum Standardverzeichnis finden Sie im Abschnitt Speicherort.

Weitere Informationen zum Starten des MERLIC Communicators mit einer benutzerdefinierten .ini-Datei, d. h. einer Datei mit einem anderen Namen oder in einem anderen Speicherort, finden Sie im Abschnitt Zusätzliche .ini-Dateien verwenden.

Allgemeine Informationen

Speicherort

Das Standardverzeichnis für die Communicator.ini-Datei ist „C:\Users\<username>\AppData\Roaming\MVTec“, d. h. das gleiche Verzeichnis, in der sich auch die .ini-Datei befindet, mit der MERLIC gestartet wird. Sie können auch %APPDATA%\MVTec im Datei-Explorer eingeben, um zu diesem Verzeichnis zu gelangen.

Zusätzliche .ini-Dateien verwenden

Sie können den MERLIC Communicator mit einer .ini-Datei, die in einem anderen Speicherort gespeichert ist oder einen anderen Namen aufweist, über die Kommandozeile starten:

  1. Öffnen Sie eine Eingabeaufforderung und wechseln Sie in das Verzeichnis „bin\x64-win64“ unter dem MERLIC-Installationspfad, z. B. "%PROGRAMFILES%\MVTec\MERLIC-5.6\bin\x64-win64".
  2. Geben Sie den folgenden Befehl ein, um den Communicator mit einer anderen .ini-Datei zu starten.
    Kopieren
    merlic_communicator.exe --ini <FILE>

Eigenschaften in der .ini-Datei außer Kraft setzen

Wenn Sie den MERLIC Communicator über die Kommandozeile starten, haben Sie die Möglichkeit, einige Eigenschaften der .ini-Datei außer Kraft zu setzen. Mit den verfügbaren Kommandozeilenoptionen können Sie spezielle Einstellungen für die aktuelle Sitzung definieren. Die angegebene Option in der Kommandozeile überschreibt den Wert, die für die jeweilige Eigenschaft in der Datei „Communicator.ini“ und in der Datei „MERLIC5.ini“ festgelegt ist. Gleiches gilt für die Eigenschaften, die in der .ini-Datei für MERLIC (standardmäßig „MERLIC5.ini“) festgelegt sind. Wenn „Communicator.ini“ verwendet wird, überschreiben die Eigenschaften in der Communicator.ini-Datei die Konfiguration der standardmäßigen MERLIC5.ini-Datei.

Aufbau und Codierung

Die .ini-Datei besteht aus verschiedenen Abschnitten, die Einstellungen für die jeweilige Komponente enthalten. Alle Abschnitte sind optional, d. h., der Communicator wird unabhängig davon gestartet, ob und welche Abschnitte enthalten sind. Die Namen der Abschnitte in der .ini-Datei stehen in eckigen Klammern [ ]. Wenn Sie die .ini-Datei bearbeiten, können Sie neue Abschnitte beliebig über oder unter vorhandenen Abschnitten hinzufügen.

Die .ini-Datei muss auf allen Plattformen die Zeichencodierung UTF-8 aufweisen. Es ist möglich, normale Schrägstriche („/“) und umgekehrte Schrägstriche („\“) als Pfadtrennzeichen in der Communicator.ini-Datei zu verwenden. Zeilen, die mit „#“ beginnen, werden von MERLIC ignoriert.

Abschnitte

Nachstehend finden Sie ausführliche Informationen zu den verfügbaren Abschnitten und Eigenschaften für die Datei „Communicator.ini“. Derzeit können Sie Eigenschaften in den folgenden Abschnitten definieren:

Alle Abschnitte sind optional, d. h., der Communicator wird unabhängig davon gestartet, ob und welche Abschnitte enthalten sind.

[Communicator]

Dieser Abschnitt enthält Eigenschaften für die Kommunikation zwischen dem Communicator und MERLIC sowie Verzeichniseinstellungen.

Eigenschaft

Standardwert

Beschreibung

Entsprechendes Kommandozeilenargument

CommandPort

21591

Diese Eigenschaft definiert den Befehlsport, der für die Kommunikation des MERLIC Communicators mit MERLIC im Prozessintegrationsmodus verwendet werden soll.

Entsprechendes Kommandozeilenargument: --command_port

--command_port

CommandTimeout

5000 [ms]

Diese Eigenschaft definiert das Timeout in Millisekunden für Befehle, die von Plugins gesendet werden, falls der Communicator nicht antwortet.

Entsprechendes Kommandozeilenargument: --command_timeout

--command_timeout

ConfigDir

%APPDATA%/MVTec/Communicator/conf

Diese Eigenschaft definiert das Verzeichnis für Plugin-Konfigurationsdateien.

Entsprechendes Kommandozeilenargument: --config_dir

--config_dir

EventPort

21590

Diese Eigenschaft definiert den Ereignisport, der für die Kommunikation des MERLIC Communicators mit MERLIC im Prozessintegrationsmodus verwendet werden soll.

Entsprechendes Kommandozeilenargument: --event_port

--event_port

PluginConfigurationPorts

Diese Eigenschaft definiert die festen Ports für die Konfigurationsdienste für Communicator-Plugins, wenn das MERLIC RTE Setup auf einem Remote-System verwendet wird. Sie müssen drei Ports angeben, damit die Remote-Konfiguration ordnungsgemäß funktioniert, z. B. „10123;10124;10125“. Sie können Ports des Betriebssystems im Bereich von 1024 bis 65535 verwenden. Wenn Sie diese Eigenschaft zum Festlegen der Ports verwenden, müssen die folgenden Bedingungen erfüllt sein:

  • Die angegebenen Ports müssen frei sein. Andernfalls wird der Communicator nicht gestartet, sodass kein Zugriff auf die Konfiguration im MERLIC RTE Setup möglich ist.
  • Die angegebenen Ports dürfen sich nicht mit den Ports überlappen, die für die Eigenschaft „ImageSourceConfigurationPorts“ im [General]-Abschnitt der MERLIC5.ini-Datei festgelegt sind. Andernfalls können die Konfigurationsdienste nicht gleichzeitig verwendet werden.

Wenn diese Eigenschaft zum Definieren fester Ports verwendet wird, kann nur eine MERLIC Communicator-Instanz gestartet werden.

Entsprechendes Kommandozeilenargument: --plugin_config_ports

--plugin_config_ports

PluginDir

Wenn MERLIC mit Administratorrechten installiert wurde:

%PROGRAMFILES%\MVTec\MERLIC-5.6

Wenn MERLIC ohne Administratorrechte installiert wurde:

%LOCALAPPDATA%\Programs\MVTec\MERLIC-5.6

Diese Eigenschaft definiert das Verzeichnis, in dem Plugins gesucht werden sollen. 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.

Entsprechendes Kommandozeilenargument: --plugin_dir

--plugin_dir

[Logging]

Dieser Abschnitt enthält Eigenschaften für Namenskonvention, Pfad, Größe und Anzahl der Log-Dateien, die vom Communicator generiert werden, sowie den Schwellenwert für Meldungen.

Eigenschaft

Standardwert

Beschreibung

LogFilePath

%LOCALAPPDATA%\MVTec\MERLIC\

%LOCALAPPDATA%\MVTec\MERLIC\

Diese Eigenschaft definiert den Pfad zum Verzeichnis, in dem die Log-Datei gespeichert wird.

Sie können Schrägstriche (/), Backslashes (\) oder doppelte Backslashes (\\) für Dateipfade in MERLIC .ini-Dateien verwenden. MERLIC speichert die Pfade intern jedoch mit Schrägstrichen (/).

LogFileSizeInBytes

10 485 760 (= 10 MB)

Diese Eigenschaft definiert die maximale Größe der Log-Datei in Bytes. Wird die maximale Größe der Log-Datei erreicht und ist die Eigenschaft „LogFilesCount“ > 1, protokolliert MERLIC die neuen Meldungen in einer neuen Datei. Wird die maximale Anzahl zulässiger Log-Dateien erreicht, überschreibt MERLIC die ältesten Meldungen.

Minimaler Wert: 1 048 576 = 1 MB

LogFilesCount

10

Diese Eigenschaft definiert die maximale Anzahl von Log-Dateien, die im Log-Dateiverzeichnis gespeichert werden. Wird die maximale Größe aller Log-Dateien erreicht, löscht MERLIC ältere Log-Dateien.

Threshold

info

Diese Eigenschaft definiert die verwendete Log-Ebene. Bei der Protokollierung von Meldungen einer bestimmten Ebene werden im Allgemeinen auch alle Meldungen von schwerwiegenderen Ebenen protokolliert. Die folgenden Log-Ebenen sind verfügbar:

  • none: Es werden keine Meldungen protokolliert.
  • critical: Meldungen des Schweregrads „critical“ enthalten Informationen zu Fehlern, die zu einem Absturz von MERLIC führen.
  • error: Meldungen des Schweregrads „error“ enthalten Informationen zu Fehlern, z. B. für MERLIC-Tools. Bei Auswahl dieser Log-Ebene werden auch Meldungen des Schweregrads „critical“ protokolliert.
  • warning: Meldungen des Schweregrads „warning“ enthalten Informationen, die auf ein Problem hinweisen, z. B. in einem MERLIC-Tool. Bei Auswahl dieser Log-Ebene werden auch Meldungen der Schweregrade „critical“ und „error“ protokolliert.
  • info: Meldungen des Schweregrads „info“ enthalten allgemeine unkritische Informationen. Bei Auswahl dieser Log-Ebene werden auch Meldungen der Schweregrade „critical“, „error“ und „warning“ protokolliert.
  • trace: Meldungen des Schweregrads „trace“ enthalten ausführliche Informationen, die u. U. für die Erkennung des Kontexts von Warn- oder Fehlermeldungen nützlich sind. Bei Auswahl dieser Log-Ebene werden auch Meldungen der Schweregrade „critical“, „error“, „warning“ und „info“ protokolliert.
Kopieren 
[Logging]
LogFilePath=C:/Users/Public/Documents/Log_Files/
LogFilesCount=5
LogFileSizeInBytes=2097152
Threshold=error

Die Log-Dateien verwenden die folgende Namenskonvention: "merlic_communicator_<YYYY-MM-DD>_<hh-mm-ss>_<ProcessID>_<Counter>.log".

Platzhalter

Beschreibung

YYYY

Jahr

MM

Monat

DD

Tag

hh

Stunde

mm

Minute

ss

Sekunde

ProcessID

Windows-Prozess-ID der jeweiligen Communicator-Instanz

Counter

Zähler der Log-Datei. Dieser wird immer dann erhöht, wenn der Communicator die Protokollierung in einer neuen Log-Datei beginnt, d. h. wenn die Log-Datei die maximale Größe überschreitet, die in „LogFileSizeInBytes“ festgelegt wurde. Bei jedem Start einer Communicator-Instanz wird der Zähler auf 0 zurückgesetzt.