Header Ads

Créer une librairie pour Arduino

Etape 1: développement la librairie
En tout premier lieu, il faut développer les classes et constantes qui seront placées dans la librairie.

Cela produira un ou plusieurs couple de fichier cpp et h.
C'est ce que j'ai fais en développant ma classe MonoLed (voir articles Led Class - Part 1, Led Class - Part 2, Led Class - Part 3 | PushButton Class - Part 2).

Ce processus est également bien décrit dans l'article "Arduino Library Tutorial" sur Arduino.cc pour la création de la classe Morse. Malheureusement il s'agit d'un article en anglais.

Etape 2: Localiser le répertoire librairies
Sur un système Unix (ex: Ubuntu), le répertoire librairies se trouve à l'emplacement suivant de l'arborescence.
/usr/share/arduino/librairies

Attention: dans le cadre d'un système Unix, pour pouvoir y ajouter une libraire (un répertoire), il faut disposer des droits d'administration.

Etape 3: Mise en place de la librairie
Lorsque le code est stable, il est alors possible de le placer dans le répertoire d'import des librairies de l'Arduino IDE.
Il faut première créer un répertoire dans le sous répertoire libraries d'Arduino pour y stocker la librairie.
Le nom du répertoire doit être rigoureusement identique (case-sensitive) au nom du fichier header à inclure, fichier header qui sera placé dans le répertoire.

Pour le cas de ma classe MonoLed (voir cet article), le nom du répertoire à créer sera LedTools puisque mes sources sont LedTools.h et LedTools.cpp.

Dans le cas de l'exemple issus de l'article "Arduino Library Tutorial", le répertoire à créer sera "Morse".

Par la suite, il suffit d'y copier le fichier .h et .cpp (fichiers qui ont le même nom que le répertoire créé à l'étape précédente).
Dans le cas de la classe MonoLed, et de ma librairie LedTools il s'agit des fichiers LedTools.h et LedTools.cpp.

NB: après avoir créé ou ajouté une librairie, il est nécessaire de redémarrer Arduino IDE pour qu'il en tienne compte du nouveau répertoire durant la phase de compilation. 

Etape 4: utilisation de la librairie
Pour utiliser une des librairies nouvellement ajoutée, il suffit de faire un #include.
A la différence d'un appel lorsque LedTools.h faisait partie du projet (et donc #include "LedTools.h"), on utilisera la notation #include <LedTools.h> lorsque le LedTools est disponible dans le répertoire librairies




Références: