Konfigurationsdatei

Der UI Client wird über die Datei config.json konfiguriert. Die Datei liegt abhängig vom Betriebssystem in folgenden Verzeichnissen.

Betriebssystem

Pfad zur Konfiguration

Pfad zur Hilfeseite

Windows

%AppData%\Beckhoff\TF1200-UI-Client

%TwinCAT3dir%\Functions\TF1200-UI-Client\documentation\TF1200-UI-Client.html

TwinCAT/BSD

/home/USER/.config/TF1200-UI-Client

USER = Benutzer für den der UI Client installiert wurde.

/usr/local/etc/TwinCAT/Functions/TF1200-UI-Client/documentation/TF1200-UI-Client.html

*Als StartUrl wird die Hilfeseite gesetzt und wird beim ersten Start angezeigt.

In der Konfigurationsdatei liegen folgende Eigenschaften in der configVersion = 1.5 vor.

Eigenschaft

Default-Wert*

Default-Konfig

Datentyp

Beispiele

Beschreibung

Erforderlich

allowMove

True

True

Boolean

True / False

Erlaubt das Verschieben des Fensters, wenn der Kiosk Modus deaktiviert ist.

-

allowResize

True

True

Boolean

True / False

Erlaubt die Größe des Fensters zu ändern, wenn der Kioskmode deaktiviert ist.

 

autoUpdateConfig

False

True

Boolean

True / False

Aktiviert die automatische Aktualisierung der Konfigurationsdatei mit neuen Eigenschaften für zukünftige Versionen.

-

commandLineSwitches

-

-

String Array

“ignore-certificate-errors”

Plattformspezifische Kommandozeilenschalter, die von Electron unterstützt und von Chromium ohne führende Bindestriche gemäß der folgenden Dokumentation gelesen werden: https://www.electronjs.org/docs/latest/api/command-line-switches.

-

configVersion

1.5

1.5

String

Wird vom UI-Client gesetzt.

Aktuelle Version der config.json Datei.

defaultTheme

““

““

String

"system"

"light"

"dark"

Standard-Theme, das verwendet wird, um den Wert zu überschreiben und zu ersetzen, den Chromium intern verwenden will.

-

enableDevTools

True

True

Boolean

True / False

Aktivieren Sie Entwicklerwerkzeuge, damit sie automatisch oder durch Drücken der konfigurierten Taste oder Tastenkombination geöffnet werden können.

-

enableIncognitoMode

True

True

Boolean

True / False

Aktivieren Sie den Inkognito-Modus, damit die sitzungsbezogenen Daten im Speicher beim Schließen der Anwendung gelöscht werden.

-

enableKioskMode

True

False

Boolean

True / False

Aktivieren Sie den Kioskmodus, damit die Anwendung im Vollbildmodus läuft und die Menüleiste entfernt wird.

-

enableMenuBar

True

False

Boolean

True / False

"Enable the default menu bar. This setting is ignored and the menu bar is disabled if kiosk mode is enabled."

-

extensions

“”

““

Object

{name: “MyExtension“,

version: “1.0.0“,

directory: “ "%ProgramData%\\Beckhoff\\TcUiClient\MyExtension”,

debugPort:60000}

Name der Erweiterung

Semantische Versions-Nr

Pfad der Erweiterung, das die Datei „<Name>.Config.json“ zum Beschreiben der Extension enthält.

Port (1-65535) zum Debuggen der Erweiterung.

Wenn gesetzt wird der Name, die Version und der Pfad zum Verzeichnis benötigt.

maxVisualZoomLevelLimit

1

1

Number

-

Der maximale Grenzwert für die Verkleinerung und Vergrößerung. Der Standardwert legt fest, dass das Zoomen nur bis zu 100 % der Originalgröße erlaubt ist, was bedeutet, dass überhaupt kein Zoomen erlaubt ist. Größere Werte erlauben das Zoomen bis zur angegebenen Grenze, z. B. 200 %, wenn ein Wert von 2 angegeben ist.

-

openDevTools

False

False

Boolean

True / False

Öffnen die Entwicklertools automatisch im Browserfenster, wenn sie aktiviert sind.

-

persistPosition

False

True

Boolean

True / False

Die aktuelle Position des Browserfensters wird beim Schließen persistiert, wenn der Kioskmodus deaktiviert ist.

-

persistSize

False

True

Boolean

True / False

Die aktuelle Größe des Browserfensters wird beim Schließen persistiert, wenn der Kioskmodus deaktiviert ist“.

-

position

-

Wird gespeichert beim Beenden des Clients, wenn persistSize=true gesetzt ist.

Object

{“x“: 100, y: 100}

Datentyp

x = Integer

y = Integer

Legt die Position des Browserfensters relativ zur linken oberen Ecke des Hauptbildschirms fest, wenn der Kioskmodus deaktiviert ist

Wenn gesetzt, müssen x und y angegeben sein.

quitApplicationKeys

“Esc“

“Esc“

String

"Alt+F4",

"CmdOrCtrl+W"

Definiert die Taste oder Tastenkombination zum Beenden der Anwendung.

-

reloadBrowserWindowKeys

““

„“F5“

String

"F5",

"CmdOrCtrl+R"

Legt die Taste oder Tastenkombination fest, mit der das Browserfenster neu geladen wird.

-

retryErrorCodes

[ ]

[-7,-100,-101,-102,-103,-104,-106,-109,-118,-119,-120,-121,-130,-133,-137,-139,-154,-352,-802,-803]

Array (Integers)

Die vollständige Liste der Fehlercodes und ihre Bedeutung finden Sie hier: https://source.chromium.org/chromium/chromium/src/+/main:net/base/net_error_list.h

Netzwerk Fehlercodes von Chromium, bei denen das Laden der angegebenen Start-URL erneut versucht werden soll, wenn dies fehlschlägt.

-

retryInterval

0

5000

Integer

-

Intervall in Millisekunden, um das Laden der angegebenen Start-URL zu wiederholen, wenn dies fehlschlägt. Wird 0 angegeben, wird das Laden der angegebenen Start-URL im Fehlerfall nicht erneut versucht.

-

retryMaxCount

 

0

5

Integer

-

Maximale Anzahl an Wiederholungen, um die angegebene Start-URL zu laden, wenn dies fehlschlägt. Wenn 0 angegeben wird, wird das Laden der angegebenen Start-URL im Fehlerfall nicht wiederholt

-

size

-

{"width": 800, "height": 600}

Object

-

Legt die Größe des Browserfensters fest, wenn der Kioskmodus deaktiviert ist.

-

startUrl

Windows:

"%ProgramData%\\Beckhoff\\TcUiClient\\resources\\app.asar\\doc\\TF1200-UI-Client.html"

TwinCAT/BSD:

"/usr/local/www/${USER}/TF1200-UI-Client/default.html"

 

String

"https://www.beckhoff.com/"

“https://127.0.0.1:2020/”

URL der Website oder (plattformspezifisch) Pfad der lokalen HTML-Datei, die beim Start geladen wird. Umgebungsvariablen in plattformspezifischer Schreibweise werden ersetzt, wenn sie vorhanden sind.

toggleDevToolsKeys

“”

“”

String

"F12", "CmdOrCtrl+Shift+I"

 

Definiert die Taste oder Tastenkombination zum Umschalten der Entwicklerwerkzeuge, wenn diese aktiviert sind.

-

windowTitle

““

““

String

“TwinCAT UI Client“

Titel des Browserfensters. Wenn kein Titel angegeben wird, wird der Titel der Website oder der lokalen HTML-Datei verwendet, die beim Start geladen wird.

-

*Default-Wert gilt, wenn die Eigenschaft in der Konfiguration nicht gesetzt ist.