如何增加一个新的模组支持

[English]

ESP-AT 工程支持多个模组,并提供了模组的配置文件:factory_param_data.csv module_config。下表列出了 ESP-AT 工程支持的平台(即芯片系列)、模组以及模组配置文件的位置。

平台

模组

默认配置文件

ESP32

  • WROOM-32

  • PICO-D4

  • SOLO-1

  • MINI-1

ESP32

WROVER-32

ESP32

ESP32-D2WD

ESP32

ESP32_QCLOUD

ESP32-C2

MINI-1

ESP32-C3

MINI-1

ESP32-C3

ESP32C3_QCLOUD

注意

  • ./build.py menuconfig 中的 silence mode0 时,对应模块的配置文件为 sdkconfig.defaults

  • ./build.py menuconfig 中的 silence mode1 时,对应模块的配置文件为 sdkconfig_silence.defaults

如果要在 ESP-AT 工程中添加对某个 ESP32 模组的支持,则需要修改这些配置文件。此处的“ESP32 模组”指的是:

  • ESP-AT 工程暂未适配支持的模组,包括 ESP-AT 已适配相应芯片的模组,和未适配相应芯片的模组。但不建议添加后者,因为工作量巨大,此文档也不做阐述。

  • ESP-AT 工程已适配支持的模组,但用户需要对其修改默认配置的。

本文档将说明如何在 ESP-AT 工程中为 ESP-AT 已支持的某款 ESP32 芯片添加新的模组支持,下文中以添加对 ESP32-WROOM-32 支持为例,该模组使用 SDIO 而不是默认的 UART 接口。

在 factory_param_data.csv 添加模组信息

打开本地的 factory_param_data.csv ,在表格最后插入一行,根据实际需要设置相关参数。本例中,我们将 platform 设置为 PLATFORM_ESP32module_name 设置为 WROOM32-SDIO,其他参数设置值见下表(参数含义请参考 factory_param_type.csv)。

  • platform: PLATFORM_ESP32

  • module_name: WROOM32-SDIO

  • description:

  • magic_flag: 0xfcfc

  • version: 3

  • reserved1: 0

  • tx_max_power: 78

  • uart_port: 1

  • start_channel: 1

  • channel_num: 13

  • country_code: CN

  • uart_baudrate: -1

  • uart_tx_pin: -1

  • uart_rx_pin: -1

  • uart_cts_pin: -1

  • uart_rts_pin: -1

  • tx_control_pin: -1

  • rx_control_pin: -1

修改 esp_at_module_info 结构体

详情请参考 修改 esp_at_module_info 结构体

配置模组文件

首先,进入 module_config 文件夹,创建一个子文件夹来存放模组的配置文件(文件夹名称为小写),然后在其中加入配置文件 IDF_VERSION、at_customize.csv、partitions_at.csv、sdkconfig.defaults 以及 sdkconfig_silence.defaults。

本例中,我们复制粘贴 module_esp32_default 文件夹及其中的配置文件,并重命名为 module_wroom32-sdio。在本例中,配置文件 IDF_VERSION、at_customize.csv 和 partitions_at.csv 无需修改,我们只需修改 sdkconfig.defaults 和 sdkconfig_silence.defaults:

  • 使用 module_wroom32-sdio 文件夹下的分区表,需要修改如下配置

    CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="module_config/module_wroom32-sdio/partitions_at.csv"
    CONFIG_PARTITION_TABLE_FILENAME="module_config/module_wroom32-sdio/partitions_at.csv"
    CONFIG_AT_CUSTOMIZED_PARTITION_TABLE_FILE="module_config/module_wroom32-sdio/at_customize.csv"
    
  • 使用 SDIO 配置,移除 UART 配置

    • 移除 UART 配置

      CONFIG_AT_BASE_ON_UART=n
      
    • 新增 SDIO 配置

      CONFIG_AT_BASE_ON_SDIO=y
      

完成上述步骤后,可重新编译 ESP-AT 工程生成模组固件。本例中,我们在配置工程时,应选择 PLATFORM_ESP32WROOM32-SDIO 来生成模组固件。