Skip to content

Commit 5cbaa45

Browse files
authored
Merge pull request #1672 from espressif/docs/translate_faq_resubmit
docs: Provide CN translation for faqs.rst (resubmit)
2 parents ebae8ed + 7d2b4cd commit 5cbaa45

File tree

2 files changed

+133
-26
lines changed

2 files changed

+133
-26
lines changed

docs_espressif/en/faqs.rst

Lines changed: 45 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,37 @@
11
FAQs
2-
===============================
2+
====
33

4-
**I have an issue or error with the Visual Studio Code extension, what can I do?**
4+
I have an issue or error with the Visual Studio Code extension. What can I do?
5+
-------------------------------------------------------------------------------
56

6-
Take a look at the :ref:`Troubleshooting documentation <troubleshooting-section>` so you can see the error in the extension. You might be able to fix the issue yourself or give enough information for others to help you with the problem.
7+
Refer to the :ref:`Troubleshooting documentation <troubleshooting-section>` to identify the error in the extension. You might resolve the issue yourself or provide enough information for others to assist you.
78

8-
Search the `ESP-IDF extension repository <https://github.com/espressif/vscode-esp-idf-extension>`_ for Visual Studio Code first and then this forum, your issue might already be solved.
9+
Search the `ESP-IDF extension repository <https://github.com/espressif/vscode-esp-idf-extension>`_ for Visual Studio Code first, and then check the forum. Your issue might already be resolved.
910

10-
**What about questions of ESP-IDF ?**
11+
--------------
1112

12-
Check out `ESP-FAQ <https://docs.espressif.com/projects/espressif-esp-faq/en/latest/>`_ or the `ESP-IDF forum <https://esp32.com>`_ itself.
13+
What about questions regarding ESP-IDF?
14+
---------------------------------------
1315

14-
**I try to build my project but there is an error and I don't know what is happening. What to do?**
16+
Consult `ESP-FAQ <https://docs.espressif.com/projects/espressif-esp-faq/en/latest/>`_ or `ESP-IDF forum <https://esp32.com>`_.
1517

16-
First of all, have you configure the IDE plugin/extension properly ? Make sure to review the documentation to :ref:`Install ESP-IDF and Tools <installation>`.
18+
--------------
1719

18-
There was error in the setup or in your project code itself. Gather the :ref:`Troubleshooting documentation <troubleshooting-section>` and look for errors in these files.
20+
I try to build my project, but there is an error, and I don't know what is happening. What should I do?
21+
---------------------------------------------------------------------------------------------------------
1922

20-
Chances are that your issue have been posted before in the `ESP-IDF github repository <https://github.com/espressif/vscode-esp-idf-extension>`_ or `ESP-IDF forum <https://esp32.com>`_. If not, you can open a new GitHub issue or open a topic in the forum.
23+
Ensure you have configured the IDE plugin/extension properly. Review the documentation to :ref:`Install ESP-IDF and Tools <installation>`.
2124

22-
**How does a ESP-IDF project looks like?**
25+
The error might be in the setup or your project code. Refer to the :ref:`Troubleshooting documentation <troubleshooting-section>` and check for errors in these files.
2326

24-
Please take a look at the `build system documentation <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html#example-project>`_ to understand how to use each file.
27+
Your issue might have been posted before in the `ESP-IDF GitHub repository <https://github.com/espressif/vscode-esp-idf-extension>`_ or `ESP-IDF forum <https://esp32.com>`_. If not, you can open a new GitHub issue or start a topic in the forum.
28+
29+
--------------
30+
31+
How does an ESP-IDF project look?
32+
----------------------------------
33+
34+
Review the `Example Project <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html#example-project>`_ to understand how to use each file.
2535

2636
.. code-block::
2737
@@ -39,30 +49,40 @@ Please take a look at the `build system documentation <https://docs.espressif.co
3949
- src1.c
4050
- src2.c
4151
52+
--------------
4253

43-
**I tried flashing my project but I have an error similar to "Error: unable to open ftdi device with vid ". What to do?**
54+
I tried flashing my project but encountered an error similar to "Error: unable to open ftdi device with vid." What should I do?
55+
-------------------------------------------------------------------------------------------------------------------------------
4456

45-
Take a look at `Configure JTAG Interface <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html>`_ to make sure that your drivers are defined correctly.
57+
Check the `Configure JTAG Interface <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html>`_ to ensure your drivers are correctly defined.
4658

47-
On Windows, you could try using `IDF-ENV <https://github.com/espressif/idf-env>`_ just running the following command in a Powershell terminal:
59+
On Windows, try using `idf-env <https://github.com/espressif/idf-env>`_ by running the following command in a PowerShell terminal:
4860

4961
.. code-block::
5062
51-
Invoke-WebRequest 'https://dl.espressif.com/dl/idf-env/idf-env.exe' -OutFile .\idf-env.exe; .\idf-env.exe driver install --espressif --ftdi --silabs
63+
Invoke-WebRequest 'https://dl.espressif.com/dl/idf-env/idf-env.exe' -OutFile .\idf-env.exe; .\idf-env.exe driver install --espressif --ftdi --silabs
64+
65+
Drivers are also included in the `IDF-Installer <https://dl.espressif.com/dl/esp-idf>`_.
66+
67+
--------------
68+
69+
What is another way to maintain the ESP-IDF environment?
70+
-----------------------------------------------------------
5271

53-
Drivers are also part of the `IDF-Installer <https://dl.espressif.com/dl/esp-idf>`_.
72+
Using `idf-env <https://github.com/espressif/idf-env>`_, you can manage several ESP-IDF versions and launchers, install drivers, manage antivirus exclusions, and more.
5473

55-
**What is another way to maintain ESP-IDF environment?**
74+
--------------
5675

57-
Using the `IDF-ENV <https://github.com/espressif/idf-env>`_ you can manage several ESP-IDF versions and launchers, install drivers, manage antivirus exclusions and more.
76+
While trying to debug my project, I encountered an issue. What should I do?
77+
-----------------------------------------------------------------------------
5878

59-
**While trying to debug my project I have encountered an issue. What should I do?**
79+
First, review the `ESP-IDF JTAG Debugging documentation <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html#jtag-debugging-setup-openocd>`_ to understand how debugging works and the expected configuration of your device. The debugger connects to OpenOCD, so check the `OpenOCD Troubleshooting FAQ <https://github.com/espressif/openocd-esp32/wiki/Troubleshooting-FAQ>`_ for any OpenOCD errors you might have encountered.
6080

61-
First review the `ESP-IDF JTAG Debugging documentation <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html#jtag-debugging-setup-openocd>`_ to understand how debugging works and the expected configuration of your device.
62-
The debugger is connected to OpenOCD. Please take a look at `OpenOCD Troubleshooting FAQ <https://github.com/espressif/openocd-esp32/wiki/Troubleshooting-FAQ>`_ for any OpenOCD errors you might have encountered.
81+
If the issue is not related to OpenOCD, check your IDE integration log files and post an issue in the respective GitHub repository. Refer to the :ref:`Troubleshooting documentation <troubleshooting-section>` to identify the error in the extension.
6382

64-
Check your IDE integration log files and post an issue in the respective GitHub repository if the issue is not related to OpenOCD itself. Take a look at the :ref:`Troubleshooting documentation <troubleshooting-section>` so you can see the error in the extension.
83+
--------------
6584

66-
**I have an issue flashing my Espressif device, What should i do?**
85+
I have an issue flashing my Espressif device. What should I do?
86+
------------------------------------------------------------------
6787

68-
Best start would be to follow the Espressif's `Esptool Troubleshooting documentation <https://docs.espressif.com/projects/esptool/en/latest/esp32/troubleshooting.html>`_.
88+
Start by following Espressif's `Esptool Troubleshooting documentation <https://docs.espressif.com/projects/esptool/en/latest/esp32/troubleshooting.html>`_.

docs_espressif/zh_CN/faqs.rst

Lines changed: 88 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,88 @@
1-
.. include:: ../en/faqs.rst
1+
常见问题
2+
========
3+
4+
我在使用 Visual Studio Code 中的 ESP-IDF 扩展时遇到问题或错误,应该如何处理?
5+
-------------------------------------------------------------------------------
6+
7+
请参阅 :ref:`故障排除 <troubleshooting-section>` 以定位扩展中的错误。有时可以自行解决,也可以提供足够的信息以便他人协助解决。
8+
9+
先在 `ESP-IDF 扩展仓库 <https://github.com/espressif/vscode-esp-idf-extension>`_ 中搜索关键词 "Visual Studio Code",然后再查看论坛。你遇到的问题可能已有解决方法。
10+
11+
--------------
12+
13+
遇到有关 ESP-IDF 的问题时应如何解决?
14+
--------------------------------------------------
15+
16+
请参考 `ESP-FAQ <https://docs.espressif.com/projects/espressif-esp-faq/zh_CN/latest/>`_ 或 `ESP-IDF 论坛 <https://esp32.com>`_。
17+
18+
--------------
19+
20+
构建项目时出现错误,无法确定原因,该如何解决?
21+
----------------------------------------------------------
22+
23+
请确保已正确配置 IDE 插件/扩展。查阅文档以 :ref:`安装 ESP-IDF 和相关工具 <installation>`。
24+
25+
错误可能出在环境设置或项目代码中。请参阅 :ref:`故障排除 <troubleshooting-section>` 并尝试解决潜在错误。
26+
27+
你遇到的问题可能在 `ESP-IDF GitHub 仓库 <https://github.com/espressif/vscode-esp-idf-extension>`_ 或 `ESP-IDF 论坛 <https://esp32.com>`_ 中已经有人提出。如果没有,可以在 GitHub 新建 issue,或在论坛发帖讨论。
28+
29+
--------------
30+
31+
ESP-IDF 项目包含哪些内容?
32+
----------------------------------
33+
34+
参考 `示例项目 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/build-system.html#example-project-structure>`_,了解项目中不同文件的用途。
35+
36+
.. code-block::
37+
38+
- myProject/
39+
- CMakeLists.txt
40+
- sdkconfig
41+
- components/ - component1/ - CMakeLists.txt
42+
- Kconfig
43+
- src1.c
44+
- component2/ - CMakeLists.txt
45+
- Kconfig
46+
- src1.c
47+
- include/ - component2.h
48+
- main/ - CMakeLists.txt
49+
- src1.c
50+
- src2.c
51+
52+
--------------
53+
54+
我尝试烧录项目但遇到了类似于 "Error: unable to open ftdi device with vid." 的错误,该如何处理?
55+
-------------------------------------------------------------------------------------------------
56+
57+
请查看 `配置 JTAG 接口 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html>`_,确保已正确定义驱动程序。
58+
59+
在 Windows 系统中,可以在 PowerShell 终端运行以下命令,尝试使用 `idf-env <https://github.com/espressif/idf-env>`_:
60+
61+
.. code-block::
62+
63+
Invoke-WebRequest 'https://dl.espressif.com/dl/idf-env/idf-env.exe' -OutFile .\idf-env.exe; .\idf-env.exe driver install --espressif --ftdi --silabs
64+
65+
驱动也包含在 `IDF-Installer <https://dl.espressif.com/dl/esp-idf>`_ 中。
66+
67+
--------------
68+
69+
还有其他方式可以维护 ESP-IDF 环境吗?
70+
-----------------------------------------------
71+
72+
使用 `idf-env <https://github.com/espressif/idf-env>`_,可以管理多个 ESP-IDF 版本及启动器、安装驱动、管理杀毒软件排除项等。
73+
74+
--------------
75+
76+
在尝试调试项目时遇到问题,该如何处理?
77+
--------------------------------------
78+
79+
首先,查阅 `ESP-IDF JTAG 调试文档 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/jtag-debugging/index.html#jtag-debugging-setup-openocd>`_,了解调试的工作方式以及设备的配置要求。调试器会连接到 OpenOCD,请查看 `OpenOCD 故障排除 FAQ <https://github.com/espressif/openocd-esp32/wiki/Troubleshooting-FAQ>`_,排查可能遇到的 OpenOCD 错误。
80+
81+
如果问题与 OpenOCD 无关,请检查 IDE 集成的日志文件,并在相应的 GitHub 仓库中提交 issue。参考 :ref:`故障排除 <troubleshooting-section>`,识别扩展中的错误。
82+
83+
--------------
84+
85+
我在烧录乐鑫设备时遇到问题,该如何处理?
86+
--------------------------------------------
87+
88+
建议先参考 `Esptool 故障排除文档 <https://docs.espressif.com/projects/esptool/en/latest/esp32/troubleshooting.html>`_。

0 commit comments

Comments
 (0)