Documentation for binary_sensor_map (#199)

* Add mpr121 docs and images

* add images

* update mpr121 docs

* Title bar same length as text

* wrong size and location

* wrong size and location

* wrong location

* wrong size and location

* wrong size and location

* Added binary_sensor_map

* tabs to spaces

* added to index

* add image

* text changes

* remove linefeed

* image is jpg not png

* preview fail??

* Update binary_sensor_map.rst

- Make use case and function more clear
- Remove options that do not exist yet.
- Fix incorrect sensor link in configuration variables
- Fix required values labeled optional
- Less literal text with backslash. Was hard to read.
- Move config example essential part up.
- Remove disqus

* Update binary_sensor_map.rst

* Fix


Co-authored-by: Otto Winter <otto@otto-winter.com>

components/sensor/binary_sensor_map.rst

@@ -0,0 +1,70 @@
+Binary Sensor Map
+=================
+
+.. seo::
+    :description: Instructions for setting up a Binary Sensor Map
+    :image: binary_sensor_map.jpg
+
+The ``binary_sensor_map`` sensor platform allows you to map :doc:`binary sensor </components/binary_sensor/index>`
+to values. When a given binary sensor is on, the value associated with it in this platform's configuration will be published.
+
+This sensor is **mostly used for touch** devices but could be used for any ``binary_sensor`` that publishes its ``ON`` or ``OFF`` state.
+
+Add your binary sensors as ``channels`` to the binary sensor map. The binary sensor map then publishes a value depending
+on the type of the binary sensor map and the values specified with each channel.
+
+This platform currently supports only one measurement type: ``GROUP``, but others might get added later.
+You need to specify which type of mapping you want with the ``type:`` configuration value:
+
+- ``GROUP`` Each channel has its own value. The sensor publishes the average value of all active
+  binary sensors.
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    sensor:
+      - platform: binary_sensor_map
+        id: group_0
+        name: 'Group Map 0'
+        type: GROUP
+        channels:
+          - binary_sensor: touchkey0
+            value: 0
+          - binary_sensor: touchkey1
+            value: 10
+          - binary_sensor: touchkey2
+            value: 20
+          - binary_sensor: touchkey3
+            value: 30
+
+    # Example binary sensors using MPR121 component
+    mpr121:
+      id: mpr121_first
+      address: 0x5A
+
+    binary_sensor:
+      - platform: mpr121
+        channel: 0
+        id: touchkey0
+      # ...
+
+Configuration variables:
+------------------------
+
+- **name** (**Required**, string): The name of the sensor.
+- **type** (**Required**, string): The sensor type. Should be one of: ``GROUP``.
+- **channels** (**Required**): A list of channels that are mapped to certain values.
+
+  - **binary_sensor** (**Required**): The id of the :doc:`binary sensor </components/binary_sensor/index>`
+    to add as a channel for this sensor.
+  - **value** (**Required**): The value this channel should report when its binary sensor is active.
+
+- All other options from :ref:`Sensor <config-sensor>`.
+
+See Also
+--------
+
+- :doc:`/components/binary_sensor/mpr121`
+- :ref:`sensor-filters`
+- :apiref:`binary_sensor_map/binary_sensor_map.h`
+- :ghedit:`Edit`

index.rst

@@ -91,6 +91,7 @@ Sensor Components
     AM2320, components/sensor/am2320, am2320.jpg
     APDS9960, components/sensor/apds9960, apds9960.jpg
     BH1750, components/sensor/bh1750, bh1750.jpg
+    Binary Sensor Map, components/sensor/binary_sensor_map, binary_sensor_map.jpg
     BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
     BME280, components/sensor/bme280, bme280.jpg
     BME680, components/sensor/bme680, bme680.jpg