Documentation for the skip_initial filter (#2760)

This commit is contained in:
Sybren A. Stüvel 2023-03-19 20:50:21 +01:00 committed by GitHub
parent 77bcde8e60
commit e01079d2be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -406,6 +406,21 @@ Configuration variables:
published. With this parameter you can specify when the very first value is to be sent.
Defaults to ``1``.
``skip_initial``
****************
A simple skip filter; `skip_initial: N` skips the first `N` sensor readings and passes on the
rest. This can be used when the sensor needs a few readings to 'warm up'. After the initial
readings have been skipped, this filter does nothing.
.. code-block:: yaml
# Example configuration entry
- platform: wifi_signal
# ...
filters:
- skip_initial: 3
``throttle``
************
@ -650,7 +665,7 @@ From :ref:`lambdas <config-lambda>`, you can call several methods on all sensors
advanced stuff (see the full API Reference for more info).
- ``publish_state()``: Manually cause the sensor to push out a value. It will then
be processed by the sensor filters, and once filtered will propagate though ESPHome and though the API to Home Assistant or out via MQTT if configured.
be processed by the sensor filters, and once filtered will propagate though ESPHome and though the API to Home Assistant or out via MQTT if configured.
.. code-block:: cpp