Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Updated Troubleshooting file #5430

Merged
merged 13 commits into from
Jul 26, 2021
Merged

Conversation

Sagar73594
Copy link
Contributor

  • Added some useful troubleshooting tips.
  • Fixed a Typo.
  • Added some needed points.

Added some useful tips for flashing/programming troubleshooting.
Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some suggestions. Please take a look @Sagar73594

@pedrominatel pedrominatel changed the title Updated Troubleshooting file. (arduino-esp32/docs/source/troubleshooting.rst) Doc: Updated Troubleshooting file Jul 21, 2021
@pedrominatel pedrominatel added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Jul 21, 2021

* 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More nitpicking

@pedrominatel
Copy link
Member

Just to make it clear, the "issue" on getting into the download mode is dependent of the development board. The hardware guide recommends adding the RC delay circuit.

@Sagar73594
Copy link
Contributor Author

I made some suggestions. Please take a look @Sagar73594

Thanks for pointing it out.

Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace the text.

@Sagar73594
Copy link
Contributor Author

@pedrominatel I have attached a screenshot. Can you suggest to me, why it doesn't look formated as something like that.
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 Power-on Sequence section.

Screenshot 2021-07-23 154223

@pedrominatel
Copy link
Member

@pedrominatel I have attached a screenshot. Can you suggest to me, why it doesn't look formated as something like that.
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 Power-on Sequence section.

Screenshot 2021-07-23 154223

Are you building the docs using make html? If so, just remove the line break after Guidelines

* USB Driver download link added.
* Link changed for the "ESP32 Hardware Design Guidelines" according to the RST format.
@Sagar73594
Copy link
Contributor Author

@pedrominatel I have removed the line break after Guidelines. Is This okay?
Capture

@pedrominatel
Copy link
Member

Hi @Sagar73594. In order to get your PR merged, we need to change the format of this troubleshooting as the following.

troubleshooting.rst.txt

Copy link
Contributor Author

@Sagar73594 Sagar73594 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sagar73594. In order to get your PR merged, we need to change the format of this troubleshooting as the following.

troubleshooting.rst.txt

Changed.


* 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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just replace the old text in the line 25 to the new one (my comment).

Done.

@me-no-dev me-no-dev merged commit d5a98f9 into espressif:master Jul 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants