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 alias board.STEMMA_I2C for all boards with qwiic/stemma/QT #5966

Merged
merged 1 commit into from
Feb 2, 2022

Conversation

Neradoc
Copy link

@Neradoc Neradoc commented Feb 2, 2022

This aliases board.I2C and board.STEMMA_I2C on all boards where they are on the same pins. Meaning they both return the same singleton object. I went through the whole list on circuitpython.org, hopefully I didn't make too many mistakes.
I'm a little worried it might be confusing though. Documentation and guides will have to clarify when I2Cand STEMMA_I2C are the same and when they are not.
Note that one sparkfun board already also had a board.QWIIC alias.
Final step for #4638 ?

@dhalbert
Copy link
Collaborator

dhalbert commented Feb 2, 2022

@kattni What do you think about whether board.STEMMA_I2C should exist on boards where board.I2C and board.STEMMA_I2C are the same?

@dhalbert dhalbert requested a review from kattni February 2, 2022 15:24
@dhalbert
Copy link
Collaborator

dhalbert commented Feb 2, 2022

@kattni What do you think about whether board.STEMMA_I2C should exist on boards where board.I2C and board.STEMMA_I2C are the same?

@ladyada: same q for you.

@kattni
Copy link

kattni commented Feb 2, 2022

@dhalbert I want to see this happen. Consistency is important, and if we have it on the boards that use SCL1/SDA1, I think having it on all boards would work. We can document that it's an alias if that is desired, but I would love to see this across all boards.

Copy link
Collaborator

@dhalbert dhalbert 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 for doing this extensive inventory!

@dhalbert
Copy link
Collaborator

dhalbert commented Feb 2, 2022

@dhalbert I want to see this happen. Consistency is important, and if we have it on the boards that use SCL1/SDA1, I think having it on all boards would work. We can document that it's an alias if that is desired, but I would love to see this across all boards.

OK, sounds good! I was not sure if there were hidden considerations. It will certainly make Learn Guide code easier. @ladyada -- I will not wait for your reply.

@dhalbert dhalbert merged commit a04cd64 into adafruit:main Feb 2, 2022
@ladyada
Copy link
Member

ladyada commented Feb 2, 2022

yes please have it point to the same if they're the same!

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.

4 participants