Add documentation for ufire_ec (#2273)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

components/sensor/ufire_ec.rst

@@ -0,0 +1,109 @@
+uFire EC sensor
+===================
+
+.. seo::
+    :description: Instructions for setting up uFire EC sensor in esphome
+    :image: ufire_ec.png
+    :keywords: ufire ec sensor temperature esphome
+
+The ``ufire_ec`` sensor platform allows you to use your uFire EC sensor with
+ESPHome. The :ref:`I²C Bus <i2c>` is
+required to be set up in your configuration for this sensor to work.
+It required also to have an temperature sensor in the liquit tank; this can
+be on the same board or external sensor linked to the uFire EC configuration.
+
+.. figure:: images/ufire_ec.png
+    :align: center
+    :width: 100.0%
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    sensor:
+      - platform: ufire_ec  
+        id: ufire_ec_board
+        temperature:
+          id: temperature_liquit
+          name: Temperature
+        ec:
+          name: EC
+
+
+Configuration variables:
+------------------------
+
+- **address** (**Optional**, int): Specify the I²C address of the sensor. Defaults to ``0x3C``,
+  this address work with the Isolated EC boards for Mod-EC use ``0x0a``.
+- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
+  sensor. Defaults to ``60s``.
+- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
+- **temperature_sensor** (*Optional*, :ref:`config-id`): Set the ID of the temperature
+  sensor. Only needed if the onboard temperature sensor is not used.
+- **ec** (*Optional*, :ref:`Sensor <config-sensor>`): Set the EC sensor configuration.
+- **temperature** (*Optional*, :ref:`Sensor <config-sensor>`): Set the onboard temperature sensor configuration.
+  Can't be used together with ``temperature_sensor``.
+- **temperature_compensation** (*Optional*, float): Set the temperature compensation for the EC
+  sensor. Defaults to ``21.0``.
+- **temperature_coefficient** (*Optional*, float): Set the temperature coefficient for the EC
+  sensor. Defaults to ``0.019``.
+- All other options from :ref:`Sensor <config-sensor>`.
+
+.. _sensor-ufire_ec-calibrate_probe_action:
+
+``sensor.ufire_ec.calibrate_probe`` Action
+------------------------------------------
+
+The EC probe have to be calibrated. For this you need know the EC reference value and temperature
+of the calibration solution.
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    sensor:
+      - platform: ufire_ec
+        id: ufire_ec_board
+        # ...
+
+    # in some trigger
+    on_...:
+      - sensor.ufire_ec_board.calibrate_probe:
+          id: ufire_ec_board
+          solution: 0.146
+          temperature: !lambda "return id(temperature_liquit).state;"
+
+Configuration options:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the ufire EC sensor.
+- **solution** (**Required**, float): Solution reference EC value.
+- **temperature** (**Required**, float): Solution current temperature.
+
+.. _sensor-ufire_ec-reset:
+
+``sensor.ufire_ec.reset`` Action
+--------------------------------
+
+Reset the current calibration on the sensor.
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    sensor:
+      - platform: ufire_ec
+        id: ufire_ec_board
+        # ...
+
+    # in some trigger
+    on_...:
+      - sensor.ufire_ec_board.reset:
+          id: ufire_ec_board
+
+Configuration options:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the ufire EC sensor.
+
+See Also
+--------
+
+- :ref:`sensor-filters`
+- :apiref:`ufire_ec/ufire_ec.h`
+- :ghedit:`Edit`

index.rst

@@ -361,6 +361,7 @@ Miscellaneous
     SMT100, components/sensor/smt100, smt100.jpg, Moisture & Temperature
     Tuya Sensor, components/sensor/tuya, tuya.png
     TX20, components/sensor/tx20, tx20.jpg, Wind speed & Wind direction
+    uFire EC sensor, components/sensor/ufire_ec, ufire_ec.png, (EC)
 
 
 Motion