jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 00:36:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documentation for window_size parameter of filter sensor (#12297)

Browse Source 
This fixes #12289.
This commit is contained in:
sithmein 2020-03-06 20:47:00 +01:00 committed by GitHub
parent e2555e3816
commit bc73d7d2c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/_integrations/filter.markdown
View File

@ -46,7 +46,7 @@ sensor:
- filter: lowpass
time_constant: 10
- filter: time_simple_moving_average
window_size: 00:05
window_size: "00:05"
precision: 2
```
@ -71,7 +71,7 @@ filters:
required: true
type: string
window_size:
description: Size of the window of previous states. Time based filters such as `time_simple_moving_average` will require a time period (size in time), while other filters such as `outlier` will require an integer (size in number of states)
description: Size of the window of previous states. Time based filters such as `time_simple_moving_average` will require a time period (size in time), while other filters such as `outlier` will require an integer (size in number of states). Time periods are in _hh:mm_ format and must be quoted.
required: false
type: [integer, time]
default: 1
@ -150,7 +150,7 @@ This filter is relevant when you have a sensor which produces states at a very h
The Time Throttle filter (`time_throttle`) will only update the state of the sensor for the first state in the window. This means the filter will skip all other values.
To adjust the rate you need to set the window_size. To throttle a sensor down to 1 value per minute, the `window_size` should be set to 00:01.
To adjust the rate you need to set the window_size. To throttle a sensor down to 1 value per minute, the `window_size` should be set to "00:01".
This filter is relevant when you have a sensor which produces states at a very high inconstant rate, which you might want to throttle down to some constant rate for storing or visualization purposes.
@ -160,7 +160,7 @@ The Time SMA filter (`time_simple_moving_average`) is based on the paper [Algori
The paper defines three types/versions of the Simple Moving Average (SMA): *last*, *next* and *linear*. Currently only *last* is implemented.
Theta, as described in the paper, is the `window_size` parameter, and can be expressed using time notation (e.g., 00:05 for a five minutes time window).
Theta, as described in the paper, is the `window_size` parameter, and can be expressed using time notation (e.g., "00:05" for a five minutes time window).
### Range