本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
Espressif ESP32-DevKitC 和 ESP-WROVER-KIT 入门
本教程提供有关配备 ESP32-WROOM-32、ESP32-SOLO-1 或 ESP-WROVER 模块的 Espressif ESP32-DevKitC 和 ESP-WROVER-KIT-VB
入门的说明。要从 AWS Partner Device Catalog 中的合作伙伴处购买,请使用以下链接:ESP32-WROOM-32 DevKitC、
目前,ESP32-WROVER-KIT 和 ESP FreeRTOS 的 DevKitC 端口不支持以下功能:
-
对称多处理 (SMP)。
Overview
本教程包含有关以下入门步骤的说明:
-
将主板连接到主机。
-
在主机上安装软件来开发和调试微控制器主板的嵌入式应用程序。
-
将 FreeRTOS 演示应用程序交叉编译为二进制映像。
-
将应用程序二进制映像加载到您的主板上,然后运行该应用程序。
-
跨串行连接与主板上运行的应用程序进行交互,以便进行监视和调试。
Prerequisites
在 Espressif 主板上开始使用 FreeRTOS 之前,您需要设置您的 AWS 账户和权限。
要创建 AWS 账户,请参阅创建和激活 AWS 账户
要将 IAM 用户添加到您的 AWS 账户,请参阅 IAM 用户指南. 要授予您的 IAM 用户账户访问 AWS IoT 和 FreeRTOS 的权限,请将以下 IAM 策略附加到您的 IAM 用户账户:
-
AmazonFreeRTOSFullAccess
-
AWSIoTFullAccess
将 AmazonFreeRTOSFullAccess 策略附加到您的 IAM 用户
-
浏览到 IAM 控制台
,在导航窗格中,选择用户. -
在搜索文本框中输入您的用户名,然后从列表中选择该名称。
-
选择 Add permissions (添加权限).
-
选择直接附加现有策略.
-
在搜索框中,输入
AmazonFreeRTOSFullAccess
,从列表中选择,然后选择下一步: 审核. -
选择 Add permissions (添加权限).
将 AWSIoTFullAccess 策略附加到您的 IAM 用户
-
浏览到 IAM 控制台
,在导航窗格中,选择用户. -
在搜索文本框中输入您的用户名,然后从列表中选择该名称。
-
选择 Add permissions (添加权限).
-
选择直接附加现有策略.
-
在搜索框中,输入
AWSIoTFullAccess
,从列表中选择,然后选择下一步: 审核. -
选择 Add permissions (添加权限).
有关 IAM 和用户账户的更多信息,请参阅 IAM 用户指南.
有关策略的更多信息,请参阅 IAM 权限和策略.
设置 Espressif 硬件
有关设置 ESP32-DevKitCDevKitCESP32-
有关设置 ESP-WROVER-KIT 开发主板硬件的信息,请参阅 ESP-WROVER-KIT 入门指南
当您到达 Espressif 指南 STOP 的 Get Started 部分时,请执行以下步骤。
设置开发环境
要与您的主板进行通信,您需要下载并安装工具链。
设置工具链
4.2 版的 ESP-IDF(FreeRTOS 所使用的版本)不支持最新版本的 ESP32 计算机。如果您已安装 ESP32 编译器,则可能需要卸载它并使用工具链安装中包含的编译器的兼容版本。请参阅此部分中的链接。如果要检查编译器的版本,请运行以下命令。
xtensa-esp32-elf-gcc --version
要设置工具链,请按照适用于您的主机操作系统的以下说明操作:
当您到达 Next Steps (后续步骤) 下的“Get ESP-IDF”说明时,停止并返回到此页面上的说明。
请确保已从系统中清除 IDF_PATH
环境变量,然后再继续操作。如果您已按照 Next Steps (后续步骤). 下的“Get ESP-IDF (获取 ESP-IDF)”说明执行操作,则会自动设置此环境变量。
安装CMake
构建系统是构建此设备的 CMake 演示和测试应用程序所必需的。FreeRTOS 支持版本 3.13 及更高版本。FreeRTOS
您可以从 CMake 下载最新版本的 CMake.org。
有关将 CMake 与 FreeRTOS 结合使用的更多详细信息,请参阅使用 CMake 配 FreeRTOS。
建立串行连接
要在您的主机和 ESP32-DevKitC 之间建立串行连接,您必须安装 CP210x USB to UART Bridge VCP 驱动程序。您可以从 Silicon Labs
要在您的主机和 ESP32-WROVER-KIT 之间建立串行连接,必须安装一些 FTDI 虚拟 COM 端口驱动程序。您可以从 FTDI
有关更多信息,请参阅使用 ESP32 建立串行连接
下载并配置 FreeRTOS
设置环境后,您可以从 FreeRTOSGitHub 或
配置 FreeRTOS 演示应用程序
-
如果您运行的是 macOS 或 Linux,请打开终端提示符。如果您运行的是 Windows,请打开 mingw32.exe。(MinGW
是面向本机 Microsoft Windows 应用程序的极简开发环境。) -
要验证您是否已安装 Python 2.7.10 或更高版本,请运行 python --version。 这将显示已安装的版本。如果您未安装 Python 2.7.10 或更高版本,可以从 Python 网站
.进行安装。 -
您需要 AWS CLI 来运行 AWS IoT 命令。如果您运行的是 Windows,请使用 easy_install awscli 在 mingw32 环境中安装 AWS CLI
如果您运行的是 macOS 或 Linux,请参阅安装 AWS 命令行界面。
-
运行 aws configure 并使用 AWS CLI 访问密钥 ID、私有访问密钥和默认区域名称配置 AWS 有关更多信息,请参阅配置 AWS CLI.
-
使用以下命令安装适用于 Python 的 AWS 开发工具包 (Boto3):
-
在 Windows 上的 mingw32 环境中,运行 easy_install boto3.
-
在 macOS 或 Linux 上,运行 pip install tornado nose --user,然后运行 pip install boto3 --user。
-
FreeRTOS 包含 SetupAWS.py
脚本,可以更轻松地设置您的 Espressif 主板以连接到 AWS IoT. 要配置此脚本,请打开
并设置以下属性:
freertos
/tools/aws_config_quick_start/configure.json
afr_source_dir
-
的完整路径
freertos
计算机上的 目录。确保您使用正斜杠来指定此路径。 thing_name
-
要分配给代表您的主板的 AWS IoT 事物的名称。
wifi_ssid
-
Wi-Fi 网络的 SSID。
wifi_password
-
Wi-Fi 网络的密码。
wifi_security
-
Wi-Fi 网络的安全类型。
有效安全类型为:
-
eWiFiSecurityOpen
(开放,不安全) -
eWiFiSecurityWEP
(WEP 安全性) -
eWiFiSecurityWPA
(WPA 安全性) -
eWiFiSecurityWPA2
(WPA2 安全性)
-
运行配置脚本
-
如果您运行的是 macOS 或 Linux,请打开终端提示符。如果您运行的是 Windows,请打开 mingw32.exe。
-
转到
目录并运行 python SetupAWS.py setup.freertos
/tools/aws_config_quick_start
该脚本执行以下操作:
-
创建 IoT 事物、证书和策略
-
将 IoT 策略附加到证书,将证书附加到 AWS IoT 事物
-
使用您的
aws_clientcredential.h
终端节点、Wi-Fi SSID 和凭证填充 AWS IoT 文件 -
设置您的证书和私有密钥格式,然后将其写入
aws_clientcredential_keys.h
标头文件注意 仅出于演示目的对证书进行了硬编码。生产级应用程序应将这些文件存储在安全位置。
有关 SetupAWS.py
的更多信息,请参阅
目录中的 README.md。
freertos
/tools/aws_config_quick_start
构建、刷写和运行 FreeRTOS 演示项目
您可以使用 Espressif 的 IDF 实用程序生成构建文件、构建应用程序二进制文件并刷写主板。
在 Linux 和 FreeRTOS 上构建MacOS
如果您使用的是 Windows,则可以跳至 在 Windows 上构建 FreeRTOS.
使用“idf.py”脚本构建项目并将二进制文件刷写到您的设备上。
生成项目
-
导航到 FreeRTOS 下载目录的根目录。
-
在命令行窗口中,输入以下命令以生成构建文件。
idf.py build
您应看到类似如下的输出:
Running cmake in directory /path/to/hello_world/build Executing "cmake -G Ninja --warn-uninitialized /path/to/hello_world"... Warn about uninitialized values. -- Found Git: /usr/bin/git (found version "2.17.0") -- Building empty aws_iot component due to configuration -- Component names: ... -- Component paths: ... ... (more lines of build system output) [527/527] Generating hello-world.bin esptool.py v2.3.1 Project build complete. To flash, run this command: ../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello-world.bin build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin or run 'idf.py -p PORT flash'
-
如果没有错误,构建将生成固件二进制 .bin 文件。
在 Windows 上构建 FreeRTOS
在 Windows 上,您必须为 CMake 指定生成生成器,否则 CMake 默认为 Visual Studio。Espressif 正式推荐使用 Ninja 构建系统,因为它适用于 Windows、Linux 和 MacOS。 您必须在本机 Windows 环境(如 cmd 或 CMake)中运行 PowerShell 命令。 不支持在虚拟 Linux 环境(如 MSYS2 或 WSL)中运行 CMake 命令。
使用 CMake 生成构建文件,然后使用 Make 构建应用程序。
使用 CMake 生成演示应用程序的构建文件
-
将目录更改为 FreeRTOS 下载的根目录。
-
使用以下命令来生成构建文件:
cmake -DVENDOR=espressif -DBOARD=esp32_wrover_kit -DCOMPILER=xtensa-esp32 -GNinja -S . -B
build-directory
注意 如果您想要构建应用程序以进行调试,请将
-DCMAKE_BUILD_TYPE=Debug
标志添加到此命令。如果您想要生成测试应用程序构建文件,请添加
-DAFR_ENABLE_TESTS=1
标志。Espressif 提供的代码使用轻型 IP (lwIP) 堆栈作为默认网络堆栈。要改用 FreeRTOS+TCP 网络堆栈,请将
–DAFR_ESP_FREERTOS_TCP
标志添加到 CMake 命令。要为非供应商提供的代码添加 lwIP 依赖项,请将以下行添加到您的自定义 CMake 组件的
CMakeLists.txt
依赖项文件 WiFi。# Add a dependency on the bluetooth espressif component to the common component set(COMPONENT_REQUIRES lwip)
构建应用程序
-
将目录更改为
build
目录。 -
调用 Ninja 以构建应用程序:
ninja
或者,使用通用 CMake 接口来构建应用程序:
cmake --build
build-directory
注意 每当您在 cmake 项目和
aws_demos
项目之间切换时,都必须使用aws_tests
命令构建生成文件。
刷写并运行 FreeRTOS
使用 Espressif 的 IDF 实用程序 (
) 刷写您的主板、运行应用程序并查看日志。
freertos
/vendors/espressif/esp-idf/tools/idf.py
要开始,您必须擦除主板的闪存。转到
目录并使用以下命令:
freertos
./vendors/espressif/esp-idf/tools/idf.py erase_flash -B
build-directory
使用 IDF 脚本将应用程序二进制文件刷写到您的主板:
./vendors/espressif/esp-idf/tools/idf.py flash -B
build-directory
如需监控,请使用以下命令:
./vendors/espressif/esp-idf/tools/idf.py monitor -p /dev/ttyUSB1 -B
build-directory
您可以组合使用这些命令。例如:
./vendors/espressif/esp-idf/tools/idf.py erase_flash flash monitor -p /dev/ttyUSB1 -B
build-directory
在云上监控 MQTT 消息
您可以使用 AWS IoT 控制台中的 MQTT 客户端监控您的设备发送到 AWS 云的消息。
使用 AWS IoT MQTT 客户端订阅 MQTT 主题
-
登录到 AWS IoT 控制台
. -
在导航窗格中,选择 Test (测试) 以打开 MQTT 客户端。
-
在 Subscription topic (订阅主题)中,输入
iotdemo/#
,然后选择 Subscribe to topic (订阅主题).
运行低功耗蓝牙演示
FreeRTOS 支持低功耗蓝牙连接。
要跨低功耗蓝牙运行 FreeRTOS 演示项目,您需要在 iOS 或 Android 移动设备上运行 FreeRTOS 低功耗蓝牙移动开发工具包演示应用程序。
设置 FreeRTOS 低功耗蓝牙移动开发工具包演示应用程序
有关如何在主板上运行低功耗蓝牙 MQTT 演示的说明,请参阅低功耗蓝牙 MQTT 演示应用程序.
有关如何在主板上运行 Wi-Fi 预置演示的说明,请参阅 Wi-Fi 预置演示应用程序.
在您自己的适用于 ESP32 的 FreeRTOS 项目中使用CMake
如果要在您自己的 FreeRTOS 项目中使用 CMake,您可以将其设置为子目录,并与应用程序一起构建。首先,从 FreeRTOS 或 GitHub
git submodule add -b release https://github.com/aws/amazon-freertos.git freertos
如果已发布更新的版本,则可使用这些命令更新本地副本。
# Pull the latest changes from the remote tracking branch. git submodule update --remote -- amazon-freertos # Commit the submodule change because it is pointing to a different revision now. git add amazon-freertos git commit -m "Update FreeRTOS to a new release"
假定您的项目具有以下目录结构:
- freertos (the copy that you obtained from GitHub or the AWS IoT console) - src - main.c (your application code) - CMakeLists.txt
以下是可用于构建应用程序与 CMakeLists.txt
的顶级 FreeRTOS. 文件的示例。
cmake_minimum_required(VERSION 3.13) project(freertos_examples) add_executable(my_app src/main.c) # Tell IDF build to link against this target. set(IDF_PROJECT_EXECUTABLE my_app) # Add FreeRTOS as a subdirectory. AFR_BOARD tells which board to target. set(AFR_BOARD espressif.esp32_devkitc CACHE INTERNAL "") add_subdirectory(freertos) # Link against the mqtt library so that we can use it. Dependencies are transitively # linked. target_link_libraries(my_app PRIVATE AFR::mqtt)
要生成项目,请运行以下 CMake 命令。确保 ESP32 编译器位于 PATH 环境变量中。
cmake -S . -B
build-directory
-DCMAKE_TOOLCHAIN_FILE=freertos/tools/cmake/toolchains/xtensa-esp32.cmake -GNinja cmake --build build
要将应用程序刷写到您的主板,请运行
cmake --build
build-directory
--target flash
使用 中的组件FreeRTOS
运行 CMake 后,您可以在摘要输出中找到所有可用的组件。它应该如下所示:
====================Configuration for FreeRTOS==================== Version: 201910.00 Git version: 201910.00-388-gcb3612cb7 Target microcontroller: vendor: Espressif board: ESP32-DevKitC description: Development board produced by Espressif that comes in two variants either with ESP-WROOM-32 or ESP32-WROVER module family: ESP32 data ram size: 520KB program memory size: 4MB Host platform: OS: Linux-4.15.0-66-generic Toolchain: xtensa-esp32 Toolchain path: /opt/xtensa-esp32-elf CMake generator: Ninja FreeRTOS modules: Modules to build: ble, ble_hal, ble_wifi_provisioning, common, crypto, defender, dev_mode_key_provisioning, freertos_plus_tcp, greengrass, https, kernel, mqtt, ota, pkcs11, pkcs11_implementation, platform, secure_sockets, serializer, shadow, tls, wifi Enabled by user: ble, ble_hal, ble_wifi_provisioning, defender, greengrass, https, mqtt, ota, pkcs11, pkcs11_implementation, platform, secure_sockets, shadow, wifi Enabled by dependency: common, crypto, demo_base, dev_mode_key_provisioning, freertos, freertos_plus_tcp, kernel, pkcs11_mbedtls, secure_sockets_freertos_plus_tcp, serializer, tls, utils 3rdparty dependencies: http_parser, jsmn, mbedtls, pkcs11, tinycbor Available demos: demo_ble, demo_ble_numeric_comparison, demo_defender, demo_greengrass_connectivity, demo_https, demo_mqtt, demo_ota, demo_shadow, demo_tcp, demo_wifi_provisioning Available tests: =========================================================================
您可以引用“要构建的模块”列表中的任何组件。要将它们链接到您的应用程序,请将 AFR::
命名空间置于名称的前面,例如 AFR::mqtt
、AFR::ota
等。
将自定义组件添加到 ESP-IDF
可以向 ESP-IDF 构建环境添加更多组件。例如,假定您想添加一个名为 foo
的组件,并且您的项目如下所示:
- freertos - components - foo - include - foo.h - src - foo.c - CMakeLists.txt - src - main.c - CMakeLists.txt
下面是您的组件的 CMakeLists.txt 文件的示例:
# include paths of this components. set(COMPONENT_ADD_INCLUDEDIRS include) # source files of this components. set(COMPONENT_SRCDIRS src) # Alternatively, use COMPONENT_SRCS to specify source files explicitly # set(COMPONENT_SRCS src/
foo.c
) # add this components, this will define a CMake library target. register_component()
您还可以使用标准 CMake 函数 target_link_libraries
指定依赖项。 请注意,组件的目标名称存储在由 ESP-IDF 定义的变量 COMPONENT_TARGET
中。
# add this component, this will define a CMake library target. register_component() # standard CMake function can be used to specify dependencies. ${COMPONENT_TARGET} is defined # from esp-idf when you call register_component, by default it's idf_component_<folder_name>. target_link_libraries(${COMPONENT_TARGET} PRIVATE AFR::mqtt)
对于 ESP 组件,这通过设置 2 个变量 COMPONENT_REQUIRES
和 COMPONENT_PRIV_REQUIRES
完成。 请参阅 ESP-IDF 编程指南 v4.2CMake 生成系统 (
# If the dependencies are from ESP-IDF, use these 2 variables. Note these need to be # set before calling register_component(). set(COMPONENT_REQUIRES log) set(COMPONENT_PRIV_REQUIRES lwip)
然后,在顶级 CMakeLists.txt
文件中,告知 ESP-IDF 从何处查找这些组件。在 之前的任何位置插入以下行:add_subdirectory(freertos)
:
# Add some extra components. IDF_EXTRA_COMPONENT_DIRS is a variable used by ESP-IDF # to collect extra components. get_filename_component( EXTRA_COMPONENT_DIRS "components/
foo
" ABSOLUTE ) list(APPEND IDF_EXTRA_COMPONENT_DIRS ${EXTRA_COMPONENT_DIRS})
默认情况下,此组件现在将自动链接到您的应用程序代码。您应能够包含其标头文件并调用它定义的函数。
覆盖 的配置FreeRTOS
目前,未提供明确定义的方法来重新定义 FreeRTOS 源树外部的配置。默认情况下,CMake 将查找
和 freertos
/vendors/espressif/boards/esp32/aws_demos/config_files/
目录。但是,可以使用解决方法来告知编译器首先搜索其他目录。例如,您可以为 FreeRTOS 配置添加其他文件夹:
freertos
/demos/include/
- freertos - freertos-configs - aws_clientcredential.h - aws_clientcredential_keys.h - iot_mqtt_agent_config.h - iot_config.h - components - src - CMakeLists.txt
freertos-configs
下的文件是从
和 freertos
/vendors/espressif/boards/esp32/aws_demos/config_files/
目录复制的。然后,在顶级 freertos
/demos/include/iCMakeLists.txt
文件中,在 add_subdirectory(freertos)
的前面添加此行,以便编译器首先搜索此目录:
include_directories(BEFORE freertos-configs)
为 ESP-IDF 提供您自己的 sdkconfig
如果要提供自己的 sdkconfig.default
,您可以从命令行设置 CMake 变量 IDF_SDKCONFIG_DEFAULTS
:
cmake -S . -B
build-directory
-DIDF_SDKCONFIG_DEFAULTS=path_to_your_sdkconfig_defaults
-DCMAKE_TOOLCHAIN_FILE=freertos/tools/cmake/toolchains/xtensa-esp32.cmake -GNinja
如果您不为自己的 sdkconfig.default
文件指定位置,则 FreeRTOS 将使用位于
. 的默认文件。
freertos
/vendors/espressif/boards/esp32/aws_demos/sdkconfig.defaults
Summary
如果您的项目具有一个名为 foo
的组件,并且您要覆盖某些配置,以下是顶级 CMakeLists.txt
文件的完整示例。
cmake_minimum_required(VERSION 3.13) project(freertos_examples) add_executable(my_app src/main.c) # Tell IDF build to link against this target. set(IDF_PROJECT_EXECUTABLE my_app) # Add some extra components. IDF_EXTRA_COMPONENT_DIRS is a variable used by ESP-IDF # to collect extra components. get_filename_component( EXTRA_COMPONENT_DIRS "components/
foo
" ABSOLUTE ) list(APPEND IDF_EXTRA_COMPONENT_DIRS ${EXTRA_COMPONENT_DIRS}) # Override the configurations for FreeRTOS. include_directories(BEFOREfreertos
-configs) # Add FreeRTOS as a subdirectory. AFR_BOARD tells which board to target. set(AFR_BOARD espressif.esp32_devkitc CACHE INTERNAL "") add_subdirectory(freertos
) # Link against the mqtt library so that we can use it. Dependencies are transitively # linked. target_link_libraries(my_app PRIVATE AFR::mqtt)
Troubleshooting
-
如果您正在运行 macOS,并且操作系统无法识别您的 ESP-WROVER-KIT,请确保您未安装 D2XX 驱动程序。要卸载它们,请按照适用于 macOS X 的
FTDI 驱动程序安装指南中的说明操作。 -
ESP-IDF 提供的监控实用程序(使用 make monitor 调用)可帮助您解码地址。因此,在应用程序崩溃时,它可以帮助您获取一些有意义的回溯跟踪信息。有关更多信息,请参阅 Espressif 网站上的自动解码地址
。 -
还可以启用 GDBstub 以与 gdb 通信,而无需任何特殊 JTAG 硬件。有关更多信息,请参阅 Espressif 网站上的为 GDBStub 启动 GDB
。 -
有关设置基于 OpenOCD 的环境(如果需要基于 JTAG 硬件的调试)的信息,请参阅 Espressif 网站上提供的 JTAG Debugging for ESP32
文档。 -
如果无法使用
pyserial
onpip
安装 macOS,请从 pyserial 网站下载。 -
如果主板连续重置,请尝试通过在终端上输入以下命令来擦除闪存:
make erase_flash
-
如果您在运行
idf_monitor.py
时看到错误,请使用 Python 2.7。 -
ESP-IDF 中必需的库包括在 FreeRTOS 中,因此无需从外部下载它们。如果已设置
IDF_PATH
环境变量,我们建议您在生成 FreeRTOS. 之前清除它。 -
在 Windows 上,生成项目可能需要 3-4 分钟。您可在
-j4
命令上使用 make 开关来缩短生成时间:make flash monitor -j4
-
如果您的设备在连接到 AWS IoT 时遇到问题,请打开
aws_clientcredential.h
文件,并验证该文件中的配置变量已正确定义。clientcredentialMQTT_BROKER_ENDPOINT[]
应类似于
。1234567890123
-ats.iot.us-east-1
.amazonaws.com -
如果您遵循在您自己的适用于 ESP32 的 FreeRTOS 项目中使用CMake中的步骤,并且您看到来自链接器的未定义的引用错误,则通常是由于缺少关联的库或演示所致。要添加它们,请使用标准
CMakeLists.txt
函数 CMake 更新target_link_libraries
文件(在根目录下)。
有关故障排除信息,请参阅问题排查入门.
在 Espressif ESP32-DevKitC 和 ESP-WROVER-KIT 上调试代码
您需要 JTAG 到 USB 电缆。我们使用 USB 到 MPSSE 电缆(例如,FTDI C232HM-DDHSL-0
ESP-DevKitC JTAG 设置
对于 FTDI C232HM-DDHSL-0 电缆,以下是与 ESP32 DevkitC 的连接:
C232HM-DDHSL-0 电线颜色 | ESP32 GPIO 针脚 | JTAG 信号名称 |
---|---|---|
棕色(针脚 5) |
IO14 |
TMS |
黄色(针脚 3) |
IO12 |
TDI |
黑色(针脚 10) |
GND |
GND |
橙色(针脚 2) |
IO13 |
TCK |
绿色(针脚 4) |
IO15 |
TDO |
ESP-WROVER-KIT JTAG 设置
对于 FTDI C232HM-DDHSL-0 电缆,以下是与 ESP32-WROVER-KIT 的连接:
C232HM-DDHSL-0 电线颜色 | ESP32 GPIO 针脚 | JTAG 信号名称 |
---|---|---|
棕色(针脚 5) |
IO14 |
TMS |
黄色(针脚 3) |
IO12 |
TDI |
橙色(针脚 2) |
IO13 |
TCK |
绿色(针脚 4) |
IO15 |
TDO |
这些表源自 FTDI C232HM-DDHSL-0 数据表
要在 ESP-WROVER-KIT 上启用 JTAG,请将跳线放在 TMS、TDO、TDI、TCK 和 S_TDI 针脚上,如此处所示:

Windows 上的调试
在 Windows 上设置调试
-
将 FTDI C232HM-DDHSL-0 的 USB 一端连接到您的计算机,另一端的操作如中所述。在 Espressif ESP32-DevKitC 和 ESP-WROVER-KIT 上调试代码. FTDI C232HM-DDHSL-0 设备应显示在设备管理器下的通用串行总线控制器.中。
-
在通用串行总线设备列表下,右键单击 C232HM-DDHSL-0 设备,然后选择 Properties (属性).
注意 该设备可能被列为 USB Serial Port (USB 串行端口).
在属性窗口中,选择 Details (详细信息) 选项卡以查看设备的属性。如果未列出设备,请安装适用于 FTDI C232HM-DDHSL-0 的 Windows 驱动程序
. -
在 Details (详细信息) 选项卡上,选择 Property (属性),然后选择 Hardware IDs (硬件)。 您应该在 Value (值) 字段中看到与以下类似的内容:
FTDIBUS\COMPORT&VID_0403&PID_6014
在此示例中,供应商 ID 为 0403,产品 ID 为 6014。
验证这些 IDs 是否与 IDs 中的
projects/espressif/esp32/make/aws_demos/esp32_devkitj_v1.cfg
匹配。 在以 IDs 开头的行中指定,后跟供应商 ID 和产品 ID:ftdi_vid_pid
ftdi_vid_pid 0x0403 0x6014
-
将文件解压缩到
C:\
并将C:\openocd-esp32\bin
添加到系统路径。 -
OpenOCD 需要 libusb,默认情况下,该版本未在 Windows 上安装。
安装 libusb
-
下载 zadig.exe
. -
运行
zadig.exe
。 从 Options (选项) 菜单中,选择 List All Devices (列出所有设备)。 -
从下拉菜单中,选择 C232HM-DDHSL-0.
-
在绿色箭头右侧的目标驱动程序字段中,选择 WinUSB。
-
从目标驱动程序字段下方的下拉框中,选择箭头,然后选择 Install Driver (安装驱动程序). 选择 Replace Driver (替换驱动程序).
-
-
打开命令提示符窗口,导航到
projects/espressif/esp32/make/aws_demos
并运行:对于 ESP32-WROOM-32 和 ESP32-WROVER:
openocd.exe -f esp32_devkitj_v1.cfg -f esp-wroom-32.cfg
对于 ESP32-SOLO-1:
openocd.exe -f esp32_devkitj_v1.cfg -f esp-solo-1.cfg
保持此命令提示符窗口处于打开状态。
-
打开一个新的命令提示符,导航到您的
msys32
目录,然后运行mingw32.exe
。 在 mingw32 终端中,导航到projects/espressif/esp32/make/aws_demos
并运行 make flash monitor。 -
打开另一个 mingw32 终端,导航到
projects/espressif/esp32/make/aws_demos
,然后等到演示开始在您的主板上运行。执行此操作时,运行xtensa-esp32-elf-gdb -x gdbinit build/aws_demos.elf
。 程序应在main
函数中停止。
ESP32 支持最多两个断点。
在 macOS 上调试
-
下载 OpenOCD
。 -
提取下载的 .tar 文件,并将
.bash_profile
中的路径设置为
.OCD_INSTALL_DIR
/openocd-esp32/bin -
使用以下命令在
libusb
上安装 macOS:brew install libusb
-
使用以下命令卸载串行端口驱动程序:
sudo kextunload -b com.FTDI.driver.FTDIUSBSerialDriver
-
如果您运行的 macOS 版本高于 10.9,请使用以下命令卸载 Apple FTDI 驱动程序:
sudo kextunload -b com.apple.driver.AppleUSBFTDI
-
使用以下命令获取 FTDI 电缆的产品 ID 和供应商 ID。它会列出连接的 USB 设备:
system_profiler SPUSBDataType
system_profiler
的输出应类似于以下内容:DEVICE
: Product ID:product-ID
Vendor ID:vendor-ID
(Future Technology Devices International Limited) -
打开
projects/espressif/esp32/make/aws_demos/esp32_devkitj_v1.cfg
。 您的设备的供应商 ID 和产品 ID 在以ftdi_vid_pid
开头的行中指定。 更改 IDs 以匹配上一步中 IDs 输出中的system_profiler
。 -
打开终端窗口,导航到
projects/espressif/esp32/make/aws_demos
,然后使用以下命令运行 OpenOCD。对于 ESP32-WROOM-32 和 ESP32-WROVER:
openocd -f esp32_devkitj_v1.cfg -f esp-wroom-32.cfg
对于 ESP32-SOLO-1:
openocd -f esp32_devkitj_v1.cfg -f esp-solo-1.cfg
-
打开一个新的终端,使用以下命令来加载 FTDI 串行端口驱动程序:
sudo kextload -b com.FTDI.driver.FTDIUSBSerialDriver
-
导航到
projects/espressif/esp32/make/aws_demos
并运行以下命令:make flash monitor
-
打开另一个新终端,导航到
projects/espressif/esp32/make/aws_demos
并运行以下命令:xtensa-esp32-elf-gdb -x gdbinit build/aws_demos.elf
程序应在 停止。
main()
.
在 Linux 上调试
-
下载 OpenOCD
。 提取 tarball 并按照自述文件中的安装说明操作。 -
使用以下命令在 Linux 上安装 libusb:
sudo apt-get install libusb-1.0
-
打开终端并输入
ls -l /dev/ttyUSB*
来列出连接到您计算机的所有 USB 设备。这可以帮助您检查操作系统是否识别主板上的 USB 端口。您应看到类似如下的输出:$ls -l /dev/ttyUSB* crw-rw---- 1 root dialout 188, 0 Jul 10 19:04 /dev/ttyUSB0 crw-rw---- 1 root dialout 188, 1 Jul 10 19:04 /dev/ttyUSB1
-
注销,然后登录并重新对主板加电,使更改生效。在终端提示符下,列出 USB 设备。确保组所有者已从
dialout
更改为plugdev
:$ls -l /dev/ttyUSB* crw-rw---- 1 root plugdev 188, 0 Jul 10 19:04 /dev/ttyUSB0 crw-rw---- 1 root plugdev 188, 1 Jul 10 19:04 /dev/ttyUSB1
较小编号的
/dev/ttyUSBn
接口用于 JTAG 通信。其他接口路由到 ESP32 的串行端口 (UART),用于将代码上传到 ESP32 的闪存。 -
在终端窗口中,导航到
projects/espressif/esp32/make/aws_demos
,然后使用以下命令运行 OpenOCD。对于 ESP32-WROOM-32 和 ESP32-WROVER:
openocd -f esp32_devkitj_v1.cfg -f esp-wroom-32.cfg
对于 ESP32-SOLO-1:
openocd -f esp32_devkitj_v1.cfg -f esp-solo-1.cfg
-
打开另一个终端,导航到
projects/espressif/esp32/make/aws_demos
并运行以下命令:make flash monitor
-
打开另一个终端,导航到
projects/espressif/esp32/make/aws_demos
并运行以下命令:xtensa-esp32-elf-gdb -x gdbinit build/aws_demos.elf
程序应在 中停止。
main()
.