Adds docs for the b-parasite soil moisture sensor (#1086)

This commit is contained in:
rbaron 2021-04-08 13:59:38 +02:00 committed by GitHub
parent 97ae661d19
commit 91e097d3d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 64 additions and 0 deletions

View File

@ -0,0 +1,63 @@
b-parasite
==========
.. seo::
:description: Instructions for setting up the b-parasite soil moisture sensor in ESPHome.
:image: b_parasite.jpg
:keywords: b-parasite, parasite, BLE, Bluetooth, soil moisture
`b-parasite <https://github.com/rbaron/b-parasite>`__ is an open source soil moisture and ambient temperature/humidity sensor.
The ``b_parasite`` sensor platform tracks b-parasite's Bluetooth Low Energy (BLE) advertisement packets. These packets contains soil moisture, air temperature/humidity and baterry voltage data.
.. figure:: images/b_parasite.jpg
:align: center
:width: 80.0%
.. code-block:: yaml
# Example configuration.
# Required.
esp32_ble_tracker:
sensor:
- platform: b_parasite
mac_address: F0:CA:F0:CA:01:01
humidity:
name: 'b-parasite Air Humidity'
temperature:
name: 'b-parasite Air Temperature'
moisture:
name: 'b-parasite Soil Moisture'
battery_voltage:
name: 'b-parasite Battery Voltage'
Configuration variables
-----------------------
- **mac_address** (**Required**): The MAC address of the device.
- **temperature** (*Optional*): Air temperature in Celcius.
- **name** (**Required**): Sensor name.
- All other options from :ref:`Sensor <config-sensor>`.
- **humidity** (*Optional*): Relative air humidity in %.
- **name** (**Required**): Sensor name.
- All other options from :ref:`Sensor <config-sensor>`.
- **moisture** (*Optional*): Soil moisture in %.
- **name** (**Required**): Sensor name.
- All other options from :ref:`Sensor <config-sensor>`.
- **battery_voltage** (*Optional*): Battery voltage in volts.
- **name** (**Required**): Sensor name.
- All other options from :ref:`Sensor <config-sensor>`.
See Also
--------
- `b-parasite on GitHub <https://github.com/rbaron/b-parasite>`__
- :doc:`/components/esp32_ble_tracker`
- :ghedit:`Edit`

Binary file not shown.

After

Width:  |  Height:  |  Size: 471 KiB

BIN
images/b_parasite.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

View File

@ -109,6 +109,7 @@ Sensor Components
BME680 via BSEC, components/sensor/bme680_bsec, bme680.jpg
BMP085, components/sensor/bmp085, bmp180.jpg
BMP280, components/sensor/bmp280, bmp280.jpg
b-parasite, components/sensor/b_parasite, b_parasite.jpg
CCS811, components/sensor/ccs811, ccs811.jpg
CSE7766, components/sensor/cse7766, cse7766.svg
CT Clamp, components/sensor/ct_clamp, ct_clamp.jpg