Skip to content

Add documentation for LD2413 mmWave sensor #4861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added components/sensor/images/ld2413-front-back.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
101 changes: 101 additions & 0 deletions components/sensor/ld2413.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
LD2413 Sensor
=============

.. seo::
:description: Integration for the HLK-LD2413 mmWave liquid/material level sensor in ESPHome.
:image: ld2413.jpg

The ``ld2413`` sensor allows you to integrate the Hi-Link HLK-LD2413 millimeter wave distance sensor with ESPHome using UART.

The HLK-LD2413 is a compact, high-precision 24GHz mmWave sensor with built-in AIoT radar chip and intelligent firmware, designed specifically for non-contact detection of liquid levels and material heights in both industrial and consumer applications.

It supports a detection range of **15 cm to 10 m** with an accuracy of **±3 mm**.

You can find the full datasheet for the HLK-LD2413 sensor `here <https://drive.google.com/file/d/1S53qdURC3W6WZIjp-AEKFxvhiGx0ZdLc/view?usp=drive_link>`_.

.. figure:: images/ld2413-front-back.png
:align: center
:width: 50.0%

Pinout: J1
----------

.. list-table::
:widths: 15 20 30 35
:header-rows: 1

* - Pin
- Name
- Function
- Illustrate
* - J1Pin1
- 3V3
- Power Input
- 3.0 V~3.6 V, Typ. 3.3 V
* - J1Pin2
- GND
- Grounding
- -
* - J1Pin3
- OT1
- UART_TX
- 0~3.3V
* - J1Pin4
- RX
- UART_RX
- 0~3.3V
* - J1Pin5
- OT2
- IO Port
- 0~3.3V

Pinout: J2
----------

.. list-table::
:widths: 15 20 30 35
:header-rows: 1

* - Pin
- Name
- Function
- Illustrate
* - J2Pin1
- 3V3
- Power Input
- 3.0 V~3.6 V, Typ. 3.3 V
* - J2Pin2
- CLK
- Clock signal
- 0~3.3V
* - J2Pin3
- DIO
- Data port
- 0~3.3V
* - J2Pin4
- GND
- Grounding
- -

.. code-block:: yaml

uart:
rx_pin: GPIO16
tx_pin: GPIO17
baud_rate: 115200

sensor:
- platform: ld2413
name: "LD2413 Distance"

Configuration variables:
------------------------

- **name** (**Required**, string): The name of the sensor.
- All other options from :ref:`Sensor <config-sensor>`.

See Also
--------

- :doc:`/components/sensor/index`
- :doc:`/components/uart`
Binary file added images/ld2413.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.