touch_pad_filter_start() function

start touch pad filter function This API will start a filter to process the noise in order to prevent false triggering when detecting slight change of capacitance. Need to call touch_pad_filter_start before all touch filter APIs

Syntax

Show:

Summary

Declaration

Definition

from touch_sensor.h:363

esp_err_t touch_pad_filter_start(uint32_t filter_period_ms);

Implemented in touch_sensor.c:455

Arguments

Argument

Description

filter_period_ms

filter calibration period, in ms

Return value

- ESP_OK Success - ESP_ERR_INVALID_ARG parameter error - ESP_ERR_NO_MEM No memory for driver - ESP_ERR_INVALID_STATE driver state error

Notes

This filter uses FreeRTOS timer, which is dispatched from a task with priority 1 by default on CPU 0. So if some application task with higher priority takes a lot of CPU0 time, then the quality of data obtained from this filter will be affected. You can adjust FreeRTOS timer task priority in menuconfig.

Examples

touch_pad_filter_start() is referenced by 2 libraries and example projects:

References

from examples

touch_pad_filter_start() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle