Projets:EncapsArduino

Description du projet

Ce programme constitue une « fenêtre d’accès » aux programme Arduino que ce soit lors de la création d’un nouveau programme ou lors de la modification de ceux-ci.

Il vise à conserver l’environnement de développement d’un programme afin de pouvoir modifier celui-ci dans le futur sans avoir à subir les inconvénients des évolutions de cartes et de librairies.

Ce logiciel fonctionne sous Windows et sous Linux en téléchargeant la version correspondant au système d’exploitation. EncapsArduino.exe est accompagné d’une icône qui permettra d’identifier dans l’explorateur de fichiers, les programme encapsulés.

Ce programme a été développé par Yves Le Chevalier & Christian Fromentin.

Cahier des charges

• Programme permettant de sauvegarder des programmes Arduino de manière pérenne avec l'ensemble des librairies associées qui permettent leur exécution, et quelque soient les mises à jour faites par la suite.

Matériel

• Ordinateur avec système d'exploitation Linux ou Windows

Coût

• gratuit

Fichiers source

Télécharger les fichiers sources pour compiler le programme

COMPILATION SOUS LINUX :

Ouvrir un terminal et aller dans le dossier où se trouve les sources de EncapsArduino avec la commande suivante :

 cd /home/yourUserName/Projets/EncapsArduino

Compiler le programme depuis ce dossier avec la commande suivante:

 python3 -m PyInstaller --hidden-import 'customtkinter' --hidden-import 'tkinter' --hidden-import='PIL._tkinter_finder' encapsarduino.py --onefile --noconsole

Le fichier éxécutable se trouve alors dans le dossier "dist".

COMPILATION SOUS WINDOWS :

Ouvrir l'invite de commande Windows et lancer la compilation depuis le dossier source EncapsArduino

 python -m PyInstaller encapsarduino.py --onefile --noconsole

Étapes de fabrication pas à pas

1-Questions initiales

À la première utilisation du logiciel, trois questions sont posées. Elles ne le seront plus par la suite.

Paramétrage initial

Le première question concerne le fichier d’exécution de l’IDE Arduino (Arduino IDE.exe).

On renseigne le champ de saisie par un copier/coller puis on clique sur [OK] ou on fait [Entrée] pour le valider.

Sous Windows, comme sous Linux, c’est le chemin complet, nom d’exe compris, qui est copié depuis la ligne « Cible » ou « Cible du lien » des propriétés de l’icône de lancement de l’IDE Arduino sur le bureau. (Clic droit/Propriétés/Ctrl+C puis Ctrl+V).

La seconde question concerne le fichier Yaml utilisé par l’IDE Arduino pour y stocker ses préférences.

C’est le fichier « arduino-cli.yaml » qui se trouve généralement dans le répertoire ..…./Utilisateurs/Nom d’utilisateur/.arduinoIDE. En cliquant sur le bouton, l’explorateur de fichiers et automatiquement ouvert pour permettre de trouver ce fichier.

Atttention : Ce fichier « arduino-cli.yaml », est un fichier caché, il faut donc dans vos préférences de dossiers, sous Windows cocher la case « Eléments masqués » ou sous Linux,valider« Afficher les fichiers cachés »).

Sous Windows, comme sous Linux, une fois trouvé le fichier « arduino-cli.yaml », on double-clique dessus et le chemin complet avec le nom de fichier apparaît sur la ligne.

La troisième question concerne le répertoire où seront stockées les versions de cartes utilisées par les programmes. Ce répertoire doit avoir été créé auparavant, et peut se situer n’importe où. C’est dans ce répertoire que seront créés automatiquement un dossier pour chaque version de carte utilisée. Il s’agit donc d’un chemin et non pas d’un nom de fichier. En cliquant sur le bouton, l’explorateur de fichier s’ouvre automatiquement pour permettre de trouver le dossier.

Sous Windows, comme sous Linux, une fois trouvé le dossier que vous avez créé pour vos cartes, on double-clique dessus et le chemin apparaît sur la ligne.

Une fois que vous avez répondu à ces 3 questions, celles-ci ne vous seront jamais redemandées sauf si vous effacez pour une raison ou une autre le fichier des paramètres (commande située dans la ligne menu de la fenêtre, sous « Param »).

En-effet, un fichier json de mémorisation de ces informations a été créé automatiquement à côté de cet exécutable.

2-Chemin des applications

Une nouvelle question est alors posée pour demander le chemin du répertoire dans lequel sont stockés les dossiers des programmes arduino.

Chemin des applications

Ce chemin est mémorisé et sera par la suite automatiquement proposé par défaut. Il sera cependant possible de le modifier en cliquant sur le bouton « Choix du répertoire des applications » qui ouvre l’explorateur de fichiers. Il suffit ensuite de cliquer sur [OK] pour valider la proposition de chemin ou la saisie d’un nouveau chemin.

Sous Windows, comme sous Linux, une fois trouvé le dossier des applications, on double-clique dessus et le chemin apparaît sur la ligne.

3-Nom du programme

Une fois le répertoire des applications validé, on saisit le nom du programme que l’on veut écrire ou modifier. Ce nom de programme est le nom générique, sans numéro de version ni suffixe « .ino »

Une fois saisi, le nom du programme doit être validé en cliquant sur [OK] ou en faisant [Entrée]. Un nom de programme doit faire au moins 3 caractères pour être accepté.

3.1 Si le programme existe déjà

On demande confirmation à l’aide de 2 « boutons radios » de la modification supposée de celui-ci.

Entrée du nom du programme et confirmation

• Soit on clique sur « Oui » et le programme fait le nécessaire pour permettre à l’IDE Arduino d’accéder à la version de carte et aux librairies spécifiques de ce programme dans leur version d’origine au moment de la création du programme.

L’explorateur de fichier s’ouvre alors sur le dossier du programme choisi et il ne vous reste plus qu’à accéder au code du programme voulu sachant que plusieurs versions du programme peuvent coexister dans ce dossier au fur et à mesure des évolutions, tout en utilisant les mêmes versions de librairies et de carte.

• Soit on clique sur « Non » et il est proposé de saisir un autre nom de programme.

C’est généralement le cas quand on veut développer un nouveau programme mais auquel on attribue par erreur un nom déjà existant.

3.2-Si c’est un nouveau programme

Lorsque le nom d’un nouveau programme est entré, une fenêtre affiche la liste des cartes déjà connues pour vous demander de choisir parmi celles-ci la carte sur laquelle vous allez développer le programme.

Il suffit de cliquer sur le signe [ V ] pour voir apparaître la liste des cartes connues, puis de dérouler éventuellement cette liste pour trouver la carte voulue.

La sélection se fait en cliquant sur la version de carte voulue. Il faut ensuite cliquer sur [Valider] pour entériner son choix.

S’il s’agit d’une carte ou d’une version de cartes jamais utilisée, celle-ci ne figure pas dans la liste proposée et il faut cliquer sur « AUTRE CARTE ».

Un nouveau champ de saisie apparaît alors pour demander d’entrer le nom et la version de la carte voulue.

Il vous est alors demandé de saisir le nom et le n° de version de la carte dans un nouveau champ de saisie.

Il est important de saisir dans le nom, le numéro de version de cette carte pour la distinguer par la suite des autres versions de cette même carte. (Cf : illustration ci-dessus)

Numéro de version de carte

Lorsque la carte a été sélectionnée dans la liste, il faut valider son choix en cliquant sur le bouton [Valider].

Si une nouvelle version de carte a été saisie, il faut valider cette saisie en cliquant sur le bouton [Valider] ou en faisant [Entrée].

Des contrôles sont alors effectués pour s’assurer par exemple que la nouvelle carte n’existe vraiment pas dans celles qui sont connues.

Nom de la nouvelle version de la carte

A ce niveau, tous les éléments nécessaires ont été recueillis et le logiciel crée un nouveau dossier du nom du programme saisi, dans le répertoire des applications.

Dans ce dossier il stocke une copie du fichier de préférence de l’IDE Arduino configurée pour ce programme qu’il ne faudra en aucun cas modifier ou effacer.

Il crée ensuite dans ce dossier un sous-dossier « Docs » qui contiendra les différentes versions du programme au cours des évolutions de celui-ci mais dans lequel on pourra aussi mettre toute la documentation voulue pour ce programme (Schémas électroniques, mode d’emploi, docs techniques, ...etc).

Sous Windows, ce dossier « Docs » est caractérisé par une icône «Application Encapsulée ».

Dans ce dossier « Docs » un sous-dossier est aussi créé avec le même nom de programme mais suffixé par « _V1 » puisqu’il s’agit de la première version de ce programme que l’on veut écrire.

Dans ce sous dossier « NomdeProgramme_V1 », un fichier du nom du programme suffixé par « .ino » est créé. C’est le squelette du nouveau programme dans lequel est déjà écrit en commentaires la date et la version de carte utilisée.

A ce niveau, la fenêtre du logiciel disparaît et ouvre le squelette du programme « Nomdeprogramme_v1.ino » dans l’IDE arduino.

Si une nouvelle carte a été choisie, un message vient s’ouvrir pour ne pas oublier de faire la mise à jour de la nouvelle carte avant même de commencer à écrire le code.

4-Exemple d’arborescence du répertoire des applications

Arborescence type

5-Remarques

5.1

Lorsqu’on veut faire une nouvelle version d’un programme Prog_v1 pour y apporter des modifications, il est conseillé de commencer par faire une copie du programme concerné dans le même répertoire et de renommer celui-ci Prog_v2 en incrémentant son numéro de version.

Ensuite il faut lancer EncapsArduino.exe pour accéder au programme.

5.2

Lorsqu’on télécharge EncapArduino , le dossier « Dist » comtient l’exe du programme. Il est accompagné dans la version Windows d’une icône. Vous pouvez stocker ce dossier où vous voulez dans votre ordinateur.

La première chose à faire ensuite est ce créer un raccourci sur le bureau vers EncapsArduino.exe

(Envoyer vers….Bureau)

A l’issue de la première utilisation un fichier « Fiparam.json » sera créé dans ce même répertoire « Dist ». Il ne faut pas le supprimer car il mémorise les chemins des dossiers et fichiers nécessaires à cette application.

5.3

A la création d’un nouveau programme, le dossier « libraries » figurant dans l’arborescence décrite ci-dessus n’existe pas. Il est automatiquement créé lorsqu’on ajoute des bibliothèques dans l’IDE Arduino (CTRL+Shift+I) et les bibliothèques installées viennent s’écrirent automatiquement dans ce dossier « libraries ». Elles resteront donc spécifiques du programme dans leur version d’installation.

5.4

Lorsque l’on clique sur le logo MHK dan le coin inférieur droit de la fenêtre, le navigateur par défaut ouvre le site internet de My Human Kit.

5.5

Lorsque l’on a commencé à développer des programmes Arduino avec ce logiciel d’encapsulage, il est primordial de toujours l’utiliser par la suite, que ce soit pour créer un nouveau programme Arduino ou pour en modifier un autre.

« Ce n’est pas la peine d’avoir trouvé de si belles chaussures pour continuer à marcher pieds nus »

(proverbe indigène)