Skip to content

Commit

Permalink
Fixed documentation for window_size parameter of filter sensor (home-…
Browse files Browse the repository at this point in the history
  • Loading branch information
thorsten-meinl-knime authored Mar 6, 2020
1 parent e2555e3 commit bc73d7d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions source/_integrations/filter.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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
Expand Down Expand Up @@ -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.

Expand All @@ -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

Expand Down

0 comments on commit bc73d7d

Please sign in to comment.