Chapter 2. API Reference
• data: Pointer to receive denoise value
esp_err_t touch_pad_waterproof_set_config(const touch_pad_waterproof_t *waterproof)
set parameter of waterproof function.
The waterproof function includes a shielded channel (TOUCH_PAD_NUM14) and a guard channel. Guard
pad is used to detect the large area of water covering the touch panel. Shield pad is used to shield the influence
of water droplets covering the touch panel. It is generally designed as a grid and is placed around the touch
buttons.
Return
• ESP_OK Success
Parameters
• waterproof: parameter of waterproof
esp_err_t touch_pad_waterproof_get_config(touch_pad_waterproof_t *waterproof)
get parameter of waterproof function.
Return
• ESP_OK Success
Parameters
• waterproof: parameter of waterproof
esp_err_t touch_pad_waterproof_enable(void)
Enable parameter of waterproof function. Should be called after function
touch_pad_waterproof_set_config.
Return
• ESP_OK Success
esp_err_t touch_pad_waterproof_disable(void)
Disable parameter of waterproof function.
Return
• ESP_OK Success
esp_err_t touch_pad_proximity_enable(touch_pad_t touch_num, bool enabled)
Enable/disable proximity function of touch channels. The proximity sensor measurement is the accumulation
of touch channel measurements.
Note Supports up to three touch channels configured as proximity sensors.
Return
• ESP_OK: Configured correctly.
• ESP_ERR_INVALID_ARG: Touch channel number error.
• ESP_ERR_NOT_SUPPORTED: Don’t support configured.
Parameters
• touch_num: touch pad index
• enabled: true: enable the proximity function; false: disable the proximity function
esp_err_t touch_pad_proximity_set_count(touch_pad_t touch_num, uint32_t count)
Set measure count of proximity channel. The proximity sensor measurement is the accumulation of touch
channel measurements.
Note All proximity channels use the same count value. So please pass the parameter TOUCH_PAD_MAX.
Return
• ESP_OK: Configured correctly.
• ESP_ERR_INVALID_ARG: Touch channel number error.
Parameters
• touch_num: Touch pad index. In this version, pass the parameter TOUCH_PAD_MAX.
• count: The cumulative times of measurements for proximity pad. Range: 0 ~ 255.
esp_err_t touch_pad_proximity_get_count(touch_pad_t touch_num, uint32_t *count)
Get measure count of proximity channel. The proximity sensor measurement is the accumulation of touch
channel measurements.
Note All proximity channels use the same count value. So please pass the parameter TOUCH_PAD_MAX.
Espressif Systems 405
Submit Document Feedback
Release v4.4
To Next Page
Loading...