alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

touch_sensor: add description to distinguish the API on different target

Browse Source 
Closes https://github.com/espressif/esp-idf/issues/9067
This commit is contained in:
laokaiyao 2022-06-01 15:41:31 +08:00
parent 08fa67fe92
commit 5c57f9c884
3 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
components/driver/esp32/include/driver/touch_sensor.h
View File

@ -121,8 +121,11 @@ esp_err_t touch_pad_isr_register(intr_handler_t fn, void *arg);
* @brief Set touch sensor measurement and sleep time.
* Excessive total time will slow down the touch response.
* Too small measurement time will not be sampled enough, resulting in inaccurate measurements.
*
* @note The touch sensor on ESP32 will fix measuring cycles (specified by the second parameter)
* and then record the count of charge and discharge cycles during the sensing period as the raw value.
* That means the raw value will decrease as the capacity of the touch pad increasing.
* @note The greater the duty cycle of the measurement time, the more system power is consumed.
*
* @param sleep_cycle The touch sensor will sleep after each measurement.
* sleep_cycle decide the interval between each measurement.
* t_sleep = sleep_cycle / (RTC_SLOW_CLK frequency).

12
components/driver/esp32s2/include/driver/touch_sensor.h
View File

@ -39,15 +39,19 @@ esp_err_t touch_pad_sw_start(void);
* @brief Set touch sensor times of charge and discharge and sleep time.
* Excessive total time will slow down the touch response.
* Too small measurement time will not be sampled enough, resulting in inaccurate measurements.
*
* @note Though this API name is same as ESP32, it has opposite logic of capacity.
* The touch sensor on ESP32-S2 will fix the count of charge and discharge cycles (specified by the second parameter)
* and then record the count of the clock cycles(which is 8 MHz) during the sensing period as the raw value.
* That means the raw value will increase as the capacity of the touch pad increasing.
* @note The greater the duty cycle of the measurement time, the more system power is consumed.
*
* @param sleep_cycle The touch sensor will sleep after each measurement.
* sleep_cycle decide the interval between each measurement.
* t_sleep = sleep_cycle / (RTC_SLOW_CLK frequency).
* The approximate frequency value of RTC_SLOW_CLK can be obtained using rtc_clk_slow_freq_get_hz function.
* @param meas_times The times of charge and discharge in each measure process of touch channels.
* The timer frequency is 8Mhz. Range: 0 ~ 0xffff.
* Recommended typical value: Modify this value to make the measurement time around 1ms.
* @param meas_times The times of charge and discharge in each measurement of touch channels. Range: 0 ~ 0xffff.
* Recommended typical value: Modify this value to make the measurement time around 1 ms.
* The clock frequency is 8 MHz, so the raw value will be about 8000 if the measurement time is 1 ms
* @return
* - ESP_OK on success
*/

12
components/driver/esp32s3/include/driver/touch_sensor.h
View File

@ -39,15 +39,19 @@ esp_err_t touch_pad_sw_start(void);
* @brief Set touch sensor times of charge and discharge and sleep time.
* Excessive total time will slow down the touch response.
* Too small measurement time will not be sampled enough, resulting in inaccurate measurements.
*
* @note Though this API name is same as ESP32, it has opposite logic of capacity.
* The touch sensor on ESP32-S3 will fix the count of charge and discharge cycles (specified by the second parameter)
* and then record the count of the clock cycles(which is 8 MHz) during the sensing period as the raw value.
* That means the raw value will increase as the capacity of the touch pad increasing.
* @note The greater the duty cycle of the measurement time, the more system power is consumed.
*
* @param sleep_cycle The touch sensor will sleep after each measurement.
* sleep_cycle decide the interval between each measurement.
* t_sleep = sleep_cycle / (RTC_SLOW_CLK frequency).
* The approximate frequency value of RTC_SLOW_CLK can be obtained using rtc_clk_slow_freq_get_hz function.
* @param meas_times The times of charge and discharge in each measure process of touch channels.
* The timer frequency is 8Mhz. Range: 0 ~ 0xffff.
* Recommended typical value: Modify this value to make the measurement time around 1ms.
* @param meas_times The times of charge and discharge in each measurement of touch channels. Range: 0 ~ 0xffff.
* Recommended typical value: Modify this value to make the measurement time around 1 ms.
* The clock frequency is 8 MHz, so the raw value will be about 8000 if the measurement time is 1 ms
* @return
* - ESP_OK on success
*/