esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

add-docs-for-ld2451

Open rickbronson opened this issue 10 months ago • 6 comments

Description:

Add documentation for the HILINK LD2451 vehicle speed detector radar, the code for this will follow soon. Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#<esphome PR number goes here>

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 /index.rst when creating new documents for new components or cookbook.

rickbronson avatar Jan 29 '25 18:01 rickbronson

Walkthrough

This pull request introduces documentation for the LD2451 sensor component in ESPHome. The documentation comprehensively covers the sensor's configuration options, including UART settings, sensor parameters, switch controls, and automation actions. The new documentation is added to the components/sensor/ld2451.rst file and references to the sensor are included in the index.rst file, positioning the LD2451 as a sensor for speed, motion, and presence detection.

Changes

File Change Summary
components/sensor/ld2451.rst New documentation for LD2451 sensor component, including configuration details for sensor, switch, number, button, text sensor, and select components
index.rst Added LD2451 sensor entries in "Motion" and "Presence Detection" sections with component path and brief description

Sequence Diagram

sequenceDiagram
    participant User
    participant ESPHome
    participant LD2451 Sensor
    
    User->>ESPHome: Configure UART and sensor parameters
    ESPHome->>LD2451 Sensor: Initialize with specified settings
    LD2451 Sensor-->>ESPHome: Send sensor data
    ESPHome-->>User: Expose sensor readings

Possibly related PRs

  • #4422: Documentation update for LD2410 sensor, which shares similar UART and sensor configuration characteristics with LD2451

Suggested reviewers

  • nagyrobi

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @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[bot] avatar Jan 29 '25 18:01 coderabbitai[bot]

Deploy Preview for esphome ready!

Name Link
Latest commit f97f6dd44751d543c7cd216cade82990b8a40da5
Latest deploy log https://app.netlify.com/sites/esphome/deploys/679a6fdfb30fb40008f6b2a2
Deploy Preview https://deploy-preview-4620--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 site configuration.

netlify[bot] avatar Jan 29 '25 18:01 netlify[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.

github-actions[bot] avatar Mar 31 '25 02:03 github-actions[bot]

Not sure how to resolve this conflict.

rickbronson avatar Mar 31 '25 23:03 rickbronson

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

Learn more about our pull request process.

esphome[bot] avatar May 28 '25 21:05 esphome[bot]

Where is the code PR that matches this PR? Good question! I spun this code for my neighbor, who wanted to check average traffic speeds on our street. Unfortunately we haven't yet installed the unit to do a complete check on the code. I've done quite a bit of testing on a very quiet street and it seems to work great. I can send what I've got now if you want.

Cheers,

Rick

On Wed, May 28, 2025 at 2:31 PM Jesse Hills @.***> wrote:

@.**** commented on this pull request.

Where is the code PR that matches this PR?

— Reply to this email directly, view it on GitHub https://github.com/esphome/esphome-docs/pull/4620#pullrequestreview-2876492882, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAXO2ACY7DF3KEQ5YUWXWZT3AYTL7AVCNFSM6AAAAABWDPMXXOVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDQNZWGQ4TEOBYGI . You are receiving this because you authored the thread.Message ID: @.***>

rickbronson avatar May 30 '25 16:05 rickbronson

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.

github-actions[bot] avatar Jul 31 '25 02:07 github-actions[bot]