Glossaire
Les mots que le reste de la documentation emploie sans s’arrêter pour les expliquer. Chaque entrée donne une définition courte, un petit exemple quand il aide, et la page qui l’explique en détail.
Le modèle#
composant (component)#
Un composant est une définition : un type d’objet, écrit une seule fois. Il a
des ports, des variables, des fonctions et au plus une machine à états.
Exemple : component Lamp { var level: uint8 = 0 }.
Voir les concepts.
part#
Une part est une utilisation d’un composant, placée dans un système ou dans un
autre composant. Deux parts d’un même composant sont deux objets distincts.
Exemple : part desk: Lamp.
Voir les concepts.
instance#
Une instance est une copie d’une définition, avec son propre état et ses propres variables. En arche-lang, une part est une instance d’un composant. Voir les concepts.
système (system)#
Un système contient des parts et les liens qui les relient. C’est ce qu’Arche
dessine sur son canevas et ce que le simulateur exécute. Un système est aussi
une définition : une part peut donc être un système entier.
Exemple : system Room { part desk: Lamp }.
Voir les concepts.
port#
Un port est l’endroit où une part envoie ou reçoit des données. Il a une
direction (entrée, sortie ou les deux), un support comme CAN ou Ethernet, et
les messages qu’il transporte.
Exemple : out click: can sends PRESS.
Voir les concepts.
message#
Un message, ce sont les données qui circulent d’un port à un autre. Il a des
champs nommés, ou bien c’est une valeur unique.
Exemple : message PRESS { count: uint8 }.
Voir les concepts.
lien (link)#
Un lien relie un port d’une part à un port d’une autre. Il s’écrit dans le
système. archec vérifie que l’autre extrémité reçoit ce qu’envoie la première.
Exemple : button.click -> lamp.cmd.
Voir les concepts.
machine à états (state machine)#
Une machine à états liste les états dans lesquels un composant peut se trouver
et les passages de l’un à l’autre. Elle démarre dans son premier état. Un
passage a lieu quand son déclencheur arrive, par exemple un message sur un
port, et que sa condition est vraie.
Exemple : Off -> On on PRESS.
Voir les concepts.
plateforme (platform)#
La plateforme est un second système qui décrit le matériel : les processeurs et les bus qui les relient. Un déploiement y place les parts du premier système. Voir les concepts.
déploiement (deployment)#
Un déploiement indique où s’exécute chaque part : dans quel programme, sur quel
processeur, dans quel thread. Il ne modifie ni le système ni la plateforme : un
même système peut donc avoir plusieurs déploiements.
Exemple : binary lamp_fw "lamp.elf" on mcu { thread ctl { runs lamp } }.
Voir le déploiement.
genre (kind)#
Le mot kind a trois usages. Dans un composant, il indique de quelle sorte
d’élément il s’agit : un processeur, un périphérique, un bus ou un capteur, par
exemple. Dans une bibliothèque, il indique ce que contient le paquet : un
pilote, un modèle de projet ou un plugin, par exemple. Avec
archec new --kind, il indique quel genre de projet démarrer, comme un
firmware ou un service web.
Exemple : kind processor.
Voir Démarrer un projet et l’Arche Store.
Comportement et code#
handler#
Un handler est le code qui exécute un morceau de comportement : le corps d’une
fonction, ce que fait un port à l’arrivée d’un message, ou ce que fait un état
quand on y entre. Le projet indique dans quel langage les handlers sont écrits :
TypeScript (le choix par défaut des nouveaux projets), Python ou le langage
d’action.
Exemple : project "Room" { handlers typescript }.
Voir les handlers.
langage d’action (action language)#
Le langage d’action est le petit langage propre à arche-lang pour décrire le
comportement. Il s’écrit dans un bloc de code marqué arche. archec le vérifie
et le traduit : en TypeScript ou en Python pour le simulateur, et en C, en Rust
ou en Go pour le firmware.
Voir la spécification.
cible (target)#
Une cible est un type de sortie que archec gen peut écrire : du C, du Rust
pour Embassy, du Go, du ROS 2 ou un fichier de base de données CAN, par
exemple. archec gen --list les liste toutes.
Exemple : archec gen main.arche --target c.
Voir la génération de code.
générateur (generator)#
Un générateur écrit, à partir du modèle, les fichiers d’une cible. archec a des générateurs intégrés, et vous pouvez ajouter les vôtres, écrits sous forme de gabarits, d’un script ou d’une commande. Voir Vos propres générateurs.
plugin#
Un plugin est un dossier unique qui apporte à archec, d’un seul tenant, des générateurs, des importeurs et des exporteurs. Il peut se trouver dans votre projet, venir de l’Arche Store ou être intégré à archec. Voir les plugins.
liaison (binding)#
Une liaison relie un élément d’un écran à quelque chose du modèle, comme une
variable ou le dernier message reçu par un port. Quand le modèle change, archec
signale les liaisons qui ne correspondent plus. Les animations sont liées au
modèle de la même façon.
Exemple : value bus.STATUS.speed.
Voir L’interface utilisateur du produit.
Exigences et tests#
exigence (requirement)#
Une exigence indique ce que le système doit faire. archec signale une exigence
que rien ne satisfait ou que rien ne vérifie.
Exemple : requirement REQ-ON { text "The lamp shall turn on within 50 ms of a press." }.
Voir les concepts.
satisfies#
satisfies indique qu’un composant ou une part est l’endroit où une exigence
est remplie. Il s’écrit dans le composant ou dans la part.
Exemple : satisfies REQ-ON.
Voir les concepts.
verifies#
verifies indique qu’un cas de test, un plan de test ou un scénario vérifie une
exigence. Il s’écrit dans le cas. (verified-by, écrit dans l’exigence, est
l’ancienne forme : lue jusqu’à 0.13.)
Exemple : verifies REQ-ON.
Voir les concepts.
plan de test (test plan)#
Un plan de test contient des cas de test. Chaque cas est une chronologie : à des
instants donnés, il agit sur le modèle, puis il vérifie le résultat.
archec test exécute les cas dans le simulateur.
Exemple : test-plan TP-ON { case TC-ON-01 { … } }.
Voir les concepts.
trace#
Une trace est une relation nommée entre deux éléments, comme satisfies,
verifies, derives ou refines. archec s’en sert pour montrer quelle part remplit
chaque exigence et quel test la vérifie. La plupart s’écrivent comme une
propriété, là où elles partent (satisfies REQ-ON) ; une ligne trace sert aux
autres sortes.
Exemple : trace refines REQ-ON-2 -> REQ-ON.
Voir la spécification.
Projets et partage#
édition (edition)#
L’édition est la version du langage dans laquelle un projet est écrit, comme la
version de Go dans un fichier go.mod. À partir de l’édition 0.12, les
anciennes graphies des mots-clés sont des erreurs.
archec fmt --edition 0.12 --write met un projet à jour.
Exemple : edition "0.12".
Voir la spécification.
bibliothèque (library)#
Une bibliothèque est un dossier de fichiers .arche que plusieurs projets
partagent. Elle a un nom et une version. Un projet indique quelles versions il
accepte, et arche.lock enregistre celles qu’il utilise.
Exemple : uses kria-parts "^1.4".
Voir le tutoriel.
paquet du store (store package)#
Un paquet du store est une bibliothèque publiée dans l’Arche Store.
archec add la vérifie, la décompresse dans votre projet et enregistre sa
version. Un paquet peut contenir une architecture réutilisable, un pilote, une
carte, un modèle de projet, un plugin, et plus encore.
Exemple : archec add main.arche acme/can-fd@^1.2.
Voir l’Arche Store.