Skip to content

Commit 76da10a

Browse files
krzychbkrzychb
committed
Merge branch 'docs/translate-getting-started-guides-devkitc2' into 'master'
Add translation for Devkitc guides and index files See merge request idf/esp-idf!4522
2 parents 6fcfdd3 + 957301f commit 76da10a

File tree

8 files changed

+1132
-621
lines changed

8 files changed

+1132
-621
lines changed

‎docs/en/get-started-cmake/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,4 +496,4 @@ Related Documents
496496
toolchain-setup-scratch
497497

498498
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
499-
.. _Releases page: https://github.com/espressif/esp-idf/releases
499+
.. _Releases page: https://github.com/espressif/esp-idf/releases

‎docs/en/get-started/index.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
***********
1+
***********
22
Get Started
33
***********
44

@@ -269,7 +269,7 @@ If the previous steps have been done correctly, the following menu appears:
269269

270270
Project configuration - Home window
271271

272-
In the menu, navigate to ``Serial flasher config`` > ``Default serial port`` to configure the serial port, where project will be loaded to. Confirm selection by pressing enter, save configuration by selecting ``< Save >`` and then exit menuconfig by selecting ``< Exit >``.
272+
In the menu, navigate to ``Serial flasher config`` > ``Default serial port`` to configure the serial port, where project will be loaded to. Confirm selection by pressing enter, save configuration by selecting ``< Save >`` and then exit ``menuconfig`` by selecting ``< Exit >``.
273273

274274
To navigate and use ``menuconfig``, press the following keys:
275275

@@ -300,6 +300,8 @@ Build and flash the project by running::
300300

301301
This command will compile the application and all ESP-IDF components, then it will generate the bootloader, partition table, and application binaries. After that, these binaries will be flashed onto your ESP32 board.
302302

303+
If there are no issues by the end of the flash process, you will see messages (below) describing progress of the loading process. Then the board will be reset and the "hello_world" application will start up.
304+
303305
.. highlight:: none
304306

305307
::
@@ -330,7 +332,6 @@ This command will compile the application and all ESP-IDF components, then it wi
330332
Leaving...
331333
Hard resetting...
332334

333-
If there are no issues by the end of the flash process, you will see messages describing progress of the loading process. Then the module will be reset and the “hello_world” application will start up.
334335

335336
If you'd like to use the Eclipse IDE instead of running ``make``, check out the :doc:`Eclipse guide <eclipse-setup>`.
336337

@@ -368,7 +369,7 @@ After startup and diagnostic logs scroll up, you should see "Hello world!" print
368369
369370
To exit IDF monitor use the shortcut ``Ctrl+]``.
370371

371-
If IDF monitor fails shortly after the upload, of if instead of the messages above you see a random garbage similar to what is given below, your board is likely using a 26MHz crystal. Most development board designs use 40MHz, so ESP-IDF uses this frequency as a default value.
372+
If IDF monitor fails shortly after the upload, or if instead of the messages above you see a random garbage similar to what is given below, your board is likely using a 26MHz crystal. Most development board designs use 40MHz, so ESP-IDF uses this frequency as a default value.
372373

373374
.. code-block:: none
374375

‎docs/zh_CN/get-started-cmake/get-started-devkitc-v2.rst

Lines changed: 82 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,82 @@
1-
.. include:: ../../en/get-started-cmake/get-started-devkitc-v2.rst
1+
ESP32-DevKitC V2 入门指南 (CMake)
2+
==================================
3+
4+
:link_to_translation:`en: [English]`
5+
6+
本指南介绍了如何开始使用 ESP32-DevKitC V2 开发板。
7+
8+
9+
准备工作
10+
--------
11+
12+
* :ref:`ESP32-DevKitC V2 开发板 <get-started-esp32-devkitc-v2-board-front-cmake>`
13+
* USB A / micro USB B 数据线
14+
* PC（Windows、Linux 或 Mac OS）
15+
16+
您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。
17+
18+
19+
概述
20+
----
21+
22+
ESP32-DevKitC V2 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小型开发板，板上模组的绝大部分管脚均已引出，开发人员可根据实际需求，轻松通过跳线连接多种外围器件，或将开发板插在面包板上使用。
23+
24+
25+
功能说明
26+
--------
27+
28+
ESP32-DevKitC V2 开发板的主要组件、接口及控制方式见下。
29+
30+
.. _get-started-esp32-devkitc-v2-board-front-cmake:
31+
32+
.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png
33+
:align: center
34+
:alt: ESP32-DevKitC V2 开发板
35+
:figclass: align-center
36+
37+
38+
39+
ESP32-DevKitC V2 开发板
40+
41+
+----------------+--------------------------------------------------------------------------------------------------------------------------+
42+
| 主要组件 | 基本介绍 |
43+
+----------------+--------------------------------------------------------------------------------------------------------------------------+
44+
| ESP32-WROOM-32 | 基于 ESP32 的模组。更多详情，请见 `《ESP32-WROOM-32 技术规格书》`_。 |
45+
+----------------+--------------------------------------------------------------------------------------------------------------------------+
46+
| EN | 复位按键。 |
47+
+----------------+--------------------------------------------------------------------------------------------------------------------------+
48+
| Boot | 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。 |
49+
+----------------+--------------------------------------------------------------------------------------------------------------------------+
50+
| Micro USB 端口 | USB 接口。可用作电路板的供电电源，或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 |
51+
+----------------+--------------------------------------------------------------------------------------------------------------------------+
52+
| I/O | 板上模组的绝大部分管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 |
53+
+----------------+--------------------------------------------------------------------------------------------------------------------------+
54+
55+
电源选项
56+
--------
57+
58+
开发板可任一选用以下三种供电方式：
59+
60+
* Micro USB 供电（默认）
61+
* 5V / GND 管脚供电
62+
* 3V3 / GND 管脚供电
63+
64+
.. warning::
65+
66+
上述供电模式 **不可同时连接**，否则可能会损坏开发板和/或电源。
67+
68+
69+
应用程序开发
70+
------------
71+
72+
ESP32-DevKitC V2 上电前，请首先确认开发板完好无损。
73+
74+
之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
75+
76+
相关文档
77+
--------
78+
79+
* `ESP32-DevKitC 原理图 <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
80+
* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
81+
* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)
82+

‎docs/zh_CN/get-started-cmake/get-started-devkitc.rst

Lines changed: 152 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,152 @@
1-
.. include:: ../../en/get-started-cmake/get-started-devkitc.rst
1+
ESP32-DevKitC V4 入门指南 (CMake)
2+
=============================================
3+
4+
:link_to_translation:`en: [English]`
5+
6+
本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍，请见：:doc:`../hw-reference/index`。
7+
8+
9+
准备工作
10+
-----------
11+
12+
* :ref:`ESP32-DevKitC V4 开发板 <get-started-esp32-devkitc-board-front-cmake>`
13+
* USB A / micro USB B 数据线
14+
* PC（Windows、Linux 或 Mac OS）
15+
16+
您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。
17+
18+
19+
.. _DevKitC-Overview-cmake:
20+
21+
概述
22+
----
23+
24+
ESP32-DevKitC V4 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小型开发板，板上模组的绝大部分管脚均已引出，开发人员可根据实际需求，轻松通过跳线连接多种外围器件，或将开发板插在面包板上使用。
25+
26+
为了更好地满足不同用户需求，ESP32-DevKitC V4 还支持以下不同配置：
27+
28+
- 可选多款 ESP32 模组
29+
30+
- :ref:`esp-modules-and-boards-esp32-wroom-32`
31+
- :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`
32+
- :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`
33+
- :ref:`esp-modules-and-boards-esp32-solo-1`
34+
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
35+
- :ref:`ESP32-WROVER-B <esp-modules-and-boards-esp32-wrover>`
36+
- :ref:`ESP32-WROVER-I <esp-modules-and-boards-esp32-wrover>`
37+
- :ref:`ESP32-WROVER-I (IPEX) <esp-modules-and-boards-esp32-wrover>`
38+
39+
- 可选排针或排母
40+
41+
详情请见 `《乐鑫产品订购信息》 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_。
42+
43+
44+
功能说明
45+
---------
46+
47+
ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。
48+
49+
.. _get-started-esp32-devkitc-board-front-cmake:
50+
51+
.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
52+
:align: center
53+
:alt: ESP32-DevKitC V4（板载 ESP32-WROOM-32）
54+
:figclass: align-center
55+
56+
ESP32-DevKitC V4（板载 ESP32-WROOM-32）
57+
58+
59+
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
60+
| 主要组件 | 基本介绍 |
61+
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
62+
| ESP32-WROOM-32 | 基于 ESP32 的模组。更多详情，请见 `《ESP32-WROOM-32 技术规格书》`_。 |
63+
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
64+
| EN | 复位按键。 |
65+
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
66+
| Boot | 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。 |
67+
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
68+
| USB-to-UART 桥接器 | 单芯片 USB-UART 桥接器，可提供高达 3 Mbps 的传输速率。 |
69+
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
70+
| Micro USB 端口 | USB 接口。可用作电路板的供电电源，或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 |
71+
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
72+
| 5V Power On LED | 开发板通电后（USB 或外部 5 V），该指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。 |
73+
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
74+
| I/O | 板上模组的绝大部分管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 |
75+
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
76+
77+
.. note::
78+
79+
管脚 D0、D1、D2、D3、CMD 和 CLK 用于 ESP32 芯片与 SPI flash 间的内部通信，集中分布在开发板两侧靠近 USB 端口的位置。通常而言，这些管脚最好不连，否则可能影响 SPI flash / SPI RAM 的工作。
80+
81+
.. note::
82+
83+
管脚 GPIO16 和 GPIO17 仅适用于板载 ESP32-WROOM 系列和 ESP32-SOLO-1 的开发板，保留内部使用。
84+
85+
86+
电源选项
87+
--------
88+
89+
开发板可任一选用以下三种供电方式：
90+
91+
* Micro USB 供电（默认）
92+
* 5V / GND 管脚供电
93+
* 3V3 / GND 管脚供电
94+
95+
.. warning::
96+
97+
上述供电模式 **不可同时连接**，否则可能会损坏开发板和/或电源。
98+
99+
100+
有关 C15 的提示
101+
--------------------
102+
103+
较早版本 ESP32-DevKitC 开发板上的 C15 可能存在以下问题：
104+
105+
* 开发板上电后可能进入下载模式；
106+
* 如果用户通过 GPIO0 输出时钟，C15 可能会影响信号。
107+
108+
用户如果认为 C15 可能影响开发板的使用，则可以将 C15 完全移除。C15 在开发板上的具体位置见下图黄色部分。
109+
110+
.. figure:: ../../_static/esp32-devkitc-c15-location.png
111+
:align: center
112+
:alt: C15（黄色）在 ESP32-DevKitC V4 开发板上的位置
113+
:figclass: align-center
114+
:width: 30%
115+
116+
C15（黄色）在 ESP32-DevKitC V4 开发板上的位置
117+
118+
119+
应用程序开发
120+
-----------------
121+
122+
ESP32-DevKitC V4 上电前，请首先确认开发板完好无损。
123+
124+
之后，请前往 之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
125+
126+
127+
开发板尺寸
128+
-------------
129+
130+
.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg
131+
:align: center
132+
:alt: ESP32-DevKitC 开发板尺寸 -- 仰视图
133+
:figclass: align-center
134+
135+
ESP32-DevKitC 开发板尺寸 -- 仰视图
136+
137+
138+
相关文档
139+
-----------
140+
141+
* `ESP32-DevKitC V4 原理图 <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf>`_ (PDF)
142+
* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
143+
* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)
144+
* `《ESP32-WROOM-32D & ESP32-WROOM-32U 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_cn.pdf>`_ (PDF)
145+
* `《ESP32-WROVER 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32_wrover_datasheet_cn.pdf>`_ (PDF)
146+
* `《ESP32-WROVER-B 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_cn.pdf>`_ (PDF)
147+
* `《乐鑫产品订购信息》 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_ (PDF)
148+
149+
.. toctree::
150+
:hidden:
151+
152+
get-started-devkitc-v2

0 commit comments

Comments
 (0)