-
-
Notifications
You must be signed in to change notification settings - Fork 489
Fix corruption of incoming UTF-8-encoded serial data #1758
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
Conversation
This file contains hidden or 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
@kittaakos
kittaakos
added
topic: code
Related to content of the project itself
type: imperfection
Perceived defect in any part of project
labels
Dec 9, 2022
z3bra5hax
z3bra5hax
suggested changes
Dec 9, 2022
Co-authored-by: z3bra <111462146+z3bra5hax@users.noreply.github.com>
z3bra5hax
z3bra5hax
approved these changes
Dec 11, 2022
kittaakos
kittaakos
approved these changes
Dec 12, 2022
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.
3 tasks
per1234
per1234
approved these changes
Dec 13, 2022
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.
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.
Motivation
Fix for #589
Change description
Fix corruption of incoming UTF8-encoded serial data
Other information
Serial data is received in chunks. When a UTF8-encoded symbol is multibyte, it cannot be decoded properly until all the bytes are available. If an attempt at decoding is made, it will fail and the symbol for UTF-8 "Replacement Character" � is inserted into the stream. TextDecoder has a "stream" option to buffer any bytes that cannot be decoded yet, for exactly this reason. This fix creates an instance of TextDecoder which is persistent for the life of the connection, and then uses that decoder with the stream option to decode UTF8-encoded data properly.
Note - this assumes we expect UTF8 encoded data from the serial port. Generally speaking, this happens if we have the sketch editor in UTF8 mode, which appears to be the default, and then UTF8 encoded characters are included in a print() statement.
Reviewer checklist