Si ya llevamos un rato jugando con nuestro arduino y poco a poco vamos tomando confianza para enfrentar proyectos cada vez más ambiciosos, seguramente nos encontraremos muy pronto en el siguiente escenario: Acabamos de adquirir un shield de arduino o un flamante nuevo sensor que requiere una librería especial para poder ser utilizado y no sabemos como instalar el software necesario para hacerlo funcionar. En este tutorial te explicamos como instalar una librería de Arduino tanto en Windows como en Mac para que puedas seguir con tu proyecto lo más rápido posible.
En este ejemplo estaremos viendo la instalación de la librería NewPing para sensores ultrasónicos y veremos las 3 formas que existen de realizar la instalación de una librería de Arduino. Hemos actualizado (en septiembre de 2018) este tutorial para que refleje los pasos a seguir en las nuevas versiones del IDE Arduino.
¿Qué es una librería de arduino?
Las librerías son colecciones de código que facilitan la interconexión de sensores, pantallas, módulos electrónicos, etc. Habitualmente las librerías se distribuyen en formato ZIP.
El entorno de arduino ya incluye algunas librerías de manera que se facilite, por ejemplo, mostrar texto en pantallas LCD. Existen miles de librerías desarrolladas por terceros en internet, que nos ayudarán a conectar prácticamente cualquier dispositivo a nuestras tarjetas con arduino. Para saber como utilizar una librería, es necesario consultar la referencia oficial de arduino o el sitio web desde el cual descargamos la librería, también podemos consultar los ejemplos que vienen con las propias librerías si es que no encontramos más documentación.
Las librerías normalmente incluyen los siguientes archivos comprimidos en un archivo ZIP:
- Un archivo .cpp (código fuente de C++).
- Un archivo .h o encabezado de C.
- Un archivo Keywords.txt.
- Muy posiblemente la librería incluye un archivo readme con información adicional sobre la librería para el desarrollador.
- Directorio de sketch de ejemplo (opcional).
- Archivo de metadatos library.properties
En la siguiente imagen vemos el contenido de la librería NewPing (que maneja varios sensores ultrasónicos) y como están organizados sus archivos:
El equipo que desarrolla Arduino ha hecho público un documento en el que se detallan las especificaciones y estructura que debe tener una librería de arduino. Puedes encontrar dicho documento en la siguiente URL, aunque solamente será útil para aquellos usuarios que quieran desarrollar sus propias librerías:
Especificación de librerías para el IDE 1.5 o superior
¿Cómo instalar una librería de Arduino?
Existen 3 formas de instalar una librería en el IDE de Arduino, dependiendo de la librería y de como la obtengamos, debemos elegir alguna de ellas:
- Instalar una librería desde el “gestor de librerías”: la forma más sencilla si la librería se encuentra dada de alta en el IDE de arduino, esto debe hacerlo el autor de la librería.
- Importar una librería desde archivo ZIP: Otra forma sencilla de agregar librerías, ideal cuando descargamos un archivo ZIP. Posiblemente debamos usar este método si la librería que buscamos NO está dada de alta en el “gestor de librerías”.
- Instalar manualmente la librería en las carpetas destinadas a almacenar librerías.
Instalar una librería de arduino mediante el gestor de librerías (método recomendado).
El gestor de librerías es una característica recién implementada en versiones recientes del IDE Arduino. Permite instalar y actualizar las librerías de forma totalmente transparente para el usuario. Para instalar una librería, solamente debemos seleccionarla de una lista y pulsar el botón “instalar”.
Tomemos como ejemplo la librería “NewPing”. Para instalar la librería usando el gestor de librerías debemos hacer lo siguiente:
1.- Abrir el “gestor de librerías” haciendo click en Programa > Incluir librería > Gestionar Librerías.
2.- En la pantalla que se despliega, debemos ingresar el nombre de la librería que deseamos instalar en el campo de búsqueda que resaltamos en la imagen.
3.- Finalmente pulsamos en el botón “instalar”.
Al instalar una librería por este método, tenemos la ventaja de que el IDE podrá ubicar y descargar actualizaciones de la librería de forma automática. Además podremos instalar la versión de la librería de nuestro interés: ya sea la más nueva o una más antigua por razones de compatibilidad con nuestros programas.
Importar librería de arduino desde archivo ZIP
1.- Ubicar y descargar la librería de arduino que requerimos. Es común en estos días encontrar las librerías alojadas en repositorios GIT con proveedores como Bitbucket y Github. Normalmente estos sitios, además del acceso mediante GIT, también brindan un enlace de descarga para los archivos en formato ZIP
2.- Abrir el IDE de Arduino y hacer click en Programa > Incluir librería… > Añadir librería .ZIP en la barra de menú.
3.- Se mostrará la pantalla donde debemos indicar la ruta del archivo .ZIP que contiene la librería de arduino. Elegimos el archivo ZIP que acabamos de descargar y damos click en “Seleccionar”.
Una vez realizados los pasos anteriores, ya debemos tener nuestra libraría lista para funcionar.
Instalación manual de una librería
Si los métodos anteriores para instalar una librería de arduino no funcionan o queremos instalar manualmente la librería para “un mayor control”. Podemos hacerlo de la siguiente forma:
- Descomprimimos el archivo .ZIP
- En Windows copiamos la carpeta de la librería a la siguiente ruta: Documents\Arduino\libraries
- En MAC copiamos la carpeta de la librería a la siguiente ruta: Documents/Arduino/libraries
Al final deberíamos tener en nuestro directorio los siguientes archivos (Windows):
1 2 3 | My Documents\Arduino\libraries\NewPing\src\NewPing.cpp My Documents\Arduino\libraries\NewPing\src\NewPing.h My Documents\Arduino\libraries\NewPing\examples |
En MAC quedaría algo así:
1 2 3 | Documents/Arduino/libraries/NewPing/src/NewPing.cpp Documents/Arduino/libraries/NewPing/src/NewPing.h Documents/Arduino/libraries/NewPing/src/examples |
Incluir la librería recién instalada en un programa
Para poder usar nuestra librería en un programa, hará falta incluirla dentro del código fuente. Para hacer esto, hacemos click en Programa > Incluir Librería > NombreDeLaLibreria. El procedimiento se ve en la siguiente imagen.
Al realizar lo anterior, debemos ver la librería incluida al inicio de nuestro programa de la siguiente forma:
1 | #include <NewPing.h> |
También podemos escribir nosotros esta misma linea en todos los programas que utilizarán la librería NewPing. No hará falta realizar el procedimiento de instalación para cada programa que deseemos realizar, pues la librería ya se encontrará instalada para todos nuestros programas. Bastará con insertar la directiva “include” en cada uno de nuestros programas que usen la librería.
Conclusión
Llegamos al final de este tutorial para instalar una librería en el IDE Arduino. Ahora solo queda aprender a usar las nuevas funciones que nos proporciona nuestra librería ya instalada. Si tienes alguna sugerencia o conoces algún tip para la instalación de librerías, por favor usa la sección de comentarios para compartir con nosotros.