-
Notifications
You must be signed in to change notification settings - Fork 77
schmatic.md: UART_TX and UART_RX pins are falsely labled #402
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
schmatic.md: UART_TX and UART_RX pins are falsely labled #402
Conversation
According to this commit message ( nrf-rs/microbit@10484c6 ) and testing this myself, the pins are falsely labeled. The RX pin should be TX and vice versa.
@microbit-carlos Can you please merge this pull request? This will help us new folks a lot. |
These are the docs for the schematic, and so they follow the naming convention used there, which in this case present the internal UART from the perspective of the Interface chip. ![]() ![]() I know this is unfortunate, as the majority of developers will look at these signals from the perspective of the Target MCU. That being said, we should definitely add a note! |
@microbit-carlos @sagrawal-mips I updated the description and added the footnote. Let me know if you like it, or if I should change it. |
Thanks @jkoeppeler! |
hardware/schematic.md
Outdated
@@ -75,6 +75,8 @@ Below is the pinmap and allocation of the nRF52833, more information is availabl | |||
| P0.31 | COL3 | N | P3 | | |||
| P0.30 | COL5 | N | P10 | | |||
|
|||
[^*]: These names follow the schematic's naming convention, labeled from the interface's perspective, not the target MCU's. So, UART_INT_TX corresponds to the MCU's RX pin, and UART_INT_RX to the MCU's TX pin. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@microbit-robert do you know if the current Markdown parser for the Tech Site Jekyll builds (is it still using Jekyll?) accepts the footnotes notation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah I just tried it, and it places the footnote at the end of the page, which I don't like. I will change to the *
as you suggested as its the better way I guess.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like we are using kramdown
and that should work:
https://stackoverflow.com/a/19507591
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah I just tried it, and it places the footnote at the end of the page, which I don't like. I will change to the * as you suggested as its the better way I guess.
Ah, good point, thanks for checking, I agree it's better with the note below the table!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just let me know if there's anything left or requires changes. Happy to apply them :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect, thanks @jkoeppeler!
And thanks @sagrawal-mips for the ping as well!
Thanks a lot @microbit-carlos @sagrawal-mips |
According to this commit message ( nrf-rs/microbit@10484c6 ) and testing this myself, the pins are falsely labeled. The RX pin should be TX and vice versa.