Add docs for Teleinfo (#666)

Signed-off-by: 0hax <0hax@protonmail.com>
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

components/sensor/teleinfo.rst

@@ -0,0 +1,104 @@
+Teleinformation from Linky electrical counter.
+==============================================
+
+.. seo::
+    :description: Instructions for setting up French Teleinformation
+    :image: teleinfo.jpg
+    :keywords: teleinfo
+
+The ``teleinfo`` component allows you to retrieve data from a 
+French electrical counter using Teleinformation (`datasheet <https://www.enedis.fr/sites/default/files/Enedis-NOI-CPT_54E.pdf>`__). It works with Linky electrical
+counter but also legacy EDF electrical counter.
+
+.. figure:: images/teleinfo-full.jpg
+    :align: center
+    :width: 50.0%
+
+    Linky electrical counter
+
+..
+
+A simple electronic assembly with an optocoupler and a resistor could
+let you retrieve detailed power consumption or power production.
+There is plenty of example on the web.
+
+As the communication with the Teleinformation is done using UART, you need to
+have an :ref:`UART bus <uart>` in your configuration with the ``rx_pin``
+connected to the output of the optocoupler component. Additionally, you need to
+set the baud rate to 9600bps if counter is configured to work in standard
+mode or 1200bps in historical mode.  To find out which mode you are using,
+simply press -/+ buttons on the counter and look for `Standard mode` or
+`Historical mode` as below.
+
+.. figure:: images/teleinfo-standard.jpg
+    :align: center
+    :width: 50.0%
+
+    Linky electrical counter configured in standard mode.
+
+..
+
+.. figure:: images/teleinfo-historical.jpg
+    :align: center
+    :width: 50.0%
+
+    Linky electrical counter configured in historical mode.
+
+..
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    uart:
+      id: uart_bus
+      rx_pin: GPIO3
+      tx_pin: GPIO1
+      baud_rate: 1200
+      parity: EVEN
+      data_bits: 7
+
+    sensor:
+      - platform: teleinfo
+        tags:
+         - name: "HCHC"
+           sensor:
+            name: "hchc"
+            unit_of_measurement: "Wh"
+            icon: mdi:flash
+         - name: "HCHP"
+           sensor:
+            name: "hchp"
+            unit_of_measurement: "Wh"
+            icon: mdi:flash
+         - name: "PAPP"
+           sensor:
+            name: "papp"
+            unit_of_measurement: "VA"
+            icon: mdi:flash
+        update_interval: 60s
+        historical_mode: true
+
+Configuration variables:
+------------------------
+
+
+- **tags** (**Required**): Specify the tag you want to retrieve from the Teleinformation and select with what name to transmit it.
+
+  - **name** (**Required**, string): The name of the tag corresponding to what the electrical counter send.
+  - **sensor** (**Required**, :ref:`Sensor <config-sensor>`): Associate a sensor with the tag. See options from :ref:`Sensor <config-sensor>`.
+
+- **historical_mode** (*Optional*): Wether to use historical mode or standard mode.
+  With historical mode, baudrate of 1200 must be used whereas 9600 must be used in
+  standard mode. Defaults to ``False``.
+
+- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
+  sensor. Defaults to ``60s``.
+
+- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component <uart>` if you want
+  to use multiple UART buses.
+
+See Also
+--------
+
+- :apiref:`teleinfo/teleinfo.h`
+- :ghedit:`Edit`

index.rst

@@ -154,6 +154,7 @@ Sensor Components
     STS3X, components/sensor/sts3x, sts3x.jpg
     SGP30, components/sensor/sgp30, sgp30.jpg
     TCS34725, components/sensor/tcs34725, tcs34725.jpg
+    Teleinfo, components/sensor/teleinfo, teleinfo.jpg
     Template Sensor, components/sensor/template, description.svg
     TMP102, components/sensor/tmp102, tmp102.jpg
     TMP117, components/sensor/tmp117, tmp117.jpg