Serge NOEL
371 lines
18 KiB
Plaintext
371 lines
18 KiB
Plaintext
<!DOCTYPE html>
|
|
<html lang="fr">
|
|
<head>
|
|
<!-- Copyright Bob Jacobsen 2008 -->
|
|
<!--Updated et Translated by Hervé Blorec le 2016-06-18 -->
|
|
<title>JMRI: DecoderPro User Guide - Creating A Custom Decoder File</title>
|
|
<!--#include virtual="/help/fr/parts/Style.shtml" -->
|
|
</head>
|
|
|
|
<body>
|
|
<!--#include virtual="/help/fr/parts/Header_fr.shtml" -->
|
|
<div id="mBody">
|
|
<!--#include virtual="Sidebar.shtml" -->
|
|
<div id="mainContent">
|
|
<!-- Page Body -->
|
|
|
|
<h1>JMRI: Guide Utilisateur DecoderPro</h1>
|
|
|
|
<h2>Création d'un fichier décodeur personnalisé</h2>
|
|
|
|
<p>Cette page fournit l'information sur la méthode de travail des fichiers de définitions
|
|
pour le Programmateur Symbolique DecoderPro et comment en créer un nouveau.</p>
|
|
|
|
<p>Dans ce guide utilisateur, nous allons cheminer á travers le processus de création
|
|
d'un fichier pour un nouveau décodeur. Vous pourrez tirer bénéfice de la lecture
|
|
des autres sections de ce guide utilisateur DecoderPro pour obtenir des informations de fond,
|
|
spécialement sur
|
|
l'<a href="IntroXML.shtml">introduction XML</a> et la section sur les
|
|
<a href="Files.shtml">Contenus des Fichiers de Configuration</a>.</p>
|
|
|
|
<p>La meilleur méthode pour créer un fichier de configuration est de modifier un
|
|
existant. Dans cette section nous allons utiliser cette méthode.</p>
|
|
|
|
<dl>
|
|
<dt class="left">Faites une copie d'un fichier existant.</dt>
|
|
<dd class="first">
|
|
<p>Bien que vous puissiez appeler votre fichier comme bon vous semble, il travaillera
|
|
mieux si vous utilisez les mêmes conventions que les fichiers fournis.
|
|
C'est <code>"manufacturer name"_"decoder family".xml</code>, par exemple:
|
|
<code>Digitrax_1x2.xml</code>et <code>Atlas_DualMode.xml</code></p>
|
|
|
|
<p>Pour les fichiers fournis, nous utilisons la même casse, etc,
|
|
que celles que les fabricants de décodeurs utilisent dans leurs documentations. </p>
|
|
|
|
<p>Ce nouveau fichier prendra place dans le sous-répertoire <code>decoders</code> dans le
|
|
répertoire preferences <code>JMRI</code> ainsi le programme pourra le trouver. Le
|
|
fichier<code>DecoderProConfig2.xml</code> se trouve dans le répertoire preferences, ainsi
|
|
vous pouvez chercher ici pour localiser le fichier.
|
|
(Voir la <a href="Files.shtml#location"><em> page de configuration des fichiers</em></a>
|
|
pour plus de détails
|
|
sur ce répertoire et ce qu'il contient.</p>
|
|
|
|
<p>Si vous modifiez une définition de décodeur, il vaut mieux commencer avec la version la plus
|
|
récente, qui peut être trouvée ici
|
|
sur le site web de JMRI à
|
|
<a href="https://jmri.org/xml/decoders/">https://jmri.org/xml/decoders/</a>.
|
|
De cette façon il ne sera pas difficile de fusionner vos changements avec ceux qui pourrait avoir
|
|
été fait entre temps.
|
|
SVP Ne reformater pas plus que nécessaire. Si vous changez
|
|
les données techniques dans les 5 ou 10 lignes du haut, ou
|
|
reformater le contenu, il sera très difficile de savoir ce qui a été changé
|
|
et ce qui ne l'a pas été .
|
|
|
|
<dt class="left">Éditer le nouveau fichier </dt>
|
|
<dd>
|
|
<p>Ouvrez le nouveau fichier avec votre éditeur de texte favori.</p>
|
|
|
|
</dd>
|
|
|
|
<dt class="left">Contenu du fichier: En tête XML </dt>
|
|
<dd>
|
|
<p>Vous verrez quelque chose comme ceci en haut du fichier ( les exemples viennent d'un fichier <a
|
|
HREF="../../../../../xml/decoders/0NMRA.xml">0NMRA.xml</a> )
|
|
|
|
<p class="exemple">
|
|
<?xml version="1.0" encoding="utf-8"?><br>
|
|
<?xml-stylesheet type="text/xsl" href="../XSLT/decoder.xsl"?><br>
|
|
<!-- Copyright (C) JMRI 2001, 2005, 2007, 2-009, 2010 All rights reserved --><br>
|
|
...<br>
|
|
<decoder-config xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://jmri.org/xml/schema/decoder.xsd"><br>
|
|
</p>
|
|
|
|
<p>N'oubliez pas ces lignes; elles décrivent le format du fichier.
|
|
</dd>
|
|
|
|
<dt class="left">File contents: Author </dt>
|
|
<dd>
|
|
<p>L'élément suivant décrit l'auteur et la version de ce fichier de décodeur:
|
|
<p class="example">
|
|
<version author="jake@physics.berkeley.edu" <br>
|
|
version="1" lastUpdated="20011201"/>
|
|
</p>
|
|
<p>Ces attributs ne sont lus que par les gens, pas par le programme,
|
|
ainsi leur format exact n'est pas critique. Mais nous vous encourageons à insérer
|
|
votre adresse courriel dans les fichiers que vous créez ou modifiez; ainsi celui qui
|
|
a une question à poser sait où vous contacter. La version et
|
|
les derniers attributs mis à jour fournissent un moyen de décrire les différentes versions
|
|
d'une définition de décodeur à part,donc nous aimerions également que vous les mettiez à jour
|
|
ceux. Pour un nouveau fichier, commencer à numéroter à "1" et si vous
|
|
modifiez un fichier existant incrémenter l'attribut version au
|
|
numéro suivant.</p>
|
|
</dd>
|
|
|
|
<dt class="left">File contents: Decoder Family and Model</dt>
|
|
<dd>
|
|
Les lignes suivantes identifient la "famille" de décodeurs que ce fichier
|
|
décrit:
|
|
<p class="example">
|
|
<decoder><br>
|
|
<family name="Digitrax 1x2" mfg="Digitrax"<br>
|
|
lowVersionID="240" highVersionID="242"<br>
|
|
comment="Digitrax DH142, etc" ><br>
|
|
<model model="DH142" numOuts="4" numFns="2"/><br>
|
|
<model model="DN142" numOuts="4" numFns="2"/><br>
|
|
<model model="DH083" numOuts="5" numFns="2"/><br>
|
|
</family>
|
|
</p>
|
|
|
|
<p>L'espacement n'est pas important, mais il est utilisé pour indenté le fichier
|
|
et le rendre plus lisible. XML utilise "éléments"
|
|
et "attributs" pour porter les informations. les choses <model> sont
|
|
des éléments; les attributs comme numOuts sont fixés á des valeurs spécifiques á l'intérieur des éléments.
|
|
Dans la 2ème á la 4ème lignes ci-dessus
|
|
|
|
<p class="example">
|
|
<family name="Digitrax 1x2" mfg="Digitrax"<br>
|
|
lowVersionID="240" highVersionID="242"<br>
|
|
comment="Digitrax DH142, etc" >
|
|
</p>
|
|
|
|
<p>L'élément est "family", avec les attributs "name", "mfg",
|
|
"lowVersionID", "highVersionID", et "comment". Un attribut est
|
|
une valeur donnée avec le signe égal et la valeur entre guillemets ( les guillemets
|
|
sont obligatoires ). L'ordre des attributs n'est pas important, et
|
|
vous pouvez cassez la lignes et la reprendre si cela rend le fichier plus facile á
|
|
lire. Notez que tous les attributs doivent être entre
|
|
crochets et après le nom de l'élément.</p>
|
|
|
|
<p>Dans cet élément, changer les attributs pour correspondre au nouveau décodeur:</p>
|
|
<ul>
|
|
<li><dfn>name</dfn> - le nom de la famille de décodeur. C'est mieux si vous utilisez le même nom
|
|
ici que celui que vous avez utilisé pour le nom de fichier.
|
|
<li><dfn>mfg</dfn> - le fabricant du décodeur. C'est mieux si vous utilisez le même
|
|
nom de fabricant ici que celui que vous avez utilisé pour le nom de fichier.
|
|
<li><dfn>lowVersionID</dfn>, <dfn>highVersionID</dfn> -
|
|
Le fabricant peut charger un numéro de version dans le CV 7 du décodeur.</li>
|
|
</ul>
|
|
Tous les fabricants ne le font pas, mais si un est disponible,
|
|
le programmateur peut vérifier si ce fichier est utilisé avec le type de décodeur attendu.
|
|
Si une valeur est valide, définissez les attributs
|
|
lowVersionID and highVersionID avec la même valeur, par exemple:
|
|
|
|
<p class="example">
|
|
lowVersionID="123" highVersionID="123"
|
|
</p>
|
|
Si le type de décodeur peut avoir plus d'une rangée de numéro,
|
|
par exemple parce que le fabricant a fait plusieurs mise á jour
|
|
définissez les deux attributs pour couvrir la gamme:
|
|
|
|
<p class="example">
|
|
lowVersionID="21" highVersionID="42"
|
|
</p>
|
|
Si vous ne connaissez pas le numéro de version, ne définissez pas
|
|
un de ces attributs.Laissez les juste á off.
|
|
lowVersionID par défauts á 0, highVersionID par défauts á 255
|
|
afin qu'ensemble, les valeurs par défaut signifie «toute valeur».
|
|
|
|
<dfn>comment</dfn> - Ceci est optionnel. Vous pouvez inclure votre nom, ou autre
|
|
info au sujet du changement dans le fichier.
|
|
|
|
<p> Les lignes suivantes:</p>
|
|
|
|
<p class="example">
|
|
<model model="DH142" numOuts="4" numFns="2"/><br>
|
|
<model model="DN142" numOuts="4" numFns="2"/><br>
|
|
<model model="DH083" numOuts="5" numFns="2"/>
|
|
</p>
|
|
<p>vous permettent de lister un nombre de modèle de décodeurs différents qui peuvent utiliser
|
|
ce fichier. Pour un simple décodeur, enlever tout sauf un
|
|
et donnez lui le nom du "modèle" de décodeur. Le numOuts
|
|
et numFns sont décrit plus tard, mais pour le moment vous pouvez les effacer
|
|
laissant quelque chose comme:</p>
|
|
|
|
<p class="example">
|
|
<model model="DH142" />
|
|
</p>
|
|
|
|
L'élément modèle peut aussi contenir les attributs lowVersionID et/ou highVersionID
|
|
, qui sont applicables á tout ce modèle. Si l'un
|
|
n'apparait pas, la valeur ( ou sa valeur par défaut ) de l'élément famille sera utilisée .
|
|
|
|
</dd>
|
|
|
|
<dt class="left">File contents: Programming Modes </dt>
|
|
<dd>
|
|
|
|
<p>L'élément suivant définit quel mode de programmation est comprit par le décodeur :</p>
|
|
|
|
<p class="example">
|
|
<programming direct="byteOnly" paged= "yes" <br>
|
|
register= "yes" ops= "yes"></programming>
|
|
</p>
|
|
|
|
<p>Pagind, registerer et ops peuvent être régler soit á "yes" ou á "no". Direct
|
|
peut être fixé á "no", "bitOnly", "byteOnly", ou "yes". Le
|
|
programmateur utilise ces informations pour sélectionner le mode de programmation á
|
|
utiliser pour travailler avec le décodeur.</p>
|
|
</dd>
|
|
|
|
|
|
<dt class="left"><a name="variable"></a>File contents: Variable names</dt>
|
|
<dd>
|
|
<p>La partie suivante du fichier consiste en un jeu d'éléments "variable"
|
|
définissant des variables spécifiques, imbriquées dans un élément "variables"(notez le"s")
|
|
Un exemple:</p>
|
|
|
|
<p class="example">
|
|
<variables><br>
|
|
<variable CV="1" item="Primary Address" default="03"><br>
|
|
<decVal min="1" max="127"/><br>
|
|
<label>Short Address</label><br>
|
|
<comment>NMRA standard form</comment><br>
|
|
<tooltip>Digitrax systems only address 1-99</tooltip><br>
|
|
</variable><br>
|
|
<br>
|
|
(followed by more <variable> entries)<br>
|
|
<br>
|
|
(Insert new ones at the end)<br>
|
|
</variables>
|
|
</p>
|
|
|
|
<p>Chaque variable représente une chose á configurer. Elle peut représenter
|
|
un CV simple, exemple une adresse, ou plusieurs bits qui doivent être configurer
|
|
pour commanderr une fonction particulière. Si plusieurs de celles-ci ne sont pas appropriées pour
|
|
votre décodeur, vous pouvez les supprimer. Soyez sûr d'enlever
|
|
l'élément entier de la <variable> pour correspondre á la
|
|
</variable>. Vous pouvez aussi les réarranger si vous préférez un
|
|
ordre différent.</p>
|
|
|
|
<p> Les attributs incluent:
|
|
<ul>
|
|
<li><dfn>item</dfn> - Un nom alternatif "standard" pour cette variable. Voir la
|
|
<a href="Programmer.shtml#id"> discussion sur la page des définitions des programmateurs</a>
|
|
pour plus de détails sur ceux-ci. Généralement, regarder le programmateur Complet
|
|
pour trouver quelque chose de similaire, et utilisez le "nom" attribué.
|
|
<li><dfn>CV</dfn> - Quel CV contient l'information de configuration
|
|
pour cette variable.
|
|
<li><dfn>mask</dfn> - Un modèle comme "XXXVVVXX" qui commande quels
|
|
bits dans le CV mettent la variable up . Chaque "V" est un bit
|
|
qui est inclut, et "X" sont des bits qui ne sont pas
|
|
inclus. Il est mieux d'avoir huit caractères,comme cela
|
|
nous savons où nous allons. Si la variable
|
|
est un Octet complet, cette attribut peut être omit .
|
|
<li><dfn>default</dfn> - la valeur par défaut pour cette varable. C'est
|
|
utilisé pour un nouveau décodeur, ou quand vous voulez remettre le
|
|
décodeur á ses réglages d'usine
|
|
</ul>
|
|
|
|
<p>(Il y en a un peu plus,que nous allons quitter pour la section avancée ci-dessous)</p>
|
|
<p>L'élément "label" inclut fournit un nom de variable lisible. Ceci est généralement
|
|
la façon dont les fabricants de décodeur appellent cet élément, même si le d'autres fabricants ou le
|
|
NMRA utilisent un nom différent pour des choses similaires. C'est en option, auquel cas la valeur "élément"
|
|
sera utilisé comme label quand il est présenté á l'utilisateur.
|
|
<p>L'élément "comment" vous permet d'ajouter des informations additionnelles
|
|
pour les futures développeurs. cette information est visible quand la définition
|
|
est éditée, mais n'est pas fournie aux simples utilisateurs de DecoderPro
|
|
<p>L'élément "tooltip" lvous permet de fournir des informations supplémentaires
|
|
á l'utilisateur quand celui-ci survole avec
|
|
le curseur la variable á l'écran.
|
|
/dd>
|
|
|
|
<dt class="left">File contents: Creating new Variable definitions </dt>
|
|
<dd>
|
|
<p>Vous pouvez aussi définir de nouvelles variables. Un bon point de départ est de
|
|
copier une définition similaire, changer son nom d'élément par une nouvelle valeur et
|
|
éditer son contenu.</p>
|
|
|
|
<p> Pour définir comment la nouvelle variable est affichée et éditée, vous
|
|
ajoutez l'élément au sein de l'élément "variable". Il y a plusieurs
|
|
formes possibles:</p>
|
|
<ul>
|
|
<li>Pour une valeur décimale, vous incluez un élément decVal comme
|
|
l'exemple ci-dessus. Les deux attributs possibles sont min et max,
|
|
qui définissent la fourchette de valeurs acceptables. Si vous les omettez
|
|
les valeurs entre 0 et 255 seront permises.
|
|
<li>Si vous préférez entrer et afficher des valeurs en hexadécimal, utilisez
|
|
l'élément "hexVal".c'est le même que l'élément
|
|
"decVal" dont nous avons déjá discuté mais en hexa.
|
|
<li>Si votre décodeur supporte les adresses longues, vous pouvez ajouter
|
|
un élément 'longAddress'. C'est peut être plus simple de copier ceci
|
|
depuis un autre fichier, ou depuis cet exemple:</li>
|
|
</ul>
|
|
|
|
<p class="example">
|
|
<variable name="Long Address" CV="17"><br>
|
|
<longAddressVal/><br>
|
|
</variable>
|
|
</p>
|
|
|
|
<p>Si votre décodeur le supporte, vous pouvez entrer un élément "speedTableVal"
|
|
pour la table de vitesse. Les attributs optionnels sont "entries","min", "max" et
|
|
"mfx" (quand vrai active le style Märklin mfx® de la table de vitesse. Exemple:</p>
|
|
|
|
<p class="example">
|
|
<variable name="Speed Table" CV="67"><br>
|
|
<speedTableVal/><br>
|
|
</variable>
|
|
</p>
|
|
|
|
Quelques options de décodeur sont mieux représenter par "choisir un
|
|
choix".Elles sont représentées par un élément enumVariable. Exemple:
|
|
|
|
<p class="example">
|
|
<variable name="F6 during DC operation" CV="13" mask="XXVXXXXX"><br>
|
|
<enumVal><br>
|
|
<enumChoice choice="Off"/><br>
|
|
<enumChoice choice="On"/><br>
|
|
</enumVal><br>
|
|
</variable>
|
|
</p>
|
|
|
|
<p>Chaque élément enumChoice décrit une possibilité. Il peut y en avoir
|
|
autant que désiré. pour le choix d'un bit, vous utilisez deux
|
|
éléments enumChoice comme dans l'exemple. Pour un choix de 4 bits, comme
|
|
les codes FX dans les décodeurs Digitrax, vous pouvez utiliser jusqu'á 16 choix.
|
|
Ils sont affichés dans l'ordre où ils ont été entrés dans le fichier, et
|
|
sont aussi numérotés dans cet ordre. Si le premier est choisi, un 0 est
|
|
entré dans les bits CV; choisir le second stocke 1; etc.</p>
|
|
|
|
<p> Si vous avez besoin de spécifier un nombre spécifique pour une option enum,
|
|
ajoutez un attribut "value":
|
|
<p class="example">
|
|
<enumChoice choice="Blue" value="32"/>
|
|
</p>
|
|
</dd>
|
|
|
|
<dt class="left">Vérification des erreurs de syntaxe </dt>
|
|
<dd>
|
|
<p>A ce point, vous avez créé un nouveau fichier de configuration!</p>
|
|
|
|
<p>Vous pouvez vérifier la syntaxe en sélectionnant l'élément"Validate XML file"
|
|
dans le menu "Débogage". Il ouvre un dialogue de sélection de fichier;
|
|
sélectionnez votre fichier et cliquez "open". Si tout est bon, vous obtenez une
|
|
boite de dialogue qui dit "OK". Si non , vous obtiendrez un message d'erreur complètement
|
|
incompréhensible. La seule partie utilisable de ce
|
|
message est le numéro de la ligne; ouvrez un éditeur á cette ligne et essayer
|
|
de trouver le problème de syntaxe.
|
|
</dd>
|
|
|
|
<dt class="left">Ajouter le fichier á l'index</dt>
|
|
<dd>
|
|
<p>Tout ce qui reste est d'entrer votre nouveau fichier dans l'index.
|
|
Cet index est utilisé pour accélérer le démarrage, quand la liste des
|
|
décodeurs disponibles est construite .</p>
|
|
|
|
<p>Sélectionner l'élément "Créer Index Décodeur" depuis le menu "Débogage"
|
|
</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Félicitations! Vous avez fini. Ensuite, ouvrez l'application programmateur et essayez le</p>
|
|
<p>Pour des informations plus avancées sur le contenu des fichiers, svp voir la page
|
|
<a href="CreateDecoderAdvanced.shtml">Advanced Decoder Definitions</a>.
|
|
|
|
<!--#include virtual="/help/fr/parts/Footer_fr.shtml" -->
|
|
</div>
|
|
</div> <!-- close #mBody -->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|