Add information re: SoftwareSerial pins for all supported boards #1884
Conversation
This file contains 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
per1234
added
fix/update
This was referenced Apr 19, 2024
content/learn/07.built-in-libraries/04.software-serial/software-serial.md
Outdated
Show resolved
Hide resolved
content/learn/07.built-in-libraries/04.software-serial/software-serial.md
Outdated
Show resolved
Hide resolved
per1234
force-pushed
the
all-softwareserial-pins
branch
from
4ccdd9e
to
c3eb74b
Compare
Previously, the information about which pins could be used with the SoftwareSerial library was documented in prose form. Although reasonable in the context of only needing to cover a few boards as was the case at the time the documentation was established, this approach does not scale as it is necessary to add information for more boards over time. For this reason, the information is migrated to a table in preparation for addition of the missing documentation for the newer boards.
Some board names (e.g., "Nano") are potentially ambiguous to the reader. This is avoided without the introduction of verbosity by linking to the specific hardware page.
Since the time the SoftwareSerial library documentation was written, Arduino has created several new products supported by the library. The information about which pins can be used on these board must be documented. After this, the only currently active product with SoftwareSerial library support not included in the table is the Portenta C33. From the information in the library's "SerialEcho" example, it might be inferred that the same limitations as the UNO R4 boards apply to this board as well, but I was not able to verify this due to not having the hardware on hand.
per1234
force-pushed
the
all-softwareserial-pins
branch
from
c3eb74b
to
7b88e86
Compare
|
This looks good to me, however I will leave the approval to the writers in the PX team 🙏🏼 cc @jacobhylen @Hannes7eicher @BenjaminDannegard |
jhansson-ard
requested review from
BenjaminDannegard,
pedromsousalima and
Hannes7eicher
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.
What This PR Changes
Since the time the SoftwareSerial library documentation was written, Arduino has created several new products supported by the library. The information about which pins can be used on these board must be documented.
Although reasonable in the context of only needing to cover a few boards as was the case at the time the documentation was established, the previous prose format of the information does not scale well with the addition of information for more boards. For this reason, the information is migrated to a table.
Contribution Guidelines
Additional Context
Since the website preview system is currently broken, I generated the website locally and took a screenshot of it to provide a preview of how the new content will be rendered:
Despite quite some efforts, I was not able to get transmit working on any pin on the Arduino 101, but I didn't find any information about whether or not that is expected (apart from the statement that the 101's variant of the library is "a work in progress"). For this reason, it would be irresponsible for me to add a claim that any pin can be used as TX on this board so I intentionally left that cell in the table empty.
I was able to verify that receive works as stated.
After this, the only currently active product with SoftwareSerial library support not included in the table is the Portenta C33. I was not able to determine which pins are supported on this board due to not having the hardware on hand. I created an issue to track that task: #1885
Related: