Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-11-16 10:55:21 +01:00
Code Issues Projects Releases Wiki Activity

Add the documentation for the autorepeat filter (#1093)

Browse Source 
* add the documentation for the autorepeat filter

* make no timing equivalent to a single default one
This commit is contained in:
Stanislav Meduna 2021-05-13 22:37:06 +02:00 committed by GitHub
parent c53de5484f
commit d125a5de77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
components/binary_sensor/index.rst
View File

@ -78,6 +78,13 @@ of these entries matters!)
- delayed_on: 100ms
- delayed_off: 100ms
- delayed_on_off: 100ms
- autorepeat:
- delay: 1s
time_off: 100ms
time_on: 900ms
- delay: 5s
time_off: 100ms
time_on: 400ms
- lambda: |-
if (id(other_binary_sensor).state) {
return x;
@ -113,6 +120,28 @@ Only send an OFF value if the binary sensor has stayed OFF for at least the spec
for at least the specified time period.
**Useful for debouncing binary switches**.
``autorepeat``
**************
A filter implementing the autorepeat behavior. The filter is parametrized by a list of timing descriptions.
When a signal ON is received it is passed to the output and the first ``delay`` is started. When this
interval expires the output is turned OFF and toggles using the ``time_off`` and ``time_on`` durations
for the OFF and ON state respectively. At the same time the ``delay`` of the second timing description
is started and the process is repeated until the list is exhausted, in which case the timing of the
last description remains in use. Receiving an OFF signal stops the whole process and immediately outputs OFF.
The example thus waits one second with the output being ON, toggles it once per second for five seconds,
then toggles twice per second until OFF is received.
An ``autorepeat`` filter with no timing description is equivalent to one timing with all the parameters
set to default values.
Configuration variables:
- **delay** (*Optional*, :ref:`config-time`): Delay to proceed to the next timing. Defaults to ``1s``.
- **time_off** (*Optional*, :ref:`config-time`): Interval to hold the output at OFF. Defaults to ``100ms``.
- **time_on** (*Optional*, :ref:`config-time`): Interval to hold the output at ON. Defaults to ``900ms``.
``lambda``
**********