Document special upload procedure in UNO R4 WiFi HID tutorial #1246
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
The sentence doesn't offer anything of value and creates an unnecessary dependence between the section that contains it and those that follow, making it difficult to add new content.
When an UNO R4 WiFi board is running a sketch that uses the HID capabilities, the port address changes during the upload. Since this change does not occur under other conditions, the platform is not configured to handle such a change. This causes uploads via the standard procedure to fail under these conditions. Since adjusting the configuration to allow reliable uploads under any conditions would have harmful side effects, the decision was made to leave the configuration as it is now. The upload can be accomplished reliably if the user performs a double reset before uploading, but this fact was not documented in the tutorial about the board's HID capabilities. The missing documentation is hereby added to the tutorial.
per1234
added
bug
jacobhylen
approved these changes
Aug 4, 2023
There was a problem hiding this comment.
Hi @per1234!
Thank you for this PR. Funny enough, I was just about to make a change addressing the same issue, so I find this very convenient 😄
LGTM!
6 tasks
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
When an UNO R4 WiFi board is running a sketch that uses the HID capabilities, the port address changes during the upload. Since this change does not occur under other conditions, the platform is not configured to handle such a change. This causes uploads via the standard procedure to fail under these conditions (arduino/ArduinoCore-renesas#73). Since adjusting the configuration to allow reliable uploads under any conditions would have harmful side effects, the decision was made to leave the configuration as it is now:
arduino/ArduinoCore-renesas#74 (comment)
The upload can be accomplished reliably if the user performs the "manual" procedure mentioned above, but this fact is not documented in the tutorial about the board's HID capabilities.
This pull request proposes to add the documentation of this important procedure to the to the tutorial.
Contribution Guidelines