Skip to content

Commit 4be2b88

Browse files
Yuan Ming Fucostaud
Yuan Ming Fu
authored andcommitted
doc(esp-idf link): update esp-idf doc link
1 parent 0f087f8 commit 4be2b88

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+129
-95
lines changed

.gitignore

+35-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,38 @@ build/
55
*.pyc
66
*.d
77
*.old
8-
*.cproject
8+
*.cproject
9+
10+
# vscode setting
11+
.vscode/
12+
13+
# eclipse setting
14+
.settings
15+
16+
# MacOS directory files
17+
.DS_Store
18+
19+
# Doc build artifacts
20+
docs/*/_build/
21+
docs/*/doxygen-warning-log.txt
22+
docs/*/sphinx-warning-log.txt
23+
docs/*/sphinx-warning-log-sanitized.txt
24+
docs/*/xml/
25+
docs/*/xml_in/
26+
docs/*/man/
27+
docs/doxygen_sqlite3.db
28+
29+
# Example project files
30+
examples/**/sdkconfig
31+
examples/**/sdkconfig.old
32+
examples/**/build
33+
34+
# Unit test app files
35+
tools/unit-test-app/sdkconfig
36+
tools/unit-test-app/sdkconfig.old
37+
tools/unit-test-app/build
38+
tools/unit-test-app/builds
39+
tools/unit-test-app/output
40+
41+
# ESP-IDF library
42+
build

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Before sending us a Pull Request, please consider this list of points:
1616

1717
* Is the contribution entirely your own work, or already licensed under an Apache License 2.0 compatible Open Source License? If not then we unfortunately cannot accept it.
1818

19-
* Does any new code conform to the esp-idf : [Style Guide](http://docs.espressif.com/projects/esp-idf/en/latest/contribute/style-guide.html)?
19+
* Does any new code conform to the esp-idf : [Style Guide](http://docs.espressif.com/projects/esp-idf/en/stable/contribute/style-guide.html)?
2020

21-
* Does the code documentation follow requirements in :doc: [documenting-code](http://docs.espressif.com/projects/esp-idf/en/latest/contribute/documenting-code.html)?
21+
* Does the code documentation follow requirements in :doc: [documenting-code](http://docs.espressif.com/projects/esp-idf/en/stable/contribute/documenting-code.html)?
2222

2323
* Is the code adequately commented for people to understand how it is structured?
2424

@@ -40,4 +40,4 @@ If this process passes, it will be merged onto the public github repository.
4040
Legal Part
4141
----------
4242

43-
Before a contribution can be accepted, you will need to sign our : [contributor-agreement](http://docs.espressif.com/projects/esp-idf/en/latest/contribute/contributor-agreement.html). You will be prompted for this automatically as part of the Pull Request process.
43+
Before a contribution can be accepted, you will need to sign our : [contributor-agreement](http://docs.espressif.com/projects/esp-idf/en/stable/contribute/contributor-agreement.html). You will be prompted for this automatically as part of the Pull Request process.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@
222222
223223
## <h2 id="preparation">Preparation(CMake)</h2>
224224
225-
* Add to PATH the path to the tools directory inside the IDF_PATH directory.[Add IDF_PATH & idf.py PATH to User Profile(CMake)](https://docs.espressif.com/projects/esp-idf/en/latest/get-started-cmake/add-idf_path-to-profile.html)
225+
* Add to PATH the path to the tools directory inside the IDF_PATH directory.[Add IDF_PATH & idf.py PATH to User Profile(CMake)](https://docs.espressif.com/projects/esp-idf/en/stable/get-started-cmake/add-idf_path-to-profile.html)
226226
* To clone this repository by
227227
228228
```

documents/DFS_and_light_sleep/DFS_test_manual_en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -166,4 +166,4 @@ We created a task to test DFS, and result are as follows:
166166
| 160MHz | 28.46mA |
167167
| 240MHz | 39.95mA |
168168

169-
More informations about DFS, please Visit [Power Management](http://docs.espressif.com/projects/esp-idf/en/latest/api-reference/system/power_management.html)
169+
More informations about DFS, please Visit [Power Management](http://docs.espressif.com/projects/esp-idf/en/stable/api-reference/system/power_management.html)

documents/DFS_and_light_sleep/light_sleep_test_manual_cn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
- **1. 工具链的安装**
66

7-
esp-iot-solution 使用 esp-idf 同一套工具链, 所以如果你的平台上能够编译 esp-idf 中的 example, 则工具链无须重复安装. 工具链的详细安装步骤可以在 [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) 找到, 这里与不多加描述.
7+
esp-iot-solution 使用 esp-idf 同一套工具链, 所以如果你的平台上能够编译 esp-idf 中的 example, 则工具链无须重复安装. 工具链的详细安装步骤可以在 [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html) 找到, 这里与不多加描述.
88

99
- **2. 测试代码下载**
1010

documents/evaluation_boards/ESP-Prog_guide_cn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ IO0 是 ESP8266 和 ESP32 的 Boot 模式选择管脚,芯片上电后 IO0 做
115115

116116
- [ESP-Prog PCB 文件](http://espressif.com/zh-hans/support/download/documents?keys=参考设计)
117117

118-
- [ESP32 JTAG 调试使用介绍](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/jtag-debugging/index.html#)
118+
- [ESP32 JTAG 调试使用介绍](https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/jtag-debugging/index.html#)
119119

120120
- [ Flash 下载工具 (ESP8266 & ESP32)](http://www.espressif.com/zh-hans/support/download/other-tools#)
121121

documents/evaluation_boards/ESP-Prog_guide_en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Pin IO0 can be set to select ESP8266's and ESP32's boot modes. This pin can be u
113113

114114
- [ESP-Prog schematics, PCB reference design, BOM](http://espressif.com/en/support/download/documents?keys=Reference+Design)
115115

116-
- [Introduction to the ESP32 JTAG Debugging](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/jtag-debugging/index.html#)
116+
- [Introduction to the ESP32 JTAG Debugging](https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/jtag-debugging/index.html#)
117117

118118
- [ Flash Download Tools (ESP8266 & ESP32)](http://espressif.com/en/support/download/other-tools)
119119

documents/evaluation_boards/ESP32_LCDKit_guide_cn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ DAC-Audio 模块 | 连接喇叭播放音频,包含音频功率放大器
4646

4747
## 3.1 ESP32 DevKitC 开发板连接模块
4848

49-
使用 ESP32-LCDKit 开发板进行 HMI 相关开发时需要搭配使用 [ESP32 DevKitC 开发板](https://docs.espressif.com/projects/esp-idf/en/latest/hw-reference/modules-and-boards.html#esp32-devkitc-v4)
49+
使用 ESP32-LCDKit 开发板进行 HMI 相关开发时需要搭配使用 [ESP32 DevKitC 开发板](https://docs.espressif.com/projects/esp-idf/en/stable/hw-reference/modules-and-boards.html#esp32-devkitc-v4)
5050

5151
ESP32-LCDKit 开发板与 ESP32 DevKitC 开发板连接模块电路原理图如下所示:
5252

documents/evaluation_boards/ESP32_LCDKit_guide_en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This section introduces the functional modules (interfaces) of ESP32-LCDKit and
4444

4545
## 3.1 ESP32 DevKitC Connection Module
4646

47-
For the HMI-related development with ESP32-LCDKit, you also need the [ESP32 DevKitC](https://docs.espressif.com/projects/esp-idf/en/latest/hw-reference/modules-and-boards.html#esp32-devkitc-v4) development board.
47+
For the HMI-related development with ESP32-LCDKit, you also need the [ESP32 DevKitC](https://docs.espressif.com/projects/esp-idf/en/stable/hw-reference/modules-and-boards.html#esp32-devkitc-v4) development board.
4848

4949
The figure below shows the schematics for the ESP32 DevKitC connection module.
5050

documents/evaluation_boards/esp32_sense_kit_guide_cn.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ESP32-Sense 开发套件用于评估和开发 ESP32 触摸传感器功能。评
1111
## 2. 相关资源
1212

1313
- **开发环境**
14-
- [ESP-IDF](https://github.com/espressif/esp-idf) 是 ESP32 平台的软件开发包。文档 [Get Started](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) 介绍编译环境的搭建和软件开发包的使用说明。
14+
- [ESP-IDF](https://github.com/espressif/esp-idf) 是 ESP32 平台的软件开发包。文档 [Get Started](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html) 介绍编译环境的搭建和软件开发包的使用说明。
1515
- [ESP-Prog](./ESP-Prog_guide_cn.md) 是 ESP32 调试工具,有下载和 Jtag 调试功能。
1616

1717
- **ESP32 IoT 应用方案**
@@ -24,7 +24,7 @@ ESP32-Sense 开发套件用于评估和开发 ESP32 触摸传感器功能。评
2424

2525
- **其他参考资料**
2626
- [Espressif 官网](http://www.espressif.com)
27-
- [ESP32 编程指南](https://docs.espressif.com/projects/esp-idf/en/latest/index.html) : ESP32 相关开发文档的汇总平台,包含硬件手册,软件 API 介绍等。
27+
- [ESP32 编程指南](https://docs.espressif.com/projects/esp-idf/en/stable/index.html) : ESP32 相关开发文档的汇总平台,包含硬件手册,软件 API 介绍等。
2828
- [触摸传感器应用设计参考文档](../touch_pad_solution/readme_cn.md): ESP32 触摸传感器功能应用设计手册,包括触摸传感器原理介绍,软件设计,PCB 设计等内容。
2929

3030
- **技术支持**

documents/evaluation_boards/esp32_sense_kit_guide_en.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The following image shows the whole ESP32-Sense development kit.
1414
## 2. Related Resources
1515

1616
- **Set up Software Environment**
17-
- [ESP-IDF](https://github.com/espressif/esp-idf) is the SDK for ESP32. You can refer to [Get Started](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for how to set up the ESP32 software environment.
17+
- [ESP-IDF](https://github.com/espressif/esp-idf) is the SDK for ESP32. You can refer to [Get Started](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html) for how to set up the ESP32 software environment.
1818
- [ESP-Prog](./ESP-Prog_guide_en.md) is the debugger for ESP32 that features download and debugging functions.
1919

2020
- **ESP32 IoT Solution**
@@ -27,7 +27,7 @@ The following image shows the whole ESP32-Sense development kit.
2727

2828
- **Related Resources**
2929
- [Espressif website](https://espressif.com)
30-
- [ESP32 programming guide](https://docs.espressif.com/projects/esp-idf/en/latest/index.html): It hosts extensive documentation for ESP-IDF ranging from hardware guides to API reference.
30+
- [ESP32 programming guide](https://docs.espressif.com/projects/esp-idf/en/stable/index.html): It hosts extensive documentation for ESP-IDF ranging from hardware guides to API reference.
3131
- [ESP32 touch sensor design](../touch_pad_solution/readme_en.md): It is the reference design manual for the ESP32 touch sensor system.
3232

3333
- **Technical Support**

documents/hmi_solution/hmi_workflow_cn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@
206206

207207
4. ESP32 平台选择
208208

209-
在 mp3_example 中使用 LittlevGL GUI 库进行开发,对内存资源要求低,所以选择 [ESP32 DevKitC](https://docs.espressif.com/projects/esp-idf/en/latest/hw-reference/modules-and-boards.html#esp32-devkitc-v4) 开发板搭配 [ESP-WROOM32](https://docs.espressif.com/projects/esp-idf/en/latest/hw-reference/modules-and-boards.html#esp32-wroom-32) 模组进行开发
209+
在 mp3_example 中使用 LittlevGL GUI 库进行开发,对内存资源要求低,所以选择 [ESP32 DevKitC](https://docs.espressif.com/projects/esp-idf/en/stable/hw-reference/modules-and-boards.html#esp32-devkitc-v4) 开发板搭配 [ESP-WROOM32](https://docs.espressif.com/projects/esp-idf/en/stable/hw-reference/modules-and-boards.html#esp32-wroom-32) 模组进行开发
210210

211211
5. 基于 [ESP32 LittlevGL](https://github.com/espressif/esp-iot-solution/tree/master/components/hmi/lvgl_gui) 库进行移植、相关驱动开发
212212

documents/hmi_solution/hmi_workflow_en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ This section uses an [mp3_example](../../examples/hmi/mp3_example/README_en.md)
199199

200200
4. Select the project-specific ESP32 module.
201201

202-
As the LittlevGL GUI library requires minimum memory, you can select the [ESP-WROOM32](https://docs.espressif.com/projects/esp-idf/en/latest/hw-reference/modules-and-boards.html#esp32-wroom-32) module and mount it on the [ESP32 DevKitC](https://docs.espressif.com/projects/esp-idf/en/latest/hw-reference/modules-and-boards.html#esp32-devkitc-v4) development board.
202+
As the LittlevGL GUI library requires minimum memory, you can select the [ESP-WROOM32](https://docs.espressif.com/projects/esp-idf/en/stable/hw-reference/modules-and-boards.html#esp32-wroom-32) module and mount it on the [ESP32 DevKitC](https://docs.espressif.com/projects/esp-idf/en/stable/hw-reference/modules-and-boards.html#esp32-devkitc-v4) development board.
203203

204204
5. Port the [ESP32 LittlevGL](https://github.com/espressif/esp-iot-solution/tree/master/components/hmi/lvgl_gui) library to your project, or port your project-related resources to [esp-iot-solution](https://github.com/espressif/esp-iot-solution) if you choose to use it, and develop related drivers.
205205

documents/low_power_solution/esp32_ulp_co-processor_and_assembly_environment_setup_cn.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ ULP 协处理器的主要特性有:
3333
## 3. 配置 ULP 协处理器编译环境
3434
ULP 协处理器目前只支持汇编开发,我们提供了三种不同平台(Linux,Windows,MacOS)的 ULP 协处理器编译环境的设置方法。
3535

36-
需说明:在安装汇编工具链之前,我们默认你已经安装和配置好 ESP32 ESP-IDF C 语言编译工具链,[安装参考链接](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html#setup-toolchain)
36+
需说明:在安装汇编工具链之前,我们默认你已经安装和配置好 ESP32 ESP-IDF C 语言编译工具链,[安装参考链接](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html#setup-toolchain)
3737

3838
#### 3.1 Linux
3939
Linux 下配置编译环境比较简单,只需要下载汇编编译工具链,解压到安装目录中,再添加环境变量即可完成设置。
4040
1. 下载工具链 [binutils-esp32ulp toolchain Linux(x64)]( https://github.com/espressif/binutils-esp32ulp/wiki#downloads)
4141
2. 解压到要安装的目录,添加工具链的 `bin` 目录到环境变量 `PATH` 中。例如,解压目录是 `/opt/esp32ulp-elf-binutils` 那么添加 `export PATH=/opt/esp32ulp-elf-binutils/bin:$PATH` 这一行到 `.bashrc` 文件中,运行 `source .bashrc` 使上述环境变量生效,这样,ULP 的汇编环境就设置完毕了。
4242

4343
#### 3.2 Windows
44-
首先安装 Windows / MSYS2 下的 C 编译工具链可参考[说明链接]( http://docs.espressif.com/projects/esp-idf/en/latest/get-started/windows-setup.html) ,之后再安装 ULP 协处理器[编译工具链链接]( https://github.com/espressif/binutils-esp32ulp/wiki#downloads)
44+
首先安装 Windows / MSYS2 下的 C 编译工具链可参考[说明链接]( https://docs.espressif.com/projects/esp-idf/en/stable/get-started/windows-setup.html) ,之后再安装 ULP 协处理器[编译工具链链接]( https://github.com/espressif/binutils-esp32ulp/wiki#downloads)
4545
1. 解压 ULP 工具链 `esp32ulp-elf-binutils-win32-...` 到 MSYS2 的 `opt` 目录中,一般建议使用 `C:\msys32\opt` 目录,因为 `ESP32 toolchain xtensa-esp32-elf` 也在这个目录下。
4646

4747
2. 打开位于目录 `C:\msys32\etc\profile.d` 下的 `esp32_toolchain.sh` 文件,把 ULP 工具链的 `bin/`目录添加到 path 中,设置例如:
@@ -62,7 +62,7 @@ MacOS 平台编译设置几乎是和 Linux 一样的,但需下载 MacOS 平台
6262
如果把 ULP 汇编代码编译为应用组件的一部分,必须采取以下步骤:
6363

6464
1. ULP 的代码是汇编写的,并且文件后缀格式是.S, 这些汇编文件必须放在一个单独的目录中,例如 ulp/
65-
2. 修改 makefile 添加如下内容,一些详细的定义在 [Compiling ULP code](http://docs.espressif.com/projects/esp-idf/en/latest/api-guides/ulp.html#compiling-ulp-code) 可以找到解释。
65+
2. 修改 makefile 添加如下内容,一些详细的定义在 [Compiling ULP code](https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/ulp.html#compiling-ulp-code) 可以找到解释。
6666
```
6767
ULP_APP_NAME ?= ulp_$(COMPONENT_NAME)
6868
ULP_S_SOURCES = $(COMPONENT_PATH)/ulp/ulp_source_file.S
@@ -72,7 +72,7 @@ include $(IDF_PATH)/components/ulp/component_ulp_common.mk
7272
3. 至此,可以编译包含 ULP 协处理器汇编代码的应用程序了。
7373

7474
## 5. ULP 协处理器的汇编指令
75-
汇编指令目前有 24 条,在 [ULP coprocessor instruction set](http://docs.espressif.com/projects/esp-idf/en/latest/api-guides/ulp_instruction_set.html#add-add-to-register) 获得更详细的说明。
75+
汇编指令目前有 24 条,在 [ULP coprocessor instruction set](https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/ulp_instruction_set.html#add-add-to-register) 获得更详细的说明。
7676

7777
##### 算数与逻辑类运算的指令
7878
* 算数指令:加 ADD,减 SUB
@@ -122,4 +122,4 @@ include $(IDF_PATH)/components/ulp/component_ulp_common.mk
122122

123123
## 7. 引用文档
124124
* [ESP-IOT-SOLUTION 的低功耗方案文档]( https://github.com/espressif/esp-iot-solution/tree/master/documents/low_power_solution)
125-
* [ULP coprocessor programming]( https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/ulp.html)
125+
* [ULP coprocessor programming]( https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/ulp.html)

documents/low_power_solution/esp32_ulp_co-processor_and_assembly_environment_setup_en.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The ULP co-processor can only be developed in assembly and compiled using the to
4747
The ULP co-processor assembly enviroment is set up now.
4848

4949
#### 3.2 Windows
50-
1. Install download the Windows all-in-one toolchain & MSYS2 zip file. Please refer to [standard setup of toolchain for windows](http://docs.espressif.com/projects/esp-idf/en/latest/get-started/windows-setup.html).
50+
1. Install download the Windows all-in-one toolchain & MSYS2 zip file. Please refer to [standard setup of toolchain for windows](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/windows-setup.html).
5151
2. Download [ULP toolchain](https://github.com/espressif/binutils-esp32ulp/wiki#downloads).
5252
3. Unzlip the ULP toolchain `esp32ulp-elf-binutils-win32-...` into MSYS2's `opt` directory. `C:\msys32\opt` directory is recommended, since it also contains the ESP32 toolchain `xtensa-esp32-elf`.
5353
4. Open `esp32_toolchain.sh` file in `C:\msys32\etc\profile.d` directory for editing and add the path to the `bin` directory of the toolchain to the `PATH` environment variable, as shown below:
@@ -75,13 +75,13 @@ ULP_S_SOURCES = $(COMPONENT_PATH)/ulp/ulp_source_file.S
7575
ULP_EXP_DEP_OBJECTS := main.o
7676
include $(IDF_PATH)/components/ulp/component_ulp_common.mk
7777
```
78-
Each line is explained in [Compiling ULP Code](http://docs.espressif.com/projects/esp-idf/en/latest/api-guides/ulp.html#compiling-ulp-code).
78+
Each line is explained in [Compiling ULP Code](https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/ulp.html#compiling-ulp-code).
7979

8080
3. Build the application as usual (e.g. make app).
8181

8282
## 5. Assembly Instructions
8383

84-
There are 24 assembly instructions for the ULP co-processor that are documented in details in [ULP coprocessor instruction set](http://docs.espressif.com/projects/esp-idf/en/latest/api-guides/ulp_instruction_set.html).
84+
There are 24 assembly instructions for the ULP co-processor that are documented in details in [ULP coprocessor instruction set](https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/ulp_instruction_set.html).
8585

8686
#### Algorithm and logical instructions
8787
* Algorithm instructions: ADD (add to register), SUB (subtract from register)
@@ -131,4 +131,4 @@ You can find some ULP co-processor examples within [esp-iot-solution](https://gi
131131

132132
## 7. Related Documents
133133
* [Low Power Solution](https://github.com/espressif/esp-iot-solution/tree/master/documents/low_power_solution)
134-
* [ULP Co-processor Programming](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/ulp.html)
134+
* [ULP Co-processor Programming](https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/ulp.html)

0 commit comments

Comments
 (0)