add documentation for the advanced configuration option 'enable_lwip_tcp_sack' #5234
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
15 tasks
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
kepstin
reviewed
Aug 13, 2025
| @@ -161,6 +161,8 @@ LWIP (Lightweight IP) behavior. Some options improve performance while others sa | |||
| improves socket operation performance by 20-200% but may reduce multi-threaded scalability. Defaults to ``true``. | |||
| - **enable_lwip_check_thread_safety** (*Optional*, boolean): Enable LWIP thread safety checks to detect incorrect usage of | |||
| the TCP/IP stack from multiple threads. This helps catch thread safety issues when core locking is enabled. Defaults to ``true``. | |||
| - **enable_lwip_tcp_sack** (*Optional*, boolean): Enable TCP selective acknowledgments | |||
| to improve performance on lossy or high latency networks. Defaults to ``true``. | |||
There was a problem hiding this comment.
The documentation should mention that the option is framework-dependent (only applies when using esp-idf)
There was a problem hiding this comment.
Ah, yeah, sorry forgot that.
The other lwip options should get the same treatment, though.
There was a problem hiding this comment.
Actually, never mind. I was missing that context. The header for the entire LWIP options section already says "LWIP Optimization Options (ESP-IDF only):" so there is no need to add notes on the specific options.
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.
Description:
add documentation for the advanced configuration option 'enable_lwip_tcp_sack'
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.