From 7de8d193adb615b13fc7279f59092fc4433a4d87 Mon Sep 17 00:00:00 2001 From: cstaahl <44496349+cstaahl@users.noreply.github.com> Date: Sun, 20 Feb 2022 21:32:50 +0100 Subject: [PATCH] Added documentation for the pulse_meter internal_filter_mode (#1832) --- components/sensor/pulse_meter.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/components/sensor/pulse_meter.rst b/components/sensor/pulse_meter.rst index f8cfa45d1..d91fc5ad6 100644 --- a/components/sensor/pulse_meter.rst +++ b/components/sensor/pulse_meter.rst @@ -26,6 +26,9 @@ Configuration variables: - **internal_filter** (*Optional*, :ref:`config-time`): If a pulse shorter than this time is detected, it’s discarded and no pulse is counted. Defaults to ``13us``. For S0 pulse meters that are used to meter power consumption 50-100 ms is a reasonable value. +- **internal_filter_mode** (*Optional*, string): Determines how the internal filter is applied. + One of ``EDGE`` and ``PULSE``. Defaults to ``EDGE``. In ``EDGE`` mode subsequent rising edges are compared and if they fall into an interval lesser than the internal filter value, the last one is discarded. In ``PULSE`` mode the rising edge is discarded if any further interrupts are detected before the internal_filter time has passed. In other words, a high pulse must be at least internal_filter long to be counted. This is useful if you are detecting long pulses that may bounces before and/or after the main pulse. + - **timeout** (*Optional*, :ref:`config-time`): If we don't see a pulse for this length of time, we assume 0 pulses/sec. Defaults to ``5 min``. - **total** (*Optional*, :ref:`config-id`): An additional sensor that outputs the total number of pulses counted. - All other options from :ref:`Sensor `.