Skip to content
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

Clarifying documentation in USART chapter. #565

Merged
merged 1 commit into from
Apr 18, 2024

Conversation

skoocda
Copy link
Contributor

@skoocda skoocda commented Apr 18, 2024

This is a small change.

I was running into issues with serial comms not coming back from my microcontroller, despite verifying that OpenOCD, itmdump, minicom/PuTTY were working correctly, and the actual pin selection was correct for my board revision.

It turns out I had misinterpreted this line in 11-usart/README.md:

Everything is already wired on the board so you don't need to wire anything yourself.

I understood this as a continuation of 10-serial-communication/loopbacks.md, where I had just shorted the PC4 and PC5 pins. I thought "already wired" meant that the PC4-PC5 wire was necessary. This loopback, of course, ends up breaking the Virtual COM Port.

I've added a couple additional lines to ensure others don't run into this same issue, by clarifying the need to remove the wires that were just added.

This could alternatively be updated in loopbacks.md, by introducing a line such as:

Ensure you remove the PC4-PC5 wire before proceeding to the next section.

@skoocda skoocda requested a review from a team as a code owner April 18, 2024 03:07
Copy link
Member

@eldruin eldruin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for fixing this!

@eldruin eldruin enabled auto-merge April 18, 2024 07:19
@eldruin eldruin added this pull request to the merge queue Apr 18, 2024
Merged via the queue into rust-embedded:master with commit 6cc8c29 Apr 18, 2024
17 checks passed
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.

2 participants