Added index configuration variable entry #5500
Open
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the new index configuration variable in the Dallas Temperature sensor component, which provides an alternative to using device addresses for identifying sensors on the bus.
- Added
indexconfiguration variable documentation - Updated
addressvariable description to clarify relationship withindex - Added example usage of
indexin the configuration example
| - **address** (*Optional*, int): The address of the sensor. Required if there is more than one device on the bus. | ||
| - **address** (*Optional*, int): The address of the sensor. Required if there is more than one device on the bus and index is not specified. | ||
| - **index** (*Optional*, byte): The index of the sensor. Required if there is more than one device on the bus and address is not specified. *Note this index is based on the hardware addresses of the sensor and indexes will shift when during startup a sensor is not connected.* |
There was a problem hiding this comment.
Grammar error: 'when during startup' should be 'when a sensor is not connected during startup' or 'during startup when a sensor is not connected'.
Suggested change
| - **index** (*Optional*, byte): The index of the sensor. Required if there is more than one device on the bus and address is not specified. *Note this index is based on the hardware addresses of the sensor and indexes will shift when during startup a sensor is not connected.* | |
| - **index** (*Optional*, byte): The index of the sensor. Required if there is more than one device on the bus and address is not specified. *Note this index is based on the hardware addresses of the sensor and indexes will shift during startup when a sensor is not connected.* |
Copilot uses AI. Check for mistakes.
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
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 index configuration attribute to reflect component change in documentation
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.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: