From cb27abacd049bfeb15d942887dac788227f80fcb Mon Sep 17 00:00:00 2001 From: AJediIAm Date: Sun, 18 Dec 2022 21:36:06 +0100 Subject: [PATCH 1/2] Update derivative.markdown --- source/_integrations/derivative.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/source/_integrations/derivative.markdown b/source/_integrations/derivative.markdown index d4144a099b3d..b7b14b67dc30 100644 --- a/source/_integrations/derivative.markdown +++ b/source/_integrations/derivative.markdown @@ -18,8 +18,9 @@ ha_platforms: ha_integration_type: helper --- -The derivative ([Wikipedia](https://en.wikipedia.org/wiki/Derivative)) integration creates a sensor that estimates the derivative of the -values provided by another sensor (the **source sensor**). Derivative sensors are updated upon changes of the **source sensor**. +The derivative ([Wikipedia](https://en.wikipedia.org/wiki/Derivative)) integration creates a sensor that "smooths-out" another sensor (the **source sensor**). +Derivatives of the specified sensor will be averaged in a given time window with a Simple Moving Average algorithm weighted by time. This is for instance useful for a sensor that outputs discrete values, or to filter out short duration noise. +Derivative sensors are updated upon changes of the **source sensor**. For sensors that reset to zero after a power interruption and need a "non-negative derivative", such as bandwidth counters in routers, or rain gauges, consider using the [Utility Meter](/integrations/utility_meter/) integration instead. Otherwise, each reset will register a significant change in the derivative sensor. @@ -82,7 +83,7 @@ unit: required: false type: string time_window: - description: The time window in which to calculate the derivative. Derivatives in this window will be averaged with a Simple Moving Average algorithm weighted by time. This is for instance useful for a sensor that outputs discrete values, or to filter out short duration noise. By default the derivative is calculated between two consecutive updates without any smoothing. + description: The time window in which to calculate the derivative. By default the derivative is calculated between two consecutive updates without any smoothing. default: 0 required: false type: time From a24c2e7be01d80085f2b4ce2fd534247a0fb7f6d Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 6 Jan 2023 12:18:03 +0100 Subject: [PATCH 2/2] Tiny tweak --- source/_integrations/derivative.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/derivative.markdown b/source/_integrations/derivative.markdown index b7b14b67dc30..0ee3617d7d86 100644 --- a/source/_integrations/derivative.markdown +++ b/source/_integrations/derivative.markdown @@ -19,7 +19,7 @@ ha_integration_type: helper --- The derivative ([Wikipedia](https://en.wikipedia.org/wiki/Derivative)) integration creates a sensor that "smooths-out" another sensor (the **source sensor**). -Derivatives of the specified sensor will be averaged in a given time window with a Simple Moving Average algorithm weighted by time. This is for instance useful for a sensor that outputs discrete values, or to filter out short duration noise. +Derivatives of the specified sensor will be averaged in a given time window with a Simple Moving Average algorithm weighted by time. This is, for instance, useful for a sensor that outputs discrete values or to filter out short-duration noise. Derivative sensors are updated upon changes of the **source sensor**. For sensors that reset to zero after a power interruption and need a "non-negative derivative", such as bandwidth counters in routers, or rain gauges, consider using the [Utility Meter](/integrations/utility_meter/) integration instead. Otherwise, each reset will register a significant change in the derivative sensor.