mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-28 17:48:35 +01:00
8d9b0d2375
* Netlify * Fix * Faster doxygen * Update Makefile * Try without api * Debug * Fix * Update Makefile * Debug * Try 1.8.13 * Remove debug * Update Makefile * Optimize
109 lines
3.7 KiB
ReStructuredText
109 lines
3.7 KiB
ReStructuredText
ESP32 Touch Pad Binary Sensor
|
|
=============================
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up the touch pad on the ESP32.
|
|
:image: touch.png
|
|
|
|
The ``esp32_touch`` binary sensor platform lets you use the touch peripheral of the
|
|
ESP32 to detect if a certain pin is being "touched".
|
|
|
|
First, you need to setup the :doc:`global touch hub </components/esp32_touch>`. Then
|
|
you can add individual touch pads as binary sensors. When a touch is detected on these pins, the binary
|
|
sensor will report an ``ON`` state. And, of course, if no touch is detected, the binary sensor will report
|
|
an ``OFF`` state.
|
|
|
|
.. figure:: images/esp32_touch-ui.png
|
|
:align: center
|
|
:width: 80.0%
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
esp32_touch:
|
|
|
|
binary_sensor:
|
|
- platform: esp32_touch
|
|
name: "ESP32 Touch Pad GPIO27"
|
|
pin: GPIO27
|
|
threshold: 1000
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
- **pin** (**Required**, :ref:`config-pin`): The pin to detect touch
|
|
events on.
|
|
- **threshold** (**Required**, int): The threshold to use to detect touch events. Smaller values mean
|
|
a higher probability that the pad is being touched.
|
|
- **name** (**Required**, string): The name of the binary sensor.
|
|
- **id** (*Optional*,
|
|
:ref:`config-id`): Manually specify
|
|
the ID used for code generation.
|
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`
|
|
and :ref:`MQTT Component <config-mqtt-component>`.
|
|
|
|
Touch Pad Pins
|
|
--------------
|
|
|
|
8 pins on the ESP32 can be used to detect touches. These are (in the default "raw" pin names):
|
|
|
|
- ``GPIO0``
|
|
- ``GPIO2``
|
|
- ``GPIO4``
|
|
- ``GPIO12``
|
|
- ``GPIO13``
|
|
- ``GPIO14``
|
|
- ``GPIO15``
|
|
- ``GPIO27``
|
|
- ``GPIO32``
|
|
- ``GPIO33``
|
|
|
|
Finding thresholds
|
|
------------------
|
|
|
|
For each touch pad you want to monitor, you need to find a threshold first. This threshold is
|
|
used to determine if a pad is being touched or not using the raw values from the sensor. Lower
|
|
raw values mean that it is more likely that a touch is happening. For example, values around
|
|
1000 to 1600 usually mean the pad is not being touched, and values in the range of 600 and less
|
|
mean the pad is probably being touched.
|
|
|
|
To find suitable threshold values, first configure the :doc:`ESP32 touch hub </components/esp32_touch>`
|
|
to output measured values using the ``setup_mode:`` configuration option. Next, add some binary sensors
|
|
for the touch pads you want to observe. Also put some threshold in the configuration as seen below
|
|
to make the validator happy, we are going to find good thresholds in a moment anyway.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry for finding threshold values
|
|
esp32_touch:
|
|
setup_mode: True
|
|
|
|
binary_sensor:
|
|
- platform: esp32_touch
|
|
name: "ESP32 Touch Pad GPIO27"
|
|
pin: GPIO27
|
|
threshold: 1000
|
|
|
|
Then upload the program and open the logs, you will see values like these. Try touching the pins
|
|
and you will (hopefully) see the value decreasing a bit. Play around with different amounts of
|
|
force you put on the touch pad until you find a good value that can differentiate between
|
|
touch/non-touch events.
|
|
|
|
.. figure:: images/esp32_touch-finding_thresholds.png
|
|
:align: center
|
|
|
|
Finally, put your threshold parameter in the configuration. Do not forget to disable the ``setup_mode``
|
|
option again by setting it to ``False``. Otherwise you will end up spamming the logs and slowing the device
|
|
down.
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :doc:`/components/esp32_touch`
|
|
- :doc:`/components/binary_sensor/index`
|
|
- :apiref:`binary_sensor/esp32_touch_binary_sensor.h`
|
|
- `esp-idf Touch Sensor API <https://esp-idf.readthedocs.io/en/latest/api-reference/peripherals/touch_pad.html>`__
|
|
- :ghedit:`Edit`
|
|
|
|
.. disqus::
|