diff --git a/components/sensor/b_parasite.rst b/components/sensor/b_parasite.rst new file mode 100644 index 000000000..3faff4609 --- /dev/null +++ b/components/sensor/b_parasite.rst @@ -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 `__ 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 `. +- **humidity** (*Optional*): Relative air humidity in %. + + - **name** (**Required**): Sensor name. + - All other options from :ref:`Sensor `. +- **moisture** (*Optional*): Soil moisture in %. + + - **name** (**Required**): Sensor name. + - All other options from :ref:`Sensor `. +- **battery_voltage** (*Optional*): Battery voltage in volts. + + - **name** (**Required**): Sensor name. + - All other options from :ref:`Sensor `. + +See Also +-------- + +- `b-parasite on GitHub `__ +- :doc:`/components/esp32_ble_tracker` +- :ghedit:`Edit` diff --git a/components/sensor/images/b_parasite.jpg b/components/sensor/images/b_parasite.jpg new file mode 100644 index 000000000..22ff8e097 Binary files /dev/null and b/components/sensor/images/b_parasite.jpg differ diff --git a/images/b_parasite.jpg b/images/b_parasite.jpg new file mode 100644 index 000000000..46e395c50 Binary files /dev/null and b/images/b_parasite.jpg differ diff --git a/index.rst b/index.rst index 27eb9c151..f734e6e96 100644 --- a/index.rst +++ b/index.rst @@ -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