Skip to content

Commit 6290cfa

Browse files
igrrigrr
committed
docs: update IDF version references from v4.0 to v4.4
1 parent ea64607 commit 6290cfa

11 files changed

+34
-34
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ You will require the following to get started:
3232
- An ESP32 development kit: ESP32-DevKitC (Available on [DigiKey](https://www.digikey.com/?_ga=2.24343738.1493252097.1552534720-1988497184.1552534720), [Mouser](https://www.mouser.com/_/?Keyword=ESP32-DevKitC), [Amazon](https://www.amazon.com/s?k=esp32-devkitc&crid=34ZPSBVQ3ZVZK&sprefix=esp32-devt%2Caps%2C738&ref=nb_sb_ss_i_1_9). You could also use any other ESP32 development boards if you already have one.)
3333
- Follow the step-by-step guide at [ESP-Jumpstart Getting Started](https://docs.espressif.com/projects/esp-jumpstart/en/latest/index.html).
3434

35-
Please ensure to use ESP-IDF v4.0 from either the tagged release or the following command,
35+
Please ensure to use ESP-IDF v4.4 from either the tagged release or the following command,
3636
```
3737
git clone --recursive https://github.com/espressif/esp-jumpstart.git
38-
git clone -b release/v4.0 --recursive https://github.com/espressif/esp-idf.git
38+
git clone -b release/v4.4 --recursive https://github.com/espressif/esp-idf.git
3939
cd esp-jumpstart
4040
export IDF_PATH=</path/to/esp-idf/>
4141
```

‎README_cn.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ ESP-Jumpstart 项目专注于在 ESP32 上构建“产品”，展示了基于 E
3030
- ESP32 开发板：ESP32-DevKitC（[DigiKey](https://www.digikey.com.cn/products/zh?WT.z_header=search_go&keywords=esp32-devkitc)、[Mouser](https://www.mouser.cn/_/?Keyword=ESP32-DevKitC)、[亚马逊](https://www.amazon.cn/s/ref=nb_sb_noss?__mk_zh_CN=亚马逊网站&url=search-alias%3Daps&field-keywords=esp32-devkitc)、[淘宝](https://item.taobao.com/item.htm?spm=a1z38n.10677092.0.0.11891debEFopAX&id=542143157571)、[微店](https://detail.youzan.com/show/goods?alias=2fwmug42fe41s&activity_alias=undefined) 均有售。您也可以使用其他 ESP32 开发板。)
3131
- 按照 [ESP-Jumpstart 快速入门指南](https://docs.espressif.com/projects/esp-jumpstart/zh_CN/latest/index.html)，搭建开发环境。
3232

33-
注意，请使用 ESP-IDF v4.0 版本。您可以直接使用以下命令，获得 ESP-IDF v4.0。
33+
注意，请使用 ESP-IDF v4.4 版本。您可以直接使用以下命令，获得 ESP-IDF v4.4。
3434

3535
```
3636
git clone --recursive https://github.com/espressif/esp-jumpstart.git
37-
git clone -b release/v4.0 --recursive https://github.com/espressif/esp-idf.git
37+
git clone -b release/v4.4 --recursive https://github.com/espressif/esp-idf.git
3838
cd esp-jumpstart
3939
export IDF_PATH=</path/to/esp-idf/>
4040
```

‎docs/en/latex/gettingstarted.tex

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ \section{ESP-IDF}\index{ESP-IDF}
2828

2929
\subsection{Setting up IDF}\index{Setting up IDF}
3030

31-
Please follow the steps in this documentation for setting up IDF: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.0/get-started/index.html}. Please complete all the steps on this page.
31+
Please follow the steps in this documentation for setting up IDF: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.4/get-started/index.html}. Please complete all the steps on this page.
3232

3333
Before proceeding, please ensure that you have setup your development host, and have built the first application as indicated in this page. Now that you have done that, let's look at some additional details about IDF.
3434

@@ -69,10 +69,10 @@ \section{Getting ESP-Jumpstart}\index{Getting ESP-Jumpstart}
6969
$ git clone --recursive https://github.com/espressif/esp-jumpstart
7070
\end{verbatim}
7171

72-
Since we are building a production-ready firmware here, we would want to base our development on a stable release of IDF. Currently, ESP-Jumpstart uses the stable version 4.0 of ESP-IDF. Let us first switch to that version of ESP-IDF.
72+
Since we are building a production-ready firmware here, we would want to base our development on a stable release of IDF. Currently, ESP-Jumpstart uses the stable version 4.4 of ESP-IDF. Let us first switch to that version of ESP-IDF.
7373
\begin{verbatim}
7474
$ cd esp-idf
75-
$ git checkout -b release/v4.0 remotes/origin/release/v4.0
75+
$ git checkout -b release/v4.4 remotes/origin/release/v4.4
7676
$ git submodule update --recursive
7777
\end{verbatim}
7878

‎docs/en/latex/networkconfig.tex

+4-4
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ \section{Unified Provisioning}\index{Unified Provisioning}\label{sec:unified_pro
8585

8686
The following components are offered as part of the provisioning infrastructure:
8787
\begin{itemize}
88-
\item \textbf{Unified Provisioning Specification:} A specification to \textit{securely} transfer Wi-Fi credentials to the device, independent of the transport (SoftAP, BLE). More details can be found here: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/provisioning.html}.
89-
\item \textbf{IDF Components:} Software modules that implement this specification in the device firmware, available through ESP-IDF. More details can be found here: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/wifi_provisioning.html}.
88+
\item \textbf{Unified Provisioning Specification:} A specification to \textit{securely} transfer Wi-Fi credentials to the device, independent of the transport (SoftAP, BLE). More details can be found here: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/provisioning.html}.
89+
\item \textbf{IDF Components:} Software modules that implement this specification in the device firmware, available through ESP-IDF. More details can be found here: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/wifi_provisioning.html}.
9090
\item \textbf{Phone apps:} Android: BLE Provisioning(\url{https://play.google.com/store/apps/details?id=com.espressif.provble}), SoftAP Provisioning(\url{https://play.google.com/store/apps/details?id=com.espressif.provsoftap}). iOS: BLE Provisioning(\url{https://apps.apple.com/in/app/esp-ble-provisioning/id1473590141}), SoftAP Provisioning(\url{https://apps.apple.com/in/app/esp-softap-provisioning/id1474040630})
9191
\item \textbf{Phone App sources:} Sources for the phone apps for Android (\url{https://github.com/espressif/esp-idf-provisioning-android}) and iOS (\url{https://github.com/espressif/esp-idf-provisioning-ios}) are available for testing during your development, or for skinning with your brand's elements.
9292
\end{itemize}
@@ -191,7 +191,7 @@ \subsubsection{Proof of Possession}\index{Proof of Possession}
191191

192192
\subsection{Additional Details}\index{Additional Details}
193193

194-
More details about Unified provisioning and the Wi-Fi provisioning abstraction layer are available at: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/provisioning.html} and \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/wifi_provisioning.html}
194+
More details about Unified provisioning and the Wi-Fi provisioning abstraction layer are available at: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/provisioning.html} and \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/wifi_provisioning.html}
195195

196196
\section{NVS: Persistent key-value store}\index{NVS: Persistent key-value store}\label{sec:nvs_info}
197197
In the Unified Provisioning section above, we mentioned in passing that the Wi-Fi credentials are stored in the NVS. The NVS is a software component that maintains a persistent storage of key-value pairs. Since the storage is persistent this information is available even across reboots and power shutdowns. The NVS uses a dedicated section of the flash to store this information.
@@ -211,7 +211,7 @@ \section{NVS: Persistent key-value store}\index{NVS: Persistent key-value store}
211211

212212
\subsection{Additional Details}\index{Additional Details}
213213

214-
More details about NVS are available at: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/storage/nvs_flash.html}
214+
More details about NVS are available at: \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/storage/nvs_flash.html}
215215

216216
\section{Reset to Factory}\index{Reset to Factory}
217217
Another common behaviour that is expected of products is \textit{Reset to Factory Settings}. Once the user configuration is stored into the NVS as discussed above, reset to factory behaviour can be achieved by simply erasing the NVS partition.

‎docs/en/latex/security.tex

+3-3
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ \subsection{Secure Boot}\index{Secure Boot}
7171
\end {itemize}
7272
\end{itemize}
7373
74-
As you might have noticed, you will have to perform some additional steps for enabling secure boot on your devices. Please head over to the detailed information about Secure Boot (\url{https://docs.espressif.com/projects/esp-idf/en/release-v4.0/security/secure-boot.html}{Secure Boot}) to understand further.
74+
As you might have noticed, you will have to perform some additional steps for enabling secure boot on your devices. Please head over to the detailed information about Secure Boot (\url{https://docs.espressif.com/projects/esp-idf/en/release-v4.4/security/secure-boot.html}{Secure Boot}) to understand further.
7575
7676
\subsection{Encrypted Flash}\index{Encrypted Flash}
7777
The flash encryption support ensures that any application firmware, that is stored in the flash of the ESP32, stays encrypted. This allows manufacturers to ship encrypted firmware in their devices.
@@ -85,7 +85,7 @@ \subsection{Encrypted Flash}\index{Encrypted Flash}
8585
\label{fig:flash_encrypt}
8686
\end{figure}
8787
88-
For more information about enabling flash encryption, you can head over to additional documentation of Flash Encryption (\url{https://docs.espressif.com/projects/esp-idf/en/release-v4.0/security/flash-encryption.html}).
88+
For more information about enabling flash encryption, you can head over to additional documentation of Flash Encryption (\url{https://docs.espressif.com/projects/esp-idf/en/release-v4.4/security/flash-encryption.html}).
8989
9090
\subsection{Encrypting NVS}\index{Encrypting NVS}
9191
@@ -109,6 +109,6 @@ \subsection{Encrypting NVS}\index{Encrypting NVS}
109109
\end {itemize}
110110
\end{itemize}
111111
112-
For more information about using NVS encryption, you can head over to the additional documentation at \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/storage/nvs_flash.html#nvs-encryption}.
112+
For more information about using NVS encryption, you can head over to the additional documentation at \url{https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/storage/nvs_flash.html#nvs-encryption}.
113113
114114
\end{document}

‎docs/en/rst/gettingstarted.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Setting up IDF
4545
~~~~~~~~~~~~~~
4646

4747
Please follow the steps in this documentation for setting up IDF:
48-
https://docs.espressif.com/projects/esp-idf/en/release-v4.0/get-started/index.html.
48+
https://docs.espressif.com/projects/esp-idf/en/release-v4.4/get-started/index.html.
4949
Please complete all the steps on this page.
5050

5151
Before proceeding, please ensure that you have setup your development
@@ -101,13 +101,13 @@ ESP-Jumpstart git repository https://github.com/espressif/esp-jumpstart.
101101

102102
Since we are building a production-ready firmware here, we would want to
103103
base our development on a stable release of IDF. Currently,
104-
ESP-Jumpstart uses the stable version 4.0 of ESP-IDF. Let us first
104+
ESP-Jumpstart uses the stable version 4.4 of ESP-IDF. Let us first
105105
switch to that version of ESP-IDF.
106106

107107
::
108108

109109
$ cd esp-idf
110-
$ git checkout -b release/v4.0 remotes/origin/release/v4.0
110+
$ git checkout -b release/v4.4 remotes/origin/release/v4.4
111111
$ git submodule update --recursive
112112

113113
Now we build our first, *Hello World*, application from ESP-Jumpstart

‎docs/en/rst/networkconfig.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -166,12 +166,12 @@ infrastructure:
166166
- **Unified Provisioning Specification:** A specification to *securely*
167167
transfer Wi-Fi credentials to the device, independent of the
168168
transport (SoftAP, BLE). More details can be found here:
169-
https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/provisioning.html.
169+
https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/provisioning.html.
170170

171171
- **IDF Components:** Software modules that implement this
172172
specification in the device firmware, available through ESP-IDF.
173173
More details can be found here:
174-
https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/wifi_provisioning.html.
174+
https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/wifi_provisioning.html.
175175

176176
- **Phone apps:** Android: BLE
177177
Provisioning(\ https://play.google.com/store/apps/details?id=com.espressif.provble),
@@ -383,9 +383,9 @@ Additional Details
383383

384384
More details about Unified provisioning and the Wi-Fi provisioning
385385
abstraction layer are available at:
386-
https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/provisioning.html
386+
https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/provisioning.html
387387
and
388-
https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/wifi_provisioning.html
388+
https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/wifi_provisioning.html
389389

390390
.. _sec_nvs\_info:
391391

@@ -423,7 +423,7 @@ Additional Details
423423
~~~~~~~~~~~~~~~~~~
424424

425425
More details about NVS are available at:
426-
https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/storage/nvs_flash.html
426+
https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/storage/nvs_flash.html
427427

428428
Reset to Factory
429429
----------------

‎docs/en/rst/security.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ The process works as follows:
121121
As you might have noticed, you will have to perform some additional
122122
steps for enabling secure boot on your devices. Please head over to the
123123
detailed information about Secure Boot
124-
(https://docs.espressif.com/projects/esp-idf/en/release-v4.0/security/secure-boot.html\ Secure
124+
(https://docs.espressif.com/projects/esp-idf/en/release-v4.4/security/secure-boot.html\ Secure
125125
Boot) to understand further.
126126

127127
Encrypted Flash
@@ -146,7 +146,7 @@ contents.
146146

147147
For more information about enabling flash encryption, you can head over
148148
to additional documentation of Flash Encryption
149-
(https://docs.espressif.com/projects/esp-idf/en/release-v4.0/security/flash-encryption.html).
149+
(https://docs.espressif.com/projects/esp-idf/en/release-v4.4/security/flash-encryption.html).
150150

151151
Encrypting NVS
152152
~~~~~~~~~~~~~~
@@ -188,4 +188,4 @@ The process works as follows: The process works as follows:
188188

189189
For more information about using NVS encryption, you can head over to
190190
the additional documentation at
191-
https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/storage/nvs_flash.html#nvs-encryption.
191+
https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/storage/nvs_flash.html#nvs-encryption.

‎docs/zh_CN/rst/gettingstarted.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ESP-IDF 是乐鑫为 ESP32 提供的物联网开发框架。
2929
设置 ESP-IDF
3030
~~~~~~~~~~~~~~
3131

32-
请参照 `ESP-IDF 入门指南 <https://docs.espressif.com/projects/esp-idf/zh_CN/release-v4.0/get-started/index.html>`_，按照步骤设置 ESP-IDF。注：请完成链接页面的所有步骤。
32+
请参照 `ESP-IDF 入门指南 <https://docs.espressif.com/projects/esp-idf/zh_CN/release-v4.4/get-started/index.html>`_，按照步骤设置 ESP-IDF。注：请完成链接页面的所有步骤。
3333

3434
在进行下面步骤之前，请确认您已经正确设置了开发主机，并按照上面链接中的步骤构建了第一个应用程序。如果上面步骤已经完成，那让我们继续探索 ESP-IDF。
3535

@@ -65,12 +65,12 @@ ESP-Jumpstart 库包含了一系列由 ESP-IDF 构建的 *应用程序*，我们
6565

6666
$ git clone --recursive https://github.com/espressif/esp-jumpstart
6767

68-
我们将构建一个可用于量产的固件，因此选择使用 ESP-IDF 稳定版本进行开发。目前 ESP-Jumpstart 使用的是 ESP-IDF v4.0 稳定版本，请切换到这一版本。
68+
我们将构建一个可用于量产的固件，因此选择使用 ESP-IDF 稳定版本进行开发。目前 ESP-Jumpstart 使用的是 ESP-IDF v4.4 稳定版本，请切换到这一版本。
6969

7070
::
7171

7272
$ cd esp-idf
73-
$ git checkout -b release/v4.0 remotes/origin/release/v4.0
73+
$ git checkout -b release/v4.4 remotes/origin/release/v4.4
7474
$ git submodule update --recursive
7575

7676
现在，我们构建 ESP-Jumpstart 中的第一个应用程序 *Hello World*，并将其烧录到开发板上，具体步骤如下，相信您已经熟悉这些步骤：

‎docs/zh_CN/rst/networkconfig.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ ESP8266 不具备蓝牙功能，因此现阶段仅支持 SoftAP 配网模式。E
9494

9595
配网底层结构包含以下组件：
9696

97-
- **统一配置规范**：用于将 Wi-Fi 信息安全地传输到设备，与传输模式（SoftAP 或 BLE 模式）无关。请参考 `统一配置相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/provisioning.html>`_，查看详细信息。
97+
- **统一配置规范**：用于将 Wi-Fi 信息安全地传输到设备，与传输模式（SoftAP 或 BLE 模式）无关。请参考 `统一配置相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/provisioning.html>`_，查看详细信息。
9898

9999
- **IDF 组件**：在设备固件中实现此规范的软件模块，可通过 ESP-IDF 获取。
100100

@@ -197,7 +197,7 @@ ESP8266 不具备蓝牙功能，因此现阶段仅支持 SoftAP 配网模式。E
197197
补充信息
198198
~~~~~~~~~~~~~~~~~~
199199

200-
请参考 `统一配置相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/provisioning/provisioning.html>`_，查看详细信息。
200+
请参考 `统一配置相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/provisioning/provisioning.html>`_，查看详细信息。
201201

202202
.. _sec_nvs\_info:
203203

@@ -221,7 +221,7 @@ NVS 经过专门设计，不但可以防止设备断电带来的数据损坏影
221221
补充信息
222222
~~~~~~~~~~~~~~~~~~
223223

224-
请参考 `NVS 相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/storage/nvs_flash.html>`_，查看详细信息.
224+
请参考 `NVS 相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/storage/nvs_flash.html>`_，查看详细信息.
225225

226226
恢复出厂设置
227227
----------------

‎docs/zh_CN/rst/security.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Secure Boot 可以确保 ESP32 从 flash 运行任何软件时，软件受信任
8585

8686
- 固件签名验证通过后，Bootloader 加载并执行固件。
8787

88-
如上所述，启动设备 Secure Boot 之前，我们需要先进行其他一些操作。请参考 `Secure Boot 相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.0/security/secure-boot.html>`_，查看更多详细信息。
88+
如上所述，启动设备 Secure Boot 之前，我们需要先进行其他一些操作。请参考 `Secure Boot 相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/security/secure-boot.html>`_，查看更多详细信息。
8989

9090
Flash 加密
9191
~~~~~~~~~~~~~~~
@@ -99,7 +99,7 @@ flash 加密可以确保储存在 ESP32 flash 中的应用程序固件保持加
9999

100100
flash 加密
101101

102-
请参考 `flash 加密文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.0/security/flash-encryption.html>`_，查看如何启用 flash 加密功能。
102+
请参考 `flash 加密文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/security/flash-encryption.html>`_，查看如何启用 flash 加密功能。
103103

104104
NVS 加密
105105
~~~~~~~~~~~~~~
@@ -126,4 +126,4 @@ NVS 加密
126126

127127
- 正常执行其他的 NVS 操作。
128128

129-
请参考 `NVS 加密相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.0/api-reference/storage/nvs_flash.html#nvs-encryption>`_，查看更多详细信息。
129+
请参考 `NVS 加密相关文档 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/api-reference/storage/nvs_flash.html#nvs-encryption>`_，查看更多详细信息。

0 commit comments

Comments
 (0)