Ressources:Arduino - Encapsulage projet avec librairies et carte
Introduction
Ce tutoriel décrit la méthode pour conserver la même version de carte et de librairies lors de la sauvegarde du projet afin que celui-ci puisse être transmis et reproduit facilement.
Auteur
Rédacteurs du tutoriel :
- Yves Le Chevalier
- Christian Fromentin
Matériel
- Ordinateur
Outils
- IDE Arduino
- Notepad++
Étapes pas à pas
Encapsulage d'un projet Arduino (24.01.2024)
Télécharger le tutoriel en pdf
Cette description s’applique plus précisément à Windows 10/11 mais fonctionne aussi sous Unix.
Une fois pour toutes faire :
- épingler à Accès rapide le chemin vers « C:\Users\[nomutilisateur]\.arduinoIDE » pour un accès plus facile.
- dans le répertoire « C:\Users\[nomutilisateur]l\.arduinoIDE » faire
une copie de sauvegarde du fichier « arduino-cli.yam » sous le nom « arduino-cli.yaml_ORIGINAL ».
- Désigner le programme Notepad++ pour ouvrir par défaut un fichier avec le suffixe ".yaml".
- Créer un dossier "Versions_cartes" dans un dossier de votre choix. (suggéré : Arduino à la racine de C:).
- Pour chaque nouvelle carte utilisée créer un sous répertoire nommé du nom et du n° de version de la carte dans le dossier "Versions_cartes". (ex : C:\Arduino\Versions_cartes\ESP32v2.0.17)
NB : Sous Windows 11, compte tenu de la limitation de longueur des noms de chemins, placer vos dossiers assez près de la racine du lecteur.
Pour créer un nouveau projet :
- Créer un répertoire pour le projet, nommé "[nom_du_projet]"
- Créer un dossier "Documents" (vide) dans le répertoire "[nom_du_projet]"
- Copier le fichier « arduino-cli.yam » dans le répertoire "[nom_du_projet]"
- Avec Notepad++ modifier dans ce fichier « arduino-cli.yam » copié, les chemins des 'directories' propres à ce projet, c’est à dire les 2 lignes 14 et 16.
....data: chemin vers le sous dossier du nom et du n° de version de la carte utilisée
....user: chemin vers le dossier "Documents" créé en 2) ci-dessus. NB : Les lignes de ce fichier doivent se terminer par LF et non pas par CRLF. Pour s’en assurer, faire dans l’éditeur Notepad++ :
[Affichage] puis [Symboles spéciaux] puis cocher ["Afficher tous les caractères"]
Si des lignes se terminent par « CRLF », faire :
[Edition] puis [Convertir les sauts de ligne] puis [Convertir en format UNIX(LF)].
Exemple des lignes modifiées : (□□□□ représentent 4 espaces ; ne pas faire de tabulation)
□□□□data: C:\Arduino\Versions_cartes\ESP32v2.0.17LF
□□□□user: C:\[nom_du_projet]\DocumentsLF
Le dossier "Documents" pourra contenir les diverses versions du programme s’il y a lieu, ainsi que tous les documents annexes s’y rapportant (schémas, docs,...etc)
Important : ne pas faire de mise à jour des nouvelles versions de cartes ou de librairies si elles sont proposées. (Il est possible de paramétrer dans l’IDE la suppression des notifications de mise à jour).
A chaque accès au projet, pour le modifier, le compiler ou le téléverser, recopier le fichier « arduino-cli.yaml » du répertoire "[nom_du_projet]" vers C:\Users\[nomutilisateur]l\.arduinoIDE en remplacant celui existant.
Ceci doit être fait systématiquement avant d’ouvrir l’IDE Arduino.
Une fois terminé restaurer le fichier d’origine à partir du fichier de sauvegarde « arduino-
cli.yaml_ORIGINAL ».
Cette façon de procéder permet de garder des programme à l’abri des modifications de versions de librairies ou de cartes et, lorsqu’on veut transmettre un programme à un tiers, on lui envoie le dossier « Documents » qui contient les librairies spécifiques au programme et éventuellement le dossier de la carte utilisée si nécessaire. (Ce dernier peut être assez volumineux selon les cartes).
