Skip to content

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

Merged
merged 4 commits into from
Jul 2, 2025

Conversation

jkoeppeler
Copy link
Contributor

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.

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.
@jkoeppeler jkoeppeler changed the title schmatic.md: UART_TX and UART_RX pins are falsy labled schmatic.md: UART_TX and UART_RX pins are falsely labled Jan 30, 2025
@sagrawal-mips
Copy link

sagrawal-mips commented Jul 2, 2025

@microbit-carlos Can you please merge this pull request? This will help us new folks a lot.

@microbit-carlos
Copy link
Contributor

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.

image

image

I know this is unfortunate, as the majority of developers will look at these signals from the perspective of the Target MCU.
We've taken this as a lesson learned, and in the future we'll use longer and more clear names, like UART_INT_TARGET_TX_INTERFACE_RX, but for the time being is better to keep the references in sync between the schematic and the docs.

That being said, we should definitely add a note!
@jkoeppeler or @sagrawal-mips would you be happy to add a * next to the pin names and a clarification below the table?

@jkoeppeler
Copy link
Contributor Author

@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.
And thanks a lot for the clarification on that issue.

@microbit-carlos
Copy link
Contributor

Thanks @jkoeppeler!
I think the markdown parser might drop the * if they are placed on their own, maybe it'll work better adding backticks like this: `*`

@@ -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.
Copy link
Contributor

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?

Copy link
Contributor Author

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.

Copy link
Contributor

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

Copy link
Contributor

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!

Copy link
Contributor Author

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 :)

Copy link
Contributor

@microbit-carlos microbit-carlos left a 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!

@microbit-carlos microbit-carlos merged commit b396182 into microbit-foundation:master Jul 2, 2025
@jkoeppeler
Copy link
Contributor Author

Thanks a lot @microbit-carlos @sagrawal-mips

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.

3 participants