Skip to content

Commit 805d2ff

Browse files
committed
docs(touch): update touch sensor docs for the new driver
1 parent 09b15b4 commit 805d2ff

File tree

16 files changed

+340
-731
lines changed

16 files changed

+340
-731
lines changed

components/esp_driver_touch_sens/hw_ver1/include/driver/touch_version_types.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ typedef struct {
108108
*
109109
*/
110110
typedef struct {
111-
uint32_t abs_active_thresh[TOUCH_SAMPLE_CFG_NUM]; /*!< The ablolute active threshould. The ``on_active`` and ``on_hw_active`` callback will trigger when
111+
uint32_t abs_active_thresh[TOUCH_SAMPLE_CFG_NUM]; /*!< The absolute active threshould. The ``on_active`` and ``on_hw_active`` callback will trigger when
112112
* - If touch_sensor_config_t::intr_trig_mode = TOUCH_INTR_TRIG_ON_BELOW_THRESH, the callback will keep triggering when the touch channel value below the threshold.
113113
* - If touch_sensor_config_t::intr_trig_mode = TOUCH_INTR_TRIG_ON_ABOVE_THRESH, the callback will keep triggering when the touch channel value above the threshold.
114114
*/
@@ -148,9 +148,9 @@ typedef struct {
148148
touch_sw_filter_t data_filter_fn; /*!< The data filter function pointer.
149149
* You can specify your own filter algorithm, or set NULL to use default software filter
150150
*/
151-
void *user_filter_ctx; /*!< User costomized filter context pointer.
151+
void *user_filter_ctx; /*!< User customized filter context pointer.
152152
* This pointer will be passed to the second parameter of `touch_sw_filter_t` .
153-
* So that users can access their costomized filter context in the software filter function.
153+
* So that users can access their customized filter context in the software filter function.
154154
*/
155155
} touch_sensor_filter_config_t;
156156

docs/conf_common.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,8 @@
122122

123123
TEMP_SENSOR_DOCS = ['api-reference/peripherals/temp_sensor.rst']
124124

125+
TOUCH_SENSOR_DOCS = ['api-reference/peripherals/cap_touch_sens.rst']
126+
125127
SPIRAM_DOCS = ['api-guides/external-ram.rst']
126128

127129
USB_DOCS = ['api-reference/peripherals/usb_device.rst',
@@ -212,7 +214,6 @@
212214
'security/secure-boot-v1.rst',
213215
'api-reference/peripherals/dac.rst',
214216
'api-reference/peripherals/sd_pullup_requirements.rst',
215-
'api-reference/peripherals/touch_pad.rst',
216217
'hw-reference/esp32/**',
217218
'api-guides/RF_calibration.rst',
218219
'api-guides/phy.rst'] + FTDI_JTAG_DOCS + QEMU_DOCS
@@ -222,15 +223,13 @@
222223
'api-reference/peripherals/ds.rst',
223224
'api-reference/peripherals/temp_sensor.rst',
224225
'api-reference/system/async_memcpy.rst',
225-
'api-reference/peripherals/cap_touch_sens.rst',
226226
'api-reference/peripherals/touch_element.rst',
227227
'api-guides/RF_calibration.rst',
228228
'api-guides/phy.rst'] + FTDI_JTAG_DOCS + USB_OTG_DFU_DOCS + USB_OTG_CONSOLE_DOCS
229229

230230
ESP32S3_DOCS = ['hw-reference/esp32s3/**',
231231
'api-reference/system/ipc.rst',
232232
'api-guides/flash_psram_config.rst',
233-
'api-reference/peripherals/cap_touch_sens.rst',
234233
'api-reference/peripherals/sd_pullup_requirements.rst',
235234
'api-guides/RF_calibration.rst',
236235
'api-guides/phy.rst'] + USB_OTG_DFU_DOCS + USB_OTG_CONSOLE_DOCS + QEMU_DOCS
@@ -297,6 +296,7 @@
297296
'CONFIG_IDF_TARGET_ARCH_XTENSA':XTENSA_DOCS,
298297
'CONFIG_IDF_TARGET_ARCH_RISCV':RISCV_DOCS,
299298
'SOC_TEMP_SENSOR_SUPPORTED':TEMP_SENSOR_DOCS,
299+
'SOC_TOUCH_SENSOR_SUPPORTED':TOUCH_SENSOR_DOCS,
300300
'SOC_TWAI_SUPPORTED':TWAI_DOCS,
301301
'SOC_I2C_SUPPORTED':I2C_DOCS,
302302
'SOC_GPSPI_SUPPORTED':SPI_DOCS,

docs/doxygen/Doxyfile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ INPUT = \
7474
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_spp_api.h \
7575
$(PROJECT_PATH)/components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \
7676
$(PROJECT_PATH)/components/console/esp_console.h \
77-
$(PROJECT_PATH)/components/driver/touch_sensor/include/driver/touch_sensor_common.h \
7877
$(PROJECT_PATH)/components/driver/twai/include/driver/twai.h \
7978
$(PROJECT_PATH)/components/driver/test_apps/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_sdio.h \
8079
$(PROJECT_PATH)/components/driver/test_apps/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_spi.h \

docs/doxygen/Doxyfile_esp32

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
INPUT += \
2-
$(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \
3-
$(PROJECT_PATH)/components/hal/include/hal/touch_sensor_legacy_types.h \
2+
$(PROJECT_PATH)/components/esp_driver_touch_sens/include/driver/touch_sens.h \
3+
$(PROJECT_PATH)/components/esp_driver_touch_sens/include/driver/touch_sens_types.h \
4+
$(PROJECT_PATH)/components/esp_driver_touch_sens/hw_ver1/include/driver/touch_version_types.h \
45
$(PROJECT_PATH)/components/esp_psram/include/esp32/himem.h \
56
$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \
67
$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \
7-
$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \
88
$(PROJECT_PATH)/components/ulp/ulp_fsm/include/$(IDF_TARGET)/ulp.h \
99
$(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt.h \
1010
$(PROJECT_PATH)/components/perfmon/include/xtensa_perfmon_access.h \

0 commit comments

Comments
 (0)