Skip to main content

Working with ESP-IDF

This chapter contains the following sections. Please read as needed:

ESP-IDF Getting Started​

New to ESP32 ESP-IDF development and looking to get started quickly? We have prepared a general Getting Started Tutorial for you.

Please Note: This tutorial uses the ESP32-S3-Zero as a teaching example, and all hardware code is based on its pinout. Before you start, it is recommended that you check the pinout of your development board to ensure the pin configuration is correct.

Setting Up the Development Environment​

warning

Note: ESP-IDF supports ESP32-H2 starting from version V5.1. ** When installing ESP-IDF, you must select version V5.1 or later.**

note

The following guide uses Windows as an example, demonstrating development using VS Code + the ESP-IDF extension. macOS and Linux users should refer to the official documentation.

Version Selection

The screenshots in this section use ESP-IDF V5.5.2 as an example. When installing, please select the ESP-IDF version that matches your board's example.

Install the ESP-IDF Development Environment​

  1. Download the installation manager from the ESP-IDF Installation Manager page. This is Espressif's latest cross-platform installer. The following steps demonstrate how to use its offline installation feature.

    Click the Offline Installer tab on the page, then select Windows as the operating system and the ESP-IDF version you need (the version shown in the screenshot is for reference only — choose the version that fits your actual needs).

    Download EIM and offline package

    After confirming your selection, click the download button. The browser will automatically download two files: the ESP-IDF Offline Package (.zst) and the ESP-IDF Installer (.exe).

    Download EIM and offline package 2

    Please wait for both files to finish downloading.

  2. Once the download is complete, double-click to run the ESP-IDF Installer (eim-gui-windows-x64.exe).

    The installer will automatically detect if the offline package exists in the same directory. Click Install from archive.

    Auto-detect offline package

    Next, select the installation path. We recommend using the default path. If you need to customize it, ensure the path does not contain Chinese characters or spaces. Click Start installation to proceed.

    Select installation path

  3. When you see the following screen, the ESP-IDF installation is successful.

    Installation successful

  4. We recommend installing the drivers as well. Click Finish installation, then select Install driver.

    Install drivers via ESP-IDF Installation Manager

Install Visual Studio Code and the ESP-IDF Extension​

  1. Download and install Visual Studio Code.

  2. During installation, it is recommended to check Add "Open with Code" action to Windows Explorer file context menu to facilitate opening project folders quickly.

  3. In VS Code, click the Extensions icon Extensions Icon in the Activity Bar on the side (or use the shortcut Ctrl + Shift + X) to open the Extensions view.

  4. Enter ESP-IDF in the search box, locate the ESP-IDF extension, and click Install.

    Search and install ESP-IDF extension in VS Code

  5. For ESP-IDF extension versions ≥ 2.0, the extension will automatically detect and recognize the ESP-IDF environment installed in the previous steps, requiring no manual configuration.

Running Official Espressif Examples​

Please refer to Waveshare ESP-IDF Getting Started - Section 2 Run Example.

Hello Word​

  • Official example path: get-started -> hello_world
  • Example effect: Outputs "Hello world!" at 10‑second intervals in the TERMINAL window.

Software Operation​

  • Create the official hello_world example following the tutorial above.

  • The program is compatible with ESP32-H2; no modification needed.

  • Set the COM port and driver target (it is recommended to use the COM port corresponding to USB; you can check it in Device Manager), then click compile and flash to run the program.

    ESP32-H2 TO Erase Flash 1.png

GPIO​

  • Official example path: peripherals -> gpio -> generic_gpio
  • Example effect: LED blinks at 1-second intervals.

Hardware Connection​

ESP32-H2LED
GPIO18 (or GPIO19)LED+
GNDLED-

Software Operation​

  • Create the official generic_gpio example following the tutorial above.

  • The program is compatible with ESP32-H2; no modification needed.

  • Set the COM port and driver target (it is recommended to use the COM port corresponding to USB; you can check it in Device Manager), then click compile and flash to run the program.

    ESP32-H2_TO_Sample

  • Go to the macro definition location in the program to see which GPIO is actually used.

    ESP32-H2_TO_Sample_1

  • Right-click and go to the GPIO definition location.

    ESP32-H2_TO_Sample_1

  • The actual GPIOs used are GPIO8 and GPIO9.

    ESP32-H2_TO_Sample_1

RGB​

  • Official example path: get-started -> blink
  • Example effect: The onboard RGB LED blinks at 1-second intervals.

Software Operation​

  • Create the official blink example following the tutorial above.

  • The program is compatible with ESP32-H2; no modification needed.

  • Set the COM port and driver target (it is recommended to use the COM port corresponding to USB; you can check it in Device Manager), then click compile and flash to run the program.

    ESP32-H2_TO_Sample

UART​

  • Official example path: peripherals -> uart -> uart_async_rxtxtasks
  • Example effect: Self‑transmission and reception of UART data when GPIO4 and GPIO5 are shorted.

Hardware Connection​

ESP32-H2ESP32-H2 (Same Board)
GPIO4GPIO5

Software Operation​

  • Create the official uart_async_rxtxtasks example following the tutorial above.

  • The program is compatible with ESP32-H2; no modification needed.

  • Set the COM port and driver target (it is recommended to use the COM port corresponding to USB; you can check it in Device Manager), then click compile and flash to run the program.

    ESP32-H2_TO_Sample

  • Make the hardware connection according to the GPIOs used.

    ESP32-H2_TO_Sample

  • You can go to the definition file to see the actual GPIOs used (select GPIO_NUM_4 -> right-click -> Go to Definition).

    ESP32-H2_TO_Sample

I2C​

  • Official example path: peripherals -> lcd -> i2c_oled
  • Example effect: Lights up a 0.96inch OLED (A) and displays a string of characters.

Hardware Connection​

0.96inch OLED (A)ESP32-H2
VCC3V3
GNDGND
DINGPIO3
CLKGPIO4
CSGND
D/CGND
RESGPIO9

Software Operation​

  • Create the official i2c_oled example following the tutorial above.

  • Modify the program to make it compatible with the 0.96inch OLED (A).

    ESP32-H2_TO_Sample

  • Adapt for the 0.96inch OLED (A); define the RES pin as GPIO9.

    ESP32-H2_TO_Sample

  • Set the COM port and target driver correctly (it is recommended to use the COM port corresponding to USB; you can check it in Device Manager) , then click Build and Flash to run the program.

    ESP32-H2_TO_Sample

  • The effect is as follows:

    ESP32-H2_TO_Sample

  • You can check the actual GPIOs used.

    ESP32-H2_TO_Sample

SPI​

  • Official example path: peripherals -> spi_master -> lcd
  • Example effect: Dynamically displays images on a 2.4inch LCD Module.

Hardware Connection​

2.4inch LCD ModuleESP32-H2
VCC3V3
GNDGND
DINGPIO5
CLKGPIO4
CSGPIO1
D/CGPIO10
RESGPIO11
BLGPIO12

Software Operation​

  • Right‑click the VS Code icon and run VS Code as administrator.

    ESP32-H2_TO_Sample

  • Create the official lcd example following the tutorial above.

  • Modify the program to make it compatible with the 2.4inch LCD Module.

    ESP32-H2_TO_Sample

  • Jump to the definition location.

    ESP32-H2_TO_Sample

  • The current target is ESP32-H2; comment out definitions for other chips.

    ESP32-H2_TO_Sample

  • And define CONFIG_IDF_TARGET_ESP32H2 for ESP32-H2.

    ESP32-H2_TO_Sample

  • Wait for the ID read.

    ESP32-H2_TO_Sample

  • Add a read delay to prevent read failures.

    ESP32-H2_TO_Sample

  • Modify the backlight control.

    ESP32-H2_TO_Sample

  • Change to gpio_set_level(PIN_NUM_BCKL, 1);.

    ESP32-H2_TO_Sample

  • Set the COM port and target driver correctly (it is recommended to use the COM port corresponding to USB; you can check it in Device Manager) , then click Build and Flash to run the program.

    ESP32-H2_TO_Sample

  • The effect is as follows:

    ESP32-H2_TO_Sample

Bluetooth​

  • Official example path: bluetooth -> bluedroid -> ble -> gatt_server
  • Example effect: Data transfer between the ESP32-H2 and a Bluetooth debugging assistant on a mobile phone.

Software Operation​

  • Install a Bluetooth debugging assistant on your phone.

  • Create the official gatt_server example following the tutorial above.

  • The program is compatible with ESP32-H2; no modification needed.

  • The Bluetooth name and UUID: the Bluetooth name is ESP_GATTS_DEMO.

    ESP32-H2_TO_Sample

  • Set the COM port and target driver correctly (it is recommended to use the COM port corresponding to USB; you can check it in Device Manager) , then click Build and Flash to run the program.

    ESP32-H2_TO_Sample

  • Connect to the ESP_GATTS_DEMO Bluetooth Bluetooth device on your phone.

    ESP32-H2_TO_Sample

  • Successful connection appears as shown below.

    ESP32-H2_TO_Sample

  • According to the UUID values in the program, the two servers below are available; choose one for uplink transmission.

    ESP32-H2_TO_Sample

  • The ESP32-H2 receives the data.

    ESP32-H2_TO_Sample

Zigbee​

  • Official example 1 path: Zigbee -> light_sample -> HA_on_off_switch
  • Official example 2 path: Zigbee -> light_sample -> HA_on_off_light
  • Example effect: Two ESP32-H2 boards; one (flashed with the HA_on_off_switch program) uses its BOOT button to control the RGB LED on the other board.
info

Note: First flash the HA_on_off_switch program on one board, then flash the HA_on_off_light program on the other board.

Software Operation 1​

  • Create the official HA_on_off_switch example following the tutorial above.

  • The program is compatible with ESP32-H2; no modification needed.

  • Set the COM port and target driver correctly (use the COM port corresponding to UART; you can check it in Device Manager), then click Build and Flash to run the program.

    ESP32-H2_TO_Sample

Software Operation 2​

  • Create the official HA_on_off_light example following the tutorial above.

  • The program is compatible with ESP32-H2; no modification needed.

  • Set the COM port and driver target (use the COM port corresponding to UART), then click Build and Flash to run the program (wait a moment for the two chips to establish a connection).

    ESP32-H2_TO_Sample

  • After a successful connection, the corresponding button program and LED program will print relevant data.

    ESP32-H2_TO_Sample

  • If initialization fails, it may be because the device still has residual network information. You can erase the device information and then re‑form the network.

Erasing Device Flash​

  • Extract the software resource package Flash debugging software

  • Open the flash_download_tool_3.9.5.exe software, select ESP32-H2 and UART

    ESP32-H2 TO Erase Flash 1.png

  • Select the UART port number, click START (do not select any bin file)

    ESP32-H2 TO Erase Flash 2.png

  • Wait for the flashing to complete, then click Erase

    ESP32-H2 TO Erase Flash 3.png

  • Wait for the erasing to complete

    ESP32-H2 TO Erase Flash 4.png