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 Flex/AnyFlex pin drivers #1659

Merged
merged 2 commits into from
Jun 10, 2024
Merged

Add Flex/AnyFlex pin drivers #1659

merged 2 commits into from
Jun 10, 2024

Conversation

bjoernQ
Copy link
Contributor

@bjoernQ bjoernQ commented Jun 5, 2024

Thank you for your contribution!

We appreciate the time and effort you've put into this pull request.
To help us review it efficiently, please ensure you've gone through the following checklist:

Submission Checklist 📝

  • I have updated existing examples or added new ones (if applicable).
  • I have used cargo xtask fmt-packages command to ensure that all changed code is formatted correctly.
  • My changes were added to the CHANGELOG.md in the proper section.
  • My changes are in accordance to the esp-rs API guidelines

Extra:

Pull Request Details 📖

Description

This adds a Flex/AnyFlex pin driver to fix #740

Testing

The GPIO HIL-test exercises the new driver. Doesn't seem to deserve a dedicated example

Copy link
Member

@MabezDev MabezDev left a comment

Choose a reason for hiding this comment

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

This is excellent, thanks for working on this! Very nice PR.

LGTM!

@jessebraham
Copy link
Member

I think we need much more documentation in this module. Looking at the docs with this branch included:

Screenshot 2024-06-05 at 06 23 40

I can't even imagine trying to figure out which pin type I need as a user who is not familiar with the HAL. I don't even really know what half of these types do, honestly.

@bjoernQ
Copy link
Contributor Author

bjoernQ commented Jun 5, 2024

I can't even imagine trying to figure out which pin type I need as a user who is not familiar with the HAL. I don't even really know what half of these types do, honestly.

I have a few ideas for improving the docs here and also on the "landing page" to help new users to have a smooth(er) start. But well - not in this PR (and we should generally wait for the doc-test PR to land before shuffling around docs I guess)

But it's definitely already much easier than the into_XXX API we had before

@bjoernQ
Copy link
Contributor Author

bjoernQ commented Jun 5, 2024

I think the docs topic touches #742

@MabezDev
Copy link
Member

MabezDev commented Jun 5, 2024

I opened #1660 to track the module level doc improvements

Copy link
Contributor

@JurajSadel JurajSadel left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@bjoernQ bjoernQ added this pull request to the merge queue Jun 10, 2024
Merged via the queue into esp-rs:main with commit b8af240 Jun 10, 2024
29 checks passed
@bjoernQ bjoernQ deleted the flex-pin-driver branch November 26, 2024 08:43
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.

Treat a Gpio pin as either input or output.
4 participants