Espressif, la empresa detrás de la familia de chips ESP32, publica su SDK oficial en GitHub bajo el nombre de ESP-IDF, o Espressif IoT Development Framework.
El IDF contiene todas las herramientas necesarias para el trabajo diario, como compiladores, ejemplos, scripts de Python para el proceso de desarrollo y gestión de proyectos, así como las librerías o componentes que necesitemos para aprovechar nuestro hardware.
Como todo proyecto, es necesario cumplir ciertos requerimientos antes de instalarlo, para que el proceso pueda realizarse correctamente, en nuestro caso, hemos probado este flujo de instalación en un sistema macOS Ventura 13.1 con procesador M1 y Python 3.10, en el que pudimos comprobar que todo funciona correctamente.
Pasos de instalación
Para realizar este proceso de instalación, es necesario realizar cinco pasos:
Preparar nuestro sistema con las dependencias necesarias.
Clonar el repositorio de GitHub con la versión del esp-idf que deseamos instalar.
Ejecutar el script de instalación.
Configurar el entorno.
Verificar la instalación.
Instalar las dependencias
El esp-idf utiliza algunas dependencias como cmake y ninja para la compilación de proyectos, las dependencias varían dependiendo del sistema operativo, pero en Unix se recomiendan las siguientes: cmake ninja dfu-util
Por lo tanto, podemos instalarlas con el siguiente comando:
brew installgit cmake ninja dfu-util python3@3.10
💡 En caso de que surja algún mensaje de error de compatibilidad o al instalar el software, puedes asegurarte primero actualizar tu sistema con: /usr/sbin/softwareupdate --install-rosetta --agree-to-license, y luego volver a intentar con la instalación.
💡 Otra herramienta necesaria es xcode.
En caso de que no lo tengas instalado puede ser que te marque el siguiente error:
Para solucionarlo, realiza la instalación en la terminal con el comando:
xcode-select --install
Una vez instaladas las dependencias, vamos a validar que nuestra versión de Python es la correcta con el comando:
python3 --version
Clonar el repositorio
Para este curso, vamos a utilizar la última versión estable del IDF, que es la v4.4.2, por lo tanto, vamos a incluir ese dato al momento de clonar el repositorio.
También vamos a pedirle a Git que descargue todos los repositorios que son dependencias del IDF, y así contar con ellos durante la instalación, es decir, vamos a indicarle un clon recursivo.
Antes de clonar el repositorio, es recomendable crear una carpeta en la cual instalaremos esta y cualquier otra versión del IDF en el futuro, se recomienda crearla en el home:
# Creamos la carpetamkdir ~/esp
# Nos movemos a ellacd ~/esp
Ya dentro de la carpeta, ejecutamos el comando para clonar el repositorio:
Una vez que termina de clonar el repositorio, tendremos una carpeta llamada esp-idf en nuestro directorio actual, y nos moveremos a ella con cd ~/esp/esp-idf.
Script de instalación
Una vez dentro de la carpeta, podríamos ver que existen varios archivos, como la carpeta de ejemplos y diferentes scripts, primero, vamos a ejecutar el script de instalación.
El comando para ejecutar el script de instalación es:
. ./install.sh
Con esto comenzará la instalación del IDF, descargando y compilando todo lo necesario.
💡 En caso de que el proceso de instalación falle, es necesario verificar que las dependencias se encuentran instaladas y que contamos con una versión de Python mayor a la 3.6, idealmente Python 3.10, pues es el que utilizamos durante las pruebas.
Una vez que termina la instalación, podemos ir al paso final, la configuración del entorno.
Configuración del entorno
Los proyectos generados con el IDF requieren dependencias y versiones muy específicas para funcionar. Es por eso que entre los scripts, nos incluyen uno llamado export.sh, que configura el entorno de la terminal para poder utilizarlos. Sin embargo, esta configuración dura únicamente hasta que se cierra la sesión en la terminal, y es por eso que cada vez que vayamos a trabajar debemos volver a ejecutarlo.
El comando para configurar el entorno cada vez que queremos usarlo en la terminal, sería:
. ~/esp/esp-idf/export.sh
Sin embargo, podemos aprovechar los alias de Unix y crear un comando más corto, que podremos utilizar cada vez que sea necesario, para crearlo sería así:
aliasget_idf='. ~/esp/esp-idf/export.sh'
Con esta configuración, tendremos el comando get_idf disponible siempre que abramos la terminal, sin importar la ubicación, y así hacernos la vida más fácil.
Para configurar el entorno en ocasiones posteriores, solamente debemos ejecutar el comando así:
get_idf
Podemos verificarlo abriendo otra terminal y ejecutando el comando.
Cabe mencionar que en teoría es posible agregar esta configuración a la de nuestra terminal para que se ejecute tan solo abrir la terminal. Sin embargo, esto no es recomendable, dado que esto podría causar conflictos con otros programas para otras tareas. Lo mejor de momento, es usar este alias siempre que vayamos a trabajar nuestros proyectos con el IDF.
Verificación de la instalación
Finalmente, ya con nuestro entorno instalado y configurado, podemos verificar nuestra instalación ejecutando el comando:
idf.py --version
Esto debería devolvernos la versión del IDF instalado, en nuestro caso muestra: ESP-IDF v4.4.2
Con todo esto, ya estamos listos para continuar el curso y compilar nuestro primer proyecto, podemos movernos a la carpeta del ejemplo blink, con el comando:
cd ~/esp/esp-idf/examples/get-started/blink
Y realizar la compilación del proyecto con el comando:
idf.py build
Si nuestra instalación es correcta, tomará un tiempo para compilar el proyecto y no mostrará ningún error.
Si tienen un error al correr el install.sh con python 3.11.3 usen
git clone -b v5.0.1 --recursive https://github.com/espressif/esp-idf.git. Hay un error con la versión dada en el texto que fue patcheada en versiones posteriores del proyecto.
