Skip to content

Add VL53L1X time-of-flight distance sensor documentation#5994

Open
will-tm wants to merge 4 commits intoesphome:nextfrom
will-tm:feature/vl53l1x-sensor
Open

Add VL53L1X time-of-flight distance sensor documentation#5994
will-tm wants to merge 4 commits intoesphome:nextfrom
will-tm:feature/vl53l1x-sensor

Conversation

@will-tm
Copy link

@will-tm will-tm commented Jan 28, 2026

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:

  • Distance modes (short/medium/long) for different range/accuracy trade-offs
  • Configurable timing budget (15-500ms)
  • Region of Interest (ROI) configuration for narrower field of view
  • Multi-sensor support via XSHUT pin control
  • Calibration offset support

Related issue (if applicable): N/A

Pull request in esphome with YAML changes (if applicable):

Checklist:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because 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.md when creating new documents for new components or cookbook.

esphome[bot]
esphome bot previously requested changes Jan 28, 2026
Copy link

@esphome esphome bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@esphome esphome bot marked this pull request as draft January 28, 2026 17:19
@esphome
Copy link

esphome bot commented Jan 28, 2026

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@netlify
Copy link

netlify bot commented Jan 28, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit a960dc8
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6994b871f7d7920008b09741
😎 Deploy Preview https://deploy-preview-5994--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@will-tm will-tm changed the base branch from current to next January 28, 2026 17:20
@esphome esphome bot added the next label Jan 28, 2026
@esphome esphome bot dismissed their stale review January 28, 2026 17:20

Base branch has been corrected - dismissing previous review.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 28, 2026

Walkthrough

A 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

Cohort / File(s) Summary
VL53L1X Sensor Documentation
content/components/_index.md, content/components/sensor/vl53l1x.md
Index entry added for the VL53L1X sensor; comprehensive new documentation file created with front-matter metadata, sensor platform overview, wiring instructions, YAML configuration variables (distance_mode, timing_budget, timeout, signal_rate_limit, ROI parameters, offset, address, enable_pin, update_interval), distance modes (short/medium/long), ROI details, multi-sensor guidance on single I2C bus, and calibration workflow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

has-parent, next

Suggested reviewers

  • jesserockz
  • swoboda1337
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly and accurately summarizes the main change: adding documentation for the VL53L1X time-of-flight distance sensor component.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description clearly relates to the changeset, which adds VL53L1X sensor documentation with comprehensive details about features, configuration options, and multi-sensor support.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@will-tm will-tm force-pushed the feature/vl53l1x-sensor branch from 608ad40 to ead7855 Compare January 28, 2026 17:25
@will-tm will-tm marked this pull request as ready for review January 28, 2026 17:27
# Conflicts:
#	content/components/_index.md
#	public/images/vl53l1x.jpg
#	src/content/docs/components/sensor/vl53l1x.md
@will-tm will-tm force-pushed the feature/vl53l1x-sensor branch from 2e9f509 to c1d5377 Compare February 17, 2026 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant