PlatformIO IDE / Visual Studio Code

NOTA: Durante la instalación del entorno de desarrollo, se realizará la descarga de las herramientas de compilación/programación, se requiere un espacio de almacenamiento de ~1.5GB. Se recomienda utilizar una conexión a internet estable.

Instalar VS Code

1. Descarga Visual Studio Code en su página oficial a través del siguiente enlace:

https://code.visualstudio.com/code.visualstudio.com

Visual Studio Code está disponible para diferentes sistemas operativos, selecciona el tuyo.

1. Ya descargado, instala Visual Studio Code, en este ejemplo usamos Windows.

1. Una vez terminada la instalación ejecuta el programa, se mostrará una ventana como la siguiente:

Instalar driver USB Silicon Labs (Solo para XC01 R4 o versiones anteriores)

Instalar driver USB Silicon Labs

1. Descarga el driver USB Silicon Labs a través de su página oficial en el siguiente enlace y descomprime el archivo.

CP210x USB to UART Bridge VCP Drivers - Silicon Labs

El driver USB Silicon Labs está disponible para diferentes sistemas operativos, selecciona el tuyo.

1. Conecta tu módulo X-NODE MCU WIFI BLE (ESP32-WROOM-32) a la computadora por medio del cable micro USB y localízalo en el administrador de dispositivos. Para este ejemplo usamos sistema operativo Windows.

1. Da clic derecho en el dispositivo y clic en Actualizar controlador.

1. Selecciona Buscar controladores en mi equipo.

1. Da clic en Examinar, selecciona la carpeta del driver y da clic en Siguiente.

1. Por último, una vez instalado el driver con éxito, da clic en cerrar.

1. ¡Listo! El dispositivo será reconocido por el sistema operativo.

Instalar PlatformIO IDE

1. Dirígete hacia la barra de herramientas de lado izquierdo, da clic en el administrador de extensiones, busca PlatformIO IDE e instálalo.

1. Al finalizar la instalación es probable que deba reiniciar VSCode para habilitar la extensión de PlatformIO, cierre todas las pestañas de VSCode y vuelva a abrirlo. Al iniciar el editor, si es la primera vez que instala una extensión, deberá deshabilitar el modo restringido presionando el botón Trust. De lo contrario PlatformIO no podrá ejecutarse.

Banner de VSCode en modo restringido

Presione el botón Trust para deshabilitar el modo restringido

1. Una vez instalado, abre el administrador de proyectos de PlatformIO IDE y crea un nuevo proyecto.

1. Configura los paramétros del proyecto en el Project Wizard y da clic en Finish:

XC01 R5

• Name: <Nombre del proyecto>

• Board: Espressif ESP32-S3-DevKitM-1

• Framework: Arduino

• Use default location

XC01 R4 o versiones anteriores

• Name: <Nombre del proyecto>

• Board: Espressif ESP32 Dev Module

• Framework: Arduino

• Use default location

1. Este proceso instala toda la cadena de herramientas requeridas para compilar los proyectos.

Debido al tamaño de los archivos el proceso de instalación puede demorar varios minutos, no canceles la instalación.

1. Al finalizar el proceso se muestra la siguiente estructura, lo que indica que ha terminado la instalación de los archivos.

1. Edita el archivo platformio.ini para agregar la definición de los pines del XC01 y tabla de particiones como se muestra a continuación.

XC01 R5

[env]
platform = espressif32@6.10.0
framework = arduino
; Serial monitor speed
monitor_speed = 115200
; Debug config
; debug_tool = esp-builtin
; debug_init_break = break setup
; build_type = debug

[env:xide-iot-trainer-r5]
board = esp32-s3-devkitm-1
; Set Flash Size & Partition table
board_build.partitions = app3M_fat9M_16MB.csv
board_build.flash_mode = qio
board_upload.flash_size = 16MB
board_upload.maximum_size = 16777216
build_flags = 
; Enable Serial comms over USB
    -DARDUINO_USB_MODE=1
    -DARDUINO_USB_CDC_ON_BOOT=1 
; Hardware version macro
    -DUSE_XC01_R5=1
; MikroBUS GPIO pinout
    -DMIKROBUS_PWM=5
    -DMIKROBUS_INT=7
    -DMIKROBUS_RX=9
    -DMIKROBUS_TX=10
    -DMIKROBUS_SDA=12
    -DMIKROBUS_SCL=13
    -DMIKROBUS_AN=4
    -DMIKROBUS_RST=15
    -DMIKROBUS_CS=6
    -DMIKROBUS_SCK=8
    -DMIKROBUS_MISO=18
    -DMIKROBUS_MOSI=17
; built-in uSD card CS GPIO
    -DuSD_CS=-1
; Built-in LED GPIO
    -DBOARD_LED=16
; BOOT button GPIO
    -DBOARD_BUTTON=0

XC01 R4 o versiones anteriores

[env]
platform = espressif32@6.10.0
framework = arduino
; Serial monitor speed
monitor_speed = 115200

[env:xide-iot-trainer-r4]
board = esp32dev
build_flags = 
; Hardware version macro
    -DUSE_XC01_R4=1
; MikroBUS GPIO pinout
    -DMIKROBUS_PWM=33
    -DMIKROBUS_INT=26
    -DMIKROBUS_RX=16
    -DMIKROBUS_TX=17
    -DMIKROBUS_SDA=21
    -DMIKROBUS_SCL=22
    -DMIKROBUS_AN=32
    -DMIKROBUS_RST=27
    -DMIKROBUS_CS=2
    -DMIKROBUS_SCK=18
    -DMIKROBUS_MISO=19
    -DMIKROBUS_MOSI=23
    -DuSD_CS=25
    -DBOARD_LED=4
    -DBOARD_BUTTON=0

1. Para asegurarse que la instalación fue exitosa, da clic en el botón Compilar que se encuentra en la parte inferior izquierda con el símbolo , si la instalación fue exitosa se muestra el mensaje: SUCCESS.

Añadir librerías a un proyecto de PlatformIO IDE

1. Ingresa al administrador de librerías en PlatformIO IDE.

1. Busca la librería deseada y presta atención en las arquitecturas compatibles.

Debe mostrarse la arquitectura Espressif 32, de lo contrario puede que la librería no sea compatible.

1. Selecciona la versión de la librería que deseas utilizar y da clic en Add to Project.

1. Selecciona el proyecto en el que se instalará la librería y da clic en Add.

Configurar parámetros de un proyecto en PlatformIO IDE (Monitor serial)

1. Ingresa al administrador de proyectos en PlatformIO IDE, selecciona el proyecto que deseas configurar y da clic en Configure.

1. En el recuadro New Option selecciona la opción que deseas agregar al proyecto, por ejemplo: monitor_speed monitor_echo

1. Configura la opción conforme a tus necesidades.

1. Por último, da clic en el botón Save para guardar los cambios.

Preguntas frecuentes

PlatformIO está demorando mucho tiempo en instalarse

El proceso de instalación requiere descargar hasta ~1.5GB de archivos. Asegúrese de contar con una conexión a internet estable con un ancho de banda de al menos 10Mbps. Si su conexión cumple con estos requisitos consulte: VSCode muestra un error al intentar instalar/ejecutar PlatformIO

PlatformIO no se está ejecutando en VSCode

Asegúrese que VSCode no se encuentre ejecutándose en modo restrictivo. Consulte el paso 2 del manual: Instalar PlatformIO IDE. En el administrador de extensiones asegurese que la extensión PlatformIO se encuentre habilitada y de ser necesario reinicie VSCode.

PlatformIO no puede programar la tarjeta: "A fatal error occured: Could not open <port>, the port doesn´t exist."

Asegúrese que ningún otro programa se encuentre utilizando el puerto de comunicación serial de la tarjeta. Desconecte la tarjeta y vuelva a conectarla a la computadora. Si el problema persiste revise las siguientes notas:

• XC01 R4 o versiones anteriores: Instale el driver de Silicon Labs. Reinicie su computadora al finalizar la instalación para aplicar los cambios.
• XC05 R5: Presione la secuencia:

Presionar el botón RST -> Presionar el botón BOOT -> Soltar el botón RST -> Soltar el botón RST. Al terminar de programar su dispositivo presione el botón RST para ejecutar el programa.

Recuerde habilitar la emulación CDC en BOOT en su entorno de desarrollo para permitir la programación automática (paso 6 en la sección Instalar PlatformIO IDE).

• Windows: Busque e instale actualizaciones en Windows Update.

• Linux: Instale el archivo de reglas udev: 99-platformio-udev.rules con el comando:

curl -fsSL https://raw.githubusercontent.com/platformio/platformio-core/develop/platformio/assets/system/99-platformio-udev.rules | sudo tee /etc/udev/rules.d/99-platformio-udev.rules

• MacOS: Si está utilizando un HUB USB, desconectelo y conecte el cable USB desde su Mac al XC01 directamente.

VSCode muestra un error al intentar instalar/ejecutar PlatformIO

PlatformIO requiere Python 3.6 o superior. Lea las notas a continuación:

• Windows: Descargue e instale Python. Durante el proceso de instalación seleccione la opción: Add Python to Path para permitir que VSCode utilice Python.

• Linux: La mayoría de las distribuciones Linux incluyen Python instalado por defecto, sin embargo, puede requerir instalar Python Virtual Environment con el siguiente comando:

sudo apt install python3-venv