Schéma, PCB, nomenclature — de quoi refaire le montage
Documenter une carte électronique
Documenter votre partie électronique pour qu'un autre puisse comprendre le schéma, retrouver les composants, et reproduire le câblage.
Logiciels :
Machines/Outils :
Votre repo de projet utilise le thème Just the Docs, pas le thème de ce site de documentation MakerSpace. Certaines fonctionnalités visibles ici (visionneuse 3D, schémas interactifs) ne sont pas disponibles chez vous par défaut. Ce tutoriel explique la méthode qui fonctionne toujours (des images), et une méthode plus avancée en option.
Une carte électronique bien documentée répond à quatre questions : à quoi sert chaque partie du circuit, quels composants exactement, comment c’est câblé, et pourquoi ces choix — ce dernier point rejoint Tracer ses choix techniques.
C’est la méthode qui marche toujours, sans rien installer de plus.
Dans l’éditeur de schéma d’KiCad (Eeschema), ouvrez le menu Fichier (ou File) puis Tracer… (ou Plot…).
Dans la fenêtre qui s’ouvre, choisissez le format de sortie SVG (KiCad n’exporte pas directement en PNG depuis cette fenêtre — le SVG a l’avantage d’être net à n’importe quelle taille d’affichage, contrairement à une image). Choisissez un dossier de sortie, par exemple le même dossier que votre page de documentation.
Cliquez sur Tracer (ou Plot). Un fichier .svg est généré. Faites la même opération dans l’éditeur de PCB (Pcbnew) si vous voulez aussi exporter une image de votre circuit imprimé.
Copiez le fichier .svg dans le dossier de votre page docs/ (par exemple docs/images/), puis dans votre fichier Markdown :
Cette section demande de modifier un fichier de configuration de votre site (_includes/head_custom.html) — pas obligatoire, une image SVG suffit largement pour la plupart des projets.
Le site kicanvas.org propose un visualiseur KiCad interactif (zoom, déplacement) intégrable sur n’importe quel site web — c’est cette technologie qui est utilisée sur ce site de documentation MakerSpace, mais elle n’est pas activée par défaut dans votre template.
Sur kicanvas.org, téléchargez le fichier kicanvas.js (voir la documentation d’intégration). Placez-le à la racine de votre dossier docs/.
Créez le fichier docs/_includes/head_custom.html (créez le dossier _includes s’il n’existe pas encore) avec ce contenu :
<script type="module" src="/kicanvas.js"></script>
Just the Docs charge automatiquement ce fichier sur chaque page — c’est le point d’extension officiel du thème pour ajouter du script.
Copiez vos fichiers .kicad_sch dans le dossier de votre page, puis :
<kicanvas-embed src="schema.kicad_sch" controls="basic"></kicanvas-embed>
KiCanvas est un outil strictement de visualisation (lecture seule) — il n’exporte ni ne calcule de BOM. La nomenclature se génère avec KiCad lui-même, pas avec KiCanvas.
Dans l’éditeur de schéma (Eeschema), menu Outils > Générer une nomenclature… (Tools > Generate Bill of Materials…, le libellé exact varie légèrement selon la version de KiCad). Choisissez un format de sortie (CSV fonctionne partout), un dossier, puis lancez la génération. Vous obtenez un fichier listant automatiquement chaque référence, valeur et quantité de votre schéma — pas besoin de les retaper à la main.
Une fois le CSV généré, reformatez les colonnes utiles en tableau Markdown pour l’intégrer proprement à votre page (référence exacte, pas juste “une résistance”) :
| Référence | Composant | Valeur / réf. exacte | Quantité | Source |
|---|---|---|---|---|
| U1 | Microcontrôleur | ESP32-S3-DevKitC-1 | 1 | ... |
| R1-R4 | Résistance | 10kΩ, 1/4W | 4 | ... |
| D1 | Driver moteur | A4988 | 1 | ... |Si reformater à la main prend trop de temps, vous pouvez simplement déposer le fichier .csv généré dans votre dossier docs/ et y faire un lien direct — moins joli qu’un tableau, mais toujours exact et à jour à chaque nouvelle génération.
Ce plugin s’installe dans KiCad (pas dans votre site), et son résultat est un fichier HTML autonome — pas besoin de modifier _includes/head_custom.html comme pour KiCanvas ou model-viewer, il s’intègre par un simple lien.
Le plugin InteractiveHtmlBom génère un fichier HTML autonome qui affiche le PCB et la nomenclature côte à côte : cliquez une ligne de la BOM, le composant correspondant s’illumine sur le circuit. Particulièrement utile pour le soudage manuel et pour Documenter l’assemblage et le montage.
Dans KiCad, ouvrez le Plugin and Content Manager (icône dédiée sur l’écran d’accueil de KiCad), recherchez Interactive Html Bom, cliquez sur Install puis Apply.
Ouvrez votre PCB dans Pcbnew, enregistrez-le. Cliquez sur l’icône du plugin dans la barre d’outils (ou menu Outils > Extensions externes > Generate Interactive HTML BOM). Dans la fenêtre qui s’ouvre, cliquez sur Generate BOM. Un fichier .html est créé — il fonctionne hors ligne, sans connexion internet.
Copiez le fichier .html généré dans votre dossier docs/ (par exemple docs/nomenclature-interactive.html), puis faites un lien vers lui depuis votre page :
[Voir la nomenclature interactive](nomenclature-interactive.html)
Le schéma montre l’intention, une photo montre la réalité — souvent
différente (fils de couleur, position des composants sur une breadboard,
bricolage temporaire). Prenez ces photos au moment du montage, pas
après coup — voir Documenter au fil de l’eau.
Une simple photo prise avec un smartphone, ajoutée avec
, suffit.
Sur votre partie électronique : exportez votre schéma en SVG et intégrez-le dans votre page, générez votre nomenclature depuis KiCad et intégrez-la (en tableau ou en CSV), et ajoutez au moins une photo du montage réel.