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: refine some details on GPIOs and GP timers #1740

Closed
wants to merge 3 commits into from

Conversation

stefanct
Copy link
Contributor

@stefanct stefanct commented Mar 18, 2018

While working on my first ESP32 project (a bit-banging UART driver) I have noticed some points in the IDF documentation that could be improved. See individual commit messages for details please.

On most microcontrollers I have worked with one can retrieve the
current state of output GPIO pins. On ESP32 this is not the case
if the pad is not explictly configured to route this information into
the port by configuring it as input or i/o.
Thus add a warning to the API documentation of gpio_get_level().
@CLAassistant
Copy link

CLAassistant commented Mar 18, 2018

CLA assistant check
All committers have signed the CLA.

@stefanct
Copy link
Contributor Author

The table on the bottom of the CLA is broken (and a bit superfluous IMHO) btw.

@stefanct stefanct changed the title docs: add warning to gpio_get_level() docs: refine some details on GPIOs and GP timers Mar 18, 2018
@igrr igrr added the Status: Pending blocked by some other factor label Mar 19, 2018
@igrr
Copy link
Member

igrr commented Mar 19, 2018

Thanks for the PR @stefanct, I've put these changes into the merge queue.

igrr pushed a commit that referenced this pull request Mar 20, 2018
On most microcontrollers I have worked with one can retrieve the
current state of output GPIO pins. On ESP32 this is not the case
if the pad is not explictly configured to route this information into
the port by configuring it as input or i/o.
Thus add a warning to the API documentation of gpio_get_level().

Merges #1740
igrr pushed a commit that referenced this pull request Mar 20, 2018
Replace c&p text with an actual description.

Merges #1740
igrr pushed a commit that referenced this pull request Mar 20, 2018
@igrr
Copy link
Member

igrr commented Mar 20, 2018

@stefanct Cherry-picked into master, thanks!

@igrr igrr closed this Mar 20, 2018
@igrr igrr removed the Status: Pending blocked by some other factor label Aug 9, 2018
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.

None yet

3 participants