Skip to content
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

update ld2420 documentation to include optional uart_id and ld2420_id configuration variables #4211

Open
wants to merge 30 commits into
base: current
Choose a base branch
from
Open
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
2b95c0e
add link to integration from total_daily_energy
nkinnan Aug 13, 2024
f67bb65
update ld2420 documentation to include optional uart_id and ld2420_id…
nkinnan Sep 1, 2024
d5e8b4e
update ld2420 documentation to include optional uart_id and ld2420_id…
nkinnan Sep 1, 2024
3aad792
Merge branch 'esphome:current' into update_ld2420_doc
nkinnan Sep 1, 2024
0cf62c7
typo
nkinnan Sep 1, 2024
b23d258
Merge branch 'update_ld2420_doc' of https://github.com/nkinnan/esphom…
nkinnan Sep 1, 2024
2dc3908
rst weirdness
nkinnan Sep 1, 2024
8e626a4
test
nkinnan Sep 4, 2024
c006af7
Merge branch 'esphome:current' into update_ld2420_doc
nkinnan Sep 4, 2024
f283699
test
nkinnan Sep 4, 2024
79a824e
Merge branch 'update_ld2420_doc' of https://github.com/nkinnan/esphom…
nkinnan Sep 4, 2024
0abaa35
test
nkinnan Sep 4, 2024
007e0c6
test
nkinnan Sep 4, 2024
aa93b5c
test
nkinnan Sep 4, 2024
cfebb19
test
nkinnan Sep 4, 2024
4fa13fb
test
nkinnan Sep 4, 2024
1de7dfd
test
nkinnan Sep 4, 2024
d28f130
test
nkinnan Sep 4, 2024
11f854f
test
nkinnan Sep 4, 2024
7847eff
test
nkinnan Sep 4, 2024
0a203aa
test
nkinnan Sep 4, 2024
53e8d46
test
nkinnan Sep 4, 2024
59640bd
test
nkinnan Sep 4, 2024
d03257e
test
nkinnan Sep 4, 2024
3add17a
test
nkinnan Sep 4, 2024
9e2de39
Merge branch 'current' into update_ld2420_doc
nkinnan Sep 18, 2024
580c009
Merge branch 'current' into update_ld2420_doc
nkinnan Sep 24, 2024
6fc60ee
Merge branch 'current' into update_ld2420_doc
nkinnan Oct 7, 2024
c2379af
Merge branch 'current' into update_ld2420_doc
nkinnan Oct 11, 2024
3f70564
Merge branch 'current' into update_ld2420_doc
nkinnan Oct 15, 2024
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
42 changes: 41 additions & 1 deletion components/sensor/ld2420.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,30 +79,47 @@ Module Pinouts
.. code-block:: yaml

# Example configuration entry

uart:
id: my_uart
...

ld2420:
id: my_ld
uart_id: my_uart

text_sensor:
- platform: ld2420
ld2420_id: my_ld

fw_version:
name: LD2420 Firmware

sensor:
- platform: ld2420
ld2420_id: my_ld

moving_distance:
name : Moving Distance

binary_sensor:
- platform: ld2420
ld2420_id: my_ld

has_target:
name: Presence

select:
- platform: ld2420
ld2420_id: my_ld

operating_mode:
name: Operating Mode

number:
- platform: ld2420
ld2420_id: my_ld

presence_timeout:
name: Detection Presence Timeout
min_gate_distance:
Expand All @@ -119,6 +136,8 @@ Module Pinouts

button:
- platform: ld2420
ld2420_id: my_ld

apply_config:
name: Apply Config
factory_reset:
Expand All @@ -135,11 +154,14 @@ Platform
.. code-block:: yaml

ld2420:
id: my_ld
uart_id: my_uart

Configuration variables:
************************

**ld2420** (*Required*): Component platform.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART this ld2420 will utilize.


Select
Expand All @@ -151,6 +173,8 @@ Select

select:
- platform: ld2420
ld2420_id: my_ld

operating_mode:
name: Operating Mode

Expand Down Expand Up @@ -179,6 +203,7 @@ you to choose the active mode.
Configuration variables:
************************

- **ld2420_id** (*Optional*): Specify which ld2420 to use for this platform section.
- **operating_mode** (*Required*): Provisions the operating mode select component.
May contain any options from :ref:`Select <config-select>`.

Expand All @@ -189,6 +214,8 @@ Number

number:
- platform: ld2420
ld2420_id: my_ld

presence_timeout:
name: Detection Presence Timeout
min_gate_distance:
Expand Down Expand Up @@ -222,6 +249,7 @@ Number
Configuration variables:
************************

- **ld2420_id** (*Optional*): Specify which ld2420 to use for this platform section.
- **presence_timeout** (*Optional*): The time in seconds during which the occupied state (presence) will persist after
presence is no longer detected. Any energy detection within the time window restarts the countdown from this value.
Defaults to 120s. **Required** when ``min_gate_distance`` and ``max_gate_distance`` is specified. May contain any
Expand Down Expand Up @@ -267,6 +295,8 @@ Button

button:
- platform: ld2420
ld2420_id: my_ld

apply_config:
name: Apply Config
factory_reset:
Expand All @@ -281,6 +311,7 @@ Four button components are available enabling configuration controls for editing
Configuration variables:
************************

- **ld2420_id** (*Optional*): Specify which ld2420 to use for this platform section.
- **apply_config** (*Optional*): Saves both manual config tuning or the auto calibrate still and move threshold config
settings. May contain any options from :ref:`Button <config-button>`.
- **restart_module** (*Optional*): Reboots the LD2420 modules. May contain any options from :ref:`Button <config-button>`.
Expand Down Expand Up @@ -374,13 +405,16 @@ between the sensor and an object moving within its field of detection.

sensor:
- platform: ld2420
ld2420_id: my_ld

moving_distance:
name : Moving Distance


Configuration variables:
************************

- **ld2420_id** (*Optional*): Specify which ld2420 to use for this platform section.
- **moving_distance** (*Optional*): Distance between the sensor and the detected moving target. May contain any options
from :ref:`Sensor <config-sensor>`.

Expand All @@ -393,12 +427,15 @@ The ``ld2420`` binary sensor allows you to use your :doc:`ld2420` to sense prese

binary_sensor:
- platform: ld2420
ld2420_id: my_ld

has_target:
name: Presence

Configuration variables:
************************

- **ld2420_id** (*Optional*): Specify which ld2420 to use for this platform section.
- **has_target** (*Optional*): If a target is detected with either still or in movement **has_target** will be set true
for the duration of the **presence_time_window** setting. May contain any options from
:ref:`Binary Sensor <config-binary_sensor>`.
Expand All @@ -412,12 +449,15 @@ The ``ld2420`` text sensor provides version information for the :doc:`ld2420`.

text_sensor:
- platform: ld2420
ld2420_id: my_ld

fw_version:
name: LD2420 Firmware

Configuration variables:
************************

- **ld2420_id** (*Optional*): Specify which ld2420 to use for this platform section.
- **fw_version** (*Optional*): Allows you to retrieve the :doc:`ld2420` firmware version. May contain any options from
:ref:`Text Sensor <config-text_sensor>`.

Expand Down