Merge branch 'feat/touch_slider' into 'master'

feat: add touch slider component

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

Author: leeebo

.github/workflows/upload_component.yml

@@ -87,6 +87,7 @@ jobs:
             components/touch/touch_button;
             components/touch/touch_button_sensor;
             components/touch/touch_proximity_sensor;
+            components/touch/touch_slider_sensor;
             components/usb/esp_msc_ota;
             components/usb/esp_tinyuf2;
             components/usb/iot_usbh;

.gitlab/ci/build.yml

@@ -736,6 +736,18 @@ build_example_touch_button_sensor:
   variables:
     EXAMPLE_DIR: examples/touch/touch_button_sensor
 
+build_example_touch_slider_sensor:
+  extends:
+    - .build_examples_template
+    - .rules:build:example_touch_touch_slider_sensor
+  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_slider_sensor
+
 build_example_touch_touch_proximity:
   extends:
     - .build_examples_template
@@ -1567,6 +1579,16 @@ build_components_touch_touch_button_sensor_test_apps:
   variables:
     EXAMPLE_DIR: components/touch/touch_button_sensor/test_apps
 
+build_components_touch_touch_slider_sensor_test_apps:
+  extends:
+    - .build_examples_template
+    - .rules:build:components_touch_touch_slider_sensor_test_apps
+  parallel:
+    matrix:
+      - IMAGE: espressif/idf:release-v5.3
+  variables:
+    EXAMPLE_DIR: components/touch/touch_slider_sensor/test_apps
+
 build_components_usb_esp_msc_ota_test_apps:
   extends:
     - .build_examples_template

.gitlab/ci/rules.yml

@@ -295,6 +295,10 @@
   - "components/touch/touch_button_sensor/**/*"
   - "tools/cmake_utilities/package_manager.cmake"
 
+.patterns-components_touch_touch_slider_sensor: &patterns-components_touch_touch_slider_sensor
+  - "components/touch/touch_slider_sensor/**/*"
+  - "tools/cmake_utilities/package_manager.cmake"
+
 .patterns-components_usb_esp_msc_ota: &patterns-components_usb_esp_msc_ota
   - "components/usb/esp_msc_ota/**/*"
   - "tools/cmake_utilities/package_manager.cmake"
@@ -560,6 +564,9 @@
 .patterns-example_touch_touch_proximity: &patterns-example_touch_touch_proximity
   - "examples/touch/touch_proximity/**/*"
 
+.patterns-example_touch_touch_slider: &patterns-example_touch_touch_slider
+  - "examples/touch/touch_slider_sensor/**/*"
+
 .patterns-example_ulp_lp_cpu_lp_environment_sensor: &patterns-example_ulp_lp_cpu_lp_environment_sensor
   - "examples/ulp/lp_cpu/lp_environment_sensor/**/*"
 
@@ -1344,6 +1351,17 @@
     - <<: *if-dev-push
       changes: *patterns-components_touch_touch_proximity_sensor
 
+.rules:build:example_touch_touch_slider_sensor:
+  rules:
+    - <<: *if-protected
+    - <<: *if-label-build
+    - <<: *if-dev-push
+      changes: *patterns-build_system
+    - <<: *if-dev-push
+      changes: *patterns-example_touch_touch_slider
+    - <<: *if-dev-push
+      changes: *patterns-components_touch_touch_slider_sensor
+
 .rules:build:example_ulp_lp_cpu_lp_environment_sensor:
   rules:
     - <<: *if-protected
@@ -2422,6 +2440,17 @@
     - <<: *if-dev-push
       changes: *patterns-components_touch_touch_button_sensor
 
+.rules:build:components_touch_touch_slider_sensor_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_slider_sensor
+
 .rules:build:components_usb_esp_msc_ota_test_apps:
   rules:
     - <<: *if-protected

README.md

@@ -132,6 +132,7 @@ The registered components in ESP-IoT-Solution are listed below:
 | [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) |
+| [touch_slider_sensor](https://components.espressif.com/components/espressif/touch_slider_sensor) | [![Component Registry](https://components.espressif.com/components/espressif/touch_slider_sensor/badge.svg)](https://components.espressif.com/components/espressif/touch_slider_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) |
 | [usb_device_uvc](https://components.espressif.com/components/espressif/usb_device_uvc) | [![Component Registry](https://components.espressif.com/components/espressif/usb_device_uvc/badge.svg)](https://components.espressif.com/components/espressif/usb_device_uvc) |
 | [usb_stream](https://components.espressif.com/components/espressif/usb_stream) | [![Component Registry](https://components.espressif.com/components/espressif/usb_stream/badge.svg)](https://components.espressif.com/components/espressif/usb_stream) |

README_CN.md

@@ -132,6 +132,7 @@ ESP-IoT-Solution 中注册的组件如下:
 | [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) |
+| [touch_slider_sensor](https://components.espressif.com/components/espressif/touch_slider_sensor) | [![Component Registry](https://components.espressif.com/components/espressif/touch_slider_sensor/badge.svg)](https://components.espressif.com/components/espressif/touch_slider_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) |
 | [usb_device_uvc](https://components.espressif.com/components/espressif/usb_device_uvc) | [![Component Registry](https://components.espressif.com/components/espressif/usb_device_uvc/badge.svg)](https://components.espressif.com/components/espressif/usb_device_uvc) |
 | [usb_stream](https://components.espressif.com/components/espressif/usb_stream) | [![Component Registry](https://components.espressif.com/components/espressif/usb_stream/badge.svg)](https://components.espressif.com/components/espressif/usb_stream) |

components/.build-rules.yml

@@ -25,6 +25,10 @@ components/touch/touch_proximity_sensor/test_apps:
   enable:
     - if: IDF_TARGET in ["esp32s3"]
 
+components/touch/touch_slider_sensor/test_apps:
+  enable:
+    - if: IDF_TARGET in ["esp32", "esp32s2", "esp32s3", "esp32p4"] and (IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR == 3)
+
 components/usb/esp_msc_ota/test_apps:
   enable:
     - if: IDF_TARGET in ["esp32s3"]

components/touch/touch_slider_sensor/CHANGELOG.md

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

components/touch/touch_slider_sensor/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRC_DIRS "."
+    INCLUDE_DIRS "include")

components/touch/touch_slider_sensor/Kconfig

@@ -0,0 +1,156 @@
+menu "Touch Slider Sensor Configuration"
+
+    config TOUCH_SLIDER_SENSOR_DEBUG
+        bool "Enable touch slider sensor debug mode"
+        default n
+        help
+            Enable touch slider sensor debug mode.
+
+    config TOUCH_SLIDER_SENSOR_CALIBRATION_TIMES
+        int "Calibration times"
+        default 50 if !IDF_TARGET_ESP32
+        default 20
+        range 10 1000
+        help
+            Number of readings used for initial calibration.
+
+    config TOUCH_SLIDER_SENSOR_DEBOUNCE_INACTIVE
+        int "Debounce inactive count"
+        default 3 if !IDF_TARGET_ESP32
+        default 1
+        range 1 50
+        help
+            Number of consecutive readings below threshold needed to confirm inactive state.
+
+    config TOUCH_SLIDER_SENSOR_POLLING_INTERVAL
+        int "Polling interval (ms)"
+        default 10
+        range 5 100
+        depends on IDF_TARGET_ESP32
+        help
+            Interval between polling touch readings in milliseconds (for ESP32 only).
+
+    config TOUCH_SLIDER_SENSOR_SMOOTH_COEF_X1000
+        int "Smooth coefficient (/1000)"
+        default 200 if IDF_TARGET_ESP32S3 || IDF_TARGET_ESP32S2
+        default 300 if IDF_TARGET_ESP32
+        default 600 if IDF_TARGET_ESP32P4
+        default 500
+        range 0 1000
+        help
+            Coefficient for smooth filter, multiplied by 1000.
+            For example, 200 means 0.2
+
+    config TOUCH_SLIDER_SENSOR_BASELINE_COEF_X1000
+        int "Baseline coefficient (/1000)"
+        default 100 if IDF_TARGET_ESP32S3 || IDF_TARGET_ESP32S2
+        default 150 if IDF_TARGET_ESP32
+        default 200 if IDF_TARGET_ESP32P4
+        default 100
+        range 0 1000
+        help
+            Coefficient for baseline filter, multiplied by 1000.
+            For example, 100 means 0.1
+
+    config TOUCH_SLIDER_SENSOR_MAX_P_X1000
+        int "Maximum positive change ratio (/1000)"
+        default 200
+        range 0 1000
+        help
+            Maximum positive change ratio from baseline, multiplied by 1000.
+            For example, 200 means 0.2. 0 means no limit.
+
+    config TOUCH_SLIDER_SENSOR_MIN_N_X1000
+        int "Minimum negative change ratio (/1000)"
+        default 200
+        range 0 1000
+        help
+            Minimum negative change ratio from baseline, multiplied by 1000.
+            For example, 200 means 0.2. 0 means no limit.
+
+    config TOUCH_SLIDER_SENSOR_NEGATIVE_LOGIC
+        bool "Using negative logic to detect touch"
+        default n
+        help
+            Using both positive and negative threshold to detect touch.
+
+    config TOUCH_SLIDER_SENSOR_NOISE_P_SNR
+        int "Positive noise SNR"
+        default 4
+        range 3 100
+        help
+            Signal-to-noise for positive Noise
+
+    config TOUCH_SLIDER_SENSOR_NOISE_N_SNR
+        int "Negative noise SNR"
+        default 4
+        range 2 100
+        help
+            Signal-to-noise for negative Noise
+
+    config TOUCH_SLIDER_SENSOR_RESET_COVER
+        int "Reset count from cover"
+        default 1000 if !IDF_TARGET_ESP32
+        default 300
+        range 0 5000
+        help
+            Reset count if cover is detected. 0 means no reset.
+
+    config TOUCH_SLIDER_SENSOR_RESET_CALIBRATION
+        int "Reset count from calibration error"
+        default 3
+        range 0 100
+        help
+            Reset count for negative threshold. 0 means no reset.
+
+    config TOUCH_SLIDER_SENSOR_RAW_BUF_SIZE
+        int "Raw buffer size"
+        default 40 if !IDF_TARGET_ESP32
+        default 10
+        range 10 100
+        help
+            Size of raw data buffer.
+
+    config TOUCH_SLIDER_SENSOR_SCALE_FACTOR
+        int "Scale factor"
+        default 100 if !IDF_TARGET_ESP32
+        default 1000
+        range 10 1000
+        help
+            Scale factor for threshold calculation.
+
+    config TOUCH_SLIDER_SENSOR_QUANTIFY_LOWER_THRESHOLD_X1000
+        int "Quantify lower threshold (/1000)"
+        default 300
+        range 0 10000
+        help
+            Ratio of activation to quantify as 0.
+
+    config TOUCH_SLIDER_SENSOR_BENCHMARK_UPDATE_TIME
+        int "Benchmark update time"
+        default 500
+        range 100 10000
+        help
+            Delay after sensor is released before benchmark is updated.
+
+    config TOUCH_SLIDER_SENSOR_POS_FILTER_SIZE
+        int "Position filter size"
+        default 10
+        range 1 100
+        help
+            Window size of slider position IIR filter.
+
+    config TOUCH_SLIDER_SENSOR_POS_FILTER_FACTOR
+        int "Position filter factor"
+        default 2
+        range 1 10
+        help
+            Divisor of slider position IIR filter.
+
+    config TOUCH_SLIDER_SENSOR_CALCULATE_CHANNEL
+        int "Position calculation window"
+        default 3
+        range 1 10
+        help
+            Number of channels in position calculation
+endmenu

components/touch/touch_slider_sensor/README.md

@@ -0,0 +1,87 @@
+# Touch Slider Sensor
+
+**Note:** This component is for developers testing only. It is not intended for production use.
+
+A component providing enhanced touch slider detection functionality for ESP32 series chips.
+
+## Features
+
+- FSM-based touch detection with configurable thresholds
+- Support for slider gesture detection
+- Callback-based event notification
+
+## 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)
+
+
+## Example
+
+```c
+#include <stdio.h>
+#include <inttypes.h>
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "touch_slider_sensor.h"
+
+static uint32_t channel_list[] = {2, 4, 6, 12, 10, 8};
+static float threshold[] = {0.005f, 0.005f, 0.005f, 0.005f, 0.005f, 0.005f};
+static int channel_num = 6;
+static int slider_range = 10000;
+
+static void touch_slider_event_callback(touch_slider_handle_t handle, touch_slider_event_t event, int32_t data, void *cb_arg)
+{
+    if (event == TOUCH_SLIDER_EVENT_RIGHT_SWIPE) {
+        printf("Right swipe (speed)\n");
+    } else if (event == TOUCH_SLIDER_EVENT_LEFT_SWIPE) {
+        printf("Left swipe (speed)\n");
+    } else if (event == TOUCH_SLIDER_EVENT_RELEASE) {
+        printf("Slide %" PRId32 "\n", data);
+        if (data > slider_range / 10) {
+            printf("Right swipe (displacement)\n");
+        } else if (data < -slider_range / 10) {
+            printf("Left swipe (displacement)\n");
+        }
+    } else if (event == TOUCH_SLIDER_EVENT_POSITION) {
+        printf("pos,%" PRId32 "\n", data);
+    }
+}
+/* Task function to handle touch slider events */
+static void touch_slider_task(void *pvParameters)
+{
+    touch_slider_handle_t handle = (touch_slider_handle_t)pvParameters;
+    while (1) {
+        touch_slider_sensor_handle_events(handle);
+        vTaskDelay(pdMS_TO_TICKS(20));
+    }
+}
+
+void app_main(void)
+{
+    touch_slider_config_t config = {
+        .channel_num = channel_num,
+        .channel_list = channel_list,
+        .channel_threshold = threshold,
+        .filter_reset_times = 5,
+        .position_range = 10000,
+        .swipe_alpha = 0.9,
+        .swipe_threshold = 50,
+        .swipe_hysterisis = 40,
+        .channel_gold_value = NULL,
+        .debounce_times = 0,
+        .skip_lowlevel_init = false
+    };
+
+    touch_slider_handle_t handle;
+    ESP_ERROR_CHECK(touch_slider_sensor_create(&config, &handle, touch_slider_event_callback, NULL));
+
+    // Create a task to handle touch slider events
+    xTaskCreate(touch_slider_task, "touch_slider_sensor", 3072, handle, 2, NULL);
+
+    // Main loop can do other things now
+    while (1) {
+        vTaskDelay(pdMS_TO_TICKS(1000)); // Main task can do other work or just idle
+    }
+}
+```