light: document transition_state_publish_interval guidance #5645
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR documents the new transition_state_publish_interval configuration option for the light component, which controls how often state updates are published during transitions and flashes.
Key changes:
- Documents the new configuration option with behavior for
0s(default, no interval publishing) and>0(enables interval publishing) - Provides performance guidance based on ESP8266-class hardware testing, recommending 200-250ms intervals for smooth updates without excessive overhead
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-authored-by: Copilot <[email protected]>
12 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 new
transition_state_publish_intervaloption on the light component.This PR:
transition_state_publish_intervallight configuration option and how0svs>0intervals affect when state is published during transitions and flashes.150msrarely produce smoother visible transitions but can generate a large number of publishes and push the device near its CPU limits.200–250msrange (≈4–5 Hz) are a good default on ESP8266-class devices, balancing smoothness and overhead.These documentation changes introduce and describe the new
transition_state_publish_intervalfeature added in the linked core ESPHome PR, and provide guidance to help users choose practical values fortransition_state_publish_interval.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.