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

Add ESP8266 tutorial instructions on entering programming mode #2910

Closed

Conversation

ARF1
Copy link

@ARF1 ARF1 commented Feb 24, 2017

This PR adds to the ESP8266 tutorial instructions on how to enter programming programming mode.

This adds to the ESP8266 tutorial instructions explainung which pins to pull
low to enter programming mode.
@@ -68,6 +68,10 @@ the DTR and RTS pins wired in a special way then deploying the firmware should
be easy as all steps can be done automatically. Boards that have such features
include the Adafruit Feather HUZZAH and NodeMCU boards.

If you do not have such a board, you need keep GPIO0 pulled to ground and reset
the device by pulling REST to ground and releasing it again to enter
Copy link
Contributor

Choose a reason for hiding this comment

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

What is:

REST

?

Copy link
Contributor

Choose a reason for hiding this comment

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

Reset

@pfalcon
Copy link
Contributor

pfalcon commented Feb 25, 2017

So, there's a usual problem: it's definitely better to provide more detailed documentation. But choosing between providing confusing, incomplete, misguiding documentation vs just referring users to external sources of documentation, the latter choice is much better.

In this case: incorrect information is provided on entering a programming mode (well, incomplete, but the outcome for a user is the same - frustration, so anyone assessing the impact of providing incomplete documentation should treat it conservatively as incorrect); (apparently) confusing abbreviation is used for "reset". I can't imagine that someone calling reset a "beach", "sun", or "rest" in their good faith (that's why I write "apparently", I can't believe this happens, maybe I'm missing something). But if it happens, I can't think of other underlying motives for doing so, except to cause confusion. And again, confusion is a precursor of frustration.

tannewt added a commit to tannewt/circuitpython that referenced this pull request May 20, 2020
dpgeorge added a commit that referenced this pull request May 4, 2021
This adds to the ESP8266 tutorial instructions explaining which pins to
pull low to enter programming mode.

Commit made originally by @ARF1 in #2910.

Signed-off-by: Damien George <damien@micropython.org>
@dpgeorge
Copy link
Member

dpgeorge commented May 4, 2021

I think this is a useful addition to the docs.

Merged in 2bf1bee with a minor change to change "REST" to "the reset pin".

Thanks for the contribution!

@dpgeorge dpgeorge closed this May 4, 2021
@ARF1 ARF1 deleted the esp8266_programming_instructions branch May 4, 2021 07:42
ksekimoto pushed a commit to ksekimoto/micropython that referenced this pull request Jul 16, 2021
This adds to the ESP8266 tutorial instructions explaining which pins to
pull low to enter programming mode.

Commit made originally by @ARF1 in micropython#2910.

Signed-off-by: Damien George <damien@micropython.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants