Skip to content

add documentation for the advanced configuration option 'enable_lwip_tcp_sack' #5234

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

add documentation for the advanced configuration option 'enable_lwip_tcp_sack' #5234

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions components/esp32.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
Copy link

Choose a reason for hiding this comment

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

The documentation should mention that the option is framework-dependent (only applies when using esp-idf)

Copy link
Contributor Author

@RubenKelevra RubenKelevra Aug 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Ah, yeah, sorry forgot that.

The other lwip options should get the same treatment, though.

Copy link

Choose a reason for hiding this comment

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

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.


Some options can be disabled to save flash memory without affecting typical ESPHome functionality. The performance
options (defaulting to ``true``) improve socket operation performance but can be disabled if you need better
Expand Down