VL53L1X

[ccutrer]

Description:

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

• esphome/esphome#8514

Checklist:

• [x] 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.

• [x] Link added in /components/index.rst when creating new documents for new components or cookbook.

[netlify[bot]]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	d8fcd01d6784460b220e7672fefafa6feceac005
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/67f1f131aa2e96000892ef29
😎 Deploy Preview	https://deploy-preview-4793--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[coderabbitai[bot]]

Walkthrough

This pull request updates versioning information across multiple project artifacts, transitioning from a stable release number to a development tag. It revises version variables in configuration files (Doxygen, Makefile, _static/version, and conf.py) and adds new configuration options in the component documentation. In addition, it introduces new documentation for several hardware components and enhances existing entries with clarifications and additional references. The command-line interface documentation is updated with options to specify upload speed and perform a device reset.

Changes

File(s)	Change Summary
Doxygen, Makefile, _static/version, conf.py	Updated version and branch references: PROJECT_NUMBER changed from 2025.3.3 to 2025.4.0-dev in Doxygen; ESPHOME_REF changed from 2025.3.3 to dev in Makefile; version in _static/version and conf.py (version from "2025.3" to "2025.4" and release from "2025.3.3" to "2025.4.0-dev") updated.
components/canbus/esp32_can.rst, components/esphome.rst, components/logger.rst	Added new configuration variables: tx_enqueue_timeout in the CAN bus doc and debug_scheduler in ESPHome; updated the description for deassert_rts_dtr in the logger documentation.
components/index.rst, components/output/mcp4461.rst, components/sensor/vl53l1x.rst	Introduced new hardware component documentation: new index entries for VL53L1x sensor and MCP4661; added dedicated documentation files for the MCP4461 output component and the VL53L1X sensor.
components/psram.rst, components/sensor/vl53l0x.rst	Revised PSRAM documentation to specify default mode (quad) and speed (40MHz) along with a new Restrictions section; added a "See Also" reference to the VL53L1X documentation in the VL53L0X sensor file.
guides/cli.rst	Added new CLI options: --upload_speed BAUD_RATE to specify serial flashing speed and --reset to reset the device before starting logs for the esphome run, upload, and logs commands.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant CLI as ESPHome CLI
    participant DEV as Device

    U->>CLI: Execute command with --upload_speed and/or --reset
    CLI->>CLI: Parse command-line options
    alt --reset provided
        CLI->>DEV: Send reset signal
    end
    CLI->>DEV: Initiate upload/logging with specified speed
    DEV-->>CLI: Process command and return response
    CLI-->>U: Display command result

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 616ec11013e0fb1a4ae78066c06ff5ff080b684b and de3d53876b5359395c1ba58f19924dd2e2a9c8bd.

⛔ Files ignored due to path filters (3)

• components/sensor/images/vl53l1x.jpg is excluded by !**/*.jpg
• images/mcp4461.jpg is excluded by !**/*.jpg
• images/vl53l1x.jpg is excluded by !**/*.jpg

📒 Files selected for processing (13)

• Doxygen (1 hunks)
• Makefile (1 hunks)
• _static/version (1 hunks)
• components/canbus/esp32_can.rst (1 hunks)
• components/esphome.rst (1 hunks)
• components/index.rst (2 hunks)
• components/logger.rst (1 hunks)
• components/output/mcp4461.rst (1 hunks)
• components/psram.rst (1 hunks)
• components/sensor/vl53l0x.rst (1 hunks)
• components/sensor/vl53l1x.rst (1 hunks)
• conf.py (1 hunks)
• guides/cli.rst (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**`: - Do not generate or add any sequence diagrams

**: - Do not generate or add any sequence diagrams

• _static/version
• components/canbus/esp32_can.rst
• components/sensor/vl53l0x.rst
• components/esphome.rst
• conf.py
• Doxygen
• components/psram.rst
• Makefile
• guides/cli.rst
• components/output/mcp4461.rst
• components/logger.rst
• components/index.rst
• components/sensor/vl53l1x.rst

🔇 Additional comments (23)

_static/version (1)

1-1: Version Update to Development Tag
The version string has been updated to "2025.4.0-dev", which clearly indicates the project's transition to a development version. Ensure that all downstream documentation references and build processes reflect this change.

Doxygen (1)

41-41: PROJECT_NUMBER Update
The PROJECT_NUMBER is now set to "2025.4.0-dev", aligning the version information with the new development release. Confirm that this update is consistently applied wherever the version number is referenced in your documentation configuration.

Makefile (1)

2-2: Update of ESPHOME_REF Variable
The ESPHOME_REF variable has been updated from "2025.3.3" to "dev". This change signals that the documentation should now use the development branch of ESPHome. Please verify that all scripts and dependencies correctly interpret this value.

conf.py (1)

75-77: Consistent Versioning in Documentation Configuration
The version and release variables have been updated to "2025.4" and "2025.4.0-dev" respectively. This ensures that Sphinx-generated documentation aligns with the new development version. Double-check that all integration points (e.g., Doxygen and other build tools) are in sync with these version strings.

components/sensor/vl53l0x.rst (1)

107-107: New Reference Link for VL53L1x Documentation

The added reference :doc:\vl53l1x`` in the "See Also" section is clear and aligns with our documentation linking standards. Please verify that the target documentation page is up-to-date.

components/canbus/esp32_can.rst (1)

31-32: Addition of TX Enqueue Timeout Parameter

The new optional configuration variable tx_enqueue_timeout is well described. It clearly explains that the timeout corresponds to the time taken to send 10 CAN messages at the given bitrate. Ensure that this description remains consistent with similar time-based configuration options across the documentation.

components/esphome.rst (1)

69-69: Addition of Debug Scheduler Option

The new configuration variable debug_scheduler is a useful addition for debugging scheduled tasks. Its description is concise and matches our documentation style. Please ensure that enabling this consistently outputs the intended DEBUG level logs throughout the system.

components/index.rst (1)

294-294: New VL53L1x Sensor Entry

The new entry for VL53L1x in the Distance section is a welcome enhancement. Please confirm that the referenced image file (vl53l1x.jpg) exists and that the description (“IR optical distance”) accurately reflects the sensor’s functionality.

components/output/mcp4461.rst (4)

1-7: File Header and SEO Block

The header section, including the title and SEO block, is clearly formatted. The description and image reference (mcp4461.jpg) are appropriate for the MCP4461 component.

---

12-17: Example Configuration for MCP4461 Component

The provided YAML snippet for a basic MCP4461 configuration is concise and serves as a good starting point for users. Consider adding a brief inline comment about the importance of the id field if needed.

---

18-28: MCP4461 Component Configuration Variables

The first configuration variables section is well structured and clearly explains each option (e.g., address, disable_wiper_0, etc.). This provides excellent context for setting up the component.

---

118-125: See Also Section

The "See Also" section effectively lists additional references including the main output documentation, API references, and editing links. No further changes are needed here.

components/psram.rst (2)

23-25: Clarify Default Values in Configuration Variables
The updated descriptions for the mode and speed parameters now clearly state that “quad” and “40MHz” are the defaults. Ensure that these documented defaults consistently match the runtime behavior of the PSRAM component.

---

26-32: Addition of Detailed Restrictions
The newly added "Restrictions" section provides valuable guidance regarding hardware limitations and mode/speed compatibility. It effectively alerts users to consult their module datasheets and be cautious with unsupported configurations. Please verify that these restrictions remain accurate as the hardware support evolves.

guides/cli.rst (3)

79-84: New --upload_speed Option in Run Command
The documentation for the --upload_speed BAUD_RATE option is clear, explaining its default (460800) and the link to the environment variable ESPHOME_UPLOAD_SPEED. This addition enhances clarity for serial flashing configurations.

---

109-113: New --reset Option in Run Command
The --reset option is now documented for the run command with a clear note about its behavior and associated environment variable. Double-check that the examples elsewhere in the docs reflect this behavior consistently.

---

271-275: Consistent --reset Option in Logs Command
The documentation for the --reset option in the logs command is clear and consistent with its behavior elsewhere. Confirm that this reset behavior is intended for all logging scenarios.

components/sensor/vl53l1x.rst (6)

1-8: New VL53L1X Sensor Documentation Introduction
This new documentation file is well structured. The title, SEO metadata, and keyword/tag details are clearly defined, helping search engines and users to identify the sensor documentation.

---

9-18: Clarify Measurement Range Description
The introduction mentions that the sensor can measure distances up to 2 meters, yet later it hints at a typical effective range of around 73 cm. Because the configuration section later describes long and short modes with ranges of up to 4 m and 1.3 m respectively, please clarify or reconcile these figures to avoid potential confusion among users.

---

26-32: Clear and Concise Wiring Instructions
The wiring instructions are succinct and cover all necessary connections, including the note that “GPIO1” is not used and the conditional requirement for the XSHUT pin. Consider including a simple diagram if space and format allow, to further aid visual learners.

---

34-43: Simple Configuration Example is Clear
The provided YAML example for a single VL53L1X configuration is easy to follow and accurately demonstrates the basic settings required.

---

44-62: Comprehensive Configuration Variables Section
The configuration variables are detailed and explain how to adjust sensor behavior (e.g., update_interval, distance_mode, address, enable_pin, and timeout). One point to review: ensure that the documented maximum distances in distance_mode (long up to 4 m, short limited to 1.3 m) are consistent with the introduction, which currently states up to 2 m.

---

89-97: Useful “See Also” Section
The “See Also” section effectively lists related resources and links to additional documentation. This aids in broader understanding and navigation of related topics.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[ccutrer]

Not stale

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[ccutrer]

Not stale

[swoboda1337]

Docs need to be updated