Skip to content

Improve Heartbeat filter #5451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open

Improve Heartbeat filter #5451

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62cfb78
optimistic mode
pkejval Oct 6, 2025
1b84646
fix space
pkejval Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions content/components/sensor/filter/heartbeat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,16 @@ description: ""
headless: true
---

Send the value periodically with the specified time interval.
If the sensor value changes during the interval the interval will not reset.
The last value of the sensor will be sent.
Send the sensor value periodically at the specified time interval. If the sensor value changes during this interval, the timer will not reset — the last known value of the sensor will still be sent when the interval elapses.

So a value of `10s` will cause the filter to output values every 10s regardless
of the input values.
For example, a value of `10s` will cause the filter to output the last known value every 10 seconds, regardless of how often the input value changes.

When using `optimistic` mode, the filter will still repeat the last known value at the configured interval, but in addition, every new incoming value is published immediately as it arrives.
This ensures that the sensor output updates instantly on change, while maintaining a steady periodic "heartbeat" of the last value between updates. This mode is useful for sensors where immediate responsiveness is desired.

Configuration variables:

- **period** (Required, time):
The interval at which the last known value is republished.
- **optimistic** (*Optional*, boolean):
When enabled, every new incoming value is published immediately as it arrives, regardless of the configured time interval.