From 2f81ac49b57305c1ebb52ad10d48e0188526d0b5 Mon Sep 17 00:00:00 2001
From: Gabe Cook <gabe565@gmail.com>
Date: Fri, 5 Mar 2021 07:10:31 -0600
Subject: [PATCH] Document new min/max filters (#1032)

---
 components/sensor/index.rst | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/components/sensor/index.rst b/components/sensor/index.rst
index 2dd80663a..eca9127cc 100644
--- a/components/sensor/index.rst
+++ b/components/sensor/index.rst
@@ -249,6 +249,41 @@ sensor data. A large window size will make the filter slow to react to input cha
       Must be smaller than or equal to ``send_every``
       Defaults to ``1``.
 
+``min`` / ``max``
+*****************
+
+Calculate min/max over the data. A large window size will make the filter slow to
+react to input changes.
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    - platform: wifi_signal
+      # ...
+      filters:
+        - min:
+            window_size: 7
+            send_every: 4
+            send_first_at: 3
+
+-  **min**: A moving minimum over the last few values.
+
+-  **max**: A moving maximum over the last few values.
+
+-  Both accept the following parameters:
+
+   -  **window_size**: The number of values over which to calculate the min/max
+      when pushing out a value.
+      Defaults to ``5``.
+   -  **send_every**: How often a sensor value should be pushed out. For
+      example, in above configuration the min is calculated after every 4th
+      received sensor value, over the last 7 received values.
+      Defaults to ``5``.
+   -  **send_first_at**: By default, the very first raw value on boot is immediately
+      published. With this parameter you can specify when the very first value is to be sent.
+      Must be smaller than or equal to ``send_every``
+      Defaults to ``1``.
+
 ``sliding_window_moving_average`` / ``exponential_moving_average``
 ******************************************************************