Skip to main content

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​

Please refer to Install ESP-IDF Development Environment.

info

For the ESP32-C6-LCD-1.47 development board, ESP-IDF ≥5.3.1 or later 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.

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.

Example​

ESP32-C6-LCD-1.47-Test​

Example Description​

  • This example demonstrates the functions of the onboard devices. The LCD screen displays parameters such as SD Card, Flash Size, Wireless scan parameters, and CPU utilization.

Hardware Connection​

  • Insert the TF card into the board

  • Connect the development board to the computer.

    ESP32-C6-LCD-1.47_Demo2.webp

Code Analysis​

  • setup
    • Wireless_Init(): Initializes the wireless communication module.
    • Flash_Searching(): Tests and prints the device's flash size information.
    • RGB_Init(): Initializes RGB‑related functions.
    • RGB_Example(): Demonstrates RGB example functionality.
    • SD_Init(): Initializes the TF card.
    • LCD_Init(): Initializes the display.
    • BK_Light(50): Sets the backlight brightness to 50.
    • VGL_Init(): Initializes the LVGL graphics library.
    • Lvgl_Example1(): Calls a specific LVGL example function.
  • while(1)
    • vTaskDelay(pdMS_TO_TICKS(10)): A short delay, every 10 milliseconds.
    • lv_timer_handler(): LVGL timer handler function for handling time‑related events and animations.

Example Flashing​

  • Select the board model ESP32C6 and the port.
  • Download via UART.
  • Flash the example.

Operation Result​

ESP32-C6-LCD-1.47_Demo3.webp