document value parameter for timeout filter (#3115)

Co-authored-by: Samuel Sieb <samuel@sieb.net>
This commit is contained in:
Samuel Sieb 2023-08-09 22:11:07 -07:00 committed by GitHub
parent 05b59d3799
commit 434888aabd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -495,10 +495,19 @@ of the input values.
************
After the first value has been sent, if no subsequent value is published within the
``specified time period``, send ``NaN``.
``specified time period``, send a value which defaults to ``NaN``.
Especially useful when data is derived from some other communication
channel, e.g. a serial port, which can potentially be interrupted.
.. code-block:: yaml
# Example filters:
filters:
- timeout: 10s # sent value will be NaN
- timeout:
timeout: 10s
value: 0
``debounce``
************