diff --git a/components/binary_sensor/images/ttp229-full.jpg b/components/binary_sensor/images/ttp229-full.jpg new file mode 100644 index 000000000..90d914992 Binary files /dev/null and b/components/binary_sensor/images/ttp229-full.jpg differ diff --git a/components/binary_sensor/ttp229.rst b/components/binary_sensor/ttp229.rst new file mode 100644 index 000000000..da8499533 --- /dev/null +++ b/components/binary_sensor/ttp229.rst @@ -0,0 +1,52 @@ +TTP229 Capacitive Touch Sensor +============================== + +.. seo:: + :description: Instructions for setting up TTP229 Capacitive Touch Sensor + :image: ttp229.jpg + :keywords: TTP229 + +The ``ttp229`` sensor platform allows you to use your TTP229 `datasheet `__ +Capacitive Touch Sensor with ESPHome. The :ref:`I²C ` is required to be set up in your configuration for this sensor to work. + +.. figure:: images/ttp229-full.jpg + :align: center + :width: 50.0% + + TTP229 Capacitive Touch Sensor. Image by `RobotDyn`_. + +.. _RobotDyn: https://www.tinytronics.nl/shop/nl/sensoren/touch/robotdyn-touch-module-ttp229-lsf-16-kanaals + +.. code-block:: yaml + + # Example configuration entry + ttp229_lsf: + id: ttp229_device + + binary_sensor: + - platform: ttp229_lsf + name: TTP229 Channel 0 + channel: 0 + +Configuration variables: +------------------------ + +The configuration is made up of two parts: The central component, and individual Binary sensors per channel. + +Base Configuration: + +- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor. + +Binary Sensor Configuration: + +- **name** (**Required**, string): The name of the binary sensor. +- **channel** (**Required**, integer): The channel number at the ttp229 the touchkey is connected to. +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. +- All other options from :ref:`Binary Sensor `. + +See Also +-------- + +- :ref:`sensor-filters` +- :apiref:`sensor/ttp229_sensor.h` +- :ghedit:`Edit` diff --git a/images/ttp229.jpg b/images/ttp229.jpg new file mode 100644 index 000000000..ce4810754 Binary files /dev/null and b/images/ttp229.jpg differ diff --git a/index.rst b/index.rst index 60dee63f9..c174ce33d 100644 --- a/index.rst +++ b/index.rst @@ -153,6 +153,7 @@ Binary Sensor Components Remote Receiver, components/binary_sensor/remote_receiver, remote.svg PN532, components/binary_sensor/pn532, pn532.jpg RDM6300, components/binary_sensor/rdm6300, rdm6300.jpg + TTP229-LSF Capacitive Touch Sensor, components/binary_sensor/ttp229, ttp229.jpg Custom Binary Sensor, components/binary_sensor/custom, language-cpp.svg Output Components