-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Added index configuration variable entry #5500
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: next
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.* |
Copilot
AI
Oct 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grammar error: 'when during startup' should be 'when a sensor is not connected during startup' or 'during startup when 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 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.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| - **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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - **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 (0-based) 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 sensors and the order can be different if any sensors are changed/added/removed.* |
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: