Add VL53L1X time-of-flight distance sensor documentation#5994
Add VL53L1X time-of-flight distance sensor documentation#5994will-tm wants to merge 4 commits intoesphome:nextfrom
Conversation
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Base branch has been corrected - dismissing previous review.
WalkthroughA new VL53L1X distance sensor component is added to the ESPHome documentation. This includes an index entry and a comprehensive guide covering the sensor's configuration, wiring, operating modes, Region of Interest settings, multi-sensor setups, and calibration procedures. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@content/components/sensor/vl53l1x.md`:
- Around line 152-155: The ordered list in content/components/sensor/vl53l1x.md
currently uses sequential numbers (1., 2., 3.) which triggers markdownlint rule
MD029; change each ordered list item so every line starts with "1." (e.g.,
replace "2." and "3." with "1.") so the three lines under the list use "1."
consistently; keep the same text/content and spacing so the driver
initialization explanation and steps remain unchanged.
Documents the VL53L1X sensor component including: - Distance modes (short/medium/long) - Timing budget configuration - Region of Interest (ROI) settings - Multi-sensor setup with XSHUT pins - Calibration offset
608ad40 to
ead7855
Compare
# Conflicts: # content/components/_index.md # public/images/vl53l1x.jpg # src/content/docs/components/sensor/vl53l1x.md
2e9f509 to
c1d5377
Compare
Description:
Add documentation for the VL53L1X time-of-flight distance sensor component.
The VL53L1X is the successor to the VL53L0X with improved range (up to 4m) and additional features:
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
/components/_index.mdwhen creating new documents for new components or cookbook.