Update mopeka pro documentation to include details about universal sensor (#3418)

This commit is contained in:
Sean Brogan 2023-11-27 23:00:50 -08:00 committed by GitHub
parent ddf45531d5
commit 75e5c52ee1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,27 +4,35 @@ Mopeka Pro Check BLE Sensor
.. seo:: .. seo::
:description: Instructions for setting up Mopeka Pro Check or Lippert Propane Tank bluetooth-based sensors in ESPHome. :description: Instructions for setting up Mopeka Pro Check or Lippert Propane Tank bluetooth-based sensors in ESPHome.
:image: mopeka_pro_check.jpg :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 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 Energy devices using the :doc:`/components/esp32_ble_tracker`. This component
will track the tank level, distance, temperature, and battery percentage of a 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 device every time the sensor sends out a BLE broadcast.
sensor sends out a BLE broadcast.
.. warning:: .. warning::
This sensor component only supports the following sensors: This sensor component only supports the following sensors:
+ Mopeka Pro Check devices + Mopeka Pro Check devices
+ Mopeka Pro Plus devices + Mopeka Pro Plus devices
+ Mopeka Pro Check Universal Sensor
+ Lippert Propane Tank Sensor, part number 2021130655 + 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. 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) Mopeka Pro Check LP over BLE.
(images/mopeka_pro_check_lippert.jpg)
.. figure:: images/mopeka_pro_check_lippert.jpg
:align: center
Lippert™ Propane Tank Sensor
The original Mopeka Check sensors are not supported. The original Mopeka Check sensors are not supported.
@ -113,8 +121,8 @@ Currently supported Tank types are:
Setting Up Devices 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 To set up the sensor devices you first need to find the MAC Address so that
ESPHome can identify them. So first, create a simple configuration with the ``esp32_ble_tracker`` ESPHome can identify it. First, create a simple configuration with the ``esp32_ble_tracker``
and the ``mopeka_ble`` component like so: and the ``mopeka_ble`` component like so:
.. code-block:: yaml .. code-block:: yaml
@ -123,8 +131,7 @@ and the ``mopeka_ble`` component like so:
mopeka_ble: mopeka_ble:
After uploading, the ESP32 will immediately try to scan for BLE devices. For Mopeka Pro After uploading, the ESP32 will immediately try to scan for BLE devices. Press and hold the sync button for it to be identified.
Check / Pro Plus / Lippert devices you must press and hold the green sync button for it to be identified.
Or alternativly set the configuration flag ``show_sensors_without_sync: true`` to see all devices. 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: 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/esp32_ble_tracker`
- :doc:`/components/sensor/index` - :doc:`/components/sensor/index`
- :apiref:`mopeka_pro_check/mopeka_pro_check.h` - :apiref:`mopeka_pro_check/mopeka_pro_check.h`
- `Mopeka <https://mopeka.com/product/mopeka-check-pro-lp-sensor/>`__ - `Mopeka <https://www.mopekaiot.com/shop>`
- `Lippert <https://store.lci1.com/lippert-propane-tank-sensor-2021130655>`__ - `Lippert <https://store.lci1.com/lippert-propane-tank-sensor-2021130655>`__
- :ghedit:`Edit` - :ghedit:`Edit`