Skip to content

Commit d013b89

Browse files
kbx81jesserockz
andauthored
[ld2450] Update docs for removal of throttle (#5226)
Co-authored-by: Jesse Hills <[email protected]>
1 parent 4bb9937 commit d013b89

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

components/sensor/ld2450.rst

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,13 @@ properly support the default 256000 baud rate of the LD2450 module.
4747
# ld2450 configuration
4848
ld2450:
4949
id: ld2450_radar
50-
throttle: 1000ms
5150
5251
Configuration variables:
5352
************************
5453

5554
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this :doc:`ld2450` component.
5655
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component <uart>` to use.
5756
Required if you have multiple UARTs configured.
58-
- **throttle** (*Optional*, int): Time in milliseconds to control the rate of data updates. Defaults to ``1000ms``.
59-
6057

6158
.. _ld2450-binary-sensors:
6259

@@ -88,6 +85,20 @@ Configuration variables:
8885
- **has_still_target** (*Optional*): True if a still target is detected.
8986
All options from :ref:`Binary Sensor <config-binary_sensor>`.
9087

88+
.. note::
89+
90+
By default, each of the :doc:`Binary Sensor </components/binary_sensor/index>` components above includes the
91+
following :ref:`filter<binary_sensor-filters>` by default to prevent flooding Home Assistant with state updates:
92+
93+
.. code-block:: yaml
94+
95+
- settle: 1000ms
96+
97+
If you have defined other filters, this default will be overridden; you may of course add it back to your custom
98+
filter(s) as above if you wish.
99+
100+
To remove the default filter for a any given binary sensor instance, add ``filters: []`` to its configuration.
101+
91102
.. _ld2450-sensors:
92103

93104
Sensor
@@ -206,6 +217,23 @@ Configuration variables:
206217
- **moving_target_count** (*Optional*, int): Count of moving targets in the zone. All options from
207218
:ref:`Sensor <config-sensor>`.
208219

220+
.. note::
221+
222+
By default, each of the :doc:`Sensor </components/sensor/index>` components above includes the following
223+
:ref:`filters<sensor-filters>` by default to prevent flooding Home Assistant with state updates:
224+
225+
.. code-block:: yaml
226+
227+
- timeout:
228+
timeout: 1s
229+
value: last
230+
- throttle_with_priority: 1000ms
231+
232+
If you have defined other filters, this default will be overridden; you may of course add it back to your custom
233+
filter(s) as above if you wish.
234+
235+
To remove the default filters for a any given sensor instance, add ``filters: []`` to its configuration.
236+
209237
.. _ld2450-switch:
210238

211239
Switch

0 commit comments

Comments
 (0)