Skip to main content

Skripting

Die CODESYS-Scripting-Engine wird von CODESYS File-Based Storage um Funktionen erweitert, mit denen ein Skript ein dateibasiertes Projekt öffnet, ein Projekt in das dateibasierte Speicherformat konvertiert und ein Projekt vor einer Konvertierung validiert. Die Skripting-Funktionalität ist nur verfügbar, wenn das Plug-in CODESYS File-Based Storage installiert ist.

. Von der Scripting-Engine werden zwei globale Objekte bereitgestellt:

  • fbs: Einstiegspunkt für die dateibasierten Speicheroperationen

  • FBSValidationStatus: Aufzählung mit den Validierungszuständen

Projekt öffnen (fbs.open)

Verwenden Sie fbs.open, um ein dateibasiertes Projekt oder einen Workspace zu öffnen.

Beispiel 2. Beispiel
project = fbs.open(path, primary=True, update_flags=VersionUpdateFlags.NoUpdates, index=-1)


path

Pfad zum Projektordner oder zu einer Workspace-Datei (.fbsws)

primary

Wenn primary auf True gesetzt ist, wird das Projekt als primäres Projekt geöffnet.

Der Standardwert ist True.

update_flags

Versions-Update-Flags, die steuern, ob die Bibliotheken und die Compiler-Version beim Öffnen des Projekts aktualisiert werden.

Der Standardwert ist VersionUpdateFlags.NoUpdates.

index

Index des zu öffnenden Projekts, wenn path eine Workspace-Datei mit mehreren Projekten ist.

Rückgabewert: Die Funktion liefert das geöffnete Projekt zurück.

Projekt konvertieren (convert_to_fbs)

Jedes Projektobjekt wird um die Methode convert_to_fbs erweitert. Die Methode ist nur verfügbar, wenn das Add-on CODESYS File-Based Storage installiert ist.

Beispiel 3. Beispiel
success = project.convert_to_fbs(path, native_import_handler, update_flags=VersionUpdateFlags.NoUpdates)


path

Zielverzeichnis für das konvertierte Projekt

native_import_handler

Import-Handler, der während der Konvertierung verwendet wird

update_flags

Versions-Update-Flags, die beim Öffnen des konvertierten Projekts angewendet werden. Der Standardwert ist VersionUpdateFlags.NoUpdates.

Rückgabewert: Wenn die Konvertierung erfolgreich war, wird True zurückgeliefert. Während der Konvertierung wird das Quellprojekt geschlossen, und ein neues, leeres dateibasiertes Projekt wird als primäres Projekt geöffnet.

Projekt validieren (validate_for_fbs)

Verwenden Sie validate_for_fbs, um ein Projekt vor einer Konvertierung auf Probleme zu prüfen.

results = project.validate_for_fbs()

Wenn kein Problem vorliegt, wird eine leere Liste zurückgegeben. Andernfalls wird eine Liste mit Validierungsergebnissen zurückgegeben. Jedes Ergebnis besitzt die folgenden Properties:

status

Status des Ergebnisses vom Typ FBSValidationStatus, Warning oder Error

message

Beschreibung des Problems

affected_object

Objekt, auf das sich das Problem bezieht

In diesem Abschnitt: