ESP-IDF开发

本章介绍 ESP-IDF 环境搭建，包括 Visual Studio、Espressif IDF插件的安装，程序编译下载及示例程序测试，帮助用户掌握开发板，便于二次开发。

环境搭建

下载和安装 Visual Studio

打开VScode官网的下载页面，选择对应系统和系统位数进行下载
运行安装包后，其余均可以默认安装，但这里为了后续的体验建议，建议在此处勾选框中的1、2、3项
- 第一二项开启后，可以直接通过鼠标右键文件或者目录打开VSCode，可以提高后续的使用体验.
- 第三项开启后，选择打开方式时，可以直接选择VSCode

环境设置是在 Windows 10 系统下进行，Linux和Mac用户可访问ESP-IDF环境搭建参考

安装Espressif IDF插件

国内部分区域安装，一般推荐“在线安装”，若因网络因素无法在线安装，则使用“离线安装”。
安装Espressif IDF插件教程，详见：安装Espressif IDF插件教程
需要安装 ESP-IDF V5.4.0 或更高版本。

运行第一个 ESP-IDF 程序

如果你刚入门学习ESP32和ESP-IDF，还不知道如何创建、编译、烧录和运行ESP-IDF程序，那么请展开看看，希望可以帮助到你！

新建项目

创建例程

使用快捷键 F1 ，输入esp-idf:show examples projects

选择你当前的IDF版本

以Hello world例程为例

①选择对应例程
②其readme会说明该例程适用于什么芯片（下文有介绍例程怎么使用与文件结构，这里略）
③点击创建例程

选择放置例程的路径，要求无例程同名文件夹

修改COM口

此处显示使用对应的COM口，点击可以修改对应COM口
请根据设备对应COM口进行选择（可通过设备管理器查看）
若出现下载失败的情况请点击复位按键1秒以上或进入下载模式，等待 PC 端重新识别到设备后再次下载

修改驱动对象

选择我们需要驱动的对象，也就是我们的主芯片为ESP32S3

选择openocd的路径，这里对我们没有影响，所以我们随便选择一个即可

其余状态栏简介

①.ESP-IDF开发环境版本管理器，当我们的工程需要区分开发环境版本时，可以通过安装不同版本的ESP-IDF来分别管理，当工程使用特定版本时，可以通过使用它来切换
②.设备烧录COM口，选择以将编译好的程序烧录进芯片上
③.set-target 芯片型号选择，选择对应的芯片型号，如:ESP32-P4-Nano需要选择 esp32p4 为目标芯片
④.menuconfig，点击修改sdkconfig配置文件内容，项目配置详细资料
⑤.fullclean 清理按钮，当工程编译报错或其他操作污染编译内容时，通过点击清理全部编译内容
⑥. Build 构建工程，当一个工程满足构建时，通过此按钮进行编译
⑦.当前下载方式，默认为UART
⑧.flash烧录按钮，当一个工程Build构建通过时，选择对应开发板COM口，点击此按钮可以将编译好的固件烧录至芯片
⑨.monitor开启烧录口监控，当一个工程Build-->flash后，可通过点击此按钮查看烧录、调试口输出的l0g，以便观察应用程序是否正常工作
⑩.Debug调试
⑪.Build Flash Monitor 一键按钮，用于连续执行Build-->Flash-->Monitor，常被称作小火苗

编译、烧录、串口监视

点击我们之前介绍的编译，烧录，打开串口监视器按键

编译可能需要较长时间才能完成，尤其是在第一次编译时

在此过程中，ESP-IDF可能会占用大量CPU资源，因此可能会导致系统卡顿
若是新工程首次烧录程序，将需要选择下载方式，选择 UART

后续也可在下载方式处进行修改（点击即可弹出选项）

因为板载自动下载电路，无需手动操作即可自动下载
下载成功后，自动进入串口监视器，可以看到芯片输出对应的信息并提示10S后重启

使用IDF 示例程序

下文以使用“ESP32-S3-LCD-1.47-Demo”为例介绍工程的两种打开方式及使用的一般步骤、ESP-IDF工程项目详解，若使用其他工程，操作步骤类推。

软件内部打开

打开 VScode 软件，选择文件夹打开示例

选择提供的 ESP-IDF 下的示例，点击选择文件(位于示例程序/Demo/ESP-IDF 路径下)

软件外部打开

正确选择工程目录，打开工程，否则会影响后续程序编译烧录

连接设备后，选择好COM口和型号，点击下方编译并烧录即可实现程序控制

ESP-IDF工程项目详解

组件（Component）:ESP-IDF中的组件是构建应用的基本模块，每个组件通常是相对独立的代码库或库，能实现特定的功能或服务，可以被应用程序或是其他组件重复使用，类似于Python开发中的库的定义。
- 组件的引用：Python开发环境中引入库只需要“import 库名或路径”即可，而ESP-IDF基于C语言基础，引入库是通过CMakeLists.txt进行配置和定义的。
- CmakeLists.txt的作用：ESP-IDF编译时编译工具CMake会首先通过读取工程目录的顶层CMakeLists.txt的内容来读取构建规则，识别需要编译的内容。当在CMakeLists.txt中引入了需要的组件、程序后，编译工具CMake会根据索引导入每个所需要编译的内容。编译过程如：

修改COM口

此处显示使用对应的COM口，点击可以修改对应COM口
请根据设备对应COM口进行选择（可通过设备管理器查看）
若出现下载失败的情况请点击复位按键1秒以上或进入下载模式，等待 PC 端重新识别到设备后再次下载

修改驱动对象

选择我们需要驱动的对象，下图以主芯片为ESP32S3 以例（用户根据手头实物板子的主控芯片对应设置）

选择openocd的路径，这里对我们没有影响，所以我们随便选择一个即可

其余状态栏简介

①.ESP-IDF开发环境版本管理器，当我们的工程需要区分开发环境版本时，可以通过安装不同版本的ESP-IDF来分别管理，当工程使用特定版本时，可以通过使用它来切换
②.设备烧录COM口，选择以将编译好的程序烧录进芯片上
③.set-target 芯片型号选择，选择对应的芯片型号，如:ESP32-P4-Nano需要选择 esp32p4 为目标芯片
④.menuconfig，点击修改sdkconfig配置文件内容，项目配置详细资料
⑤.fullclean 清理按钮，当工程编译报错或其他操作污染编译内容时，通过点击清理全部编译内容
⑥. Build 构建工程，当一个工程满足构建时，通过此按钮进行编译
⑦.当前下载方式，默认为UART
⑧.flash烧录按钮，当一个工程Build构建通过时，选择对应开发板COM口，点击此按钮可以将编译好的固件烧录至芯片
⑨.monitor开启烧录口监控，当一个工程Build-->flash后，可通过点击此按钮查看烧录、调试口输出的l0g，以便观察应用程序是否正常工作
⑩.Debug调试
⑪.Build Flash Monitor 一键按钮，用于连续执行Build-->Flash-->Monitor，常被称作小火苗

编译、烧录、串口监视

点击我们之前介绍的编译，烧录，打开串口监视器按键

编译可能需要较长时间才能完成，尤其是在第一次编译时

在此过程中，ESP-IDF可能会占用大量CPU资源，因此可能会导致系统卡顿
若是新工程首次烧录程序，将需要选择下载方式，选择 UART

后续也可在下载方式处进行修改（点击即可弹出选项）

因为板载自动下载电路，无需手动操作即可自动下载
下载成功后，自动进入串口监视器，可以看到芯片输出对应的信息并提示10S后重启

使用IDF 示例程序

下文以使用“ESP32-S3-LCD-1.47-Demo”为例介绍工程的两种打开方式及使用的一般步骤、ESP-IDF工程项目详解，若使用其他工程，操作步骤类推。

软件内部打开

打开 VScode 软件，选择文件夹打开示例

选择提供的 ESP-IDF 下的示例，点击选择文件(位于示例程序/Demo/ESP-IDF 路径下)

软件外部打开

正确选择工程目录，打开工程，否则会影响后续程序编译烧录

连接设备后，选择好COM口和型号，点击下方编译并烧录即可实现程序控制

ESP-IDF工程项目详解

组件（Component）:ESP-IDF中的组件是构建应用的基本模块，每个组件通常是相对独立的代码库或库，能实现特定的功能或服务，可以被应用程序或是其他组件重复使用，类似于Python开发中的库的定义。
- 组件的引用：Python开发环境中引入库只需要“import 库名或路径”即可，而ESP-IDF基于C语言基础，引入库是通过CMakeLists.txt进行配置和定义的。
- CmakeLists.txt的作用：ESP-IDF编译时编译工具CMake会首先通过读取工程目录的顶层CMakeLists.txt的内容来读取构建规则，识别需要编译的内容。当在CMakeLists.txt中引入了需要的组件、程序后，编译工具CMake会根据索引导入每个所需要编译的内容。编译过程如：

示例程序

**当使用电池供电时，按下 PWR 按键会启动供电。为保持持续供电，需要将 BAT_EN（GPIO2）配置为高电平。**

示例程序下载

ESP32-S3-LCD-1.54 示例程序
示例程序	基础例程说明
01_factory	综合示例程序
02_button_example	按键测试
03_ws2812b_example	LED灯测试
04_sd_card_test	SD Card 读写测试
05_lvgl_example	lvgl 示例

01_factory

【程序说明】

本示例演示是ESP32-S3-LCD-0.85的综合示例，也是出厂默认烧录的示例。

【运行效果】

长按左键不松开，扬声器实时播放麦克风采集的声音。
单击左右键进行页面切换

02_button_example

【程序说明】

本示例演示如何使用 espressif/button 库读取按键的单击、双击和长按等状态，并通过串口打印。

【代码分析】

绑定回调函数

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

【运行效果】

屏幕无现象
打开串口监视器

03_ws2812b_example

【程序说明】

本示例演示如何使用ESP32的RMT外设控制WS2812 LED灯带，实现LED的开关控制

【代码分析】

配置LED灯带参数并初始化
循环控制LED灯带的开关状态

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));
    }

【运行效果】

屏幕无现象
LED灯珠会同时以500ms间隔闪烁
打开串口监视器

04_sd_card_test

【程序说明】

本示例使用 ESP32-S3-LCD-0.85 对SD卡的读写功能进行测试。

【硬件连接】

将板子接入电脑
将Micro SD卡插入卡槽（SD卡需要格式化为FAT32）

【代码分析】

SD卡初始化，并挂载

    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 SD 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);

【运行效果】

屏幕无现象
打开串口监视器

05_lvgl_example

【程序说明】

本示例演示了 ESP32-S3-LCD-0.85 运行lvgl示例程序（支持lvgl v8 和 lvgl v9）

【准备工作】

默认使用的 LVGL 版本为 v9.3.0。如需更换版本，请修改 main/idf_component.yml 文件中的 LVGL 配置，例如将其改为 lvgl/lvgl:^8.4.0。

【代码分析】

初始化

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

    /* Touch initialization */
    app_touch_init();

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

【运行效果】

导航菜单

模板: ESP32-S3-LCD-0.85-IDF-Demo

目录

ESP-IDF开发

环境搭建

下载和安装 Visual Studio

安装Espressif IDF插件

运行第一个 ESP-IDF 程序

新建项目

创建例程

修改COM口

修改驱动对象

其余状态栏简介

编译、烧录、串口监视

使用IDF 示例程序

软件内部打开

软件外部打开

ESP-IDF工程项目详解

修改COM口

修改驱动对象

其余状态栏简介

编译、烧录、串口监视

使用IDF 示例程序

软件内部打开

软件外部打开

ESP-IDF工程项目详解

示例程序

01_factory

02_button_example

03_ws2812b_example

04_sd_card_test

05_lvgl_example