Skip to content

Get Started with ESP-IDF

Install the software

Install ESP-IDF

Through https://github.com/espressif/idf-installer/releases search for 4.4.1 and download the version.

Get_Started_with_ESP-IDF_1

Double-click the esp-idf-tools-setup-offline file to install ESP-IDF.

get-started-with-ESP-IDF-2

Select setup language.

get-started-with-ESP-IDF-3

Accept the license agreement and go next.

get-started-with-ESP-IDF-4

Select "Next"

get-started-with-ESP-IDF-5

Accept the default location or click 'Browse...' to change the installation location. Then go next.

get-started-with-ESP-IDF-6

get-started-with-ESP-IDF-7

Click install and wait for the installation ...

get-started-with-ESP-IDF-8

get-started-with-ESP-IDF-9

Click 'Finish' to exit the installation and (by default) launch ESP-IDF:

get-started-with-ESP-IDF-10

The installation is successful if the following information is displayed.

get-started-with-ESP-IDF-11

Install Visual Studio Code

Search for Visual Studio Code download on Google or enter the https://code.visualstudio.com/download, select the version compatible with your computer system and download Visual Studio Code installer. In this instructions we are selecting Windows.

Get_Started_with_PlatformIO_1

Double-click the VSCodeUserSetup file to install the Visual Studio Code.

get-started-with-platformio-2

Accept the license agreement and go next.

get-started-with-platformio-3(1)

Accept the default location or click 'Browse...' to change the installation location.

get-started-with-platformio-4

Accept the resting default option and click 'Next >'...

Click install and waiting for the installation ...

get-started-with-platformio-5

Click 'Finish' to exit the installation and (by default) launch Visual Studio Code:

get-started-with-platformio-6

Open Visual Studio Code and open Extension Manager.

get-started-with-platformio-7

Install Python

Search for 'Python' and install.

get-started-with-platformio-8

Install ESP-IDF

Search for 'ESP-IDF' and install.

get-started-with-ESP-IDF-12

ESP-IDF setup.

get-started-with-ESP-IDF-14

Select the previously installed ESP-IDF and install.

get-started-with-ESP-IDF-15

Wait until the installation is completed.

get-started-with-ESP-IDF-16

Create a project

After installation, click 'New Project'.

get-started-with-ESP-IDF-18

Or click the ESP-IDF icon, click 'COMMANDS', then click 'New Project Wizard'.

get-started-with-ESP-IDF-17

Modify the project name or default. Then click 'Choose Template' to create the project.

get-started-with-ESP-IDF-19

Select 'ESP-IDF' and select 'hello_world'.

get-started-with-ESP-IDF-20

get-started-with-ESP-IDF-21

Click 'create project using template hello_world'.

get-started-with-ESP-IDF-22

Open project in a new window

get-started-with-ESP-IDF-23

Successfully created the project.

get-started-with-ESP-IDF-24

Run the program

In this case, we'll run a hello_world demo on the CrowPanel-ESP32 Display to check that the installation is correct.

  1. Connect the CrowPanel-ESP32 Display to the computer with a USB cable.

  2. Click the Compile button and wait for the project to compile successfully.

    get-started-with-ESP-IDF-25

  3. Select the corresponding serial port.

    get-started-with-ESP-IDF-26

  4. Click Download and select UART.

    get-started-with-ESP-IDF-27

  5. Wait a while until the download is successful.

    get-started-with-ESP-IDF-28

  6. Click the serial port to view the terminal information.

    get-started-with-ESP-IDF-29