Incorrect information re: SoftwareSerial RX pins #291
Labels
topic: documentation
Related to documentation for the project
type: imperfection
Perceived defect in any part of project
Describe the problem
Information about which pins can be used as RX is provided in a comment in the "SoftwareSerial" library's example sketch:
ArduinoCore-renesas/libraries/SoftwareSerial/examples/SerialEcho/SerialEcho.ino
Lines 3 to 5 in b5a3b9d
From experimentation with the UNO R4 Minima and WiFi boards, I found some of this information to be incorrect.
UNO R4 Minima
🐛 Pins
12
and13
can be used, yet these are not mentioned.🐛 The claim is made that pin
14
can be used, yet this pin does not work as RX.UNO R4 WiFi
🐛 Pins
6
,11
, and12
can be used, yet these are not mentioned.🐛 The claim is made that pin
14
can be used, yet this pin does not work as RX.General
🐛 Pin
15
is mentioned explicitly. This is the same pin asA1
, which is also mentioned explicitly. Although not incorrect, this is inconsistent (and therefore confusing to the user) since the same redundant approach is not done for pins16
(A2
)-19
(A5
).To reproduce
UNO R4 Minima
Hello to RX pin 12
" is printed in Serial Monitor, indicating that pin can be used as RX even though the comment in the example says otherwise.byte RxPin = 13;
🐛 The message "
Hello to RX pin 12
" is printed in Serial Monitor, indicating that pin can be used as RX even though the comment in the example says otherwise.14
).byte RxPin = 14;
🐛 The message "
Hello to RX pin 14
" is not printed in Serial Monitor, indicating that pin can not be used as RX even though the comment in the example says otherwise.UNO R4 WiFi
Hello to RX pin 6
" is printed in Serial Monitor, indicating that pin can be used as RX even though the comment in the example says otherwise.byte RxPin = 11;
🐛 The message "
Hello to RX pin 11
" is printed in Serial Monitor, indicating that pin can be used as RX even though the comment in the example says otherwise.🐛 The message "
Hello to RX pin 12
" is printed in Serial Monitor, indicating that pin can be used as RX even though the comment in the example says otherwise.14
).byte RxPin = 14;
🐛 The message "
Hello to RX pin 14
" is not printed in Serial Monitor, indicating that pin can not be used as RX even though the comment in the example says otherwise.Expected behavior
Information in example sketch comments is correct.
Since it is likely not feasible for Arduino to maintain multiple copies of this documentation, I would recommend replacing the information in the example with a link to the documentation for the SoftwareSerial library:
https://docs.arduino.cc/learn/built-in-libraries/software-serial/
(I am working to add this information to that documentation: arduino/docs-content#1884)
"Arduino Renesas fsp Boards" version
b5a3b9d
Additional context
I did not investigate the situation with Portenta C33 due to not having access to that hardware, but from the results of the other boards I suspect that the information is also incorrect for this board.
Additional reports
The text was updated successfully, but these errors were encountered: