Merge branch 'feat/add_touch_button_example' into 'master'

feat(touch_button): add touch button component

See merge request ae_group/esp-iot-solution!1251

Author: lijunru-hub

.github/workflows/upload_component.yml

@@ -84,6 +84,7 @@ jobs:
             components/sensors/sensor_hub;
             components/spi_bus;
             components/storage/eeprom/at24c02;
+            components/touch/touch_button;
             components/touch/touch_button_sensor;
             components/touch/touch_proximity_sensor;
             components/usb/esp_msc_ota;

.gitlab/ci/build.yml

@@ -712,6 +712,18 @@ build_example_sensors_sensor_hub_monitor:
   variables:
     EXAMPLE_DIR: examples/sensors/sensor_hub_monitor
 
+build_example_touch_button:
+  extends:
+    - .build_examples_template
+    - .rules:build:example_touch_touch_button
+  parallel:
+    matrix:
+      - IMAGE: espressif/idf:release-v4.4
+      - IMAGE: espressif/idf:release-v5.1
+      - IMAGE: espressif/idf:release-v5.4
+  variables:
+    EXAMPLE_DIR: examples/touch/touch_button
+
 build_example_touch_button_sensor:
   extends:
     - .build_examples_template
@@ -1509,6 +1521,16 @@ build_components_touch_touch_proximity_sensor_test_apps:
   variables:
     EXAMPLE_DIR: components/touch/touch_proximity_sensor/test_apps
 
+build_components_touch_touch_button_test_apps:
+  extends:
+    - .build_examples_template
+    - .rules:build:components_touch_touch_button_test_apps
+  parallel:
+    matrix:
+      - IMAGE: espressif/idf:release-v5.3
+  variables:
+    EXAMPLE_DIR: components/touch/touch_button/test_apps
+
 build_components_touch_touch_button_sensor_test_apps:
   extends:
     - .build_examples_template

.gitlab/ci/rules.yml

@@ -206,7 +206,7 @@
 
 .patterns-components_sensors_power_measure: &patterns-components_sensors_power_measure
   - "components/sensors/power_measure/**/*"
-  - "components/tools/cmake_utilities/package_manager.cmake"
+  - "tools/cmake_utilities/package_manager.cmake"
 
 .patterns-components_sensors_adc_mcp3201: &patterns-components_sensors_adc_mcp3201
   - "components/sensors/adc/mcp3201/**/*"
@@ -287,6 +287,10 @@
   - "components/touch/touch_proximity_sensor/**/*"
   - "tools/cmake_utilities/package_manager.cmake"
 
+.patterns-components_touch_touch_button: &patterns-components_touch_touch_button
+  - "components/touch/touch_button/**/*"
+  - "tools/cmake_utilities/package_manager.cmake"
+
 .patterns-components_touch_touch_button_sensor: &patterns-components_touch_touch_button_sensor
   - "components/touch/touch_button_sensor/**/*"
   - "tools/cmake_utilities/package_manager.cmake"
@@ -1296,6 +1300,17 @@
     - <<: *if-dev-push
       changes: *patterns-example_sensors_sensor_hub_monitor
 
+.rules:build:example_touch_touch_button:
+  rules:
+    - <<: *if-protected
+    - <<: *if-label-build
+    - <<: *if-dev-push
+      changes: *patterns-build_system
+    - <<: *if-dev-push
+      changes: *patterns-example_touch_touch_button
+    - <<: *if-dev-push
+      changes: *patterns-components_touch_touch_button
+
 .rules:build:example_touch_touch_button_sensor:
   rules:
     - <<: *if-protected
@@ -2352,6 +2367,17 @@
     - <<: *if-dev-push
       changes: *patterns-components_touch_touch_proximity_sensor
 
+.rules:build:components_touch_touch_button_test_apps:
+  rules:
+    - <<: *if-protected
+    - <<: *if-label-build
+    - <<: *if-label-target_test
+    - <<: *if-trigger-job
+    - <<: *if-dev-push
+      changes: *patterns-build_system
+    - <<: *if-dev-push
+      changes: *patterns-components_touch_touch_button
+
 .rules:build:components_touch_touch_button_sensor_test_apps:
   rules:
     - <<: *if-protected

README.md

@@ -128,6 +128,7 @@ The registered components in ESP-IoT-Solution are listed below:
 | [servo](https://components.espressif.com/components/espressif/servo) | [![Component Registry](https://components.espressif.com/components/espressif/servo/badge.svg)](https://components.espressif.com/components/espressif/servo) |
 | [sht3x](https://components.espressif.com/components/espressif/sht3x) | [![Component Registry](https://components.espressif.com/components/espressif/sht3x/badge.svg)](https://components.espressif.com/components/espressif/sht3x) |
 | [spi_bus](https://components.espressif.com/components/espressif/spi_bus) | [![Component Registry](https://components.espressif.com/components/espressif/spi_bus/badge.svg)](https://components.espressif.com/components/espressif/spi_bus) |
+| [touch_button](https://components.espressif.com/components/espressif/touch_button) | [![Component Registry](https://components.espressif.com/components/espressif/touch_button/badge.svg)](https://components.espressif.com/components/espressif/touch_button) |
 | [touch_button_sensor](https://components.espressif.com/components/espressif/touch_button_sensor) | [![Component Registry](https://components.espressif.com/components/espressif/touch_button_sensor/badge.svg)](https://components.espressif.com/components/espressif/touch_button_sensor) |
 | [touch_proximity_sensor](https://components.espressif.com/components/espressif/touch_proximity_sensor) | [![Component Registry](https://components.espressif.com/components/espressif/touch_proximity_sensor/badge.svg)](https://components.espressif.com/components/espressif/touch_proximity_sensor) |
 | [usb_device_uac](https://components.espressif.com/components/espressif/usb_device_uac) | [![Component Registry](https://components.espressif.com/components/espressif/usb_device_uac/badge.svg)](https://components.espressif.com/components/espressif/usb_device_uac) |

README_CN.md

@@ -128,6 +128,7 @@ ESP-IoT-Solution 中注册的组件如下:
 | [servo](https://components.espressif.com/components/espressif/servo) | [![Component Registry](https://components.espressif.com/components/espressif/servo/badge.svg)](https://components.espressif.com/components/espressif/servo) |
 | [sht3x](https://components.espressif.com/components/espressif/sht3x) | [![Component Registry](https://components.espressif.com/components/espressif/sht3x/badge.svg)](https://components.espressif.com/components/espressif/sht3x) |
 | [spi_bus](https://components.espressif.com/components/espressif/spi_bus) | [![Component Registry](https://components.espressif.com/components/espressif/spi_bus/badge.svg)](https://components.espressif.com/components/espressif/spi_bus) |
+| [touch_button](https://components.espressif.com/components/espressif/touch_button) | [![Component Registry](https://components.espressif.com/components/espressif/touch_button/badge.svg)](https://components.espressif.com/components/espressif/touch_button) |
 | [touch_button_sensor](https://components.espressif.com/components/espressif/touch_button_sensor) | [![Component Registry](https://components.espressif.com/components/espressif/touch_button_sensor/badge.svg)](https://components.espressif.com/components/espressif/touch_button_sensor) |
 | [touch_proximity_sensor](https://components.espressif.com/components/espressif/touch_proximity_sensor) | [![Component Registry](https://components.espressif.com/components/espressif/touch_proximity_sensor/badge.svg)](https://components.espressif.com/components/espressif/touch_proximity_sensor) |
 | [usb_device_uac](https://components.espressif.com/components/espressif/usb_device_uac) | [![Component Registry](https://components.espressif.com/components/espressif/usb_device_uac/badge.svg)](https://components.espressif.com/components/espressif/usb_device_uac) |

components/.build-rules.yml

@@ -12,6 +12,10 @@ components/avi_player/test_apps:
   enable:
     - if: IDF_TARGET in ["esp32s3", "esp32p4"]
 
+components/touch/touch_button/test_apps:
+  enable:
+    - if: IDF_TARGET in ["esp32s2", "esp32s3", "esp32p4"]
+
 components/touch/touch_button_sensor/test_apps:
   enable:
     - if: IDF_TARGET in ["esp32", "esp32s2", "esp32s3"] and (IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR == 1)

components/button/test_apps/main/CMakeLists.txt

@@ -3,7 +3,6 @@ if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "5.0")
 endif()
 
 idf_component_register(SRC_DIRS "."
-                       PRIV_REQUIRES esp_event
                        PRIV_INCLUDE_DIRS "."
-                       PRIV_REQUIRES unity test_utils button ${PRIVREQ}
+                       PRIV_REQUIRES esp_event unity test_utils button ${PRIVREQ}
                        WHOLE_ARCHIVE)

components/touch/touch_button/CHANGELOG.md

@@ -0,0 +1,5 @@
+# ChangeLog
+
+## v0.1.0 - 2025-03-18
+
+* Add Initial version

components/touch/touch_button/CMakeLists.txt

@@ -0,0 +1,5 @@
+idf_component_register(SRC_DIRS "."
+                    INCLUDE_DIRS ".")
+
+include(package_manager)
+cu_pkg_define_version(${CMAKE_CURRENT_LIST_DIR})

components/touch/touch_button/README.md

@@ -0,0 +1,25 @@
+[![Component Registry](https://components.espressif.com/components/espressif/touch_button/badge.svg)](https://components.espressif.com/components/espressif/touch_button)
+
+# Touch Button
+
+Supports a series of operations on touch buttons, such as press, release, long press, and short press.
+
+**Note:** This component is for developers testing only. It is not intended for production use.
+
+ESP32/ESP32-S2/ESP32-S3 touch-related components are intended for testing or demo purposes only. Due to the poor anti-interference capability of the touch functionality, it may not pass EMS testing, and therefore, it is not recommended for mass production products.
+
+This component is currently applicable to ESP32, ESP32-S2, and ESP32-S3, and ESP32-P4 and requires an IDF version greater than or equal to v4.4 and less than or equal to v5.4.
+
+## Dependencies
+
+- [touch_sensor_fsm](https://components.espressif.com/components/espressif/touch_sensor_fsm)
+- [touch_sensor_lowlevel](https://components.espressif.com/components/espressif/touch_sensor_lowlevel)
+- [touch_button_sensor](https://components.espressif.com/components/espressif/touch_button_sensor)
+
+## Add component to your project
+
+Please use the component manager command `add-dependency` to add the `touch_button` to your project's dependency, during the `CMake` step the component will be downloaded automatically
+
+```
+idf.py add-dependency "espressif/touch_button=*"
+```