Update dallas_temp.md #5847
Update dallas_temp.md #5847
Conversation
Added info on Arduino IDE LSB vs EspHome MSB on address IDs
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughDocumentation update to the Dallas temperature sensor component explaining byte order differences between EspHome and Arduino IDE, including example address transformation and usage guidance. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Pre-merge checks❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
content/components/sensor/dallas_temp.md (1)
49-52: Improve writing formality in documentation.The phrasing "if you want" on line 52 is too casual for technical documentation. Consider more formal alternatives like "optionally" or "if you do not have the addresses available".
🔎 Proposed improvement
-If you don't have the addresses, use index instead of addresses for the first run. EspHome will print the addresses on the log at first use with index. After that, try with addresses, if you want. +If you don't have the addresses, use index instead of addresses for the first run. EspHome will print the addresses to the log at first use with index. Afterward, optionally switch to using addresses for more reliable identification.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/components/sensor/dallas_temp.md
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/components/sensor/dallas_temp.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: danielkent-net
Repo: esphome/esphome-docs PR: 5778
File: content/components/sensor/bmp581.md:10-12
Timestamp: 2025-12-14T20:08:17.373Z
Learning: In ESPHome documentation, sensors that support both I²C and SPI interfaces use separate platform names with `_i2c` and `_spi` suffixes (e.g., `bmp280_i2c`/`bmp280_spi`, `bmp3xx_i2c`/`bmp3xx_spi`, `bmp581_i2c`/`bmp581_spi`). This is the established naming convention and should not be flagged as incorrect.
📚 Learning: 2025-12-14T20:08:13.374Z
Learnt from: danielkent-net
Repo: esphome/esphome-docs PR: 5778
File: content/components/sensor/bmp581.md:10-12
Timestamp: 2025-12-14T20:08:13.374Z
Learning: In ESPHome docs, when listing sensors that support both I2C and SPI interfaces, use separate platform names with _i2c and _spi suffixes (e.g., bmp280_i2c and bmp280_spi; bmp3xx_i2c and bmp3xx_spi; bmp581_i2c and bmp581_spi). This naming convention is established and should not be flagged as incorrect. Apply this pattern across sensor documentation files under content/components/sensor and ensure examples reflect both suffix variants where applicable.
Applied to files:
content/components/sensor/dallas_temp.md
🪛 GitHub Check: Lint
content/components/sensor/dallas_temp.md
[failure] 49-49:
Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Byte Order of the Address"]
🪛 LanguageTool
content/components/sensor/dallas_temp.md
[style] ~52-~52: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ... index. After that, try with addresses, if you want. ### See Also - [Arduino DallasTemper...
(IF_YOU_WANT)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build
| - All other options from [Sensor](/components/sensor). | ||
| ### Byte Order of the Address |
There was a problem hiding this comment.
Add a blank line before the heading.
The linting check requires headings to be surrounded by blank lines. Add a blank line between line 48 and the heading.
🔎 Proposed fix
- All other options from [Sensor](/components/sensor).
~
### Byte Order of the Address🧰 Tools
🪛 GitHub Check: Lint
[failure] 49-49:
Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Byte Order of the Address"]
🤖 Prompt for AI Agents
In content/components/sensor/dallas_temp.md around line 49, the heading "###
Byte Order of the Address" is not preceded by a blank line; add a single blank
line between line 48 and this heading so the heading is surrounded by blank
lines to satisfy the lint rule.
1 participant
Added info on Arduino IDE LSB vs EspHome MSB on address IDs
Description:
Related issue (if applicable): fixes
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.mdwhen 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 lower_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
/static/images/folder of this repository.Use the image in your component's index table entry in
/components/_index.md.Example: For a component called "DHT22 Temperature Sensor", use: