Skip to main content

Scripting

Le CODESYS Le moteur de script est étendu avec des fonctions par CODESYS File-Based Storage qui peut être utilisé dans un script pour ouvrir un projet basé sur des fichiers, pour convertir un projet au format de stockage basé sur des fichiers et pour valider un projet avant conversion. La fonctionnalité de script est disponible uniquement lorsque le CODESYS File-Based Storage Le module complémentaire est installé.

. Le moteur de script fournit deux objets globaux :
  • fbs Point d'entrée des opérations de stockage basées sur des fichiers

  • FBSValidationStatus Liste des états de validation

Ouverture d'un projet (fbs.open)

Utiliser fbs.open pour ouvrir un projet basé sur des fichiers ou un espace de travail.

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


path

Chemin d'accès au dossier du projet ou à un fichier d'espace de travail (.fbsws )

primary

Si primary est réglé sur True, le projet sera alors ouvert en tant que projet principal.

La valeur par défaut est True.

update_flags

Indicateurs de mise à jour de version qui déterminent si les bibliothèques et la version du compilateur sont mises à jour ou non lors de l'ouverture du projet.

La valeur par défaut est VersionUpdateFlags.NoUpdates.

index

Index du projet à ouvrir quand path est un fichier d'espace de travail contenant plusieurs projets.

valeur de retour La fonction renvoie le projet ouvert.

Conversion d'un projet (convert_to_fbs)

Chaque objet de projet est étendu avec le convert_to_fbs méthode. Cette méthode n'est disponible que lorsque la CODESYS File-Based Storage L'extension est installée.

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


path

Répertoire de destination du projet converti

native_import_handler

Gestionnaire d'importation utilisé lors de la conversion

update_flags

Indicateurs de mise à jour de version appliqués lors de l'ouverture du projet converti. La valeur par défaut est VersionUpdateFlags.NoUpdates.

valeur de retour: Lorsque la conversion réussit, True est renvoyé. Lors de la conversion, le projet source est fermé et un nouveau projet vide, basé sur des fichiers, est ouvert comme projet principal.

Validation d'un projet (validate_for_fbs)

Utiliser validate_for_fbs Vérifier qu'un projet ne présente pas de problèmes avant sa conversion.

results = project.validate_for_fbs()

En l'absence de problème, une liste vide sera renvoyée. Sinon, une liste de résultats de validation sera renvoyée. Chaque résultat possède les propriétés suivantes :

status

Statut du résultat de type FBSValidationStatus, Warning, ou Error

message

Description du problème

affected_object

Objet auquel le problème se rapporte