Emphasize that IO functions take Arduino pin numbers #516
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's fairly common for users dabbling with bare microcontroller chips (e.g. "Arduino on a breadboard") to think that they can pass either the port/bit pin notation (e.g. PB5) or physical chip pin numbers to the Arduino IO functions. These changes are intended to emphasize that these functions only accept Arduino pin numbers as their pin parameter, without complicating the documentation for the users of standard Arduino boards.
|
Thanks, per! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's fairly common for users dabbling with bare microcontroller chips (e.g. "Arduino on a breadboard") to think that they can pass either the port/bit pin notation (e.g. PB5) or physical chip pin numbers to the Arduino IO functions.
These changes are intended to emphasize that these functions only accept Arduino pin numbers as their pin parameter, without complicating the documentation for the users of standard Arduino boards.
I'd like to eventually add a simple explanation of Arduino pin numbers to the "Digital Pins" tutorial, and perhaps the "Analog Pins" tutorial as well.
Reference:
Related: