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: content/hardware/03.nano/boards/nano-esp32/tutorials/debugging/debugging.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
---
2
2
title: Debugging with the Nano ESP32
3
-
description: Get started with debugging using the Arduino Nano ESP32 with the IDE 2.
3
+
description: Get started with debugging the Arduino Nano ESP32 with the IDE 2.
4
4
author: Hannes Siebeneicher
5
5
hardware:
6
6
- hardware/03.nano/boards/nano-esp32
7
7
tags: [ESP32, Debugging, IDE]
8
8
---
9
9
10
-
Debugging is a crucial step especially when developing more complex projects. But even for beginners, it can be worth looking into as it gives you a lot more insights on what your code does at a specific time.
10
+
Debugging skills are valuable not only for tackling complex projects but also for beginners and those working on intermediate-level projects, as they offer valuable insights into the specific behavior of your code.
11
11
12
12
## What Is Debugging?
13
13
@@ -24,12 +24,12 @@ Debugging is an essential skill for anyone working with technology, whether you'
-[Arduino ESP32 Core](https://github.com/arduino/arduino-esp32) installed (2.0.12 or newer)
29
29
30
30
## IDE Setup
31
31
32
-
In order to use the debugging feature on the Nano ESP32 you will need to download and install the IDE 2.2.0 or newer. After you install it, you have to configure the IDE as follows:
32
+
To use the debugging feature on the Nano ESP32, you need to have the IDE 2.2.0 or a newer version installed. After you install it, you have to configure the IDE as follows:
@@ -49,15 +49,15 @@ If this is your first time debugging your code we recommend starting with the cl
49
49
50
50
Before starting a debug session make sure to always do one of the following:
51
51
52
-
- Either connect a jumper cable between the **GND** and the **B1** pins and press the reset button **once**. The RGB LED will turn on with a green or blue color. Inside **Tools**, the board will be shown as a random ESP32 board.
52
+
- Either connect a jumper cable between the **GND** and the **B1** pins, press the reset button **once**, and remove the jumper cable. The RGB LED will turn on with a green or blue color. Inside **Tools**, the board will be shown as a random ESP32 board.
53
53
54
54
***This is because in this mode all ESP32 chips share the same identifier assigned to USB devices, therefore the IDE selects a random ESP32 board.***
55
55
56
56
Continue to select **Tools** > **Board** > **Arduino Nano ESP32** as well as the correct **Port**.
57
57
58
58
After that select **Sketch** > **Upload Using Programmer**.
59
59
60
-
- Or doubletap the reset button. You will see the RGB LED fading slowly which means you correctly entered the recovery / Device Firmware Update (DFU) mode. You should see two ports in the drop-down menu, one showing a USB symbol and another one showing a cube.
60
+
- Or double-tap the reset button. You will see the RGB LED fading slowly which means you correctly entered the recovery / Device Firmware Update (DFU) mode. You should see two ports in the drop-down menu, one showing a USB symbol and another one showing a cube.
61
61
62
62

63
63
@@ -67,9 +67,9 @@ Finally, after completing all steps above the last step is to start the debuggin
67
67
68
68

69
69
70
-
***Note: During the upload you will see a debug_custom.json being created at the top of the IDE. If you want to debug using another board it's important that you delete this file otherwise the IDE will use the wrong debugger and fail. You can find the file inside your sketch folderat ~\Documents\Arduino\sketches\"Your Sketch".***
70
+
***Note: During the upload you will see a debug_custom.json appear in the file view. If you want to debug using another board it's important that you delete this file otherwise the IDE will use the wrong debugger and fail. You can find the file inside your sketch folder, typically at `~/documents/Arduino/<yoursketch>`***
71
71
72
-
After starting the debugging session you will have to press the continue button **several times** until you reach you main sketch and the breakpoints you set. This is due to how the recovery system works and is **expected behavior**.
72
+
After starting the debugging session you have to press the continue button **several times** until you reach your main sketch and the breakpoints you set. This is due to how the recovery system works is expected behavior.
73
73
74
74

75
75
@@ -79,14 +79,13 @@ Debug-enabled sketches will only accept updates with the above instructions. To
79
79
80
80
Then repeat the steps described above:
81
81
82
-
- Either connect a jumper cable between the **GND** and the **B1** pins press the reset button **once** and upload using programmer
82
+
- Either connect a jumper cable between the **GND** and the **B1** pins press the reset button **once** and upload using programmer.
83
83
84
-
- Or **double tap** the reset button to enter **DFU mode** and perform a normal upload using the upload button.
85
-
86
-
## Learn More
87
-
88
-
To learn more about how to debug using the IDE check out [Debugging with the Arduino IDE 2](/software/ide-v2/tutorials/ide-v2-debugger)
84
+
- Or **double-tap** the reset button to enter **DFU mode** and perform a normal upload using the upload button.
89
85
90
86
## Summary
91
87
92
-
In this article we covered the basic steps for getting started with debugging using the Arduino Nano ESP32 and the IDE 2.
88
+
In this article we covered the basic steps for debugging the Arduino Nano ESP32 using the Arduino IDE. We have learned how to select the debug mode, how to place the board in the right mode, and how to test out the Arduino IDE's debugging features.
89
+
90
+
## Learn More
91
+
This article only covers how to configure the Nano ESP32 for debugging, and how to get things working. To learn more about how to use the debugging features in the IDE, see the [Debugging with the Arduino IDE 2](/software/ide-v2/tutorials/ide-v2-debugger) article, which covers things in more detail.
0 commit comments