Skip to content

Commit e507029

Browse files
committed
Merge branch 'docs/maintenance_25q2' into 'master'
Docs: maintenance 2025q2 Closes AEG-2761, AEG-1583, AEG-1018, and AEG-2756 See merge request ae_group/esp-iot-solution!1335
2 parents e13640c + acde6da commit e507029

File tree

17 files changed

+1798
-953
lines changed

17 files changed

+1798
-953
lines changed

README_CN.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ESP-IoT-Solution 包含物联网系统开发中常用的外设驱动和代码框
1212

1313
ESP-IoT-Solution 包含的内容如下:
1414

15-
* 传感器、显示屏、音频设备、输入设备、执行机构等设备驱动
15+
* 传感器、显示屏、音频设备、输入设备、电机控制等设备驱动
1616
* 低功耗、安全加密、存储方案等代码框架或说明文档;
1717
* 从实际应用的角度出发,为乐鑫开源解决方案提供了入口指引。
1818

@@ -21,35 +21,38 @@ ESP-IoT-Solution 包含的内容如下:
2121
- 中文:https://docs.espressif.com/projects/esp-iot-solution/zh_CN
2222
- English: https://docs.espressif.com/projects/esp-iot-solution/en
2323

24-
## 快速参考
25-
26-
### 硬件准备
27-
28-
您可以选择任意 ESP 系列开发板使用 ESP-IoT-Solution,或者选择[板级支持组件](./examples/common_components/boards)中支持的开发板快速开始。
29-
30-
ESP 系列 SoC 采用 40nm 工艺制成,具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性,适用于各种应用场景和不同功耗需求。
24+
## 版本说明
3125

32-
### 环境搭建
26+
`release/v2.0` 起,ESP-IoT-Solution 采用组件化管理,各组件与示例独立迭代,不再绑定仓库分支。具体依赖的 ESP-IDF 版本请查阅组件 `idf_component.yml` 文件中的声明。Release 分支仅用于维护组件的历史大版本,例如 `button` `v3.x` 版本在 `release/v2.0` 分支中维护,`master` 分支中维护最新的 `button` 版本(例如 `v4.x`)。
3327

34-
#### 搭建 ESP-IDF 开发环境
35-
36-
由于 ESP-IoT-Solution 依赖 ESP-IDF 的基础功能和编译工具,因此首先需要参考 [ESP-IDF 详细安装步骤](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/index.html#get-started-step-by-step) 完成 ESP-IDF 开发环境的搭建。
37-
38-
请注意,不同 ESP-IoT-Solution 版本 依赖的 ESP-IDF 版本可能不同,请参考下表进行选择。
3928

4029
| ESP-IoT-Solution | 依赖的 ESP-IDF | 主要变更 | 文档 | 支持状态 |
4130
| :--------------: | :--------------: | :----------------------------------------: | :----------------------------------------------------------------------------------------------------------: | ---------------------------- |
4231
| master | >= v5.3 | 新芯片支持 | [Docs online](https://docs.espressif.com/projects/esp-iot-solution/zh_CN) | 新功能开发分支 |
43-
| release/v2.0 | <= v5.3, >= v4.4 | 支持组件管理器 | [Docs online](https://docs.espressif.com/projects/esp-iot-solution/zh_CN/release-v2.0/index.html) | 仅限 Bugfix,维护到 v5.3 EOL |
32+
| release/v2.0 | <= v5.3, >= v4.4 | 支持组件管理器 | [Docs online](https://docs.espressif.com/projects/esp-iot-solution/zh_CN/release-v2.0/index.html) | 仅限组件历史版本 Bugfix,维护到 v5.3 EOL |
4433
| release/v1.1 | v4.0.1 | IDF 版本更新,删除已经移动到其它仓库的代码 | [v1.1 Overview](https://github.com/espressif/esp-iot-solution/tree/release/v1.1#esp32-iot-solution-overview) | 备份,停止维护 |
4534
| release/v1.0 | v3.2.2 | 历史版本 | [v1.0 Overview](https://github.com/espressif/esp-iot-solution/tree/release/v1.0#esp32-iot-solution-overview) | 备份,停止维护 |
4635

47-
> `release/v2.0` `master` 分支使用 `ESP 组件管理器` 来管理组件,因此每个组件都是一个单独的软件包,每个包可能支持不同版本的 ESP-idf,这些版本将在组件的 `idf_component.yml` 文件中声明。
36+
## 快速参考
37+
38+
### 硬件准备
39+
40+
您可以选择任意 ESP 系列开发板使用 ESP-IoT-Solution,或者选择[esp-bsp](https://github.com/espressif/esp-bsp)中支持的开发板快速开始。
41+
42+
ESP 系列 SoC 采用先进工艺制程,提供业界领先的射频性能、低功耗特性和稳定可靠性,适用于物联网、工业控制、智能家居、可穿戴设备等多种应用场景。各系列芯片的具体规格和功能请参考 [ESP 产品选型工具](https://products.espressif.com/)
43+
44+
### 组件使用或二次开发
45+
46+
请参考 [ESP-IDF 详细安装步骤](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/index.html#get-started-step-by-step) 先完成 ESP-IDF 开发环境的搭建。
4847

4948
#### 从 ESP 组件注册表获取组件
5049

5150
如果您只想使用 ESP-IoT-Solution 中的组件,我们建议您从 ESP 组件注册表 [ESP Component Registry](https://components.espressif.com/) 中使用它。
5251

52+
可以在项目根目录下使用 `idf.py add-dependency` 命令直接将组件从 Component Registry 添加到项目中。例如,执行 `idf.py add-dependency "espressif/button"` 命令添加 `button`,该组件将在 `CMake` 步骤中自动下载。
53+
54+
> 请参考 [IDF Component Manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html) 查看更多关于组件管理器的细节.
55+
5356
ESP-IoT-Solution 中注册的组件如下:
5457

5558
<center>
@@ -153,10 +156,6 @@ ESP-IoT-Solution 中注册的组件如下:
153156

154157
</center>
155158

156-
可以在项目根目录下使用 `idf.py add-dependency` 命令直接将组件从 Component Registry 添加到项目中。例如,执行 `idf.py add-dependency "espressif/usb_stream"` 命令添加 `usb_stream`,该组件将在 `CMake` 步骤中自动下载。
157-
158-
> 请参考 [IDF Component Manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html) 查看更多关于组件管理器的细节.
159-
160159
#### 从 ESP-IoT-Solution 仓库获取组件
161160

162161
如果您想为 `ESP-IoT-Solution` 中的组件或示例[贡献代码](https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/contribute/index.html),或者想基于 `ESP-IoT-Solution` 中的示例开发项目,您可以通过以下步骤下载 ESP-IoT-Solution 代码仓库:
@@ -173,7 +172,7 @@ ESP-IoT-Solution 中注册的组件如下:
173172
git clone -b release/v2.0 --recursive https://github.com/espressif/esp-iot-solution
174173
```
175174
176-
#### 编译和下载示例
175+
### 构建和烧录示例
177176
178177
**我们强烈建议**您 [构建您的第一个项目](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#build-your-first-project) 以熟悉 ESP-IDF 并确保环境已经设置正确。
179178

docs/doxygen-known-warnings.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
bldc_control.h:line: warning: parameters of member bldc_control_config_t::@49 are not (all) documented
22
bldc_control.h:line: warning: parameters of member bldc_control_config_t::@51 are not (all) documented
33
sensor_type.h:line: warning: parameters of member sensor_data_t::@53 are not (all) documented
4+

0 commit comments

Comments
 (0)