[docs] Document wake_loop_threadsafe() for low-latency background thread events #63
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
✅ Deploy Preview for esphome-dev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for a new feature that allows components to wake the main loop from background threads for low-latency event processing. The feature uses App.wake_loop_threadsafe() to avoid the 0-16ms select() timeout delay.
- Added comprehensive documentation for the
wake_loop_threadsafe()API - Documented platform support (ESP32 ESP-IDF and LibreTiny only)
- Provided setup instructions and usage examples with best practices
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jesserockz
approved these changes
Nov 7, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 does this implement/fix?
Documents the
App.wake_loop_threadsafe()API added in esphome/esphome#11681 for components that need to wake the main loop from background threads/FreeRTOS tasks.Changes
Adds new section to
docs/architecture/components/advanced.md:require_wake_loop_threadsafe())App.wake_loop_threadsafe()from background thread context)Related PRs: esphome/esphome#11681 (implementation), esphome/esphome#11677 (selective waking example)