Skip to content

throttle option description #3057

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

Merged
merged 4 commits into from
Oct 2, 2024
Merged

throttle option description #3057

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
61384d5
throttle option description
ivanfmartinez Oct 1, 2024
a23ac03
update text with @Nerivec suggestions
ivanfmartinez Oct 1, 2024
6790b25
more update with @Nerivec suggestions
ivanfmartinez Oct 1, 2024
ec2bab0
more update with @Nerivec suggestions
ivanfmartinez Oct 1, 2024
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
View file
Open in desktop
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 messages of this device. When setting e.g. `throttle: 10` the first message from device is accepted but all other messages in next 10 seconds will be ignored. Be carefull when using this option, unlike debounce that can ignore some attributes this will drop entire message.

For now this option will only work when debounce is disabled.

This is handy for some sensor devices that keep sending messages each second, e.g. 'TS0601_air_quality_sensor', even without considerable changes of values, like some water level sensors and ambient sensors.

This option will reduce the MQTT messages sent for this device and also reduce storage if the states are stored in homeassistant.

**`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