diff --git a/components/sensor/bmp3xx.rst b/components/sensor/bmp3xx.rst new file mode 100644 index 000000000..28ebee1db --- /dev/null +++ b/components/sensor/bmp3xx.rst @@ -0,0 +1,86 @@ +BMP388 / BMP390 Temperature+Pressure Sensor +=========================================== + +.. seo:: + :description: Instructions for setting up BMP388 or BMP390 temperature and pressure sensors with ESPHome + :image: bmp388.jpg + :keywords: BMP388 BMP390 + +The ``bmp3xx`` sensor platform allows you to use your BMP388 or BMP390 +(`datasheet `__, `BMP390 product page `__) temperature and pressure sensors with ESPHome. The :ref:`I²C ` bus is +required to be set up in your configuration for this sensor to work. + +.. figure:: images/bmp388.jpg + :align: center + :width: 50.0% + + BMP388/BMP390 Temperature and Pressure Sensor. + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: bmp3xx + temperature: + name: "Outside Temperature" + oversampling: 16x + pressure: + name: "Outside Pressure" + address: 0x77 + update_interval: 60s + +Configuration variables: +------------------------ + +- **temperature** (*Optional*): The information for the temperature sensor. + + - **name** (**Required**, string): The name for the temperature + sensor. + - **oversampling** (*Optional*): The oversampling parameter for the temperature sensor. + See :ref:`Oversampling Options `. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **pressure** (*Optional*): The information for the pressure sensor. + + - **name** (**Required**, string): The name for the pressure sensor. + - **oversampling** (*Optional*): The oversampling parameter for the temperature sensor. + See :ref:`Oversampling Options `. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **address** (*Optional*, int): Manually specify the I²C address of + the sensor. Defaults to ``0x77``. Another address can be ``0x76``. +- **iir_filter** (*Optional*): Set up an Infinite Impulse Response filter to increase accuracy. One of + ``OFF``, ``2x``, ``4x``, ``16x``, ``32``, ``64x``, ``128x``. Defaults to ``OFF``. +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the + sensor. Defaults to ``60s``. + + +.. _bmp3xx-oversampling: + +Oversampling Options +-------------------- + +By default, the BMP3xx sensor measures pressure 16 times and temperature 2 times when requesting a new value. You can, however, +configure this amount. Possible oversampling values: + +- ``NONE`` (value is skipped) +- ``2x`` +- ``4x`` +- ``8x`` +- ``16x`` (default) +- ``32x`` + +See Also +-------- + +- :ref:`sensor-filters` +- :doc:`bme280` +- :doc:`bmp280` +- :doc:`bme680` +- :doc:`bmp085` +- :apiref:`bmp3xx/bmp3xx.h` +- `BMP3 sensor API `__ +- `BMP388/BMP390 Library `__ by Martin Lindupp +- :ghedit:`Edit` diff --git a/components/sensor/images/bmp388.jpg b/components/sensor/images/bmp388.jpg new file mode 100644 index 000000000..369bc4a29 Binary files /dev/null and b/components/sensor/images/bmp388.jpg differ diff --git a/images/bmp388.jpg b/images/bmp388.jpg new file mode 100644 index 000000000..1b50b71db Binary files /dev/null and b/images/bmp388.jpg differ diff --git a/index.rst b/index.rst index a5152804c..f68cf6e00 100644 --- a/index.rst +++ b/index.rst @@ -271,6 +271,7 @@ Environmental BME680 via BSEC, components/sensor/bme680_bsec, bme680.jpg, Temperature & Humidity & Pressure & Gas BMP085, components/sensor/bmp085, bmp180.jpg, Temperature & Pressure BMP280, components/sensor/bmp280, bmp280.jpg, Temperature & Pressure + BMP388 and BMP390, components/sensor/bmp3xx, bmp388.jpg, Temperature & Pressure b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light Dallas DS18B20, components/sensor/dallas, dallas.jpg, Temperature DHT, components/sensor/dht, dht.jpg, Temperature & Humidity