feat(ws-s3-touch): Add espp::WsS3Touch Board Support Package (BSP) component for the Waveshare ESP32-S3 TouchLCD hardware. (#475)

* feat(ws-s3-touch): Add `espp::WsS3Touch` Board Support Package (BSP) component for the Waveshare ESP32-S3 TouchLCD hardware.

* readme: update

Author: finger563

.github/workflows/build.yml

@@ -192,6 +192,8 @@ jobs:
           target: esp32
         - path: 'components/wrover-kit/example'
           target: esp32
+        - path: 'components/ws-s3-touch/example'
+          target: esp32s3
 
     steps:
     - name: Checkout repo

.github/workflows/upload_components.yml

@@ -113,6 +113,7 @@ jobs:
             components/vl53l
             components/wifi
             components/wrover-kit
+            components/ws-s3-touch
           namespace: "espp"
           # use old version if this isn't a release for testing
           version: ${{ github.event.release && github.event.release.tag_name || 'v0.20.2' }}

components/ws-s3-touch/CMakeLists.txt

@@ -0,0 +1,6 @@
+idf_component_register(
+  INCLUDE_DIRS "include"
+  SRC_DIRS "src"
+  REQUIRES driver base_component display display_drivers i2c input_drivers interrupt led cst816 task qmi8658
+  REQUIRED_IDF_TARGETS "esp32s3"
+  )

components/ws-s3-touch/Kconfig

@@ -0,0 +1,28 @@
+menu "Waveshare ESP32-S3 TouchLCD Configuration"
+  choice WS_S3_TOUCH_VERSION
+  prompt "TouchLCD Version"
+  default WS_S3_TOUCH_VERSION_NEW
+  help
+    Select the version of the Waveshare ESP32-S3 TouchLCD you are using.
+    This will determine which pins the driver configures.
+
+  config WS_S3_TOUCH_VERSION_NEW
+  bool "New Version"
+  help
+    The new version of the Waveshare ESP32-S3 TouchLCD uses different pins
+    for the touch controller.
+
+  config WS_S3_TOUCH_VERSION_OLD
+  bool "Old Version"
+  help
+    The old version of the Waveshare ESP32-S3 TouchLCD uses different pins
+    for the touch controller.
+  endchoice
+
+  config WS_S3_TOUCH_INTERRUPT_STACK_SIZE
+  int "Interrupt stack size"
+  default 4096
+  help
+    Size of the stack used for the interrupt handler. Used by the touch
+    callback.
+endmenu

components/ws-s3-touch/README.md

@@ -0,0 +1,17 @@
+# Waveshare ESP32-S3 TouchLCD Board Support Package (BSP) Component
+
+[![Badge](https://components.espressif.com/components/espp/ws-s3-touch/badge.svg)](https://components.espressif.com/components/espp/ws-s3-touch)
+
+The Waveshare ESP32-S3 TouchLCD is a development board for the ESP32-S3 module.
+It features a nice touchscreen display, an IMU, a buzzer, and a real-time clock
+(RTC).
+
+The `espp::WsS3Touch` component provides a singleton hardware abstraction for
+initializing the touch, display, IMU, and audio subsystems.
+
+## Example
+
+The [example](./example) shows how to use the `espp::WsS3Touch` hardware
+abstraction component to automatically detect and initialize components on the
+Waveshare ESP32-S3 TouchLCD board.
+

components/ws-s3-touch/example/CMakeLists.txt

@@ -0,0 +1,21 @@
+# The following lines of boilerplate have to be in your project's CMakeLists
+# in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.20)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+
+# add the component directories that we want to use
+set(EXTRA_COMPONENT_DIRS
+  "../../../components/"
+)
+
+set(
+  COMPONENTS
+  "main esptool_py ws-s3-touch filters"
+  CACHE STRING
+  "List of components to include"
+  )
+
+project(ws_s3_touch_example)
+
+set(CMAKE_CXX_STANDARD 20)

components/ws-s3-touch/example/README.md

@@ -0,0 +1,44 @@
+# Waveshare ESP32-S3 TouchLCD Example
+
+This example shows how to use the `espp::WsS3Touch` hardware abstraction
+component to automatically detect and initialize components on the Waveshare
+ESP32-S3 TouchLCD board, and use the LVGL graphics library to draw on the
+display. It also plays a sound when you touch the screen using the buzzer on the
+system, and it changes the frequency of the sound based on the position of the
+touch.
+
+<img width="1260" height="949" alt="image" src="https://github.com/user-attachments/assets/17e8def4-0d64-4e9e-8cee-dc2753a657a6" />
+<img width="1260" height="949" alt="image" src="https://github.com/user-attachments/assets/512ca611-1ab0-4941-b4a3-4ef22d65e567" />
+
+https://github.com/user-attachments/assets/e1905efc-d7cf-448a-86e8-a15c3f294f8c
+
+## How to use example
+
+### Hardware Required
+
+This example is designed to run on the Waveshare ESP32-S3 TouchLCD board.
+
+### Build and Flash
+
+Build the project and flash it to the board, then run monitor tool to view
+serial output:
+
+```
+idf.py -p PORT flash monitor
+```
+
+(Replace PORT with the name of the serial port to use.)
+
+(To exit the serial monitor, type ``Ctrl-]``.)
+
+See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
+
+## Example Output
+
+<img width="777" height="604" alt="CleanShot 2025-07-13 at 22 01 56" src="https://github.com/user-attachments/assets/02ea3513-7af9-43bb-96e4-10706f31f831" />
+
+<img width="1260" height="949" alt="image" src="https://github.com/user-attachments/assets/17e8def4-0d64-4e9e-8cee-dc2753a657a6" />
+<img width="1260" height="949" alt="image" src="https://github.com/user-attachments/assets/512ca611-1ab0-4941-b4a3-4ef22d65e567" />
+
+https://github.com/user-attachments/assets/e1905efc-d7cf-448a-86e8-a15c3f294f8c
+

components/ws-s3-touch/example/main/CMakeLists.txt

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