Chapter 2. API Reference
• ESP_OK Success
Parameters
• pad_num: Set touch channel number for sleep pad. Only one touch sensor channel is supported in
deep sleep mode.
• touch_thres: touch sleep pad threshold
esp_err_t touch_pad_sleep_get_threshold(touch_pad_t pad_num, uint32_t *touch_thres)
Get the trigger threshold of touch sensor in deep sleep. The threshold determines the sensitivity of the touch
sensor.
Note In general, the touch threshold during sleep can use the threshold parameter parameters before sleep.
Return
• ESP_OK Success
Parameters
• pad_num: Set touch channel number for sleep pad. Only one touch sensor channel is supported in
deep sleep mode.
• touch_thres: touch sleep pad threshold
esp_err_t touch_pad_sleep_channel_read_benchmark(touch_pad_t pad_num, uint32_t
*benchmark)
Read benchmark of touch sensor sleep channel.
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG parameter is NULL
Parameters
• pad_num: Set touch channel number for sleep pad. Only one touch sensor channel is supported in
deep sleep mode.
• benchmark: pointer to accept touch sensor benchmark value
esp_err_t touch_pad_sleep_channel_read_smooth(touch_pad_t pad_num, uint32_t
*smooth_data)
Read smoothed data of touch sensor sleep channel. Smoothed data is filtered from the raw data.
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG parameter is NULL
Parameters
• pad_num: Set touch channel number for sleep pad. Only one touch sensor channel is supported in
deep sleep mode.
• smooth_data: pointer to accept touch sensor smoothed data
esp_err_t touch_pad_sleep_channel_read_data(touch_pad_t pad_num, uint32_t *raw_data)
Read raw data of touch sensor sleep channel.
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG parameter is NULL
Parameters
• pad_num: Set touch channel number for sleep pad. Only one touch sensor channel is supported in
deep sleep mode.
• raw_data: pointer to accept touch sensor raw data
esp_err_t touch_pad_sleep_channel_reset_benchmark(void)
Reset benchmark of touch sensor sleep channel.
Return
• ESP_OK Success
esp_err_t touch_pad_sleep_channel_read_proximity_cnt(touch_pad_t pad_num, uint32_t
*proximity_cnt)
Read proximity count of touch sensor sleep channel.
Return
• ESP_OK Success
Espressif Systems 407
Submit Document Feedback
Release v4.4