From 75e5c52ee158b4d44cf0e0374333d25837b8bd69 Mon Sep 17 00:00:00 2001 From: Sean Brogan Date: Mon, 27 Nov 2023 23:00:50 -0800 Subject: [PATCH] Update mopeka pro documentation to include details about universal sensor (#3418) --- components/sensor/mopeka_pro_check.rst | 29 ++++++++++++++++---------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/components/sensor/mopeka_pro_check.rst b/components/sensor/mopeka_pro_check.rst index accd95e91..d5b8b8406 100644 --- a/components/sensor/mopeka_pro_check.rst +++ b/components/sensor/mopeka_pro_check.rst @@ -4,27 +4,35 @@ Mopeka Pro Check BLE Sensor .. seo:: :description: Instructions for setting up Mopeka Pro Check or Lippert Propane Tank bluetooth-based sensors in ESPHome. :image: mopeka_pro_check.jpg - :keywords: Mopeka, Mopeka Pro Check, Mopeka Pro Plus, Lippert, Lippert Propane, Lippert Propane Sensor, Lippert Propane Tank Sensor, BLE, Bluetooth + :keywords: Mopeka, Mopeka Pro Check, Mopeka Pro Plus, Mopeka Pro Universal, Lippert, Lippert Propane, Lippert Propane Sensor, Lippert Propane Tank Sensor, BLE, Bluetooth The ``mopeka_pro_check`` sensor platform lets you track the output of Mopeka Pro -Check LP, Mopeka Pro Plus, or Lippert Propane Tank Sensors, Bluetooth Low +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 -Mopeka Pro Check LP or Mopeka Pro Plus Residential BLE device every time the -sensor sends out a BLE broadcast. +device every time the sensor sends out a BLE broadcast. .. warning:: This sensor component only supports the following sensors: + Mopeka Pro Check devices + Mopeka Pro Plus devices + + Mopeka Pro Check Universal Sensor + Lippert Propane Tank Sensor, part number 2021130655 + + Sensors are calibrated for propane only. See :doc:`/components/sensor/mopeka_std_check` for original Mopeka Check sensors support. +.. figure:: images/mopeka_pro_check.jpg + :align: center -(images/mopeka_pro_check.jpg) -(images/mopeka_pro_check_lippert.jpg) + Mopeka Pro Check LP over BLE. + +.. figure:: images/mopeka_pro_check_lippert.jpg + :align: center + + Lippert™ Propane Tank Sensor The original Mopeka Check sensors are not supported. @@ -113,8 +121,8 @@ Currently supported Tank types are: Setting Up Devices ------------------ -To set up Mopeka Pro Check / Mopeka Pro Plus / Lippert Propane Tank Sensor devices you first need to find their MAC Address so that -ESPHome can identify them. So first, create a simple configuration with the ``esp32_ble_tracker`` +To set up the sensor devices you first need to find the MAC Address so that +ESPHome can identify it. First, create a simple configuration with the ``esp32_ble_tracker`` and the ``mopeka_ble`` component like so: .. code-block:: yaml @@ -123,8 +131,7 @@ and the ``mopeka_ble`` component like so: mopeka_ble: -After uploading, the ESP32 will immediately try to scan for BLE devices. For Mopeka Pro -Check / Pro Plus / Lippert devices you must press and hold the green sync button for it to be identified. +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. For all sensors found the ``mopeka_ble`` component will print a message like this one: @@ -146,6 +153,6 @@ See Also - :doc:`/components/esp32_ble_tracker` - :doc:`/components/sensor/index` - :apiref:`mopeka_pro_check/mopeka_pro_check.h` -- `Mopeka `__ +- `Mopeka ` - `Lippert `__ - :ghedit:`Edit`