Skip to content

ESP32S2: Add Readme #3417

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

Merged
merged 3 commits into from
Sep 17, 2020
Merged

ESP32S2: Add Readme #3417

merged 3 commits into from
Sep 17, 2020

Conversation

hierophect
Copy link
Collaborator

This PR adds a Readme to the ESP32-S2 port, containing information on how to connect, build, flash and debug ESP32-S2 development boards.

Added partially as an extension to #3392, since the configuration files for OpenOCD are presumably GPL and can't be included in the port, so I've documented how to find and modify them yourself. Also includes notes about flashing on Mac OSX figured out by folks on the discord.

@hierophect hierophect added the espressif applies to multiple Espressif chips label Sep 14, 2020
@hierophect hierophect requested a review from tannewt September 14, 2020 17:39
jerryneedell
jerryneedell previously approved these changes Sep 14, 2020
Copy link
Collaborator

@jerryneedell jerryneedell left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks. I have not tried the OCD configuration myself. Looking forward to trying it.

@hierophect
Copy link
Collaborator Author

(I was a little confused that the top level makefile only generates documentation.)

No problem, anything else that was confusing as a first-time port builder? Would like to make this accessible as possible.

@julianrendell
Copy link

(I was a little confused that the top level makefile only generates documentation.)

No problem, anything else that was confusing as a first-time port builder? Would like to make this accessible as possible.

Over all, very impressed - better than what I got to see over peoples shoulder 10 years ago from commercial vendors (worked adjacent to base port devs.) it would be helpful to have a few short readme files sprinkled around in the HAL, binding, driver directories for both the shares and port directories. I imagine if you’ve seen a BSP package before/HAL abstractions it might be a different kind of confusing due to some of it being for python bindings.

@tannewt
Copy link
Member

tannewt commented Sep 16, 2020

Over all, very impressed - better than what I got to see over peoples shoulder 10 years ago from commercial vendors (worked adjacent to base port devs.) it would be helpful to have a few short readme files sprinkled around in the HAL, binding, driver directories for both the shares and port directories. I imagine if you’ve seen a BSP package before/HAL abstractions it might be a different kind of confusing due to some of it being for python bindings.

In case you haven't seen, all of the shared-bindings APIs are documented inline in the C source files: https://github.com/adafruit/circuitpython/blob/main/shared-bindings/digitalio/DigitalInOut.c#L46

@julianrendell
Copy link

julianrendell commented Sep 16, 2020

In case you haven't seen, all of the shared-bindings APIs are documented inline in the C source files: https://github.com/adafruit/circuitpython/blob/main/shared-bindings/digitalio/DigitalInOut.c#L46

Thanks @tannewt - I just found that info while looking at RTD/Sphinx doc generation. I seem to be 'gifted' at looking for info in the wrong place... while there are large, blinking, vibrantly coloured signs pointing to it over there.

@fede2cr
Copy link

fede2cr commented Sep 16, 2020

Followed the instructions and seem to work fine, as well as the debug stuff which I've never done before.
I agree on clarifying the port directory as an instruction.

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

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

Thank you all. Looks like discussion has settled on this PR and it's been tested. So, approving and merging.

@tannewt tannewt merged commit 78338ac into adafruit:main Sep 17, 2020
@hierophect hierophect deleted the esp32s2-readme branch September 17, 2020 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
espressif applies to multiple Espressif chips
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants