You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,9 @@ Before sending us a Pull Request, please consider this list of points:
16
16
17
17
* 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.
18
18
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)?
20
20
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)?
22
22
23
23
* Is the code adequately commented for people to understand how it is structured?
24
24
@@ -40,4 +40,4 @@ If this process passes, it will be merged onto the public github repository.
40
40
Legal Part
41
41
----------
42
42
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.
Copy file name to clipboardexpand all lines: README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -222,7 +222,7 @@
222
222
223
223
## <h2 id="preparation">Preparation(CMake)</h2>
224
224
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)
Copy file name to clipboardexpand all lines: documents/DFS_and_light_sleep/DFS_test_manual_en.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -166,4 +166,4 @@ We created a task to test DFS, and result are as follows:
166
166
| 160MHz | 28.46mA |
167
167
| 240MHz | 39.95mA |
168
168
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)
Copy file name to clipboardexpand all lines: documents/evaluation_boards/ESP32_LCDKit_guide_en.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ This section introduces the functional modules (interfaces) of ESP32-LCDKit and
44
44
45
45
## 3.1 ESP32 DevKitC Connection Module
46
46
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.
48
48
49
49
The figure below shows the schematics for the ESP32 DevKitC connection module.
Copy file name to clipboardexpand all lines: documents/evaluation_boards/esp32_sense_kit_guide_en.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ The following image shows the whole ESP32-Sense development kit.
14
14
## 2. Related Resources
15
15
16
16
-**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.
18
18
-[ESP-Prog](./ESP-Prog_guide_en.md) is the debugger for ESP32 that features download and debugging functions.
19
19
20
20
-**ESP32 IoT Solution**
@@ -27,7 +27,7 @@ The following image shows the whole ESP32-Sense development kit.
27
27
28
28
-**Related Resources**
29
29
-[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.
31
31
-[ESP32 touch sensor design](../touch_pad_solution/readme_en.md): It is the reference design manual for the ESP32 touch sensor system.
Copy file name to clipboardexpand all lines: documents/hmi_solution/hmi_workflow_en.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -199,7 +199,7 @@ This section uses an [mp3_example](../../examples/hmi/mp3_example/README_en.md)
199
199
200
200
4. Select the project-specific ESP32 module.
201
201
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.
203
203
204
204
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.
需说明:在安装汇编工具链之前,我们默认你已经安装和配置好 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)。
37
37
38
38
#### 3.1 Linux
39
39
Linux 下配置编译环境比较简单,只需要下载汇编编译工具链,解压到安装目录中,再添加环境变量即可完成设置。
首先安装 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)
Copy file name to clipboardexpand all lines: documents/low_power_solution/esp32_ulp_co-processor_and_assembly_environment_setup_en.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ The ULP co-processor can only be developed in assembly and compiled using the to
47
47
The ULP co-processor assembly enviroment is set up now.
48
48
49
49
#### 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).
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`.
53
53
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:
include $(IDF_PATH)/components/ulp/component_ulp_common.mk
77
77
```
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).
79
79
80
80
3. Build the application as usual (e.g. make app).
81
81
82
82
## 5. Assembly Instructions
83
83
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).
85
85
86
86
#### Algorithm and logical instructions
87
87
* 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
131
131
132
132
## 7. Related Documents
133
133
*[Low Power Solution](https://github.com/espressif/esp-iot-solution/tree/master/documents/low_power_solution)
0 commit comments