[sntp]: document change in behaviour for ESP8266 and ESP32 #5276
+4
−4
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
Signed-off-by: Felix Kaechele <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR documents a change in behavior for the SNTP component's on_time_sync trigger, specifically clarifying that the limitation where the trigger fires only once when the system clock is set now applies only to platforms other than ESP8266 and ESP32.
- Updated warning message in SNTP documentation to specify platform-specific behavior
- Adjusted general time component documentation to reflect the conditional nature of SNTP's behavior
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| content/components/time/sntp.md | Updated warning to specify that the on_time_sync limitation applies only to non-ESP8266/ESP32 platforms |
| content/components/time/_index.md | Modified note to clarify that SNTP's behavior of triggering when other components change time is conditional |
15 tasks
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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:
Clarify new behaviour of SNTP
on_time_syncfor ESP8266 and ESP32.Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
on_time_syncfor ESP32 and ESP8266 esphome#10390Checklist:
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.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
COMPONENT_NAMEwith your component name in UPPER_CASE format with underscores (e.g.,BME280,SHT3X,DALLAS_TEMP):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/folder of this repository.Use the image in your component's index table entry in
/components/index.rst.Example: For a component called "DHT22 Temperature Sensor", use: