Read from read loop remove generator logic#228
Merged
brianignacio5 merged 6 commits intomainfrom Jan 15, 2026
Merged
Conversation
|
Download the artifacts for this pull request: |
This was referenced Dec 16, 2025
|
can confirm fixed on Chrome Version 143.0.7499.110 |
|
yeah seems fine on an s2 with same chrome version win11. |
Contributor
|
I tried this patch on my problem ESP32-S3. Unfortunately, it does not work. The failure is that the code fails to detect the S3s entry to Waiting for download state, even though the S3 really did enter that state and issued the appropriate message. Then the serial port gets a bunch of Buffer Overflows and never recovers. I think it is a race condition between the serial port setup and the timing of the messages. This branch https://github.com/MitchBradley/esptool-js/tree/timedRead works with all of the ESP32s and ESP32-S3s that I have tested so far. Every read goes through a low-level "timedRead()" function whose timeout ensures that the reader cannot stay locked forever. It retries all possible non-fatal errors that cause the loss of the reader, by getting a new reader per the example code in core WebSerial documentation. Fatal errors that cannot be recovered cause a throw. The SLIP reader and a new "readLine(timeout)" function are built on top of a buffering layer that sits above timedRead(). readLine() is used for parsing/detecting the entry to download mode, thus avoiding a regex that spans multiple lines, and avoiding the possible race condition when those initial bytes were read all at once. |
Collaborator
Author
|
Hi @MitchBradley Could you share which board are you using ? Using ESP32-S3-DevKitC-1 seems to work for me with this branch but maybe 3rd party boards would work differently. Also does it happen when using baud rate 115200 ? Your approach is closer to the previous implementation without async generators which is cool but I have no way to test these changes unfortunately as I can't reproduce myself with Espressif boards. |
|
@brianignacio5 Do you need any testing of this PR to help it move along? Without this merged, we are seeing reliability issues with Esptool-js. |
* New types for stopbits and databits * readLoop retries on recoverable errors instead of failing
brianignacio5
force-pushed
the
enhance/readFromSerial
branch
from
1d31e27 to
377281e
Compare
Collaborator
Author
|
Hi @brentru Yes I would appreciate someone testing this PR, since it is just me pushing these changes to the repository. |
|
@brianignacio5 Okay, @tyeth or I can take a look at this next week |
|
Appears to resolve the HuzzahV1 installer issue we were seeing, where it stalled on Loading esptool stub (at 115k baud) Win11. |
|
A new error was encountered, during the write, Details with debug trace - failed at 75% of first file write (always seq 46)
|
Appears resolved after changing our file firmware formats (passing through esploader.bstrToUi8) and updating the calculateMD5Hash function in line with #226 |
|
@tyeth So the PR is OK and @brianignacio5 can move forward with merging? |
Yeah looks good. Just the minor turbulence with the format reshuffle. @brianignacio5 ok to release, but probably worth noting the Uint8Array and calculateMD5Hash change in release notes. Tested on: |
Collaborator
Author
|
Thanks for the review @tyeth ! |
This was referenced Jan 15, 2026
3 tasks
3 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Fix #224
Description
Using yield and async generator is not efficient logic for reading the serial port.
This PR introduces
readloopas an always reading to a buffer and SLIP parsing from buffer. Seems to be more reliable.This pull request refactors the serial communication logic to simplify data reading and improve reliability. The main changes focus on removing asynchronous generators in favor of simpler async functions, introducing a new
sleeputility, and enhancing debugging and buffer management. The updates affect both theesploader.tsandwebserial.tsfiles, resulting in more maintainable and understandable code.Serial Communication Refactor:
Transportwith a simpler async function, removingnewReadand generator-basedreadLoop. The newreadmethod now waits for data with a timeout and processes available bytes in a straightforward loop. (src/webserial.ts) [1] [2]transport.read().next()andtransport.newRead()inESPLoaderto use the newtransport.read()interface, simplifying packet reading and improving consistency. (src/esploader.ts) [1] [2] [3] [4]Utility and Buffer Management:
sleeputility function inutil.tsand replaced all internal_sleepusages with this shared function. (src/util.ts,src/esploader.ts,src/webserial.ts) [1] [2] [3] [4]peek()method toTransportfor safely inspecting the buffer contents without consuming data, improving boot log detection logic. (src/webserial.ts,src/esploader.ts) [1] [2]Debugging and Logging Enhancements:
src/esploader.ts) [1] [2]Bug Fixes and Logic Improvements:
src/webserial.ts) [1] [2] [3]src/esploader.ts)These changes collectively make the serial communication code easier to understand, more robust, and better suited for debugging and extension.
Testing
Manual testing using
examples/typescriptcommands.Checklist
Before submitting a Pull Request, please ensure the following: