Open
Conversation
18 tasks
✅ Deploy Preview for esphome 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
Documents the new esphome config-hash CLI command so users can compute and compare a configuration hash against a running device.
Changes:
- Added a new
config-hashcommand section to the CLI guide. - Linked the comparison workflow to the Version Text Sensor documentation.
| ### `config-hash` Command | ||
|
|
||
| The `esphome config-hash <CONFIG>` loads the configuration and calculates the hash that you can compare | ||
| against the hash from the [Version Text Sensor](/components/text_sensor/version/) on a running device. |
There was a problem hiding this comment.
Wording here is a bit ambiguous about where the “hash from the Version Text Sensor” comes from. The version text sensor exposes the config hash as part of its state string and it can be suppressed with hide_hash; it would be clearer to mention that the value to compare is the config hash shown in the Version text sensor output (and that it won’t be present if hide_hash: true).
Suggested change
| against the hash from the [Version Text Sensor](/components/text_sensor/version/) on a running device. | |
| against the config hash shown in the output of the [Version Text Sensor](/components/text_sensor/version/) | |
| on a running device. If the Version Text Sensor is configured with `hide_hash: true`, that hash will not | |
| be present in the sensor output. |
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
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
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.