From 61384d53125653868c000689ef876016c69cee96 Mon Sep 17 00:00:00 2001 From: Ivan Martinez Date: Tue, 1 Oct 2024 07:26:11 -0300 Subject: [PATCH 1/4] throttle option description --- docs/guide/configuration/devices-groups.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/guide/configuration/devices-groups.md b/docs/guide/configuration/devices-groups.md index 143ba1bea6259..e027c5124d6a5 100644 --- a/docs/guide/configuration/devices-groups.md +++ b/docs/guide/configuration/devices-groups.md @@ -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. From a23ac03bc986627d0173dd9b47aa8217785bb31a Mon Sep 17 00:00:00 2001 From: Ivan Martinez Date: Tue, 1 Oct 2024 17:02:37 -0300 Subject: [PATCH 2/4] update text with @Nerivec suggestions --- docs/guide/configuration/devices-groups.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guide/configuration/devices-groups.md b/docs/guide/configuration/devices-groups.md index e027c5124d6a5..ce21cf76b873e 100644 --- a/docs/guide/configuration/devices-groups.md +++ b/docs/guide/configuration/devices-groups.md @@ -99,9 +99,9 @@ hand `debounce: 1` with `debounce_ignore: - action` will publish all unique acti 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. +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. -For now this option will only work when debounce is disabled. +`debounce` option has priority over `throttle`; if both are present for one device, only `debounce` will have any effect. 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. From 6790b2515866ce37d1feabcb7710e7f8105fdfb9 Mon Sep 17 00:00:00 2001 From: Ivan Martinez Date: Tue, 1 Oct 2024 17:23:02 -0300 Subject: [PATCH 3/4] more update with @Nerivec suggestions --- docs/guide/configuration/devices-groups.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guide/configuration/devices-groups.md b/docs/guide/configuration/devices-groups.md index ce21cf76b873e..8db9a95c850ed 100644 --- a/docs/guide/configuration/devices-groups.md +++ b/docs/guide/configuration/devices-groups.md @@ -103,9 +103,9 @@ Throttle processing of messages from this device. When setting e.g. `throttle: 1 `debounce` option has priority over `throttle`; if both are present for one device, only `debounce` will have any effect. -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. +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. -This option will reduce the MQTT messages sent for this device and also reduce storage if the states are stored in homeassistant. +Some ambient sensors like `TS0601_air_quality_sensor` and some water level sensors at least are know to get improved behaviour with this setting. **`retrieve_state`** (DEPRECATED) Retrieves the state after setting it. Should only be enabled when the reporting feature From ec2bab077db332ab145048ef69b39a4e6b7042cd Mon Sep 17 00:00:00 2001 From: Ivan Martinez Date: Tue, 1 Oct 2024 18:12:37 -0300 Subject: [PATCH 4/4] more update with @Nerivec suggestions --- docs/guide/configuration/devices-groups.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/configuration/devices-groups.md b/docs/guide/configuration/devices-groups.md index 8db9a95c850ed..959a3cb89d149 100644 --- a/docs/guide/configuration/devices-groups.md +++ b/docs/guide/configuration/devices-groups.md @@ -105,7 +105,7 @@ Throttle processing of messages from this device. When setting e.g. `throttle: 1 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 at least are know to get improved behaviour with this setting. +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