ESP-IDF

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

ESP-IDF Getting Started
Setting Up Development Environment
Demo

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 Development Environment

info

For the ESP32-S3-LCD-0.85 development board, ESP-IDF version V5.5.0 or above is required.

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.

Install the ESP-IDF Development Environment

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 choose your desired version from the filter bar.

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).

Please wait for both files to finish downloading.
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.

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.
When you see the following screen, the ESP-IDF installation is successful.
We recommend installing the drivers as well. Click Finish installation, then select Install driver.

Install Visual Studio Code and the ESP-IDF Extension

Download and install Visual Studio Code.
During installation, it is recommended to check Add "Open with Code" action to Windows Explorer file context menu to facilitate opening project folders quickly.
In VS Code, click the Extensions icon in the Activity Bar on the side (or use the shortcut Ctrl + Shift + X) to open the Extensions view.
Enter ESP-IDF in the search box, locate the ESP-IDF extension, and click Install.
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.

Demo

The ESP-IDF demos are located in the ESP-IDF directory of the demo package.

01_factory

This example demonstrates a comprehensive demo for the ESP32-S3-LCD-0.85, and it is also the factory default flashed example.

Specific Operations

Press and hold the left button, the speaker will play the sound captured by the microphone in real time
Double-click the middle button to turn off the screen; double-click again to restore the display
When powered by battery, long press the middle button to power on; long press again and release to power off
Long press the right button, the LED lights up and cycles through 4 colors; long press again to turn off the LED
Click the left or right button to switch pages

Operation Result

The first page displays red, green, and blue colors in rotation
The second page displays development board information
The third page displays the IP address of the connected WiFi (if not connected or connection fails, it shows 0.0.0.0) and the scanned WiFi networks

02_button_example

This example demonstrates how to use the espressif/button library to read button states such as single click, double click, and long press, and print them via serial port.

Code Analysis

Bind callback functions:

  ret = iot_button_register_cb(boot_btn, BUTTON_PRESS_DOWN, NULL, button_event_cb, NULL);
  ret |= iot_button_register_cb(boot_btn, BUTTON_PRESS_UP, NULL, button_event_cb, NULL);
  ret |= iot_button_register_cb(boot_btn, BUTTON_PRESS_REPEAT, NULL, button_event_cb, NULL);
  ret |= iot_button_register_cb(boot_btn, BUTTON_PRESS_REPEAT_DONE, NULL, button_event_cb, NULL);
  ret |= iot_button_register_cb(boot_btn, BUTTON_SINGLE_CLICK, NULL, button_event_cb, NULL);
  ret |= iot_button_register_cb(boot_btn, BUTTON_DOUBLE_CLICK, NULL, button_event_cb, NULL);
  ret |= iot_button_register_cb(boot_btn, BUTTON_LONG_PRESS_START, NULL, button_event_cb, NULL);
  ret |= iot_button_register_cb(boot_btn, BUTTON_LONG_PRESS_HOLD, NULL, button_event_cb, NULL);
  ret |= iot_button_register_cb(boot_btn, BUTTON_LONG_PRESS_UP, NULL, button_event_cb, NULL);
  ret |= iot_button_register_cb(boot_btn, BUTTON_PRESS_END, NULL, button_event_cb, NULL);

Operation Result

Open the serial monitor

03_ws2812b_example

This example demonstrates how to use the ESP32's RMT peripheral to control a WS2812 LED strip, achieving LED on/off control.

Code Analysis

Configure LED strip parameters and initialize:

Loop to control the LED strip's on/off state:

  led_strip_config_t strip_config {
      .strip_gpio_num = LED_STRIP_GPIO_PIN, // The GPIO that connected to the LED strip's data line
      .max_leds = LED_STRIP_LED_COUNT,      // The number of LEDs in the strip,
      .led_model = LED_MODEL_WS2812,        // LED strip model
      .color_component_format = LED_STRIP_COLOR_COMPONENT_FMT_GRB, // The color order of the strip: GRB
      .flags = {
          .invert_out = false, // don't invert the output signal
      }
    while (1) {
      if (led_on_off) {
          /* Set the LED pixel using RGB from 0 (0%) to 255 (100%) for each color */
          for (int i = 0; i < LED_STRIP_LED_COUNT; i++) {
              ESP_ERROR_CHECK(led_strip_set_pixel(led_strip, i, 5, 5, 5));
          }
          /* Refresh the strip to send data */
          ESP_ERROR_CHECK(led_strip_refresh(led_strip));
          ESP_LOGI(TAG, "LED ON!");
      }else{
          ESP_ERROR_CHECK(led_strip_clear(led_strip));
          ESP_LOGI(TAG, "LED OFF!");
      }

      led_on_off = !led_on_off;
      vTaskDelay(pdMS_TO_TICKS(500));
  }

Operation Result

The screen shows no output
The LED beads will blink simultaneously at 500ms intervals
Open the serial monitor

04_sd_card_test

This demo tests the TF card read/write functionality on the ESP32-S3-LCD-0.85.

Insert the TF card into the card slot (TF card needs to be formatted as FAT32)

Code Analysis

Initialize and mount the TF card:

  sdmmc_slot_config_t slot_config = SDMMC_SLOT_CONFIG_DEFAULT();
#if EXAMPLE_IS_UHS1
    slot_config.flags |= SDMMC_SLOT_FLAG_UHS1;
#endif

    // Set bus width to use:
#ifdef CONFIG_EXAMPLE_SDMMC_BUS_WIDTH_4
    slot_config.width = 4;
#else
    slot_config.width = 1;
#endif

    // On chips where the GPIOs used for TF card can be configured, set them in
    // the slot_config structure:
#ifdef CONFIG_SOC_SDMMC_USE_GPIO_MATRIX
    slot_config.clk = CONFIG_EXAMPLE_PIN_CLK;
    slot_config.cmd = CONFIG_EXAMPLE_PIN_CMD;
    slot_config.d0 = CONFIG_EXAMPLE_PIN_D0;
#ifdef CONFIG_EXAMPLE_SDMMC_BUS_WIDTH_4
    slot_config.d1 = CONFIG_EXAMPLE_PIN_D1;
    slot_config.d2 = CONFIG_EXAMPLE_PIN_D2;
    slot_config.d3 = CONFIG_EXAMPLE_PIN_D3;
#endif // CONFIG_EXAMPLE_SDMMC_BUS_WIDTH_4
#endif  // CONFIG_SOC_SDMMC_USE_GPIO_MATRIX

    // Enable internal pullups on enabled pins. The internal pullups
    // are insufficient however, please make sure 10k external pullups are
    // connected on the bus. This is for debug / example purpose only.
    slot_config.flags |= SDMMC_SLOT_FLAG_INTERNAL_PULLUP;

    ESP_LOGI(TAG, "Mounting filesystem");
    ret = esp_vfs_fat_sdmmc_mount(mount_point, &host, &slot_config, &mount_config, &card);

Operation Result

Open the serial monitor
Print TF card information

05_lvgl_example

This demo demonstrates how to run the lvgl demos (LVGL v8 and LVGL v9) on the ESP32-S3-LCD-0.85.

Code Analysis

Initialize:

   /* LCD HW initialization */
  ESP_ERROR_CHECK(app_lcd_init());

  /* Touch initialization */
  app_touch_init();

  /* LVGL initialization */
  ESP_ERROR_CHECK(app_lvgl_init());

Operation Result

The default LVGL version used is v9.3.0. To change the version, modify the LVGL configuration in the main/idf_component.yml file, for example, change it to lvgl/lvgl:^8.4.0.
Operation effect

ESP-IDF Getting Started​

Setting Up Development Environment​

Install the ESP-IDF Development Environment​

Install Visual Studio Code and the ESP-IDF Extension​

Demo​

01_factory​

Specific Operations​

Operation Result​

02_button_example​

Code Analysis​

Operation Result​

03_ws2812b_example​

Code Analysis​

Operation Result​

04_sd_card_test​

Code Analysis​

Operation Result​

05_lvgl_example​

Code Analysis​

Operation Result​

ESP-IDF Getting Started

Setting Up Development Environment

Install the ESP-IDF Development Environment

Install Visual Studio Code and the ESP-IDF Extension

Demo

01_factory

Specific Operations

Operation Result

02_button_example

Code Analysis

Operation Result

03_ws2812b_example

Code Analysis

Operation Result

04_sd_card_test

Code Analysis

Operation Result

05_lvgl_example

Code Analysis

Operation Result