diff --git a/components/binary_sensor/images/mpr121-full.jpg b/components/binary_sensor/images/mpr121-full.jpg new file mode 100644 index 000000000..fb6bacde3 Binary files /dev/null and b/components/binary_sensor/images/mpr121-full.jpg differ diff --git a/components/binary_sensor/mpr121.rst b/components/binary_sensor/mpr121.rst new file mode 100644 index 000000000..18686b0fa --- /dev/null +++ b/components/binary_sensor/mpr121.rst @@ -0,0 +1,60 @@ +MPR121 Capacitive Touch Sensor +============================== + +.. seo:: + :description: Instructions for setting up MPR121 Capacitive Touch Sensor + :image: mpr121.jpg + :keywords: MPR121 + +The ``mpr121`` sensor platform allows you to use your MPR121 +(`datasheet `__, +`Adafruit`_) Capacitive Touch Sensor with esphomelib. The :ref:`I²C ` is +required to be set up in your configuration for this sensor to work. + +.. figure:: images/mpr121-full.jpg + :align: center + :width: 50.0% + + MPR121 Capacitive Touch Sensor. Image by `Adafruit`_. + +.. _Adafruit: https://learn.adafruit.com/adafruit-mpr121-12-key-capacitive-touch-sensor-breakout-tutorial/overview + +.. code-block:: yaml + + # Example configuration entry + mpr121: + id: mpr121_component + address: 0x5A + + binary_sensor: + - platform: mpr121 + id: touch_key0 + channel: 0 + name: "Touch Key 0" + +Configuration variables: +------------------------ + +The configuration is made up of two parts: The central component, and individual Binary sensors per channel. + +Base Configuration: + +- **address** (*Optional*, integer): The i2c address of the sensor. Defaults to ``0x5A``. +- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor. + +Binary Sensor Configuration: + +- **name** (**Optional**, string): The name for the binary sensor. +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. +- **channel** (*Required*, integer): The channel number at the mpr121 the touchkey is connected to. +- All other options from :ref:`Binary Sensor `. + +See Also +-------- + +- :ref:`sensor-filters` +- :apiref:`sensor/mpr121_sensor.h` +- `Adafruit MPR121 Library `__ by `Adafruit `__ +- :ghedit:`Edit` + +.. disqus:: diff --git a/images/mpr121.jpg b/images/mpr121.jpg new file mode 100644 index 000000000..fec7ea733 Binary files /dev/null and b/images/mpr121.jpg differ diff --git a/index.rst b/index.rst index 8459f5e5c..eabf36b5c 100644 --- a/index.rst +++ b/index.rst @@ -146,6 +146,7 @@ Binary Sensor Components Status, components/binary_sensor/status, server-network.svg ESP32 BLE Device, components/binary_sensor/esp32_ble_tracker, bluetooth.svg ESP32 Touch Pad, components/binary_sensor/esp32_touch, touch.svg + MPR121 Capacitive Touch Sensor, components/binary_sensor/mpr121, mpr121.jpg Nextion Touch, components/binary_sensor/nextion, nextion.jpg Template Binary Sensor, components/binary_sensor/template, description.svg Remote Receiver, components/binary_sensor/remote_receiver, remote.svg