From ac7836a5d1fd1279510021c9985753ff0a0d944f Mon Sep 17 00:00:00 2001 From: Sagar Date: Mon, 19 Jul 2021 23:47:29 +0530 Subject: [PATCH 1/9] Update troubleshooting.rst Added some useful tips for flashing/programming troubleshooting. --- docs/source/troubleshooting.rst | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index f0d2df2a8ce..ce59eb90e75 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -1,5 +1,5 @@ ############### -Troubleshotting +Troubleshooting ############### Common Issues @@ -18,10 +18,22 @@ Building Flashing -------- -* The board is not flashing. +*Here are some of the tips if The board is not flashing..* + +* Sometimes to program ESP32 via serial you must keep GPIO0 LOW during the programming process. +* Hold-down the **“BOOT”** button in your ESP32 board while unloading. +* In some ESP32 development boards when trying to upload a new sketch, the Arduino IDE gives you a fatal error *(i.e A fatal error occurred: Failed to connect to ESP32: Timed out waiting for packet header).* This means your ESP32 board is not automatically in the flashing/uploading mode. +**Solution:** +To make flashing automatically, you have to connect a **10 uF** capacitor between the **EN** and **GND** pins. This capacitor value could be lower (> 2.2 uF) if you don't have this part available. **EN <----||---- GND.** + +*(The capacitor can be electrolytic, ceramic, or tantalum. Using lower values like 2.2uF and 4.7 uF is also possible in most cases.)* + + Hardware -------- -* Power Source -* Bad USB cable or charging only cables +* Power Source. +* Bad USB cable or charging only cables (without data wires.) +* USB drivers missing. +* Board with some defect. From 3b3914b2dcfb9539a0e366e32c8fa7d722bdcb91 Mon Sep 17 00:00:00 2001 From: Sagar Date: Wed, 21 Jul 2021 16:54:19 +0530 Subject: [PATCH 2/9] Update troubleshooting.rst Some changes were made. --- docs/source/troubleshooting.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index ce59eb90e75..f9b1a286112 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -20,20 +20,21 @@ Flashing *Here are some of the tips if The board is not flashing..* -* Sometimes to program ESP32 via serial you must keep GPIO0 LOW during the programming process. -* Hold-down the **“BOOT”** button in your ESP32 board while unloading. +* In some instances, you must keep **GPIO0** LOW during the uploading process via serial interface. +* Hold-down the **“BOOT”** button in your ESP32 board while uploading/flashing. * In some ESP32 development boards when trying to upload a new sketch, the Arduino IDE gives you a fatal error *(i.e A fatal error occurred: Failed to connect to ESP32: Timed out waiting for packet header).* This means your ESP32 board is not automatically in the flashing/uploading mode. **Solution:** -To make flashing automatically, you have to connect a **10 uF** capacitor between the **EN** and **GND** pins. This capacitor value could be lower (> 2.2 uF) if you don't have this part available. **EN <----||---- GND.** - -*(The capacitor can be electrolytic, ceramic, or tantalum. Using lower values like 2.2uF and 4.7 uF is also possible in most cases.)* - +1. To automatically get into the flashing mode, you have to connect a **10 uF** capacitor between the **EN** and **GND** pins. This capacitor value could be lower (> 2.2 uF) if you don't have this part available. **EN <----||---- GND.** *(The capacitor can be electrolytic, ceramic, or tantalum. Using lower values like 2.2uF and 4.7 uF is also possible in most cases.)* +2. The hardware guide recommends adding the RC delay circuit. For more details, see the **ESP32 Hardware Design Guidelines** + https://www.espressif.com/sites/default/files/documentation/esp32_hardware_design_guidelines_en.pdf + + ``in the '2.2.1 Power-on Sequence' section.`` Hardware -------- * Power Source. -* Bad USB cable or charging only cables (without data wires.) +* Bad/damaged USB cable or charging only cables (without data wires). * USB drivers missing. * Board with some defect. From 8bbc91cd07c9e45832de48d89256cb851032c141 Mon Sep 17 00:00:00 2001 From: Sagar Date: Thu, 22 Jul 2021 23:20:55 +0530 Subject: [PATCH 3/9] Update troubleshooting.rst --- docs/source/troubleshooting.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index f9b1a286112..14276e5fbca 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -22,7 +22,7 @@ Flashing * In some instances, you must keep **GPIO0** LOW during the uploading process via serial interface. * Hold-down the **“BOOT”** button in your ESP32 board while uploading/flashing. -* In some ESP32 development boards when trying to upload a new sketch, the Arduino IDE gives you a fatal error *(i.e A fatal error occurred: Failed to connect to ESP32: Timed out waiting for packet header).* This means your ESP32 board is not automatically in the flashing/uploading mode. +* When trying to upload a new sketch in some ESP32 development boards, the Arduino IDE gives you a fatal error *(i.e A fatal error occurred: Failed to connect to ESP32: Timed out waiting for packet header)*. This means your ESP32 board is not automatically in the flashing/uploading mode. **Solution:** 1. To automatically get into the flashing mode, you have to connect a **10 uF** capacitor between the **EN** and **GND** pins. This capacitor value could be lower (> 2.2 uF) if you don't have this part available. **EN <----||---- GND.** *(The capacitor can be electrolytic, ceramic, or tantalum. Using lower values like 2.2uF and 4.7 uF is also possible in most cases.)* From a2b5257935126a19cea513c803dbd35c84b1bd7e Mon Sep 17 00:00:00 2001 From: Sagar Date: Thu, 22 Jul 2021 23:28:11 +0530 Subject: [PATCH 4/9] Update troubleshooting.rst USB Driver Link Added. --- docs/source/troubleshooting.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index 14276e5fbca..e3be2109455 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -36,5 +36,5 @@ Hardware * Power Source. * Bad/damaged USB cable or charging only cables (without data wires). -* USB drivers missing. +* USB drivers missing. **Download link:** https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers * Board with some defect. From 643bd021749148e72d66a8ded00d6924976b19e8 Mon Sep 17 00:00:00 2001 From: Sagar Date: Fri, 23 Jul 2021 15:17:27 +0530 Subject: [PATCH 5/9] Update troubleshooting.rst --- docs/source/troubleshooting.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index e3be2109455..8c8f8b3818c 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -26,10 +26,9 @@ Flashing **Solution:** 1. To automatically get into the flashing mode, you have to connect a **10 uF** capacitor between the **EN** and **GND** pins. This capacitor value could be lower (> 2.2 uF) if you don't have this part available. **EN <----||---- GND.** *(The capacitor can be electrolytic, ceramic, or tantalum. Using lower values like 2.2uF and 4.7 uF is also possible in most cases.)* -2. The hardware guide recommends adding the RC delay circuit. For more details, see the **ESP32 Hardware Design Guidelines** - https://www.espressif.com/sites/default/files/documentation/esp32_hardware_design_guidelines_en.pdf - - ``in the '2.2.1 Power-on Sequence' section.`` +2. For more details, see the `ESP32 Hardware Design Guidelines + `_ in the *Power-on Sequence* section. + Hardware -------- From 85d26c29eb715000e4fcfdf95b28eaf65885a791 Mon Sep 17 00:00:00 2001 From: Sagar Date: Fri, 23 Jul 2021 15:31:52 +0530 Subject: [PATCH 6/9] Update troubleshooting.rst --- docs/source/troubleshooting.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index 8c8f8b3818c..c036ce6c806 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -23,12 +23,12 @@ Flashing * In some instances, you must keep **GPIO0** LOW during the uploading process via serial interface. * Hold-down the **“BOOT”** button in your ESP32 board while uploading/flashing. * When trying to upload a new sketch in some ESP32 development boards, the Arduino IDE gives you a fatal error *(i.e A fatal error occurred: Failed to connect to ESP32: Timed out waiting for packet header)*. This means your ESP32 board is not automatically in the flashing/uploading mode. -**Solution:** +**Solution:** 1. To automatically get into the flashing mode, you have to connect a **10 uF** capacitor between the **EN** and **GND** pins. This capacitor value could be lower (> 2.2 uF) if you don't have this part available. **EN <----||---- GND.** *(The capacitor can be electrolytic, ceramic, or tantalum. Using lower values like 2.2uF and 4.7 uF is also possible in most cases.)* -2. For more details, see the `ESP32 Hardware Design Guidelines - `_ in the *Power-on Sequence* section. +For more details, see the `ESP32 Hardware Design Guidelines + `_ in the *Power-on Sequence* section. Hardware -------- From f86bc803ea176b237f0da85644da3074d24411bd Mon Sep 17 00:00:00 2001 From: Sagar Date: Sat, 24 Jul 2021 11:17:00 +0530 Subject: [PATCH 7/9] Update troubleshooting.rst * USB Driver download link added. * Link changed for the "ESP32 Hardware Design Guidelines" according to the RST format. --- docs/source/troubleshooting.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index c036ce6c806..7f261656789 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -27,13 +27,12 @@ Flashing 1. To automatically get into the flashing mode, you have to connect a **10 uF** capacitor between the **EN** and **GND** pins. This capacitor value could be lower (> 2.2 uF) if you don't have this part available. **EN <----||---- GND.** *(The capacitor can be electrolytic, ceramic, or tantalum. Using lower values like 2.2uF and 4.7 uF is also possible in most cases.)* -For more details, see the `ESP32 Hardware Design Guidelines - `_ in the *Power-on Sequence* section. +For more details, see the `ESP32 Hardware Design Guidelines `_ in the *Power-on Sequence* section. Hardware -------- * Power Source. * Bad/damaged USB cable or charging only cables (without data wires). -* USB drivers missing. **Download link:** https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers +* USB drivers missing. - `USB Driver Download Link `_ * Board with some defect. From cbf1001985ddecc9f81f2fbaa111c0112212e615 Mon Sep 17 00:00:00 2001 From: Sagar Date: Mon, 26 Jul 2021 20:22:34 +0530 Subject: [PATCH 8/9] Update troubleshooting.rst * Updated the format. * USB Driver Download Link. --- docs/source/troubleshooting.rst | 36 ++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index 7f261656789..ad422f30355 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -18,21 +18,37 @@ Building Flashing -------- -*Here are some of the tips if The board is not flashing..* +Why is my board not flashing/uploading when I try to upload my sketch? +********************************************************************** +If you are trying to upload a new sketch and your board isn't responding, there are some possible reasons. +To be able to upload the sketch via serial interface, the ESP32 must be in the download mode. The download mode allows you to upload the sketch over the serial port and to get into it, you need to keep the **GPIO0** in LOW while a resetting (**EN** pin) cycle. + +Possible fatal error message from the Arduino IDE: + + *A fatal error occurred: Failed to connect to ESP32: Timed out waiting for packet header* + +Here are some steps that you can try to: + +* Check your USB cable and try a new one. +* Change the USB port. +* Check your power supply. * In some instances, you must keep **GPIO0** LOW during the uploading process via serial interface. * Hold-down the **“BOOT”** button in your ESP32 board while uploading/flashing. -* When trying to upload a new sketch in some ESP32 development boards, the Arduino IDE gives you a fatal error *(i.e A fatal error occurred: Failed to connect to ESP32: Timed out waiting for packet header)*. This means your ESP32 board is not automatically in the flashing/uploading mode. -**Solution:** -1. To automatically get into the flashing mode, you have to connect a **10 uF** capacitor between the **EN** and **GND** pins. This capacitor value could be lower (> 2.2 uF) if you don't have this part available. **EN <----||---- GND.** *(The capacitor can be electrolytic, ceramic, or tantalum. Using lower values like 2.2uF and 4.7 uF is also possible in most cases.)* - -For more details, see the `ESP32 Hardware Design Guidelines `_ in the *Power-on Sequence* section. +In some development boards, you can try adding the reset delay circuit, as decribed in the *Power-on Sequence* section on the `ESP32 Hardware Design Guidelines `_ in order to get into the download mode automatically. Hardware -------- -* Power Source. -* Bad/damaged USB cable or charging only cables (without data wires). -* USB drivers missing. - `USB Driver Download Link `_ -* Board with some defect. +Why is my computer not detecting my board? +************************************************** + +If your board is not detected after connecting into the USB, you can try to: + +* Check if the USB driver is missing. - `USB Driver Download Link `_ +* Check your USB cable and try a new one. +* Change the USB port. +* Check your power supply. +* Check if the board is damaged or defective. + From 9ba7cfcc2dc13b76153a27a51d76ff07cdee370a Mon Sep 17 00:00:00 2001 From: Sagar Date: Mon, 26 Jul 2021 22:05:22 +0530 Subject: [PATCH 9/9] Update troubleshooting.rst --- docs/source/troubleshooting.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index ad422f30355..f2398502ef8 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -51,4 +51,3 @@ If your board is not detected after connecting into the USB, you can try to: * Change the USB port. * Check your power supply. * Check if the board is damaged or defective. -