aaryaapg / esp-idf-vscode-procedure

Procedure and resources for getting started with ESP-IDF on VSCode.

esp-idf-vscode-procedure

This repository is a template for creating a new project on ESP-IDF using VSCode. After downloading it, follow these steps

1. Unzip into C:\esp
2. Rename the unzipped folder
3. In Makefile, replace "esp-idf-vscode-procedure" with the new project name
4. In the main folder, rename "main_program" (.c file)
5. In CMakeLists.txt, replace "main_program" with the new program name
6. Start editing!

Sample: https://github.com/espressif/esp-idf/tree/master/examples/get-started/sample_project

How to build and flash ESP32 on ESP-IDF 4.2 CMD (Example)

C:\esp>cd C:\esp\hello_world

C:\esp\hello_world>idf.py set-target esp32

C:\esp\hello_world>idf.py menuconfig

C:\esp\hello_world>idf.py build

C:\esp\hello_world>idf.py -p COM3 flash

C:\esp\hello_world>idf.py monitor

Procedure for Installation and Setup

Step 1: Install ESP-IDF

https://www.youtube.com/watch?v=K58Y2dFsQ2A -> Follow the same procedure

Step 2: Install VSCode

https://www.youtube.com/watch?v=aQi8qiW9fmg&list=PLfcVdODhZSagC8s_13x22eAf0X9TP4zqy&index=9 -> 00:00 to 01:52

1. Set Environment Variables
2. Enable C/C++ Extension on VSCode
3. Enable Native Debug exension on VSCode

Step 3: Check versions of OpenOCD and Python

https://www.youtube.com/watch?v=KRyvly_SYS8 -> 05:33 to 06:12 PS: I did not do all the extra stuff he was doing for python packages. Also, I had the latest version of python installed and not 2 versions like he had later in the video.

Step 4: Open example project and resolve errors (Do this IFF there are errors)

https://www.youtube.com/watch?v=KRyvly_SYS8 -> 10:18 to 14:34

Errors are:

1. Include Errors
2. portTICK_PERIOD_MS underline

How to resolve them?

Press F1, then select C/C++ Edit configurations (UI).

Include Path :

${workspaceFolder}/**

${env:IDF_PATH}/components/**

build/config

[espressif/vscode-esp-idf-extension#26]

Compiler path

C:\esp\.espressif\tools\xtensa-esp32-elf\esp-2020r3-8.4.0\xtensa-esp32-elf\bin\xtensa-esp32-elf-gcc.exe [espressif/vscode-esp-idf-extension#27]

IntelliSense mode : Choose gcc-x64(legacy)