Boards
The commands for boards, devices and their pins.
Commands: archec board · archec device · archec pins
Known boards — the store archec ships (arche-hw-store: ESP32, STM32 Nucleo, Raspberry Pi Pico and Pi, nRF52840 DK, Jetson Orin Nano, Kria KR260) and your own collections, found in the project's libraries, in ARCHE_BOARDS (a path list; VS Code's arche.boardCollections sets it) and beside archec. A board is a component of kind board: its product { vendor; part-number; url }, its processors (compute { hal …; chip "…" }) and its connectors with their pins (pins { tx PA12; rx PA11 }). A binary on a board runs on its processor, and archec gen --target embassy drives the CAN controller on the board's pins. See the board store.
| Command | What it does |
|---|---|
archec device list [--family i2c] [--displays] [--json] · archec device show <device> · archec device add <main.arche> <device> [--to <board>.<port>] [--as <part>] [--into <System>] [--dry-run] |
The hardware store's devices (sensors, displays, motors…: devices/ of lib/arche-hw-store), their bus, address, readings and Go driver (--displays: the screens — ILI9341, ST7789, SSD1306, HDMI — with the size, density and input a ui takes from them, ui.md); add writes the uses, the include, the part in the platform and, with --to, its link to the board's port — kept only if the project builds as before. |
archec board list [<main.arche>] [--json] |
Every board of every collection the project (or this machine) sees: its processors, HAL and connectors. |
archec board show <board> [<main.arche>] |
One board — by its id (nucleo-g474re), its definition (NucleoG474RE) or collection/id: what it is, its processors, its connectors and their pins. |
archec board picture <board> | <main.arche> [--system <System>] [-o <file.svg>] |
A picture of a board, as SVG: its outline, its processor, its headers and connectors, each port numbered with what it is and its pins. Given a model, the hardware of each system that has boards: its boards, its devices and its buses, wired as its links say (--system for one; with -o, one file each). The playground's Hardware diagrams are these. |
archec board add <main.arche> <board> [--copy] [--as <part>] [--into <System>] [--dry-run] |
The board in the project: uses its collection (and libraries for one of yours), include its file, and a part in the platform — the system a deployment names, else the one board add made, else a new system <Project>Hw. --copy copies its folder into components/ instead. Nothing is written unless the project builds as well as before. |
archec board new <id> --in <folder> [--from <board>] [--name "…"] [--vendor "…"] |
A board of your own in a collection (its library.arche made if the folder is not one yet): from a template, or a copy of another board to adapt. |
archec board check [<folder>] |
A collection (default: the store): each board builds on its own, its processors say hal and chip (or os), its pins are pins of its chip, its picture is there. Exit 1 on an error. |
archec pins <main.arche> [System] [--json] |
Each board's pin map: every pin its connectors use, the port and role on it, where the port is linked, its level, whether the part wrote it; then the pin plan's warnings (pin-conflict, pin-function, pin-pair, pin-level, board-pin). Exit 1 on one. See boards. |
archec board extract <main.arche> <Def|System.part> --in <folder> [--id <id>] |
A board the model defines, copied into your collection with its picture; what it uses from the project is reported. |