Add Update by time filter

[dbrand666]

Proposed change

As currently implemented, the Time Simple Moving Average filter only gets updated when it receives a new value. This is counter to most people's expectations. See, for example, #57337 "the Time Simple Moving Average shows wrong state when the input sensor doesn't change state".

This is an old issue and Daniel Hjelseth Høyer had created and then abandoned #53053 as an enhancement to let the user ask HA to update the state periodically. That was about 3 years ago.

I rebased that deleted branch, fixed it a bit, and added a test. I think it's time we get this merged.

I followed his lead and left the old behavior intact and added a new flag update_by_time to the existing SMA filter that tells it to update as the time changes - not just on new data.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: Time Simple Moving Average shows wrong state when the input sensor doesn't change state #57337
• Link to documentation pull request: Document new Time SMA Filter flag, update_by_time. home-assistant.io#36181

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Ruff (ruff format homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

Hi @dbrand666

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

[home-assistant]

Hey there @dgomes, mind taking a look at this pull request as it has been labeled with an integration (filter) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of filter can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign filter Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

[dgomes]

Not sure if update by time should be considered a filter

[dbrand666]

Not sure if update by time should be considered a filter

I'm not sure what you mean. Are you thinking that I should create a new filter for this rather than adding the flag to TimeSMAFilter? What would I call it? TimeSMAFilterV2? TimedTimeSMAFilter? Just TimedSMAFilter?

My own preference would be to treat this as a bugfix and get rid of the update_by_time flag - I really can't see anyone actually expecting the current behavior.

[dgomes]

Filter is something that processes the output of a source sensor, this is more like a sampler (therefore the need to update by time which is not commanded by the source)

That's also the reason I created https://github.com/dgomes/ha_sampler to keep it separate.

But lets listen to other folks