Como utilizar o ESP-IDF no Visual Studio Code

 

{getToc} $title={Índice}

O ESP-IDF é o framework e sistema operacional oficial da Espressif Systems para programar os MCUs da mesma, como o ESP32. Neste artigo, será apresentado como configurar o Visual Studio Code para trabalhar com o ESP-IDF. No momento em que este artigo foi escrito, a versão estável do ESP-IDF é a v5.2.2.

Pré-requisitos

Primeiramente, deve-se instalar o VS Code, navegando até a página de downloads[1] do editor de textos.

Caso o sistema operacional seja Linux e possua o gerenciador de pacotes snap, pode-se instalar com o comando a seguir:

sudo snap install code

Se o sistema operacional for Linux ou macOS, deve-se instalar também os pré-requisitos presentes na página oficial do ESP-IDF [2].

Para evitar problemas ao fazer o flash na placa no Linux, deve-se adicionar o usuário aos grupos uucp e dialout, com os comandos a seguir (para aplicar as modificações, o usuário terá que reiniciar a sessão ou reiniciar o computador):

sudo usermod -aG uucp $USER

sudo usermod -aG dialout $USER

 

Instalação ESP-IDF no VS Code

Após instalados o VS Code e os pré-requisitos, abra a aba de extensões do VS Code e procure por ESP-IDF.

Depois de instalada a extensão, vá na aba do ESP-IDF explorer na esquerda e em Configure ESP-IDF Extension ou pressione F1 para abrir a paleta de comandos do VS Code e procure por ESP-IDF: Configure ESP-IDF Extension. Na tela que aparecer, clique em EXPRESS para começar a configuração rápida.

Na próxima tela, será configurada a instalação do ESP-IDF no computador.

O campo Select ESP-IDF version permite o usuário escolher a versão do ESP-IDF a ser instalada. Caso já possua o ESP-IDF instalado na máquina, basta selecionar a opção Find ESP-IDF in your system. Caso contrário, selecione a versão do ESP-IDF que deseja instalar, neste caso será utilizada a versão v5.2.2, que é a versão estável atual.

Também é possível de se alterar os diretórios onde serão instalados o ESP-IDF e o ESP-IDF Tools, e no Linux pode-se alterar inclusive o executável do Python a ser utilizado. Contudo, é recomendado que não se altere essas configurações caso não tenha o conhecimento necessário.

Após isso, basta clicar em Install para iniciar a instalação.

Ao terminar a instalação, o ESP-IDF já estará pronto para ser utilizado no VS Code!

Em sistemas Linux, após a instalação, deverá aparecer um comando que deve ser executado no terminal com privilégios de sudo, basta copiá-lo e executá-lo em um terminal para assim finalizar a instalação.

Criando um projeto a partir de um exemplo

Para criar um projeto a partir de um exemplo, vá na aba do ESP-IDF explorer na esquerda, depois em Show examples e selecione Use current ESP-IDF.

Na aba de exemplos, em get_started selecione o projeto hello_world e depois Create project using example hello_world. Após isso, selecione a pasta onde deseja salvar o projeto, e confirme:

Por fim, o projeto será criado e um workspace com o projeto será iniciado. Na barra inferior ficam os comandos específicos do ESP-IDF:

Selecione a porta onde o ESP32 está conectado, o modelo do mesmo e logo após faça o build do projeto. No setup utilizado para este artigo, o ESP32 está conectado na porta COM5 via conversor USB-Serial, o modo de flash é UART e o modelo do ESP32 é o esp32c6 (via ESP-PROG).

Se o build ocorrer corretamente a seguinte mensagem será mostrada no terminal:

Project build complete. To flash, run:

ESP-IDF: Flash your project in the ESP-IDF Visual Studio Code Extension

or in a ESP-IDF Terminal:

idf.py flash

or

idf.py -p PORT flash

or

python -m esptool --chip esp32c6 -b 460800 --before default_reset --after hard_reset  --port COM5 write_flash --flash_mode dio --flash_size 2MB --flash_freq 80m 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin 0x8000 partition_table/partition-table.bin 

or from the "c:\Users\mathe\Desktop\esp_examples\hello_world\build" directory

python -m esptool --chip esp32c6 -b 460800 --before default_reset --after hard_reset write_flash "@flash_args"

Para fazer o flash, clique em ESP-IDF: Flash device (símbolo de relâmpago) e depois abra o monitor clicando em ESP-IDF: Monitor device (símbolo de um monitor) para visualizar a execução do código.

Em caso de sucesso, o projeto será executado conforme a seguir:

Hello world!

This is esp32c6 chip with 1 CPU core(s), WiFi/BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.0, 2MB external flash

Minimum free heap size: 467556 bytes

Restarting in 10 seconds...

Restarting in 9 seconds...

Restarting in 8 seconds...

Restarting in 7 seconds...

Restarting in 6 seconds...

Restarting in 5 seconds...

Restarting in 4 seconds...

Restarting in 3 seconds...

Restarting in 2 seconds...

Restarting in 1 seconds...

Restarting in 0 seconds...

Restarting now.

Dicas e considerações finais:

Seguindo os passos deste artigo é possível de se começar a programar o ESP32 com o ESP-IDF pelo Visual Studio Code!

No caso do projeto não conseguir encontrar algumas referências, instale a extensão "C/C++" da Microsoft, pressione as teclas "ctrl ," depois em workspace procure por compileCommands, e adicione a mensagem "${workspaceFolder}/build/compile_commands.json". Após o build, as referências deverão ser encontradas.

[1] Download Visual Studio Code

[2] Pré-requisitos ESP-IDF