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-18 06:46:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update filter precision info (#23524)

Browse Source
This commit is contained in:
Geoff 2022-08-21 12:38:06 -07:00 committed by GitHub
parent 3ea6d133ef
commit ee2cb92df6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/_integrations/filter.markdown
View File

@ -78,16 +78,16 @@ filters:
description: Algorithm to be used to filter data. Available filters are `lowpass`, `outlier`, `range`, `throttle`, `time_throttle` and `time_simple_moving_average`. description: Algorithm to be used to filter data. Available filters are `lowpass`, `outlier`, `range`, `throttle`, `time_throttle` and `time_simple_moving_average`.
required: true required: true
type: string type: string
precision:
description: Defines the precision of the filtered state, through the argument of round().
required: false
type: integer
default: 2
window_size: 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). Time periods are in _hh:mm_ format and must be quoted. 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 required: false
type: [integer, time] type: [integer, time]
default: 1 default: 1
precision:
description: See [_lowpass_](#low-pass) filter. Defines the precision of the filtered state, through the argument of round().
required: false
type: integer
default: None
time_constant: time_constant:
description: See [_lowpass_](#low-pass) filter. Loosely relates to the amount of time it takes for a state to influence the output. description: See [_lowpass_](#low-pass) filter. Loosely relates to the amount of time it takes for a state to influence the output.
required: false required: false
@ -129,8 +129,6 @@ A = 1.0 - B
LowPass(state) = A * previous_state + B * state LowPass(state) = A * previous_state + B * state
``` ```
The returned value is rounded to the number of decimals defined in (`precision`).
### Outlier ### Outlier
The Outlier filter (`outlier`) is a basic Band-pass filter, as it cuts out any value outside a specific range. The Outlier filter (`outlier`) is a basic Band-pass filter, as it cuts out any value outside a specific range.