Skip to content

Commit

Permalink
docs: update touch sensor of esp32s2 and esp32s3
Browse files Browse the repository at this point in the history
  • Loading branch information
Lindazhxy committed Aug 24, 2022
1 parent abb35ac commit 0fa32f2
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 13 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 20 additions & 7 deletions docs/en/api-reference/peripherals/touch_pad.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,16 +131,29 @@ The following list summarizes available measurement parameters and corresponding

* Charge and discharge times of one measurement: :cpp:func:`touch_pad_set_charge_discharge_times`

Relationship between the voltage range (high / low reference voltages), speed (slope), and measurement time is shown in the figure below.
Relationship between the voltage range (high/low reference voltages), speed (slope), and measurement time is shown in the figure below.

.. figure:: ../../../_static/touch_pad-measurement-parameters.jpg
:align: center
:alt: Touch Pad - relationship between measurement parameters
:figclass: align-center
.. only:: SOC_TOUCH_VERSION_1

.. figure:: ../../../_static/touch_pad-measurement-parameters.jpg
:align: center
:alt: Touch Pad - relationship between measurement parameters
:figclass: align-center

Touch pad - relationship between measurement parameters

The last chart *Output* represents the touch sensor reading, i.e., the count of pulses collected within the measurement time.

.. only:: SOC_TOUCH_VERSION_2

.. figure:: ../../../_static/touch_pad-measurement-parameters-version2.png
:align: center
:alt: Touch Pad - relationship between measurement parameters
:figclass: align-center

Touch pad - relationship between measurement parameters
Touch pad - relationship between measurement parameters

The last chart *Output* represents the touch sensor reading, i.e., the count of pulses collected within the measurement time.
The last chart *Output* represents the touch sensor reading, i.e., the time taken to accumulate the fixed number of cycles.

All functions are provided in pairs to *set* a specific parameter and to *get* the current parameter's value, e.g., :cpp:func:`touch_pad_set_voltage` and :cpp:func:`touch_pad_get_voltage`.

Expand Down
25 changes: 19 additions & 6 deletions docs/zh_CN/api-reference/peripherals/touch_pad.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,14 +133,27 @@

电压门限(参考低值/参考高值)、速率(斜率)与测量时间的关系如下图所示:

.. figure:: ../../../_static/touch_pad-measurement-parameters.jpg
:align: center
:alt: Touch Pad - relationship between measurement parameters
:figclass: align-center
.. only:: SOC_TOUCH_VERSION_1

.. figure:: ../../../_static/touch_pad-measurement-parameters.jpg
:align: center
:alt: Touch Pad - relationship between measurement parameters
:figclass: align-center

触摸传感器 - 测量参数之间的关系

上图中的 *Output* 代表触摸传感器读值,即一个测量周期内测得的脉冲计数值。

.. only:: SOC_TOUCH_VERSION_2

.. figure:: ../../../_static/touch_pad-measurement-parameters-version2.png
:align: center
:alt: Touch Pad - relationship between measurement parameters
:figclass: align-center

触摸传感器 - 测量参数之间的关系
触摸传感器 - 测量参数之间的关系

上图中的 *Output* 代表触摸传感器读值,即一个测量周期内测得的脉冲计数值
上图中的 *Output* 代表触摸传感器读值,即固定充放电次数所需的时间

所有函数均成对出现,用于设定某一特定参数,并获取当前参数值。例如::cpp:func:`touch_pad_set_voltage` 和 :cpp:func:`touch_pad_get_voltage`。

Expand Down

0 comments on commit 0fa32f2

Please sign in to comment.