Add documentation for LD2413 mmWave sensor

[BBart19]

Description:

This PR adds documentation for the new LD2413 mmWave distance sensor.

The HLK-LD2413 is a compact 24GHz radar sensor designed for high-precision, non-contact measurement of liquid and material levels. The documentation includes:

• Overview and product description
• Example YAML configuration
• Pinout tables (J1 and J2)
• Product images

Related issue (if applicable): None

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

• Add LD2413 mmWave UART sensor component esphome#8661

[coderabbitai]

Walkthrough

A new documentation file has been introduced for the LD2413 millimeter wave distance sensor within the ESPHome ecosystem. This file details the sensor’s features, provides pinout tables for its connectors, and offers a sample YAML configuration for integration via UART. The documentation also explains required parameters, references standard sensor configuration options, and links to related ESPHome resources.

Changes

File(s)	Change Summary
components/sensor/ld2413.rst	Added new documentation describing the LD2413 sensor, its features, pinouts, and configuration.

Suggested labels

next

---

📜 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 4c98ea2 and 25d5a80.

⛔ Files ignored due to path filters (1)

• images/ld2413.jpg is excluded by !**/*.jpg

📒 Files selected for processing (1)

• components/sensor/ld2413.rst (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• components/sensor/ld2413.rst

---

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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

components/sensor/ld2413.rst (1)

25-28: Suggest clearer table header
The column header "Illustrate" in the Pinout tables may confuse readers. Consider renaming it to something more descriptive, e.g., "Voltage Range" or "Signal Voltage".

🧰 Tools

🪛 GitHub Check: build

[failure] 25-25:
Directive 'list-table' must be indented with 4 spaces, not 3. See components/sensor/ld2413.rst:25

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 69da99b and 3fed02f.

⛔ Files ignored due to path filters (2)

• components/sensor/images/ld2413-front-back.png is excluded by !**/*.png
• images/ld2413.png is excluded by !**/*.png

📒 Files selected for processing (1)

• components/sensor/ld2413.rst (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

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

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

• components/sensor/ld2413.rst

🪛 GitHub Check: build

components/sensor/ld2413.rst

[failure] 57-57:
Directive 'list-table' must be indented with 4 spaces, not 3. See components/sensor/ld2413.rst:57

---

[failure] 25-25:
Directive 'list-table' must be indented with 4 spaces, not 3. See components/sensor/ld2413.rst:25

---

[failure] 16-16:
Directive 'figure' is not followed by an empty line. Please insert an empty line after components/sensor/ld2413.rst:16

---

[failure] 17-17:
File contains tab character. Please convert tabs to spaces.

🪛 GitHub Actions: Lint

components/sensor/ld2413.rst

[error] 17-17: File contains tab character. Please convert tabs to spaces.

[netlify]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	25d5a80
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/6812c4b2a3c98100082264ac
😎 Deploy Preview	https://deploy-preview-4861--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]

Actionable comments posted: 4

♻️ Duplicate comments (1)

components/sensor/ld2413.rst (1)

14-17: ⚠️ Potential issue

Add blank line after figure directive and remove tab
RST requires an empty line between directive options and subsequent content. Also remove the stray tab on line 17.

-    :width: 50.0%
-	
+    :width: 50.0%
+

🧰 Tools

🪛 GitHub Check: build

[failure] 16-16:
Directive 'figure' is not followed by an empty line. Please insert an empty line after components/sensor/ld2413.rst:16

---

[failure] 17-17:
File contains tab character. Please convert tabs to spaces.

🪛 GitHub Actions: Lint

[error] 17-17: File contains tab character. Please convert tabs to spaces.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3fed02f and 4c98ea2.

📒 Files selected for processing (1)

• components/sensor/ld2413.rst (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

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

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

• components/sensor/ld2413.rst

🪛 GitHub Check: build

components/sensor/ld2413.rst

[failure] 54-54:
Directive 'list-table' is not followed by an empty line. Please insert an empty line after components/sensor/ld2413.rst:54

---

[failure] 23-23:
Directive 'list-table' is not followed by an empty line. Please insert an empty line after components/sensor/ld2413.rst:23

---

[failure] 16-16:
Directive 'figure' is not followed by an empty line. Please insert an empty line after components/sensor/ld2413.rst:16

---

[failure] 17-17:
File contains tab character. Please convert tabs to spaces.

🪛 GitHub Actions: Lint

components/sensor/ld2413.rst

[error] 17-17: File contains tab character. Please convert tabs to spaces.

🔇 Additional comments (1)

components/sensor/ld2413.rst (1)

4-6: Verify SEO image path
The SEO block references ld2413.png, but the actual product image file is images/ld2413-front-back.png. Please confirm that ld2413.png exists or update the path to the correct image file.