Une bibliothèque est un ensemble de fonctions qui s’ajoutent aux fonctions de base du logiciel de l’Arduino et qui adressent plus particulièrement un domaine spécifique de la programmation comme, par exemple :
- EEPROM - lire et écrire dans cette zone de mémoire permanente du micro-contrôleur ;
- Ethernet - accéder à un réseau TCP/IP comme Internet, mais ça peut être aussi un réseau local à votre domicile, avec l’aide de la carte Ethernet ;
- LiquidCrystal - utiliser un écran LCD ;
- SD - lire et écrire une carte SD de technologie flash et formatée en FAT16 ou FAT32, sauf reformatage de votre part, toutes les cartes SD le sont ;
- Servo - piloter des servomécanismes ;
- WiFi - se connecter à un réseau sans fil à partir d’une carte WiFi ;
- Wire - Communiquer entre Arduinos et avec des périphériques capteurs, actionneurs avec le protocole I2C.
Ces bibliothèques sont installées en même temps que l’IDE. Vous n’aurez pas à les ajouter.
Mais surtout, il existe sur le net des multitudes de bibliothèques dans pratiquement tous les domaines, ce qui donne à l’Arduino cette puissance incontestable et son succès. Certaines sont créées par Locoduino, d’autres sont décrites grâce à des articles, en particulier celles qui concernent -de près ou de loin- le modélisme ferroviaire.
Il y a en gros deux types de bibliothèques : celles qui permettent de piloter simplement un circuit, un écran ou un shield. Et celles qui ajoutent des fonctionnalités utiles d’une manière générale, comme SlowMotionServo pour piloter finement un servo moteur, DCCpp pour gérer un réseau en DCC, ou le couple Accessories/Commanders pour gérer les accessoires d’un réseau par des boutons ou des commandes DCC.
Cet article concerne donc l’installation de librairies supplémentaires, qu’elles soient issues de Locoduino ou pas.
Bibliothèque ou Librairie ?
Avant de commencer, revenons sur un point de traduction. Arduino est un projet où l’anglais prédomine. Library est normalement traduit littéralement en français par bibliothèque. Cependant l’anglicisme a pris le dessus et vous trouverez beaucoup de pages en français où on parle de librairie Arduino.
Nous allons voir dans cet article comment installer une bibliothèque qui n’est pas de base dans l’IDE Arduino.
Où les trouver ?
Comme Arduino est un projet communautaire, vous trouverez des bibliothèques sur le web en général. Celles de Locoduino sont accessibles sur ce que l’on nomme une ’forge’, parce que c’est là qu’elles se construisent. Locoduino place ses bilbiothèques sur Github, mais il y a bien d’autres forges…
Quelques bibliothèques sont recensées sur le site officiel sur cette page. Si vous ne trouvez pas votre bonheur, une recherche avec le type de shield ou de composant accompagné de Arduino et library vous donnera les pointeurs souhaités.
Où les installer ?
Revenons sur un point de la structure d’un ordinateur. Quel que soit son environnement de travail (Windows, Mac OS X ou GNU/Linux), il y a un répertoire privé où vous mettez vos documents auxquels d’autres utilisateurs de l’ordinateur n’ont pas forcément accès, et un répertoire accessible par toute personne possédant un droit de lecture sur les répertoires de programmes.
Dans votre répertoire personnel, après installation de l’IDE Arduino, vous avez un répertoire sketchbook (GNU/Linux) ou Documents/Arduino (Mac) ou Documents/Arduino (Windows) qui est créé. À l’intérieur, vous avez un répertoire pour chaque programme que vous avez enregistré, ainsi qu’un répertoire particulier nommé libraries (si il n’y est pas, vous pourrez le créer si vous choisissez cet emplacement, mais nommez le bien ’libraries’ en Anglais !).
Si la librairie est installée dans ce répertoire, seul l’utilisateur du répertoire y aura accès dans son programme. Si vous êtes seul sur l’ordinateur, c’est la méthode la plus facile.
Vous voyez d’ailleurs que les bibliothèques officielles ne sont pas dans celui-ci. Afin que chaque utilisateur de l’ordinateur y ait accès, elles sont installées dans un répertoire qui diffère du précédent et même selon les ordinateurs :
- sous GNU/Linux, dans /usr/share/arduino/libraries/ ;
- sous Mac OS X, dans le bundle de l’application : Arduino/Contents/Resources/Java/libraries [1] ;
- sous Windows 32 bits, dans C :\Program Files\Arduino\libraries ;
- sous Windows 64 bits, dans C :\Program Files (x86)\Arduino\libraries ;
Vous pourrez faire une installation ici si vous en avez les droits pour faire profiter tous les utilisateurs de l’ordinateur de cette bibliothèque. Toutefois, ce n’est pas une procédure prévue dans l’IDE Arduino et c’est inutile si vous êtes le seul à programmer sur Arduino avec votre ordinateur, cas le plus fréquent.
Plusieurs méthodes d’installation
Nous allons prendre un exemple :
la bibliothèque Tone qui permet de faire jouer un buzzer en sortant des sons, vous la trouverez ici, téléchargez-la pour essayer.
Méthode facile
Dans l’IDE Arduino, vous avez le menu Croquis/Importer bibliothèque…/add library (Et non, ce n’est pas traduit…) en version 1.0.6, ou Croquis/Inclure une bibliothèque/Ajouter la bibliothèque .ZIP… dans la version 1.6.7 et suivantes. Vous sélectionnez l’archive de la bibliothèque et vous cliquez sur OK.
Elle est installée.
Par exemple sous Windows, vous aurez un répertoire Mes Documents/Arduino/libraries/Tone qui contient le fichier tone.h entre autres…
Sous Mac le dossier est dans Documents/Arduino/libraries.
Autre méthode
Décompressez votre archive, vous trouverez un répertoire du nom de la bibliothèque qui contient les fichiers nécessaires pour l’exécution dans un code. Vous copiez ce répertoire dans le dossier que vous préférez, soit votre home si vous êtes seul sur le PC sinon le répertoire d’installation du programme que nous avons vu précédemment pour que tous les utilisateurs profitent de la bibliothèque, à coté des bibliothèques officielles.
Par exemple sous Windows, vous aurez un répertoire c :/Program Files (x86)/Arduino/libraries/Tone qui contient le fichier tone.h entre autres…
Attention au nom de la bibliothèque qui peut être différent dans le Zip, en particulier s’il a été téléchargé sur une ’forge’ comme [https://github.com/Locoduino/], GitHub ou Sourceforge. Ces environnements de travail collaboratifs ajoutent le nom de la branche (la version de travail) à celui du projet, ce qui donnerait ’tone-master’ pour Tone. Enlevez bien tout ce qui n’est pas le nom la bibliothèque sinon elle ne sera pas reconnue. Pour savoir à coup sûr quel nom utiliser, le répertoire doit porter le nom du fichier .h qui sera inclus : Tone.h -> Tone !
Redémarrez l’IDE pour profiter de la bibliothèque.
Depuis l’IDE 1.6.0
Depuis cette version de l’IDE Arduino, un Gestionnaire de bibliothèques est disponible par la commande Croquis/Inclure une bibliothèque/Gérer les bibliothèques… Il permet de retrouver une liste détaillée des bibliothèques présentes, de les mettre à jour lorsqu’une évolution a été détectée chez son créateur, et d’en installer de nouvelles proposées automatiquement. Cette liste peut être triée par thème, ou par état (installées, à mettre à jour…) .
Désinstallation
Supprimez simplement le répertoire de la bibliothèque et redémarrez l’IDE pour que ça soit pris en compte.