Documentation d’arche-lang
Les pages sont classées selon ce que vous voulez faire. Vous découvrez arche-lang ? Suivez Apprendre dans l’ordre. Revenez ensuite chercher un guide quand vous avez une tâche à mener, ou la référence quand il vous faut une réponse précise.
Apprendre#
Lisez ces cinq pages dans l’ordre.
- Concepts — Comprendre les cinq idées sur lesquelles repose tout modèle, avant toute syntaxe.
- Tutoriel — Construire le contrôleur d’une petite pompe à eau, du premier modèle jusqu’au firmware qui tourne.
- Tutoriel sur une carte — Mener un thermostat de serre jusqu’à une vraie NUCLEO-F446RE, avec un capteur et un ventilateur, et le mesurer.
- Aide-mémoire — Retrouver l’essentiel du langage et les commandes de tous les jours sur une seule page.
- Démarrer un projet — Lancer votre propre projet à partir d’un modèle de projet, d’un paquet partagé ou d’une simple phrase, avec un modèle qui fonctionne déjà.
Guides pratiques#
Chaque guide montre comment mener une tâche.
Écrire et vérifier un modèle#
- Correctifs et niveau débutant — Laisser archec corriger pour vous les erreurs les plus courantes, et lire des messages d’erreur plus simples.
- L’extension VS Code — Écrire vos modèles dans VS Code, avec les diagnostics, la complétion, un diagramme à jour et un débogueur pour la simulation.
- L’application Arche — Ouvrir votre projet dans l’éditeur visuel d’Arche et le modifier là.
- Le simulateur dans le navigateur — Voir votre modèle tourner dans une page web, sans rien installer d’autre.
- L’interface utilisateur du produit — Décrire les écrans de votre produit dans le modèle et laisser archec les vérifier.
- Handlers en TypeScript ou en Python — Écrire le comportement de votre modèle dans des fichiers TypeScript ou Python, et récupérer les modifications faites dans Arche.
Matériel, robots et physique#
- Déploiement — Indiquer sur quel processeur et dans quel thread tourne chaque part, puis suivre le système en direct pendant qu’il tourne.
- Cartes — Partir d’une carte connue, comme un ESP32 ou un Raspberry Pi, ou décrire la vôtre.
- Pilotes de périphériques sur microcontrôleur — Piloter un capteur ou un actionneur depuis une carte STM32, nRF, RP2040 ou ESP32, en Rust avec Embassy.
- Robots — Faire tourner le logiciel de votre robot sous ROS 2 et le tester dans un monde simulé.
- Prototyper un robot — Dire une tâche en mots, regarder un petit bras la faire dans MuJoCo, l’ajuster jusqu’à ce que ses exigences passent.
- Physique — Ajuster un modèle physique à vos mesures et simuler des équipements à côté du modèle.
- La CAO en code — Écrire la forme d’une pièce en Python, la mesurer, et prouver sa taille, sa masse et ses jeux face aux exigences.
- Composants FPGA — Écrire du matériel comme un composant avec une horloge, générer son VHDL et exécuter ses cas de test dans GHDL.
- Une recherche de cellule 5G, de bout en bout — Suivre une chaîne de traitement du signal de ses exigences jusqu’à un corrélateur sur FPGA : OFDM, bruit, une FFT, des tests à des SNR fixés, GHDL et synthèse.
- Régler selon les exigences — Laisser archec essayer les gains d’un contrôleur jusqu’à ce que ses cas de test et ses exigences passent.
Vérifier et évaluer#
- Vérification — Prouver que vos machines à états et vos exigences tiennent, tester avec des fautes injectées et contrôler les journaux du système réel.
- Pourquoi a-t-il fait ça ? — Voir une exécution sous forme de chronologie, remonter d’un événement jusqu’à la lecture qui l’a causé, et trouver pourquoi quelque chose n’est jamais arrivé.
- Ce qui prouve chaque exigence — Voir, pour chaque exigence, ce qui la satisfait, où elle est construite et ce qui la prouve aujourd’hui.
- Sûreté et cybersécurité — Produire les analyses de sûreté et de sécurité directement à partir du modèle.
Générer du code#
- Régénérer le code — Garder le code écrit à la main chaque fois qu’archec réécrit le code généré.
- La qualité du code généré — Vérifier que le code généré compile proprement, et remonter de chaque problème jusqu’au modèle.
- C++ — Générer du C++ pour un ordinateur sous Linux ou avec un système d’exploitation complet.
- Cartes de registres — Générer des cartes de registres cohérentes pour le logiciel, le matériel et les documents.
- Cibles d’intégration — Générer les fichiers que lisent les outils autour de votre firmware, comme les descriptions de protocoles et les scripts de build.
- Vos propres générateurs — Ajouter un générateur de code pour le format propre à votre entreprise.
- Plugins — Réunir générateurs, importeurs et exportateurs dans un seul dossier.
Documents et présentations#
- Documents modèles — Remplir votre propre document Word ou LibreOffice avec le contenu du modèle.
- Animations — Ajouter à vos présentations des images animées qui restent fidèles au modèle.
Partager, importer et lire du code#
- L’Arche Store — Partager votre travail, et utiliser en toute sécurité les paquets des autres dans votre projet.
- Les rayons — Des types, unités, cartes, pilotes, capteurs et algorithmes tout prêts, à prendre au lieu de les réécrire.
- Algorithmes — Un PID, des filtres, un anti-rebond, de l’odométrie, des CRC et plus encore, testés dans le simulateur et générés pour chaque cible.
- Importer des modèles — Reprendre des modèles venant d’autres outils, comme SysML v2, une base de données CAN ou la description d’un robot.
- Comprendre du code existant — Savoir qui a écrit un morceau de code, ce qu’il fait et comment un code existant est organisé.
- L’ingénierie assistée par IA, hors ligne — Garder compris le code écrit par une IA, avec des contrôles locaux ; choisir ce qui peut quitter la machine.
Référence#
Des réponses précises, à consulter au besoin.
- Le cœur — Lire tout le cœur du langage en une soirée : ce que l’édition 1.0 promet de garder, avec un exemple de chaque construction.
- La spécification — Savoir exactement ce que le langage permet et ce que signifie chaque construction, extensions comprises.
- Éditions — Voir ce que change chaque édition, la promesse de stabilité, et comment un nom renommé continue de marcher pendant une édition.
- Référence du langage — Retrouver n’importe quelle déclaration, avec ses propriétés et un exemple. Une page par groupe : structure, comportement, exigences, déploiement, etc.
- Commandes — Retrouver n’importe quelle commande d’archec et ses options, une page par type de tâche.
- Codes d’erreur — Comprendre ce que
signifie une erreur ou un avertissement, et comment le corriger. L’éditeur et
archec explain <code>renvoient vers la même page. - Génération de code — Voir tous les types de code qu’archec sait générer, et ce que chacun produit.
- Handlers — Savoir exactement comment le code de comportement dialogue avec le simulateur, dans chaque langage.
- Effective Arche — Retrouver chaque avertissement de style et apprendre à écrire un modèle qui se lit comme tous les autres.
- Glossaire — Trouver une définition courte de chaque mot qu’emploie la documentation.
Explications#
Le contexte, à lire quand vous voulez savoir pourquoi.
- Correspondance avec Arche — Voir ce que devient chaque élément de votre modèle dans le projet Arche.
- Qualifier archec — Comprendre comment montrer qu’archec est digne de confiance dans un projet de sûreté.
- Notes de conception — Comprendre pourquoi le langage est conçu ainsi, et à quelle vitesse archec travaille.
Comment fonctionne arche-lang— Explorer la chaîne d’outils, décrite comme un modèle dans son propre langage.
Voir aussi : le README du projet, pour installer arche-lang, et
la liste des évolutions de chaque version.