Merge branch 'fix/button_long_press_start_no_triggered_v2.0' into 'release/v2.0'

leeebo · leeebo · commit 0411b1639005 · 2024-12-10T11:58:47.000+08:00
fix(button): fix not triggering longpress start with polling intervals over 20ms (v2.0)

See merge request ae_group/esp-iot-solution!1166
diff --git a/README.md b/README.md
@@ -67,7 +67,7 @@ The registered components in ESP-IoT-Solution are listed below:
 | [ble_ota](https://components.espressif.com/components/espressif/ble_ota/versions/0.1.12) | [![0.1.12](https://img.shields.io/badge/Beta-0.1.12-yellow)](https://components.espressif.com/components/espressif/ble_ota/versions/0.1.12) |
 | [ble_services](https://components.espressif.com/components/espressif/ble_services/versions/0.1.0) | [![0.1.0](https://img.shields.io/badge/Beta-0.1.0-yellow)](https://components.espressif.com/components/espressif/ble_services/versions/0.1.0) |
 | [bootloader_support_plus](https://components.espressif.com/components/espressif/bootloader_support_plus/versions/0.2.6) | [![0.2.6](https://img.shields.io/badge/Beta-0.2.6-yellow)](https://components.espressif.com/components/espressif/bootloader_support_plus/versions/0.2.6) |
-| [button](https://components.espressif.com/components/espressif/button/versions/3.4.0) | [![3.4.0](https://img.shields.io/badge/Stable-3.4.0-blue)](https://components.espressif.com/components/espressif/button/versions/3.4.0) |
+| [button](https://components.espressif.com/components/espressif/button/versions/3.4.1) | [![3.4.1](https://img.shields.io/badge/Stable-3.4.1-blue)](https://components.espressif.com/components/espressif/button/versions/3.4.1) |
 | [cmake_utilities](https://components.espressif.com/components/espressif/cmake_utilities/versions/1.0.0) | [![1.0.0](https://img.shields.io/badge/Stable-1.0.0-blue)](https://components.espressif.com/components/espressif/cmake_utilities/versions/1.0.0) |
 | [drv10987](https://components.espressif.com/components/espressif/drv10987/versions/0.1.0) | [![0.1.0](https://img.shields.io/badge/Beta-0.1.0-yellow)](https://components.espressif.com/components/espressif/drv10987/versions/0.1.0) |
 | [elf_loader](https://components.espressif.com/components/espressif/elf_loader/versions/0.1.0) | [![0.1.0](https://img.shields.io/badge/Beta-0.1.0-yellow)](https://components.espressif.com/components/espressif/elf_loader/versions/0.1.0) |
diff --git a/README_CN.md b/README_CN.md
@@ -67,7 +67,7 @@ ESP-IoT-Solution 中注册的组件如下:
 | [ble_ota](https://components.espressif.com/components/espressif/ble_ota/versions/0.1.12) | [![0.1.12](https://img.shields.io/badge/Beta-0.1.12-yellow)](https://components.espressif.com/components/espressif/ble_ota/versions/0.1.12) |
 | [ble_services](https://components.espressif.com/components/espressif/ble_services/versions/0.1.0) | [![0.1.0](https://img.shields.io/badge/Beta-0.1.0-yellow)](https://components.espressif.com/components/espressif/ble_services/versions/0.1.0) |
 | [bootloader_support_plus](https://components.espressif.com/components/espressif/bootloader_support_plus/versions/0.2.6) | [![0.2.6](https://img.shields.io/badge/Beta-0.2.6-yellow)](https://components.espressif.com/components/espressif/bootloader_support_plus/versions/0.2.6) |
-| [button](https://components.espressif.com/components/espressif/button/versions/3.4.0) | [![3.4.0](https://img.shields.io/badge/Stable-3.4.0-blue)](https://components.espressif.com/components/espressif/button/versions/3.4.0) |
+| [button](https://components.espressif.com/components/espressif/button/versions/3.4.1) | [![3.4.1](https://img.shields.io/badge/Stable-3.4.1-blue)](https://components.espressif.com/components/espressif/button/versions/3.4.1) |
 | [cmake_utilities](https://components.espressif.com/components/espressif/cmake_utilities/versions/1.0.0) | [![1.0.0](https://img.shields.io/badge/Stable-1.0.0-blue)](https://components.espressif.com/components/espressif/cmake_utilities/versions/1.0.0) |
 | [drv10987](https://components.espressif.com/components/espressif/drv10987/versions/0.1.0) | [![0.1.0](https://img.shields.io/badge/Beta-0.1.0-yellow)](https://components.espressif.com/components/espressif/drv10987/versions/0.1.0) |
 | [elf_loader](https://components.espressif.com/components/espressif/elf_loader/versions/0.1.0) | [![0.1.0](https://img.shields.io/badge/Beta-0.1.0-yellow)](https://components.espressif.com/components/espressif/elf_loader/versions/0.1.0) |
diff --git a/components/button/CHANGELOG.md b/components/button/CHANGELOG.md
@@ -1,5 +1,12 @@
 # ChangeLog
 
+## v3.4.1 - 2024-12-6
+
+### Fix:
+
+* Fix the issue where `BUTTON_LONG_PRESS_START` is not triggered when the polling interval exceeds 20ms.
+* Remove the `BUTTON_LONG_PRESS_TOLERANCE_MS` configuration option.
+
 ## v3.4.0 - 2024-10-22
 
 ### Enhancements:
diff --git a/components/button/Kconfig b/components/button/Kconfig
@@ -24,10 +24,6 @@ menu "IoT Button"
         range 500 5000
         default 1500
 
-    config BUTTON_LONG_PRESS_TOLERANCE_MS
-        int "BUTTON LONG PRESS TOLERANCE TIME (MS)"
-        default 20
-
     config BUTTON_SERIAL_TIME_MS
         int "BUTTON SERIAL TIME (MS)"
         range 2 1000
diff --git a/components/button/idf_component.yml b/components/button/idf_component.yml
@@ -1,4 +1,4 @@
-version: "3.4.0"
+version: "3.4.1"
 description: GPIO and ADC button driver
 url: https://github.com/espressif/esp-iot-solution/tree/master/components/button
 repository: https://github.com/espressif/esp-iot-solution.git
diff --git a/components/button/iot_button.c b/components/button/iot_button.c
@@ -94,7 +94,7 @@ static button_power_save_config_t power_save_usr_cfg = {0};
 #define SHORT_TICKS       (CONFIG_BUTTON_SHORT_PRESS_TIME_MS /TICKS_INTERVAL)
 #define LONG_TICKS        (CONFIG_BUTTON_LONG_PRESS_TIME_MS /TICKS_INTERVAL)
 #define SERIAL_TICKS      (CONFIG_BUTTON_SERIAL_TIME_MS /TICKS_INTERVAL)
-#define TOLERANCE         CONFIG_BUTTON_LONG_PRESS_TOLERANCE_MS
+#define TOLERANCE         (CONFIG_BUTTON_PERIOD_TIME_MS*4)
 
 #define CALL_EVENT_CB(ev)                                                   \
     if (btn->cb_info[ev]) {                                                 \
@@ -148,7 +148,7 @@ static void button_handler(button_dev_t *btn)
             btn->ticks = 0;
             btn->state = 2;
 
-        } else if (btn->ticks > btn->long_press_ticks) {
+        } else if (btn->ticks >= btn->long_press_ticks) {
             btn->event = (uint8_t)BUTTON_LONG_PRESS_START;
             btn->state = 4;
             /** Calling callbacks for BUTTON_LONG_PRESS_START */
diff --git a/components/button/test_apps/main/button_test.c b/components/button/test_apps/main/button_test.c
@@ -595,7 +595,7 @@ TEST_CASE("gpio button auto-test", "[button][iot][auto]")
     vTaskDelay(pdMS_TO_TICKS(100));
 }
 
-#define TOLERANCE CONFIG_BUTTON_LONG_PRESS_TOLERANCE_MS
+#define TOLERANCE (CONFIG_BUTTON_PERIOD_TIME_MS * 4)
 
 uint16_t long_press_time[5] = {2000, 2500, 3000, 3500, 4000};
 static SemaphoreHandle_t long_press_check = NULL;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: "3.4.0"`
	`1`	`+version: "3.4.1"`
`2`	`2`	`description: GPIO and ADC button driver`
`3`	`3`	`url: https://github.com/espressif/esp-iot-solution/tree/master/components/button`
`4`	`4`	`repository: https://github.com/espressif/esp-iot-solution.git`
Original file line number	Diff line number	Diff line change
`@@ -595,7 +595,7 @@ TEST_CASE("gpio button auto-test", "[button][iot][auto]")`
`595`	`595`	`vTaskDelay(pdMS_TO_TICKS(100));`
`596`	`596`	`}`
`597`	`597`
`598`		`-#define TOLERANCE CONFIG_BUTTON_LONG_PRESS_TOLERANCE_MS`
	`598`	`+#define TOLERANCE (CONFIG_BUTTON_PERIOD_TIME_MS * 4)`
`599`	`599`
`600`	`600`	`uint16_t long_press_time[5] = {2000, 2500, 3000, 3500, 4000};`
`601`	`601`	`static SemaphoreHandle_t long_press_check = NULL;`