diff options
| author | Francis Tisserant <tissf@free.fr> | 2014-04-29 00:10:34 +0200 |
|---|---|---|
| committer | Francis Tisserant <tissf@free.fr> | 2014-04-29 00:10:34 +0200 |
| commit | 951ad5190b9f9f1574b9c2cbab919b2f82883e69 (patch) | |
| tree | 5af79251cd2190fa10ef139fd720ee09728bb0f2 | |
| parent | cd7f7d6130feaac40e2cf402ffccd73ed55541d3 (diff) | |
| download | linuxcnc-951ad5190b9f9f1574b9c2cbab919b2f82883e69.tar.gz linuxcnc-951ad5190b9f9f1574b9c2cbab919b2f82883e69.zip | |
French doc: add info about the direction arrow requirements
Signed-off-by: Francis Tisserant <tissf@free.fr>
| -rw-r--r-- | docs/src/hal/basic_hal.txt | 2 | ||||
| -rw-r--r-- | docs/src/hal/basic_hal_fr.txt | 176 |
2 files changed, 93 insertions, 85 deletions
diff --git a/docs/src/hal/basic_hal.txt b/docs/src/hal/basic_hal.txt index 37810ef13..6f108d70b 100644 --- a/docs/src/hal/basic_hal.txt +++ b/docs/src/hal/basic_hal.txt @@ -91,7 +91,7 @@ In English it means 'loadusr wait for name spindle component gs2_vfd name spindl === net [[sub:net]] (((net))) -The command 'net' creates a 'connection' between a signal and and one +The command 'net' creates a 'connection' between a signal and one or more pins. If the signal does not exist net creates the new signal. This replaces the need to use the command newsig. The optional direction arrows '<=', '=>' and '<=>' make it easier to follow the logic when reading diff --git a/docs/src/hal/basic_hal_fr.txt b/docs/src/hal/basic_hal_fr.txt index 4af97d27c..e5e71626d 100644 --- a/docs/src/hal/basic_hal_fr.txt +++ b/docs/src/hal/basic_hal_fr.txt @@ -8,10 +8,10 @@ == Commandes de Hal Des informations plus détaillées peuvent être trouvées dans la man -page en tapant _man halcmd_ dans une console. Pour voir la +page en tapant 'man halcmd' dans une console. Pour voir la configuration de HAL ainsi que le statut de ses pins et paramètres -utiliser la fenêtre HAL Configuration dans le menu _Machine_ d'AXIS. -Pour visualiser le statut des pins, ouvrir l'onglet _Watch_ puis +utiliser la fenêtre HAL Configuration dans le menu 'Machine' d'AXIS. +Pour visualiser le statut des pins, ouvrir l'onglet 'Watch' puis cliquer dans l'arborescence sur les pins qui doivent être visualisées dans la fenêtre watch. @@ -21,22 +21,23 @@ image::images/HAL_Configuration.png[] === loadrt -La commande _loadrt_ charge un composant temps réel de HAL. Les +La commande 'loadrt' charge un composant temps réel de HAL. Les composants temps réel doivent être ajoutés au thread temps réel pour être fonctionnels. Il n'est pas possible de charger un composant de l'espace utilisateur dans l'espace temps réel. Syntaxe et exemple: -+loadrt <component> <options>+ - ---- +loadrt <component> <options> + + loadrt mux4 count=1 ---- === addf -La commande _addf_ ajoute une fonction à un thread temps réel. Si +La commande 'addf' ajoute une fonction à un thread temps réel. Si l'assistant StepConf a été utilisé pour créer la configuration, deux threads ont été créés. @@ -48,16 +49,16 @@ threads ont été créés. mouvement, l'API Classic Ladder et les commandes manuelles. Syntaxe et exemple: +---- +addf <component> <thread> -+addf <component> <thread>+ ----- addf mux4 servo-thread ---- === loadusr[[sec:loadusr]] -La commande _loadusr_ charge un composant de HAL de l'espace +La commande 'loadusr' charge un composant de HAL de l'espace utilisateur. Les programmes de l'espace utilisateur ont leur propre process séparé qui optionellement communique avec les autres composants de HAL via leurs pins et paramètres. Il n'est pas possible de charger @@ -65,52 +66,51 @@ un composant temps réel dans l'espace utilisateur. Les drapeaux peuvent être un ou plusieurs parmis les suivants: --W :: +-W:: pour attendre que le composant soit prêt. Le composant est supposé avoir le même nom que le premier argument de la commande. --Wn <nom> :: +-Wn <nom>:: pour attendre un composant, qui porte le nom donné sous la forme <nom>. --w :: +-w:: pour attendre la fin du programme --i :: +-i:: pour ignorer la valeur retournée par le programme (avec -w) Syntaxe et exemple: +---- +loadusr <component> <options> -+loadusr <component> <options>+ ----- loadusr halui loadusr -Wn spindle gs2_vfd -n spindle ---- -En anglais ça donne _loadusr wait for name spindle component gs2_vfd name spindle_. +En anglais ça donne 'loadusr wait for name spindle component gs2_vfd name spindle'. Le -n spindle est une partie du composant gs2_vfd et non de la commande loadusr. === net[[sub:net]] -La commande _net_ crée une _connexion_ entre un signal et une ou plusieurs pins. -Si le signal n'existe pas, net le crée. Les indicateurs de direction _<=_ et _=>_ -sont seulement là pour aider à la lecture de la logique, ils n'ont pas d'autre -usage. - -Syntaxe et exemple: - -+net signal-name <pin-name> <direction optionnelle> (<pin-name>|<direction>)+ +La commande 'net' crée une 'connexion' entre un signal et une ou plusieurs pins. +Si le signal n'existe pas, net le crée. Les flèches de direction '<=', '=>' et +'<=>' sont seulement là pour aider à la lecture de la logique, ils ne sont pas +utilisés par la commande net. +.Syntaxe et exemple: ---- -net home-x axis.0.home-sw-in <= parport.0.pin-11-in +net signal-name pin-name <direction optionnelle> <second pin-name optionnel> + +net home-x axis.0.home-sw-in <= parport.0.pin-11-in ---- -Dans l'exemple ci-dessus, _home-x_ est le nom du signal, _axis.0.home-sw-in_ est -une pin de Direction IN, _<=_ est un indicateur de direction optionnel et -_parport.0.pin-11-in_ est une pin de Direction OUT. Cela peut paraître déroutant -mais les labels in et out pour les broches d'un port parallèle indiquent la voie -physique dans laquelle travaille la broche mais non comment elle est traitée dans -HAL. +Dans l'exemple ci-dessus, 'home-x' est le nom du signal, 'axis.0.home-sw-in' est +une pin de direction IN, '<=' est une flèche de direction optionnelle et +'parport.0.pin-11-in' est une pin de direction OUT. Cela peut paraître déroutant +mais les labels in et out pour une broche de port parallèle indiquent la +direction physique dans laquelle travaille la broche mais non comment elle est +traitée dans HAL. Une pin peut être connectée à un signal si elle obéit aux règles suivantes: @@ -119,7 +119,7 @@ Une pin peut être connectée à un signal si elle obéit aux règles suivantes: * Une pin OUT peut être connectée seulement si il n'y a pas d'autre pin OUT ou IO sur le signal. -Le même <signal-name> peut être utilisé dans de multiples commandes net pour +Le même 'signal-name' peut être utilisé dans de multiples commandes net pour connecter des pins additionnelles, tant que les règles précédentes sont observées. .Direction du signal[[cap:Signal-Direction]] @@ -151,31 +151,31 @@ net xStep stepgen.0.out => parport.0.pin-02-out parport.0.pin-08-out .Pins I/O -Les pins appelées I/O pins comme _index-enable_, ne suivent pas cette règle. +Les pins appelées I/O pins comme 'index-enable', ne suivent pas cette règle. === setp[[sub:setp]] (((setp))) -La commande _setp_ ajuste la valeur d'une pin ou d'un paramètre. Les +La commande 'setp' ajuste la valeur d'une pin ou d'un paramètre. Les valeurs valides dépendront du type de la pin ou du paramètre. C'est une erreur si les types de donnée ne correspondent pas. Certains composants ont des paramètres qui doivent être positionnés avant -utilisation. Il n'est pas possible d'utiliser _setp_ sur une pin connectée à +utilisation. Il n'est pas possible d'utiliser 'setp' sur une pin connectée à un signal. Syntaxe et exemple: +---- +setp <pin/parameter-name> <value> -+setp <pin/parameter-name> <value>+ ----- setp parport.0.pin-08-out TRUE ---- === sets [[sub:sets]] (((sets))) -La commande _sets_ positionne la valeur d'un signal. +La commande 'sets' positionne la valeur d'un signal. Syntaxe et exemple: @@ -195,15 +195,14 @@ C'est une erreur si: === unlinkp -La commande _unlinkp_ déconnecte la pin du signal auquel elle est connectée. +La commande 'unlinkp' déconnecte la pin du signal auquel elle est connectée. Si aucun signal n'a été connecté à la pin avant de lancer cette commande, rien ne se passe. Syntaxe et exemple: - -+unlinkp <pin-name>+ - ---- +unlinkp <pin-name> + unlinkp parport.0.pin-02-out ---- @@ -214,44 +213,46 @@ versions. Toute nouvelle configuration doit utiliser la commande <<sub:net,'net' === linksp -La commande _linksp_ a été incluse dans la commande _net_. +La commande 'linksp' a été remplacée par la commande 'net'. -La commande _linksp_ crée une _connexion_ entre un signal et une pin. +La commande 'linksp' créait une 'connexion' entre un signal et une pin. Syntaxe et exemple: +---- +linksp <signal-name> <pin-name> -+linksp <signal-name> <pin-name>+ -+linksp X-step parport.0.pin-02-out+ +linksp X-step parport.0.pin-02-out +---- === linkps -La commande _linkps_ a été incluse dans la commande _net_. +La commande 'linkps' a été remplacée par la commande 'net'. -La commande _linksp_ crée une _connexion_ entre une pin et un signal. C'est la +La commande 'linksp' créait une 'connexion' entre une pin et un signal. C'est la même chose que linksp mais les arguments sont inversés. Syntaxe et exemple: - -+linkps <pin-name> <signal-name>+ - ---- +linkps <pin-name> <signal-name> + linkps parport.0.pin-02-out X-Step ---- === newsig -the command _newsig_ creates a new HAL signal by the name <signame> -and the data type of <type>. Type must be _bit_, _s32_, _u32_ or -_float_. Error if <signame> already exists. +the command 'newsig' creates a new HAL signal by the name <signame> +and the data type of <type>. Type must be 'bit', 's32', 'u32' or +'float'. Error if <signame> already exists. Syntaxe et exemple: +---- +newsig <signame> <type> -+newsig <signame> <type>+ - -+newsig Xstep bit+ +newsig Xstep bit +---- D'autres informations peuvent être trouvées dans le manuel de HAL ou -la man page de _halrun_. +la man page de 'halrun'. == HAL Data[[sec:HAL-Data]] footnote:[NDT la description des données de HAL reste en Anglais, elle sont @@ -265,7 +266,7 @@ A bit value is an on or off. === Float (((Float))) -A _float_ is a floating point number. In other words the decimal point +A 'float' is a floating point number. In other words the decimal point can move as needed. - float values = a 32 bit floating point value, with approximately 24 @@ -277,14 +278,14 @@ http://fr.wikipedia.org/wiki/Nombre_flottant[http://fr.wikipedia.org/wiki/Nombre === s32 (((s32))) -An _s32_ number is a whole number that can have a negative or positive +An 's32' number is a whole number that can have a negative or positive value. - s32 values = integer numbers -2147483648 to 2147483647 === u32 (((u32))) -A _u32_ number is a whole number that is positive only. +A 'u32' number is a whole number that is positive only. - u32 values = integer numbers 0 to 4294967295 @@ -316,10 +317,10 @@ est créé. Ces paramètres permettent d'encadrer le temps d'exécution d'un com +.tmax+(((tmax))) -_.time_ est le nombre de cycles du CPU qu'il a fallu pour exécuter la fonction. +'time' est le nombre de cycles du CPU qu'il a fallu pour exécuter la fonction. -_.tmax_ est le nombre maximum de cycles du CPU qu'il a fallu pour exécuter la fonction. -_.tmax_ est un paramètre en lecture/écriture, de sorte que l'utilisateur peut le +'tmax' est le nombre maximum de cycles du CPU qu'il a fallu pour exécuter la fonction. +'tmax' est un paramètre en lecture/écriture, de sorte que l'utilisateur peut le mettre à 0 pour se débarrasser du premier temps d'initialisation de la fonction. == Composants de logiques combinatoire @@ -332,12 +333,13 @@ table de vérité des portes. === and2 -Le composant _and2_ est une porte _and_ à deux entrées. Sa table de +Le composant 'and2' est une porte 'and' à deux entrées. Sa table de vérité montre la sortie pour chaque combinaison des entrées. Syntaxe - -+and2 [count=N] or [names=name1[,name2...]]+ +---- +and2 [count=N] or [names=name1[,name2...]] +---- Fonctions @@ -362,11 +364,12 @@ Table de vérité === not -Le composant _not_ est un simple inverseur d'état. +Le composant 'not' est un simple inverseur d'état. Syntaxe - -+not [count=n] or [names=name1[,name2...]]+ +---- +not [count=n] or [names=name1[,name2...]] +---- Fonctions @@ -389,11 +392,12 @@ Table de vérité === or2 -Le composant _or2_ est une porte OR à deux entrées. +Le composant 'or2' est une porte OR à deux entrées. Syntaxe - -+or2[count=n] or [names=name1[,name2...]]+ +---- +or2[count=n] or [names=name1[,name2...]] +---- Functions @@ -418,11 +422,12 @@ Table de vérité === xor2 -Le composant _xor2_ est une porte XOR à deux entrées (OU exclusif). +Le composant 'xor2' est une porte XOR à deux entrées (OU exclusif). Syntaxe - -+xor2[count=n] or [names=name1[,name2...]]+ +---- +xor2[count=n] or [names=name1[,name2...]] +---- Fonctions @@ -469,24 +474,27 @@ parallèle. Ainsi en suivant la table de vérité du and2, si les broches === Somme pondérée (weighted_sum) La somme pondérée converti un groupe de bits en un entier. La conversion est la -somme des _poids_ des bits présents plus n'importe quel offset. C'est similaire -au _binaire codé décimal_ mais avec plus d'options. Le bit _hold_ interrompt le -traitement des entrées, de sorte que la valeur _sum_ ne change plus. +somme des 'poids' des bits présents plus n'importe quel offset. C'est similaire +au 'binaire codé décimal' mais avec plus d'options. Le bit 'hold' interrompt le +traitement des entrées, de sorte que la valeur 'sum' ne change plus. La syntaxe suivante est utilisée pour charger le composant weighted_sum. - -+loadrt weighted_sum wsum_sizes=size[,size,...]+ +---- +loadrt weighted_sum wsum_sizes=size[,size,...] +---- Crée des groupes de weighted_sum, chacun avec le nombre donné de bits d'entrée (size). Pour mettre à jour la weighted_sum, le process_wsums doit être attaché à un thread. -+addf process_wsums servo-thread+ +---- +addf process_wsums servo-thread +---- Ce qui met à jour le composant weighted_sum. Dans l'exemple suivant, une copie de la fenêtre de configuration de HAL d'Axis, -les bits _0_ et _2_ sont TRUE, ils n'ont pas d'offset. Le poids (_weight_) du bit 0 +les bits '0' et '2' sont TRUE, ils n'ont pas d'offset. Le poids ('weight') du bit 0 est 1, celui du bit 2 est 4, la somme est donc 5. .weighted_sum (somme pondérée) |