Skip to content

Filter Sensor#4725

Merged
c727 merged 7 commits intohome-assistant:nextfrom
dgomes:filter
Mar 2, 2018
Merged

Filter Sensor#4725
c727 merged 7 commits intohome-assistant:nextfrom
dgomes:filter

Conversation

@dgomes
Copy link
Copy Markdown
Contributor

@dgomes dgomes commented Feb 21, 2018

Description:

Documentation for the filter component

Pull request in home-assistant (if applicable): home-assistant/core#12650

Checklist:

  • Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the [standards][standards].

logo: home-assistant.png
---

The `filter` component supports sensors which process the **numeric states** from other entities. `filter` will apply a signal processing algorithm to a serie of states and produce a `new state` given the choosen algorithm.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

series
produces/ generates/ calculates

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

`filter` will apply a signal processing algorithm to a series of states and generate a `new state` given the chosen algorithm.

I changed to series (plural), but each filter works with a single serie (singular). I'm no english speaking native, but it made sense to me. Tell me how to proceed.

name: filtered temperature
filter: outlier
options:
constant: 0.10
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this time_constant? it's not listed again in the details below

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no... it's radius... will correct


{% configuration %}
entity_id:
description: An entity ID so the sensor only reacts to state changes of this entity.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs a better description, something like Entity ID of the sensor for the input signal

sharing: true
footer: true
ha_category: Sensor
ha_release: 0.12
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0.64

@dgomes dgomes changed the title Filter component Data Filter component Feb 22, 2018
@dgomes dgomes mentioned this pull request Feb 25, 2018
4 tasks
@dgomes dgomes changed the title Data Filter component Filter Sensor Feb 25, 2018
@c727 c727 merged commit e99a85a into home-assistant:next Mar 2, 2018
corneyl pushed a commit to corneyl/home-assistant.github.io that referenced this pull request Mar 9, 2018
* Filter component

* changes as requested

* Changed the component name

* updated according to new version

* Chaining explained

* Added extra sensor and screenshot

* Update sensor.filter.markdown
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants