[esphome] Document esphome: provisioning:#6833
Open
kbx81 wants to merge 2 commits into
Open
Conversation
Document the new (API) provisioning window: the `provisioning_timeout` configuration variable, its interaction with `reboot_timeout`, and the `on_provisioning_timeout` trigger. Companion to esphome/esphome#17152.
18 tasks
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The provisioning window moved out of the api component into the core `esphome: provisioning:` block. Revert the api.mdx additions and document `provisioning` (with `timeout` and `on_timeout`) on the esphome core page. Companion to esphome/esphome#17152.
kbx81
changed the title
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
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
Documents the new provisioning window on the core
esphome:component page (esphome: provisioning:withtimeoutandon_timeout).Covers what closing the window does (refuses provisioning, turns API clients away, stops BLE Improv — serial Improv stays enabled) and that
reboot_timeoutis paused while unprovisioned, with a power cycle / reset reopening the window.Related issue (if applicable): N/A
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
/src/content/docs/components/index.mdxwhen creating new documents for new components or cookbook.