Add ld2454 #4606
Add ld2454 #4606
Conversation
WalkthroughThis pull request introduces comprehensive documentation for the LD2454 sensor component in ESPHome. The documentation covers the sensor's capabilities, including vehicle and pedestrian detection up to 100 meters, Bluetooth connectivity, and UART configuration. It provides detailed YAML configuration examples for various components such as sensor, switch, number, button, text sensor, and select. The documentation also includes an automation section for setting Bluetooth passwords and integrating with Home Assistant. Changes
Possibly related PRs
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: 5
📜 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)
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
🪛 GitHub Actions: Lint
components/sensor/ld2454.rst
[error] 17-17: Image file 'components/sensor/images/ld2454.png' is not readable
🔇 Additional comments (2)
components/sensor/ld2454.rst (1)
247-247: Verify source of inspiration reference.The source of inspiration links to the LD2410 implementation. Please verify if this is intentional or if it should reference an LD2454-specific implementation.
index.rst (1)
606-606: LGTM!The LD2454 entries are correctly added to both the Motion and Presence Detection sections, following the existing format and accurately reflecting the component's capabilities.
Also applies to: 710-710
| .. figure:: images/ld2454.png | ||
| :align: center | ||
| :width: 50.0% | ||
|
|
||
| LD2454 vehicle speed and presence sensor |
There was a problem hiding this comment.
Add the missing image file.
The pipeline is failing because the image file components/sensor/images/ld2454.png is missing. Please add the image file to the correct location.
🧰 Tools
🪛 GitHub Actions: Lint
[error] 17-17: Image file 'components/sensor/images/ld2454.png' is not readable
| - **target_snr** (*Optional*, int): Target signal to noise ration. | ||
| Value between ``0`` and ``255`` inclusive. |
There was a problem hiding this comment.
Fix typo in SNR description.
There's a typo in "ration" - it should be "ratio".
-- **target_snr** (*Optional*, int): Target signal to noise ration.
++ **target_snr** (*Optional*, int): Target 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.
| - **target_snr** (*Optional*, int): Target signal to noise ration. | |
| Value between ``0`` and ``255`` inclusive. | |
| - **target_snr** (*Optional*, int): Target signal to noise ratio. | |
| Value between ``0`` and ``255`` inclusive. |
| target_speed: | ||
| name: "Speed (km/h)" | ||
| target_snr: | ||
| name: "Speed (km/h)" |
There was a problem hiding this comment.
Fix copy-paste error in sensor name.
The name for target_snr is incorrectly showing "Speed (km/h)" which appears to be copied from the target_speed sensor above.
- 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" |
| 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.
Fix incorrect configuration references.
The configuration options are referencing "Sensor" configuration instead of "Number" configuration in multiple places.
- All options from :ref:`Sensor <config-sensor>`.
+ All options from :ref:`Number <config-number>`.This change needs to be applied to all configuration variables in the Number section (effective_trigger_time, snr_threshold_level, max_detect_distance, min_speed, no_target_timeout).
📝 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.
| 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>`. | |
| 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>`. |
|
|
||
| - **move_direction** (*Optional*, int): Movement direction setting (0: Only detect away, 1: Only detect approach, 2: All detected) | ||
| Value between ``0`` and ``2`` inclusive. | ||
| All options from :ref:`Sensor <config-sensor>`. |
There was a problem hiding this comment.
Fix incorrect configuration reference.
The configuration option is referencing "Sensor" configuration instead of "Select" configuration.
- All options from :ref:`Sensor <config-sensor>`.
+ All options from :ref:`Select <config-select>`.Committable suggestion skipped: line range outside the PR's diff.
✅ 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.