Add docs for ld2454 #4602
Add docs for ld2454 #4602
Conversation
WalkthroughThis pull request introduces comprehensive documentation for the LD2454 sensor component in ESPHome. The documentation covers the sensor's capabilities for detecting vehicles and people, including configuration options for UART connectivity, measurement parameters, and various related components like switches, buttons, and text sensors. The documentation provides detailed configuration guidelines, highlighting the sensor's ability to track targets with parameters such as angle, distance, direction, speed, and signal-to-noise ratio. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
components/sensor/ld2454.rst (3)
8-8: Enhance the component overview with specific capabilities.Consider adding more specific details about the sensor's capabilities:
- Maximum detection range for each lane
- Speed measurement range
- Accuracy specifications
- Detection angle coverage
27-30: Add more details to configuration variables.Consider adding:
- Example values for the
uart_idparameter- Valid range for the
throttleparameter- Impact of different throttle values on performance
70-72: Improve target_snr documentation.The description has a typo ("ration" instead of "ratio") and could benefit from more details about what the SNR values indicate.
- Target signal to noise ration. + Target signal to noise ratio. Higher values indicate stronger signal quality.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
images/ld2454.pngis excluded by!**/*.png
📒 Files selected for processing (2)
components/sensor/ld2454.rst(1 hunks)index.rst(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
components/sensor/ld2454.rst (1)
Pattern **: - Do not generate or add any sequence diagrams
index.rst (1)
Pattern **: - Do not generate or add any sequence diagrams
🪛 GitHub Check: build
components/sensor/ld2454.rst
[failure] 133-133:
File contains tab character. Please convert tabs to spaces.
🪛 GitHub Actions: Lint
components/sensor/ld2454.rst
[error] 133-133: File contains tab character. Please convert tabs to spaces.
🔇 Additional comments (2)
components/sensor/ld2454.rst (1)
207-243: Well-documented automation section!The bluetooth_password.set action is clearly documented with good examples for both direct use and Home Assistant integration.
index.rst (1)
606-606: Correctly added to relevant sections!The LD2454 sensor is appropriately added to both the Motion and Presence Detection sections, maintaining consistency with other entries.
Also applies to: 710-710
| - **min_speed** (*Optional*, int): Minimum movement speed (km/h) | ||
| Value between ``0`` and ``120`` inclusive. | ||
| All options from :ref:`Sensor <config-sensor>`. | ||
| - **no_target_timeout** (*Optional*, int): No target delay time setting (seconds). If target is detected, it will delay notification (retriggerable). |
There was a problem hiding this comment.
Replace tab character with spaces.
The line contains a tab character which should be replaced with spaces to maintain consistent formatting.
🧰 Tools
🪛 GitHub Check: build
[failure] 133-133:
File contains tab character. Please convert tabs to spaces.
🪛 GitHub Actions: Lint
[error] 133-133: File contains tab character. Please convert tabs to spaces.
| target_speed: | ||
| name: "Speed (km/h)" | ||
| target_snr: | ||
| name: "Speed (km/h)" |
There was a problem hiding this comment.
Fix copy-paste error in target_snr name.
The name shows "Speed (km/h)" which appears to be copied from the target_speed sensor.
- name: "Speed (km/h)"
+ name: "Signal to Noise Ratio"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| name: "Speed (km/h)" | |
| name: "Signal to Noise Ratio" |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Description:
This is a pull request for documentation for the HILINK LD2454 radar vehicle speed sensor. I will be following this up with the code pull request.
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable): esphome/esphome#
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
/index.rstwhen creating new documents for new components or cookbook.