Skip to content
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.

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

throttle option description #3057

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions docs/guide/configuration/devices-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,15 @@ and `debounce` option without `debounce_ignore` publishes only last payload with
hand `debounce: 1` with `debounce_ignore: - action` will publish all unique action messages, at least two (
e.g. `action: rotate_left` and `action: rotate_stop`)

**`throttle`**
Throttle processing of messages from this device. When setting e.g. `throttle: 10` the first message from the device is processed but all other messages within the next 10 seconds are ignored. Be careful when using this option, unlike `debounce` that can ignore some attributes, this will drop the entire message.

`debounce` option has priority over `throttle`; if both are present for one device, only `debounce` will have any effect.

Setting this option reduces the number of MQTT messages sent for a particular device. This is directly linked to how high the option is set. When used on misbehaving devices with proper values, it can drastically reduce the size of external databases that store history (like Home Assistant), and yet have little to no impact on the quality of said history.

Some ambient sensors like `TS0601_air_quality_sensor` and some water level sensors, among others, are known to benefit from this option

**`retrieve_state`**
(DEPRECATED) Retrieves the state after setting it. Should only be enabled when the reporting feature
does not work for this device.
Expand Down