Fichier de configuration

Présentation

Controller Assistant peut être paramétré à l'aide d'un fichier de configuration externe au format XML. Ce fichier de configuration propre à l'utilisateur peut être chargé au démarrage du programme. Ensuite, les paramètres sont disponibles. Le fichier est lu par Controller Assistant et non modifié.

Si le fichier de configuration se trouve dans le répertoire d'exécution de Controller Assistant, il est pris en compte au démarrage du programme. Ses paramètres influencent le comportement et le fonctionnement de Controller Assistant. Les paramètres sont utilisés à des fins d'intégration dans les IHM.

Structure

Le fichier est structuré au format XML (http://www.xml.org) et doit inclure la norme de codage ISO-8859-1. Cela vous permet de saisir des caractères spéciaux (tels que ä, ö et ü) à tout moment à l'aide d'un éditeur de texte.

Le nœud racine est nommé <config>. Vous trouverez la description des autres nœuds dans la section Paramètres de ce chapitre.

L'exemple ci-dessous de fichier de configuration contient 2 entrées : autofilesavefilename et defaultfilesavedirectory. Elles sont toutes les deux regroupées sous le nœud parent fileoptions.

Exemple de fichier de configuration avec 2 entrées :

<?xml version="1.0" encoding="ISO-8859-1" ?>
<config>
  <fileoptions>
    <autofilesavefilename>
      <![CDATA[Backup_<date>_<counter>.pdi]]
    <autofilesavefilename>
    <defaultfilesavedirectory>
       c:\temp\PD-BackUp
    <defaultfilesavedirectory>
  <fileoptions>
</config>>

Les modifications apportées au fichier doivent être conformes au langage XML. Sinon, le chargement du fichier échouera. Au démarrage de Controller Assistant, cette situation est indiquée par un message de diagnostic qui précise la ligne et la colonne incorrectes. Le programme démarre, mais le fichier de configuration n'est pas pris en compte.

Appel

Il existe 2 manières de charger le fichier de configuration souhaité :

  • Automatique

    S'il y a un fichier nommé Controller assistant.config.xml dans le répertoire de démarrage de Controller Assistant, il est chargé automatiquement au démarrage. Le programme utilise ensuite les paramètres qu'il contient pendant son exécution.

  • Manuelle

    Vous pouvez aussi charger un fichier de configuration explicitement à partir d'un autre emplacement du système de fichiers en utilisant une ligne de commande. Celle-ci est prioritaire sur l'appel automatique. Vous pouvez utiliser la syntaxe suivante sur la ligne de commande :

    -userconfigfile <file name>

    Dans ce cas, le fichier de configuration indiqué par <file name> est chargé.

Paramètres

Les paramètres sont décrits là où ils apparaissent dans le fichier de configuration Controller assistant.config.xml. Vous y trouverez des exemples d'applications. Comme ce fichier se trouve dans le répertoire du programme, vous pouvez l'utiliser comme modèle.

De plus, les paramètres sont décrits en détail. Ils sont répertoriés sous forme de chemins XML qui décrivent leur position distinctive au sein du fichier XML.

config/fileoptions/autofilesavefilename

Quand un fichier est enregistré, un nom de fichier peut être généré automatiquement. Ce nom peut comprendre des éléments constants, des valeurs (date ou type de contrôleur) et un compteur. Le nom généré automatiquement est ensuite proposé, par exemple dans la boîte de dialogue Enregistrer sous.

Le nom généré automatiquement peut être décrit par du texte et des espaces réservés.

Exemple

BackUp_date=<date>.bpd obtient le nom du fichier BackUp_date=2006-03-12.bpd

La date courante est utilisée. L'espace réservé doit être saisi en minuscules. Ainsi, <date> est valide, tandis que <Date> n'est pas reconnu.

Le nom de fichier nouvellement généré peut contenir des caractères qui ne sont pas pris en charge par le système de fichiers (par exemple, My?File). Ces caractères sont alors remplacés par un x minuscule.

Exemple

My?File.bpd est remplacé par MyxFile.bpd.

Les 8 caractères suivants sont ainsi remplacés :

\/:*?"<>|

La description (avec espaces réservés) du nom à générer comprend des caractères XML spéciaux qui ne peuvent pas être simplement écrits dans un fichier XML. C'est pourquoi la description doit être incluse dans une section CDATA.

Exemple

BackUp_<date>.bpd doit être modifié en <!CDATA[BackUp_<date>.bpd]] pour être inséré dans le fichier XML.

Comme la description d'un nom de fichier à générer automatiquement peut contenir des caractères spéciaux, elle doit être incluse dans une section CDATA.

<?xml version="1.0" encoding="ISO-8859-1" ?>
<config>
  <fileoptions>
    <autofilesavefilename>
      <![CDATA[Backup_<date>_<counter>.pdi]]
    <autofilesavefilename>
    <defaultfilesavedirectory>
       c:\temp\PD-BackUp
    <defaultfilesavedirectory>
  <fileoptions>
</config>>

Les espaces réservés sont entourés de crochets < et >. Ils doivent être saisis manuellement. Voici une liste des espaces réservés possibles :

  • <date>

    Date courante :

    Format : yyyy-MM-dd

    Exemples

    1999-12-01 2006-03-21

  • <time>

    Heure courante sur 24 heures :

    Format : HH-mm-ss

    Exemples

    07-41-29 19-41-29

  • <counter>

    Le compteur est une exception. Tout d'abord, il remplace l'espace réservé <counter> par un nombre dans le nom de fichier, en commençant à 1. Cela donne, par exemple, un nom de fichier comme PD-BackUp_1.bpd. Ensuite, il vérifie si le répertoire contient déjà un fichier portant ce nom. Si tel est le cas, il ajoute 1 au compteur et réitère le test jusqu'à ce qu'il ne trouve plus de fichier de même nom.

  • <controllertype>

    Ce paramètre insère le type de contrôleur dans un format abrégé.

    Exemples

    LMC 300 C400600

  • <firmwareversion>

    Définit la version du micrologiciel selon le format Major.Minor.Build.Revision

    Exemples

    1.30.0.0 1.31.201.2.

Exemples d'appels et résultats possibles

<controllertype>_<firmwareversion>.bpd
--> MAX4_0.22.6.0.bpd
<controllertype>_<firmwareversion>_<date>_<counter>.bpd
--> C400600_2206_2006-03-22_1.bpd

config/fileoptions/defaultfilesavedirectory

Ce paramètre définit le répertoire par défaut qui apparaît en premier lorsque la boîte de dialogue Enregistrer sous est ouverte. Il vous permet de changer de répertoire et d'enregistrer le fichier. La prochaine fois que vous ouvrirez la boîte de dialogue Enregistrer sous, le répertoire défini dans <defaultfilesavedirectory> sera de nouveau suggéré.

L'exemple suivant définit c:\temp\PD-BackUp comme répertoire par défaut.

<?xml version="1.0" encoding="ISO-8859-1" ?>
<config>
  <fileoptions>
    <autofilesavefilename>
      <![CDATA[Backup_<date>_<counter>.pdi]]
    <autofilesavefilename>
    <defaultfilesavedirectory>
       c:\temp\PD-BackUp
    <defaultfilesavedirectory>
  <fileoptions>
</config>>

Cette entrée définit c:\temp\PD-BackUp comme répertoire par défaut

config/fileoptions/defaultfileopendirectory

Ce paramètre définit le répertoire par défaut qui apparaît en premier lorsque la boîte de dialogue Ouvrir est ouverte. Il vous permet de changer de répertoire et d'ouvrir le fichier. La prochaine fois que vous ouvrirez la boîte de dialogue Ouvrir , le répertoire défini dans <defaultfileopendirectory> sera de nouveau suggéré.

config/application/usermode

Le mode utilisateur permet de paramétrer davantage Controller Assistant. Le mode utilisateur est destiné aux applications IHM. Il définit les fonctionnalités disponibles.

Les modes possibles sont les suivants :

Mode

Description

Default

Paramètre par défaut (aucun mode utilisateur actif)

NoFirmwareChange

Les boîtes de dialogue de remplacement du micrologiciel ont été désactivées.

DontEditImage

Le menu permettant de modifier une image a été désactivé.

NoExplorer

La boîte de dialogue Gestionnaire d'images de Controller Assistant qui permet de modifier manuellement l'image a été désactivée.

config/application/quicktransfermode

Dans le cas d'un programme qui consomme beaucoup de ressources et sollicite particulièrement le contrôleur (notamment si le micrologiciel de ce dernier est obsolète), les cycles peuvent dépasser les durées normales. Si <quicktransfermode> est défini sur FALSE, le transfert se déroule lentement (le facteur de ralentissement peut atteindre 15). Cela permet de réduire le risque de dépassement de durée de cycle, et donc les erreurs de temporisation de chien de garde qui s'ensuivent.

NOTE : La valeur par défaut de <quicktransfermode> est TRUE.