Anwendungs-Einstellungsdatei

Die Einstellungen der Anwendung sind in lumiscan-calibration.json gespeichert. Enthält der Einstellungsordner keine solche Datei, kopiert die Anwendung beim Start ihr Beispiel dorthin, zusammen mit dem Beispielmodul.

  • Auf ctrlX OS: Die Beispiel-TIFF-Datei wird nicht mit der App ausgeliefert. Das Beispielmodul meldet Status -2, bis Sie Ihre eigene TIFF-Datei hochladen und das Modul zurücksetzen.

  • Auf einem PC: Die Beispiel-TIFF-Datei wird mit der Installation ausgeliefert, sodass das Beispielmodul sofort funktioniert.

{
    "$schema": "schemas/lumiscan-calibration.schema.json",
    "meta": {
        "inputFileType": "LumiScan-CtrlX-Calibration",
        "inputFileVersion": "1.0.0",
        "targetMachine": "MachineName",
        "programName": "LumiScan-Calibration",
        "programVersion": "1.0.0"
    },
    "modules": [
        "example.json"
    ],
    "system": {
        "debug": false,
        "logLevel": "INFO",
        "storage": {
            "type": "Internal",
            "parameters": {
                "rootPath": "output"
            }
        }
    }
}

Die Parameter sind in Tabelle 4 beschrieben. Die Datei darf Kommentare enthalten (// und /* */).

Tabelle 1. Tabelle 4: Beschreibung der JSON-Einstellungsdatei der Anwendung
Parameter Beschreibung

meta

Metadaten der Datei. Sie dienen nur der Information.

meta.inputFileType

Der Dateityp: LumiScan-CtrlX-Calibration.

meta.inputFileVersion

Die Version des Dateiformats: 1.0.0.

meta.targetMachine

Der Name der Maschine, für die die Konfiguration bestimmt ist.

meta.programName

Die Anwendung, die die Datei verwendet: LumiScan-Calibration.

meta.programVersion

Die Anwendungsversion, für die die Konfiguration erstellt wurde.

modules

Die Modul-Konfigurationsdateien, relativ zu dieser Datei. Jede ist ein Modul, benannt nach ihrer Datei ohne .json. Siehe Modul-Konfigurationsdatei.

system.logLevel

Der Log-Level: TRACE, DEBUG, INFO, WARN, ERROR, FATAL oder OFF. Der Standard ist INFO.

system.debug, system.storage

Gemeinsam mit den anderen LumiScan-Anwendungen. Von LumiScan Calibration nicht verwendet.

Starten Sie LumiScan Calibration nach einer Änderung dieser Datei neu, zum Beispiel nach dem Hinzufügen eines Moduls.

  • Kann die Datei nicht gelesen werden, schreibt die Anwendung den Grund in das Protokoll und beendet sich.

  • Ein Modul, dessen Datei oder TIFF-Datei nicht geladen werden kann, wird trotzdem bedient: Es meldet Status -2 (invalidSetting), bis seine Dateien korrigiert sind und das Modul zurückgesetzt wird.

  • Ohne aufgeführtes Modul läuft die Anwendung weiter, und hdvisionsystems/lumiscan-calibration/system/status-text meldet das.

Mit einem Beispiel beginnen (PC)

Auf einem PC schreibt die Calibration ein Beispiel ihrer Einstellungen in einen Ordner Ihrer Wahl und beendet sich, ohne zu starten. Zum Beispiel unter Windows:

lumiscan-calib --generate-settings C:\work\calibration-settings

Ohne Ordner (-g allein) schreibt sie in den aktuellen Ordner. Das Beispiel besteht aus der Anwendungs-Einstellungsdatei lumiscan-calibration.json, ihrer Beispiel-Moduldatei example.json mit der Lookup-Tabelle example.tiff, die dieses Modul benennt, und den vier Schemata im Ordner schemas, mit denen ein Editor sie prüft. Vorhandene Dateien werden nie überschrieben: Liegt eine davon bereits im Ordner, wird nichts geschrieben, und die Calibration nennt welche.

Die Calibration nennt dann den Ordner, aus dem sie ihre Einstellungen liest, standardmäßig (Windows) C:\ProgramData\HD Vision Systems GmbH\LumiScan Vision Suite\lumiscan-calib\etc\lumiscan-calibration. Bearbeiten Sie das Beispiel, kopieren Sie es dorthin, und starten Sie die Calibration.

Vollständige Referenz

Alle Einstellungen dieser Datei, wie sie ihr JSON-Schema lumiscan-calibration.schema.json festlegt, erzeugt für Version 2.0.0 (Beschreibungen aus dem Schema, auf Englisch):

Einstellung Typ Standard Zulässige Werte Beschreibung

meta

object

Pflichtangabe. Meta information about the application and current setting. This is mainly for information purpose and not used by the application itself

meta/inputFileType

string

nicht leer

Pflichtangabe.

meta/inputFileVersion

string

nicht leer

Pflichtangabe.

meta/targetMachine

string

nicht leer

Pflichtangabe.

meta/programName

string

nicht leer

Pflichtangabe.

meta/programVersion

string

nicht leer

Pflichtangabe.

modules

string[]

mindestens 1 Eintrag

Pflichtangabe. List of module setting files that will be loaded by the application

system

object

system/debug

boolean

false

Enable debug mode for the application.

system/logLevel

string

INFO

TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Log level for the application.

system/storage

object

Configuration for storage. The storage is used to store the images when save function is called.

system/storage/type

string

Samba

Pflichtangabe. The storage is a Samba storage.

system/storage/parameters

object

Parameters for the storage. The parameters are different for each storage type.

system/storage/parameters/ip

string

nicht leer

Pflichtangabe. The IP address of the Samba server.

system/storage/parameters/remotePath

string

nicht leer

Pflichtangabe.

system/storage/parameters/domain

string

nicht leer

Pflichtangabe.

system/storage/parameters/username

string

nicht leer

Pflichtangabe.

system/storage/parameters/password

string

nicht leer

Pflichtangabe.

JSON-Schemas

Die Anwendung legt die JSON-Schemas ihrer Einstellungsdateien in ihrem Ordner schemas ab; diese Kopien passen immer zur installierten Version. Die Schemas von LumiScan Calibration 2.0.0 stehen außerdem zum Download bereit: JSON-Schemas von LumiScan Calibration 2.0.0.

Damit ein Editor wie Visual Studio Code eine Kopie einer Einstellungsdatei prüft, die Sie auf Ihrem PC bearbeiten, lassen Sie deren Eintrag $schema auf das veröffentlichte Schema zeigen:

{
  "$schema": "https://docs.hdvisionsystems.com/schemas/lumiscan-calibration/2.0.0/lumiscan-calibration.schema.json",
  ...
}

Lassen Sie den Eintrag $schema der Dateien auf dem Gerät so, wie die Anwendung ihn geschrieben hat.