Update Mopeka docs to include new optional sensors and configuration (#4281)

components/sensor/mopeka_pro_check.rst

@@ -9,8 +9,9 @@ Mopeka Pro Check BLE Sensor
 The ``mopeka_pro_check`` sensor platform lets you track the output of Mopeka Pro
 Check LP, Mopeka Pro Plus, Mopeka Pro Universal or Lippert Propane Tank Sensors,   Bluetooth Low
 Energy devices using the :doc:`/components/esp32_ble_tracker`. This component
-will track the tank level, distance, temperature, and battery percentage of a
-device every time the sensor sends out a BLE broadcast.
+will track the tank level, distance, temperature, battery percentage, and sensor reading quality of a
+device every time the sensor sends out a BLE broadcast.  There are additional configuration options
+to control handling of poor quality readings and reporting reading quality issues.
 
 .. warning::
 
@@ -56,6 +57,12 @@ Mopeka Pro Check LP over BLE:
             name: "Propane test distance"
         battery_level:
             name: "Propane test battery level"
+        signal_quality:
+            name: "Propane test read quality"
+        ignored_reads:
+            name: "Propane test ignored reads"
+        # Report sensor distance/level data for all equal or greater than 
+        minimum_signal_quality: "LOW"
 
       # Custom example - user defined empty / full points
       - platform: mopeka_pro_check
@@ -87,11 +94,13 @@ Configuration variables:
 - **custom_distance_empty** (*Optional*): distance sensor will read when it should be
   considered empty (0%).  This is only used when tank_type = CUSTOM
 
-- **level** (*Optional*): The percentage of full for the tank sensor
+- **level** (*Optional*): The percentage of full for the tank sensor.  If
+  read is ignored due to quality this sensor will not be updated.
 
   - All options from :ref:`Sensor <config-sensor>`.
 
 - **distance** (*Optional*): The raw distance/depth of the liquid for the sensor in mm.
+  If read is ignored due to quality this sensor will not be updated.
 
   - All options from :ref:`Sensor <config-sensor>`.
 
@@ -105,6 +114,31 @@ Configuration variables:
 
   - All options from :ref:`Sensor <config-sensor>`.
 
+- **signal_quality** (*Optional*): The information for the read quality
+  sensor.
+
+  - All options from :ref:`Sensor <config-sensor>`.
+
+- **ignored_reads** (*Optional*): A diagnostic sensor indicating the number
+  of consecutive ignored reads.  This resets to zero each time the read is
+  equal or greater than the configured ignored quality.  Only the distance
+  and level sensors are not reported.
+
+  - All options from :ref:`Sensor <config-sensor>`.
+
+- **minimum_signal_quality** (*Optional*): Each report from the sensor
+  indicates the quality or confidence in the distance the sensor calculated. Physical
+  sensor placement, tank material or quality, or other factors can influence the
+  sensors ability to read with confidence.  As quality gets lower, the accuracy of the
+  distance reading may not align with expectations. This value allows configuration of
+  the minimum quality level that the distance should be evaluated/reported.
+  Acceptable Values:
+
+  - "HIGH": High Quality
+  - "MEDIUM": Medium Quality (default value)
+  - "LOW": Low Quality
+  - "ZERO": Zero Quality
+
 Tank Types
 ----------
 
@@ -132,7 +166,7 @@ and the ``mopeka_ble`` component like so:
     mopeka_ble:
 
 After uploading, the ESP32 will immediately try to scan for BLE devices.  Press and hold the sync button for it to be identified.
-Or alternativly set the configuration flag ``show_sensors_without_sync: true`` to see all devices.
+Or alternatively set the configuration flag ``show_sensors_without_sync: true`` to see all devices.
 For all sensors found the ``mopeka_ble`` component will print a message like this one:
 
 .. code::