Touch Peripheral
Initialize ESP32 touchpad peripheral and retrieve information from the touch sensors.
Application Example
Implementation of this API is demonstrated in get-started/play_mp3_control example.
API Reference
Header File
Functions
-
esp_periph_handle_t periph_touch_init(periph_touch_cfg_t *config)
Create the touch peripheral handle for esp_peripherals.
Note
The handle was created by this function automatically destroy when
esp_periph_destroyis called- Parameters
config – The configuration
- Returns
The esp peripheral handle
Structures
-
struct periph_touch_cfg_t
The Touch peripheral configuration.
Public Members
-
int touch_mask
Touch pad mask using for this Touch peripheral, ex: TOUCH_PAD_SEL0 | TOUCH_PAD_SEL1
-
int tap_threshold_percent
Tap threshold percent, Tap event will be determined if the percentage value is less than the non-touch value
-
int long_tap_time_ms
Long tap duration in milliseconds, default is 2000ms, PERIPH_TOUCH_LONG_TAP will be occurred if TAP and time hold longer than this value
-
int touch_mask
Enumerations
-
enum esp_touch_pad_sel_t
Touch pad selection.
Values:
-
enumerator TOUCH_PAD_SEL0
-
enumerator TOUCH_PAD_SEL1
-
enumerator TOUCH_PAD_SEL2
-
enumerator TOUCH_PAD_SEL3
-
enumerator TOUCH_PAD_SEL4
-
enumerator TOUCH_PAD_SEL5
-
enumerator TOUCH_PAD_SEL6
-
enumerator TOUCH_PAD_SEL7
-
enumerator TOUCH_PAD_SEL8
-
enumerator TOUCH_PAD_SEL9
-
enumerator TOUCH_PAD_SEL0
-
enum periph_touch_event_id_t
Peripheral touch event id.
Values:
-
enumerator PERIPH_TOUCH_UNCHANGE
No event
-
enumerator PERIPH_TOUCH_TAP
When touch pad is tapped
-
enumerator PERIPH_TOUCH_RELEASE
When touch pad is released after tap
-
enumerator PERIPH_TOUCH_LONG_TAP
When touch pad is tapped and held after
long_tap_time_mstime
-
enumerator PERIPH_TOUCH_LONG_RELEASE
When touch pad is released after long tap
-
enumerator PERIPH_TOUCH_UNCHANGE