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

GPIO C-HIDDEN violations #2697

Closed
Tracked by #2492
MabezDev opened this issue Dec 6, 2024 · 4 comments
Closed
Tracked by #2492

GPIO C-HIDDEN violations #2697

MabezDev opened this issue Dec 6, 2024 · 4 comments
Labels
Milestone

Comments

@MabezDev
Copy link
Member

MabezDev commented Dec 6, 2024

  • Things to make private or doc-hidden
    • AlternateFunction
    • Pin trait (anything but number,mask,degrade cannot be called by the user - everything but number + degrade is doc hidden)
    • InputPin trait (all functions are doc-hidden)
    • OutputPin trait (all functions are doc-hidden)
    • AnalogPin (functions are doc-hidden)
    • TouchPin (functions are doc-hidden)
    • GpioRegisterAccess? (doc-hidden, functions are user-callable but should they?)
@bjoernQ
Copy link
Contributor

bjoernQ commented Dec 20, 2024

I'm not sure about hiding the traits anymore - they might be useful to users as trait bounds?

@bjoernQ bjoernQ mentioned this issue Dec 20, 2024
6 tasks
@MabezDev MabezDev added this to the 1.0.0-beta.0 milestone Jan 7, 2025
@bjoernQ
Copy link
Contributor

bjoernQ commented Jan 10, 2025

we still need to agree if we want the mentioned traits to be hidden or not - if not #2856 should be enough to close this

worst case we can just hide them now and see if someone complains - we can make anything public at any point of time later but not the other way around

@bugadani
Copy link
Contributor

bugadani commented Jan 10, 2025

I don't think we want the pin traits hidden - although InputPin and OutputPin are implemented for pretty much all pins except on ESP32, users might need to refer to them still if they create pin drivers hidden behind some abstraction.

GpioRegisterAccess is hidden right now. Other HALs expose the port of the pins, but that isn't terribly useful for us publicly at the moment. We can mark it as unstable I think, but I'm not sure if it needs to be public at all at least initially.

The rest are unstable so I don't care at the moment.

@MabezDev
Copy link
Member Author

I believe this is implemented in #2926

@github-project-automation github-project-automation bot moved this from Todo to Done in esp-rs Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

No branches or pull requests

3 participants