Skip to content

[preferences] Docs for add start poller and stop poller to interval syncer#6310

Open
rwrozelle wants to merge 2 commits intoesphome:nextfrom
rwrozelle:Docs-for-Add-start_poller-and-stop_poller-to-IntervalSyncer
Open

[preferences] Docs for add start poller and stop poller to interval syncer#6310
rwrozelle wants to merge 2 commits intoesphome:nextfrom
rwrozelle:Docs-for-Add-start_poller-and-stop_poller-to-IntervalSyncer

Conversation

@rwrozelle
Copy link
Contributor

Description

Add start_poller() and stop_poller() public methods to IntervalSyncer, allowing users to suspend and resume periodic preference syncing via lambda.

This enables power-saving use cases such as automatic light sleep, where after the initial save of persistently stored data there is no need to continue periodic flash writes. Users can stop the syncer after boot and restart it only when needed.

Example usage:

on_boot:
  then:
    - delay: 70sec
    - lambda: |-
        preferences_intervalsyncer_id->stop_poller();
    - logger.log: "Disabled preference sync"

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

Checklist

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /src/content/docs/components/index.mdx when 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:

  1. Comment on this pull request with the following command, replacing component_name with your component name in lower_case format with underscores (e.g., bme280, sht3x, dallas_temp):

    @esphomebot generate image component_name
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the /public/images/ folder of this repository.

  4. Use the image in your component's index table entry in /src/content/docs/components/index.mdx.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image dht22

Note: All images used in ImgTable components must be placed in /public/images/ as the component resolves them to absolute paths.

esphome[bot]
esphome bot previously requested changes Mar 20, 2026
Copy link

@esphome esphome bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@rwrozelle rwrozelle changed the base branch from current to next March 20, 2026 02:03
@esphome esphome bot added the next label Mar 20, 2026
@esphome esphome bot dismissed their stale review March 20, 2026 02:03

Base branch has been corrected - dismissing previous review.

@netlify
Copy link

netlify bot commented Mar 20, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit de20229
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/69bcac2e522c210008de2bbe
😎 Deploy Preview https://deploy-preview-6310--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant