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.

Sign up for GitHub

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

Jump to bottom

Doc update: Troubleshooting + SD libs #8241

Merged
merged 19 commits into from
Aug 30, 2023
Merged

Doc update: Troubleshooting + SD libs #8241

merged 19 commits into from
Aug 30, 2023

Conversation

PilnyTomas
Copy link
Contributor

@PilnyTomas PilnyTomas commented May 23, 2023 •
edited
Loading

Troubleshooting:

SD libraries updates:
SD_MMC_Test.ino - added hint to read README
SD_MMC/README.md - new file, partially based on IDF example
SD/README.md - extended

Minor updates:

  • cdc_dfu_flash.rst - removed extra "it"
  • io_mux.rst - added note about pins used for SPI flash
  • SD_MMC.cpp - typo fix

@PilnyTomas PilnyTomas self-assigned this May 23, 2023
@PilnyTomas PilnyTomas marked this pull request as draft May 23, 2023 15:17
@PilnyTomas PilnyTomas added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label May 23, 2023
@PilnyTomas PilnyTomas marked this pull request as ready for review May 30, 2023 15:20
@PilnyTomas PilnyTomas changed the title Draft - Doc update Doc update: Troubleshooting + SD libs May 31, 2023
@VojtechBartoska VojtechBartoska requested review from P-R-O-C-H-Y and removed request for me-no-dev May 31, 2023 12:14
@PilnyTomas PilnyTomas mentioned this pull request Jun 8, 2023
Closed
pedrominatel
pedrominatel reviewed Jun 12, 2023
View reviewed changes
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.

PTAL @PilnyTomas

docs/source/troubleshooting.rst Outdated
* Check your power supply.
* Make sure that nothing is connected to pins labeled **TX** and **RX**.
Copy link
Member

Choose a reason for hiding this comment

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

Please mention checking the pin layout table in order to make sure the GPIOs numbers are.

docs/source/troubleshooting.rst Outdated
* Hold down the **“BOOT”** button in your ESP32 board while uploading/flashing.
* Hold down the **“BOOT”** button on your ESP32 board while uploading/flashing.
* Solder a **10uF** capacitor in parallel with **RST** and **GND**.
* If you bought your dev board from a questionable seller, they might have scammed you and sent ESP8266 instead of ESP32.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is relevant or should be mentioned in this document.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

do you mean only the last one, or the capacitor too?

Copy link
Member

Choose a reason for hiding this comment

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

I mean the sentence about questionable sellers. This must be removed.

docs/source/troubleshooting.rst Outdated

[ 1065][E][sd_diskio.cpp:807] sdcard_mount(): f_mount failed: (3) The physical drive cannot work

Most of the problems originate from a poor connection caused by Dupont cables, and one of the best solutions is to **solder all the connections** or use good quality connectors.
Copy link
Member

Choose a reason for hiding this comment

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

Dupont cables -> prototyping cables/wires

docs/source/tutorials/cdc_dfu_flash.rst Outdated Show resolved Hide resolved
libraries/SD/README.md Outdated Show resolved Hide resolved
libraries/SD_MMC/README.md

No, just wire your SD card directly to ESP32.

Tip: If you are using a microSD card and have a spare adapter to full-sized SD, you can solder Dupont pins on the adapter.
Copy link
Member

Choose a reason for hiding this comment

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

Dupont -> wires

Copy link
Contributor Author

@PilnyTomas PilnyTomas Jun 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I'm trying to describe this... not really wires... IMG_20230615_144850_926

Copy link
Member

Choose a reason for hiding this comment

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

This is called a 'pin header'.

Copy link
Member

Choose a reason for hiding this comment

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

To be more accurate, '2.54mm pin header'.

libraries/SD_MMC/README.md Outdated Show resolved Hide resolved
@PilnyTomas PilnyTomas mentioned this pull request Jun 15, 2023
Merged
pedrominatel
pedrominatel approved these changes Jun 26, 2023
View reviewed changes
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.

LGTM

@VojtechBartoska VojtechBartoska added the Status: Pending Merge Pull Request is ready to be merged label Jun 26, 2023
@VojtechBartoska
Copy link
Contributor

can be merged @me-no-dev

@PilnyTomas PilnyTomas mentioned this pull request Jul 4, 2023
Closed
@P-R-O-C-H-Y P-R-O-C-H-Y added this to the 2.0.12 milestone Aug 23, 2023
P-R-O-C-H-Y
P-R-O-C-H-Y requested changes Aug 24, 2023
View reviewed changes
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

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

Just 2 small typos, else LGTM!

docs/source/tutorials/io_mux.rst Outdated Show resolved Hide resolved
libraries/SD/README.md Outdated Show resolved Hide resolved
@P-R-O-C-H-Y
Copy link
Member

@PilnyTomas Can you please fix those 2 typos so this can be merged? Thanks :)

P-R-O-C-H-Y
P-R-O-C-H-Y approved these changes Aug 30, 2023
View reviewed changes
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

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

LGTM

@me-no-dev me-no-dev merged commit 6bdef28 into espressif:master Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@P-R-O-C-H-Y P-R-O-C-H-Y P-R-O-C-H-Y approved these changes

@pedrominatel pedrominatel pedrominatel approved these changes

@me-no-dev me-no-dev Awaiting requested review from me-no-dev

Assignees

@PilnyTomas PilnyTomas

Labels
Status: Pending Merge Pull Request is ready to be merged Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
Arduino ESP32 Core Project Roadmap
Status: Done
Milestone
2.0.12
Development

Successfully merging this pull request may close these issues.

Failed to connect to ESP32: Timed out waiting for packet header
5 participants
@PilnyTomas @VojtechBartoska @P-R-O-C-H-Y @pedrominatel @me-no-dev