Add ld2454 #4608
Add ld2454 #4608
Conversation
WalkthroughThis pull request introduces documentation for the LD2454 sensor platform in ESPHome. The new documentation file 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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
components/sensor/images/ld2454.pngis excluded by!**/*.pngimages/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)
index.rst (1)
Pattern **: - Do not generate or add any sequence diagrams
components/sensor/ld2454.rst (1)
Pattern **: - Do not generate or add any sequence diagrams
🔇 Additional comments (8)
components/sensor/ld2454.rst (7)
1-18: LGTM! Clear and comprehensive overview.The component overview effectively describes the LD2454 sensor's capabilities and requirements.
27-30: LGTM! Well-documented configuration variables.Configuration options are clearly described with appropriate optionality and default values.
58-72: LGTM! Comprehensive sensor configuration documentation.All sensor types are well documented with clear value ranges and proper references to ESPHome sensor configuration options.
91-93: LGTM! Clear switch configuration documentation.Switch configuration options are well documented with appropriate defaults and references.
157-163: LGTM! Clear button configuration documentation.Button actions are well documented with clear descriptions of their purposes.
182-186: LGTM! Well-documented text sensor configuration.Text sensor options are clearly documented with helpful behavior descriptions.
213-242: LGTM! Clear automation documentation with helpful example.The bluetooth_password.set action is well documented with a clear example for Home Assistant integration.
index.rst (1)
606-606: LGTM! Proper integration in the index.The LD2454 sensor is correctly added to both Motion and Presence Detection sections, following the established format.
Also applies to: 710-710
| - **effective_trigger_time** (*Optional*, int): The alarm information will be reported only when the number of consecutive detections is met. | ||
| Value between ``1`` and ``10`` inclusive. | ||
| All options from :ref:`Sensor <config-sensor>`. | ||
| - **snr_threshold_level** (*Optional*, int): The larger the value, the lower the sensitivity and the more difficult it is to detect the target. | ||
| Value between ``3`` and ``8`` inclusive. | ||
| All options from :ref:`Sensor <config-sensor>`. | ||
| - **max_detect_distance** (*Optional*, int): Maximum detection distance (meters) | ||
| Value between ``10`` and ``255`` inclusive. | ||
| All options from :ref:`Sensor <config-sensor>`. | ||
| - **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). | ||
| Value between ``0`` and ``255`` inclusive. | ||
| All options from :ref:`Sensor <config-sensor>`. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix incorrect configuration reference.
The number configuration options reference the Sensor configuration (<config-sensor>) instead of the Number configuration (<config-number>).
Apply this correction to each number configuration option:
- All options from :ref:`Sensor <config-sensor>`.
+ All options from :ref:`Number <config-number>`.📝 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.
| - **effective_trigger_time** (*Optional*, int): The alarm information will be reported only when the number of consecutive detections is met. | |
| Value between ``1`` and ``10`` inclusive. | |
| All options from :ref:`Sensor <config-sensor>`. | |
| - **snr_threshold_level** (*Optional*, int): The larger the value, the lower the sensitivity and the more difficult it is to detect the target. | |
| Value between ``3`` and ``8`` inclusive. | |
| All options from :ref:`Sensor <config-sensor>`. | |
| - **max_detect_distance** (*Optional*, int): Maximum detection distance (meters) | |
| Value between ``10`` and ``255`` inclusive. | |
| All options from :ref:`Sensor <config-sensor>`. | |
| - **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). | |
| Value between ``0`` and ``255`` inclusive. | |
| All options from :ref:`Sensor <config-sensor>`. | |
| - **effective_trigger_time** (*Optional*, int): The alarm information will be reported only when the number of consecutive detections is met. | |
| Value between ``1`` and ``10`` inclusive. | |
| All options from :ref:`Number <config-number>`. | |
| - **snr_threshold_level** (*Optional*, int): The larger the value, the lower the sensitivity and the more difficult it is to detect the target. | |
| Value between ``3`` and ``8`` inclusive. | |
| All options from :ref:`Number <config-number>`. | |
| - **max_detect_distance** (*Optional*, int): Maximum detection distance (meters) | |
| Value between ``10`` and ``255`` inclusive. | |
| All options from :ref:`Number <config-number>`. | |
| - **min_speed** (*Optional*, int): Minimum movement speed (km/h) | |
| Value between ``0`` and ``120`` inclusive. | |
| All options from :ref:`Number <config-number>`. | |
| - **no_target_timeout** (*Optional*, int): No target delay time setting (seconds). If target is detected, it will delay notification (retriggerable). | |
| Value between ``0`` and ``255`` inclusive. | |
| All options from :ref:`Number <config-number>`. |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Description:
Add documentation for the HILINK LD2454 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#
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.