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

docs(esp8266): change boot select pin to IO0 (ESPTOOL-968) #1038

Merged
merged 1 commit into from
Nov 25, 2024

Conversation

chromalock
Copy link
Contributor

@chromalock chromalock commented Nov 24, 2024

Quick background: I am building a simple breakout board for an esp-wroom-02 module, and noticed what seems to be an error in the current esptool.py ESP8266 "Boot Mode Selection" documentation.

Notably, the boot mode documentation lists GPIO0 in some sections correctly, but GPIO9 later in reference to the same thing.

Specifically, it lists GPIO9 as the boot mode selection pin that must be connected to DTR, when both documentation for the esp-wroom-02 module and esp8266EX microcontroller list GPIO0 as the boot mode selection pin.

Hopefully this is not just a misunderstanding with the documentation; I've been searching for that mythical GPIO9 on the esp8266 for a while! 🤣

This change fixes the following bug(s):

Error in the "Boot Mode Selection" documentation for the ESP8266, where it claims GPIO9 is the selection pin instead of GPIO0

I have tested this change with the following hardware & software combinations:

NO TESTING

I have run the esptool.py automated integration tests with this change and the above hardware:

NO TESTING

Copy link

github-actions bot commented Nov 24, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello chromalock, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against c06ce1e

@chromalock chromalock changed the title fix(docs): change esp8266 bootstrapping pin to be IO0 instead of IO9 docs(esp8266): change boot select pin to IO0 Nov 24, 2024
@github-actions github-actions bot changed the title docs(esp8266): change boot select pin to IO0 docs(esp8266): change boot select pin to IO0 (ESPTOOL-968) Nov 24, 2024
Copy link
Collaborator

@peterdragun peterdragun left a comment

Choose a reason for hiding this comment

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

Hi @chromalock
I am sorry for any confusion that this issue caused and thank you for the contribution!
LGTM

@espressif-bot espressif-bot merged commit c06ce1e into espressif:master Nov 25, 2024
13 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants