adafruit-circuitpython-bmp5xx

Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bmp5xx/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/bmp5xx/en/latest/
    :alt: Documentation Status


.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord


.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BMP5xx/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_BMP5xx/actions
    :alt: Build Status


.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Code Style: Ruff

CircuitPython library for the BMP580 / BMP581 / BMP585 / etc barometric pressure sensors.

Please note: This driver currently only supports I2C communication. If you have a need for SPI support in the CircuitPython driver please file an issue.


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.

* `Purchase BMP580 from the Adafruit shop <http://www.adafruit.com/products/6411>`_
* `Purchase BMP581 from the Adafruit shop <http://www.adafruit.com/products/6407>`_
* `Purchase BMP585 from the Adafruit shop <http://www.adafruit.com/products/6413>`_

Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-bmp5xx/>`_.
To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-bmp5xx

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-bmp5xx

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .env/bin/activate
    pip3 install adafruit-circuitpython-bmp5xx

Installing to a Connected CircuitPython Device with Circup
==========================================================

Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the
following command to install:

.. code-block:: shell

    circup install adafruit_bmp5xx

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python

    import time

    import board

    from adafruit_bmp5xx import BMP5XX

    SEALEVELPRESSURE_HPA = 1013.25

    # I2C setup
    i2c = board.I2C()  # uses board.SCL and board.SDA
    # i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller

    bmp = BMP5XX(i2c)

    bmp.sea_level_pressure = SEALEVELPRESSURE_HPA

    while True:
        if bmp.data_ready:
            print(
                f"temp F: {bmp.temperature * (9 / 5) + 32} "
                f"pressure: {bmp.pressure} hPa "
                f"Approx altitude: {bmp.altitude} m"
            )
            time.sleep(1)


Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bmp5xx/en/latest/>`_.

For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_BMP5xx/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.