Merge pull request #4789 from TD-er/feature/BMP3xx

[BMP3xx] Add support for Bosch BMP384/388/390 temp/pressure modules

docs/source/Plugin/P154.rst

@@ -0,0 +1,119 @@
+.. include:: ../Plugin/_plugin_substitutions_p15x.repl
+.. _P154_page:
+
+|P154_typename|
+==================================================
+
+|P154_shortinfo|
+
+Plugin details
+--------------
+
+Type: |P154_type|
+
+Name: |P154_name|
+
+Status: |P154_status|
+
+GitHub: |P154_github|_
+
+Maintainer: |P154_maintainer|
+
+Used libraries: |P154_usedlibraries|
+
+Description
+-----------
+
+As a successor to their BMP280, Bosch made the BMP388 and the even higher resolution BMP390 temperature and air pressure sensors.
+
+The main improvements compared to the BMP280 are:
+
+* Lower power consumption
+* Higher possible sample rate
+* Option to store a number of samples in the 512 byte buffer to burst read
+* Higher resolution
+* Less noise
+
+
+Configuration
+-------------
+
+.. image:: P154_DeviceConfiguration.png
+
+* **Name**: Required by ESPEasy, must be unique among the list of available devices/tasks.
+
+* **Enabled**: The device can be disabled or enabled. When not enabled the device should not use any resources.
+
+I2C options
+^^^^^^^^^^^
+
+* **I2C Address**: The sensor supports a single address, but that address depends on the actual type suffix, printed on the sensor chip (and usually included in the documentation for the device/board).
+
+.. csv-table::
+    :header: "Address", "Remark"
+    :widths: 10, 50
+
+    "0x76",  "Connect SDO to GND"
+    "0x77",  "Connect SDO to V_DDIO (default on most boards)"
+
+The available I2C settings here depend on the build used. At least the **Force Slow I2C speed** option is available, but selections for the I2C Multiplexer can also be shown. For details see the :ref:`Hardware_page`
+
+Since this chip supports both SPI and I2C, the pin naming may be slightly confusing:
+
+* SCK: Serial Clock (SCL)
+* SDI: Data (SDA)
+* SDO: Slave Address LSB (GND = '0', V_DDIO = '1')
+* CSB is not used and left open.
+* SDI must be externally connected to V_DDIO via pull-up resistor.
+
+On most boards sold online, SDO and SDI are already pulled-up, setting the default I2C address to 0x77.
+
+
+Device Settings
+^^^^^^^^^^^^^^^
+
+* **Detected Sensor Type**: Shows either ``BMP38x`` or ``BMP390`` or a number if no sensor or an unknown sensor ID is detected.
+* **Altitude**: Optionally set the offset (in meters) of the sensor to convert pressure measurements to sea level pressure.
+
+Data Acquisition
+^^^^^^^^^^^^^^^^
+
+This group of settings, **Single event with all values** and **Send to Controller** settings are standard available configuration items. Send to Controller is only visible when one or more Controllers are configured.
+
+* **Interval** By default, Interval will be set to 60 sec. The data will be collected and optionally sent to any configured controllers using this interval. If the Interval is set lower or equal than the required 10 * Heater time, the plugin will not start!
+
+Values
+^^^^^^
+
+The plugin provides the ``Temperature`` and ``Pressure`` values. A formula can be set to recalculate. The number of decimals can be set as desired, and defaults to 2.
+
+In selected builds, per Value is a **Stats** checkbox available, that when checked, gathers the data and presents recent data in a graph, as described here: :ref:`Task Value Statistics:  <Task Value Statistics>`
+
+Currently the extra features offered by the sensore are not configurable in this plugin.
+These may be added later.
+
+The internal filtering in the sensor is fixed to these settings:
+
+* Temperature: 8x oversampling
+* Pressure: 4x oversampling
+* IIR Filter Coefficient: 3
+* Sample rate: 50 Hz
+
+
+.. figure:: P154_HighResolutionTemperatureStatsExample.png
+  :alt: Example of the high temperature resolution of a BMP388
+  :width: 50 %
+  :align: center
+
+  Example of the high temperature resolution of a BMP388
+
+
+Change log
+----------
+
+.. versionchanged:: 2.0
+  ...
+
+  |added|
+  2023-09-07 Initial release version.
+

docs/source/Plugin/_Plugin.rst

@@ -381,6 +381,7 @@ There are different released versions of ESP Easy:
    ":ref:`P151_page`","|P151_status|","P151"
    ":ref:`P152_page`","|P152_status|","P152"
    ":ref:`P153_page`","|P153_status|","P153"
+   ":ref:`P154_page`","|P154_status|","P154"
 
 
 Internal GPIO handling

docs/source/Plugin/_plugin_categories.repl

@@ -8,7 +8,7 @@
 .. |Plugin_Energy_AC| replace:: :ref:`P076_page`, :ref:`P077_page`, :ref:`P078_page`, :ref:`P102_page`, :ref:`P108_page`
 .. |Plugin_Energy_DC| replace:: :ref:`P027_page`, :ref:`P085_page`, :ref:`P115_page`, :ref:`P132_page`
 .. |Plugin_Energy_Heat| replace:: :ref:`P088_page`, :ref:`P093_page`
-.. |Plugin_Environment| replace:: :ref:`P004_page`, :ref:`P005_page`, :ref:`P006_page`, :ref:`P014_page`, :ref:`P024_page`, :ref:`P028_page`, :ref:`P030_page`, :ref:`P031_page`, :ref:`P032_page`, :ref:`P034_page`, :ref:`P039_page`, :ref:`P047_page`, :ref:`P051_page`, :ref:`P068_page`, :ref:`P069_page`, :ref:`P072_page`, :ref:`P103_page`, :ref:`P105_page`, :ref:`P106_page`, :ref:`P122_page`, :ref:`P150_page`, :ref:`P151_page`, :ref:`P153_page`
+.. |Plugin_Environment| replace:: :ref:`P004_page`, :ref:`P005_page`, :ref:`P006_page`, :ref:`P014_page`, :ref:`P024_page`, :ref:`P028_page`, :ref:`P030_page`, :ref:`P031_page`, :ref:`P032_page`, :ref:`P034_page`, :ref:`P039_page`, :ref:`P047_page`, :ref:`P051_page`, :ref:`P068_page`, :ref:`P069_page`, :ref:`P072_page`, :ref:`P103_page`, :ref:`P105_page`, :ref:`P106_page`, :ref:`P122_page`, :ref:`P150_page`, :ref:`P151_page`, :ref:`P153_page`, :ref:`P154_page`
 .. |Plugin_Extra_IO| replace:: :ref:`P011_page`, :ref:`P022_page`
 .. |Plugin_Gases| replace:: :ref:`P049_page`, :ref:`P052_page`, :ref:`P083_page`, :ref:`P090_page`, :ref:`P117_page`, :ref:`P127_page`, :ref:`P135_page`, :ref:`P145_page`, :ref:`P147_page`
 .. |Plugin_Generic| replace:: :ref:`P003_page`, :ref:`P026_page`, :ref:`P033_page`, :ref:`P037_page`, :ref:`P081_page`, :ref:`P100_page`, :ref:`P146_page`

docs/source/Plugin/_plugin_substitutions_p15x.repl

@@ -49,3 +49,16 @@
 .. |P153_maintainer| replace:: `tonhuisman`
 .. |P153_compileinfo| replace:: `.`
 .. |P153_usedlibraries| replace:: `.`
+
+.. |P154_name| replace:: :cyan:`BMP3xx`
+.. |P154_type| replace:: :cyan:`Environment`
+.. |P154_typename| replace:: :cyan:`Environment - BMP3xx`
+.. |P154_porttype| replace:: `.`
+.. |P154_status| replace:: :yellow:`COLLECTION F` :yellow:`CLIMATE`
+.. |P154_github| replace:: P154_BMP3xx.ino
+.. _P154_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P154_BMP3xx.ino
+.. |P154_usedby| replace:: `.`
+.. |P154_shortinfo| replace:: `BMP3xx Temperature and Pressure sensors`
+.. |P154_maintainer| replace:: `TD-er`
+.. |P154_compileinfo| replace:: `.`
+.. |P154_usedlibraries| replace:: `Adafruit BMP3XX Library`

lib/Adafruit_BMP3XX/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,46 @@
+Thank you for opening an issue on an Adafruit Arduino library repository.  To
+improve the speed of resolution please review the following guidelines and
+common troubleshooting steps below before creating the issue:
+
+- **Do not use GitHub issues for troubleshooting projects and issues.**  Instead use
+  the forums at http://forums.adafruit.com to ask questions and troubleshoot why
+  something isn't working as expected.  In many cases the problem is a common issue
+  that you will more quickly receive help from the forum community.  GitHub issues
+  are meant for known defects in the code.  If you don't know if there is a defect
+  in the code then start with troubleshooting on the forum first.
+
+- **If following a tutorial or guide be sure you didn't miss a step.** Carefully
+  check all of the steps and commands to run have been followed.  Consult the
+  forum if you're unsure or have questions about steps in a guide/tutorial.
+
+- **For Arduino projects check these very common issues to ensure they don't apply**:
+
+  - For uploading sketches or communicating with the board make sure you're using
+    a **USB data cable** and **not** a **USB charge-only cable**.  It is sometimes
+    very hard to tell the difference between a data and charge cable!  Try using the
+    cable with other devices or swapping to another cable to confirm it is not
+    the problem.
+
+  - **Be sure you are supplying adequate power to the board.**  Check the specs of
+    your board and plug in an external power supply.  In many cases just
+    plugging a board into your computer is not enough to power it and other
+    peripherals.
+
+  - **Double check all soldering joints and connections.**  Flakey connections
+    cause many mysterious problems.  See the [guide to excellent soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) for examples of good solder joints.
+
+  - **Ensure you are using an official Arduino or Adafruit board.** We can't
+    guarantee a clone board will have the same functionality and work as expected
+    with this code and don't support them.
+
+If you're sure this issue is a defect in the code and checked the steps above
+please fill in the following fields to provide enough troubleshooting information.
+You may delete the guideline and text above to just leave the following details:
+
+- Arduino board:  **INSERT ARDUINO BOARD NAME/TYPE HERE**
+
+- Arduino IDE version (found in Arduino -> About Arduino menu):  **INSERT ARDUINO
+  VERSION HERE**
+
+- List the steps to reproduce the problem below (if possible attach a sketch or
+  copy the sketch code in too): **LIST REPRO STEPS BELOW**

lib/Adafruit_BMP3XX/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+Thank you for creating a pull request to contribute to Adafruit's GitHub code!
+Before you open the request please review the following guidelines and tips to
+help it be more easily integrated:
+
+- **Describe the scope of your change--i.e. what the change does and what parts
+  of the code were modified.**  This will help us understand any risks of integrating
+  the code.
+
+- **Describe any known limitations with your change.**  For example if the change
+  doesn't apply to a supported platform of the library please mention it.
+
+- **Please run any tests or examples that can exercise your modified code.**  We
+  strive to not break users of the code and running tests/examples helps with this
+  process.
+
+Thank you again for contributing!  We will try to test and integrate the change
+as soon as we can, but be aware we have many GitHub repositories to manage and
+can't immediately respond to every request.  There is no need to bump or check in
+on a pull request (it will clutter the discussion of the request).
+
+Also don't be worried if the request is closed or not integrated--sometimes the
+priorities of Adafruit's GitHub code (education, ease of use) might not match the
+priorities of the pull request.  Don't fret, the open source community thrives on
+forks and GitHub makes it easy to keep your changes in a forked repo.
+
+After reviewing the guidelines above you can delete this text from the pull request.

lib/Adafruit_BMP3XX/.github/workflows/githubci.yml

@@ -0,0 +1,29 @@
+name: Arduino Library CI
+
+on: [pull_request, push, repository_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+    - uses: actions/checkout@v3
+    - uses: actions/checkout@v3
+      with:
+         repository: adafruit/ci-arduino
+         path: ci
+
+    - name: pre-install
+      run: bash ci/actions_install.sh
+
+    - name: test platforms
+      run: python3 ci/build_platform.py main_platforms
+
+    - name: doxygen
+      env:
+        GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
+        PRETTYNAME : "Adafruit BMP3XX Library"
+      run: bash ci/doxy_gen_and_deploy.sh

lib/Adafruit_BMP3XX/.gitignore

@@ -0,0 +1,3 @@
+# Our handy .gitignore for automation ease
+doxygen_sqlite3.db
+html