touch_pad_read() function

get touch sensor counter value. Each touch sensor has a counter to count the number of charge/discharge cycles. When the pad is not 'touched', we can get a number of the counter. When the pad is 'touched', the value in counter will get smaller because of the larger equivalent capacitance.

Syntax

Show:

Summary

Declaration

Definition

from touch_sensor.h:48

esp_err_t touch_pad_read(touch_pad_t touch_num, uint16_t *touch_value);

Implemented in touch_sensor.c:380

Arguments

Argument

Description

touch_num

touch pad index

touch_value

pointer to accept touch sensor value

Return value

- ESP_OK Success - ESP_ERR_INVALID_ARG Touch pad parameter error - ESP_ERR_INVALID_STATE This touch pad hardware connection is error, the value of "touch_value" is 0. - ESP_FAIL Touch pad not initialized

Notes

This API requests hardware measurement once. If IIR filter mode is enabled, please use 'touch_pad_read_raw_data' interface instead.

Examples

touch_pad_read() is referenced by 1 libraries and example projects:

References

from examples

touch_pad_read() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle