From 1132a4ed5168a226a4e579326e961fb9b896e5df Mon Sep 17 00:00:00 2001 From: shenmengjing Date: Tue, 9 Jul 2024 16:50:12 +0800 Subject: [PATCH] docs: Update the application examples in touch_element.rst --- docs/en/api-reference/peripherals/touch_element.rst | 10 +++++++--- docs/zh_CN/api-reference/peripherals/touch_element.rst | 8 ++++++-- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/en/api-reference/peripherals/touch_element.rst b/docs/en/api-reference/peripherals/touch_element.rst index 8be2d2ecdc..22d1761d83 100644 --- a/docs/en/api-reference/peripherals/touch_element.rst +++ b/docs/en/api-reference/peripherals/touch_element.rst @@ -450,10 +450,14 @@ The Touch Element Wakeup example is available in `system/light_sleep` directory. ... } -Application Example -------------------- +Application Examples +-------------------- -All the Touch Element library examples could be found in the :example:`peripherals/touch_sensor/touch_element` directory of ESP-IDF examples. +- :example:`peripherals/touch_sensor/touch_element/touch_element_waterproof` demonstrates how to use the Touch Element library to set up capacitive touch sensors with waterproof protection. +- :example:`peripherals/touch_sensor/touch_element/touch_slider` demonstrates how to use the Touch Element library to set up and operate a touch slider. +- :example:`peripherals/touch_sensor/touch_element/touch_elements_combination` demonstrates how to use the Touch Element library to set up multiple types of touch elements and handle all the event messages in one task. +- :example:`peripherals/touch_sensor/touch_element/touch_matrix` demonstrates how to use the Touch Element library to set up and use a touch matrix with a capacitive touch sensor on {IDF_TARGET_NAME} development boards. +- :example:`peripherals/touch_sensor/touch_element/touch_button` demonstrates how to use the Touch Element library to set up and use a touch button on {IDF_TARGET_NAME} development boards. API Reference - Touch Element Core diff --git a/docs/zh_CN/api-reference/peripherals/touch_element.rst b/docs/zh_CN/api-reference/peripherals/touch_element.rst index 1616b9e9a2..22c22ad58b 100644 --- a/docs/zh_CN/api-reference/peripherals/touch_element.rst +++ b/docs/zh_CN/api-reference/peripherals/touch_element.rst @@ -451,9 +451,13 @@ } 应用示例 -------------------- +-------- -查看使用触摸元件库的示例代码，请前往 ESP-IDF 示例的 :example:`peripherals/touch_sensor/touch_element` 目录。 +- :example:`peripherals/touch_sensor/touch_element/touch_element_waterproof` 演示了如何使用触摸元件库来设置带有防水保护的电容式触摸传感器。 +- :example:`peripherals/touch_sensor/touch_element/touch_slider` 演示了如何使用触摸元件库来设置和操作触摸滑条。 +- :example:`peripherals/touch_sensor/touch_element/touch_elements_combination` 演示了如何使用触摸元件库来设置多种类型的触摸元件，并在一个任务中处理所有的事件消息。 +- :example:`peripherals/touch_sensor/touch_element/touch_matrix` 演示了如何通过触摸元件库，在 {IDF_TARGET_NAME} 开发板上使用电容式触摸传感器来构建触摸矩阵。 +- :example:`peripherals/touch_sensor/touch_element/touch_button` 演示了如何通过触摸元件库，在 {IDF_TARGET_NAME} 开发板上设置和使用触摸按键。 API 参考 - 触摸元件核心