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
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.
7
8
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.
9
10
10
-
**What about questions of ESP-IDF ?**
11
+
--------------
11
12
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
+
---------------------------------------
13
15
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>`_.
15
17
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
+
--------------
17
19
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?
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>`.
21
24
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.
23
26
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.
25
35
26
36
.. code-block::
27
37
@@ -39,30 +49,40 @@ Please take a look at the `build system documentation <https://docs.espressif.co
39
49
- src1.c
40
50
- src2.c
41
51
52
+
--------------
42
53
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?
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.
46
58
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:
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.
54
73
55
-
**What is another way to maintain ESP-IDF environment?**
74
+
--------------
56
75
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?
**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.
60
80
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.
63
82
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
+
--------------
65
84
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?
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>`_.
0 commit comments