Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bme280/badge/?version=latest
:target: https://docs.circuitpython.org/projects/bme280/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_BME280/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_BME280/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
I2C and SPI driver for the Bosch BME280 Temperature, Humidity, and Barometric Pressure sensor
Installation and Dependencies
=============================
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure that the driver and all dependencies are available on the
CircuitPython filesystem. This can be most easily achieved by downloading and
installing the latest
`Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_
on your device.
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-bme280/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-bme280
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-bme280
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-bme280
Installing to a connected CircuitPython Device
==============================================
Some devices, eg. the QT-PY, are very limited in memory. The BME280 library contains
two variants - basic and advanced - which give different levels of functionality.
Installing the BME280 library could have the following outcomes:
* It installs successfully and your code runs successfully. Woo-hoo! Continue with
your amazing project.
* It installs successfully and your code fails to run with a memory allocation
error. Try one of the following:
* If your ``code.py`` is large, especially if it has lots of comments, you
can shrink it into a ``.mpy`` file instead. See the Adafruit
`Learn Guide <https://learn.adafruit.com/Memory-saving-tips-for-CircuitPython/non-volatile-not-enough-disk-space>`_
on shrinking your code.
* Only use the basic BME280 implementation, and remove the following file:
``<CIRCUITPY>/lib/adafruit_bme280/advanced.mpy`` where <CIRCUITPY> is the
mounted location of your device. Make sure that your code only uses the basic
implementation.
Usage Example
=============
.. code-block:: python3
import board
import time
from adafruit_bme280 import basic as adafruit_bme280
# Create sensor object, using the board's default I2C bus.
i2c = board.I2C() # uses board.SCL and board.SDA
bme280 = adafruit_bme280.Adafruit_BME280_I2C(i2c)
# change this to match the location's pressure (hPa) at sea level
bme280.sea_level_pressure = 1013.25
while True:
print("\nTemperature: %0.1f C" % bme280.temperature)
print("Humidity: %0.1f %%" % bme280.relative_humidity)
print("Pressure: %0.1f hPa" % bme280.pressure)
print("Altitude = %0.2f meters" % bme280.altitude)
time.sleep(2)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bme280/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_BME280/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-bme280",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, bme280, sensor, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/46/dd/c438ce929025d09d63210aa1f264eb738ced1f1535dc0d89b8d0fd1baffb/adafruit_circuitpython_bme280-2.6.26.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bme280/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/bme280/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BME280/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_BME280/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nI2C and SPI driver for the Bosch BME280 Temperature, Humidity, and Barometric Pressure sensor\n\nInstallation and Dependencies\n=============================\n\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure that the driver and all dependencies are available on the\nCircuitPython filesystem. This can be most easily achieved by downloading and\ninstalling the latest\n`Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_\non your device.\n\nInstalling from PyPI\n--------------------\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-bme280/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-bme280\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-bme280\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-bme280\n\n\nInstalling to a connected CircuitPython Device\n==============================================\nSome devices, eg. the QT-PY, are very limited in memory. The BME280 library contains\ntwo variants - basic and advanced - which give different levels of functionality.\n\nInstalling the BME280 library could have the following outcomes:\n\n * It installs successfully and your code runs successfully. Woo-hoo! Continue with\n your amazing project.\n * It installs successfully and your code fails to run with a memory allocation\n error. Try one of the following:\n\n * If your ``code.py`` is large, especially if it has lots of comments, you\n can shrink it into a ``.mpy`` file instead. See the Adafruit\n `Learn Guide <https://learn.adafruit.com/Memory-saving-tips-for-CircuitPython/non-volatile-not-enough-disk-space>`_\n on shrinking your code.\n * Only use the basic BME280 implementation, and remove the following file:\n ``<CIRCUITPY>/lib/adafruit_bme280/advanced.mpy`` where <CIRCUITPY> is the\n mounted location of your device. Make sure that your code only uses the basic\n implementation.\n\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import board\n import time\n from adafruit_bme280 import basic as adafruit_bme280\n\n # Create sensor object, using the board's default I2C bus.\n i2c = board.I2C() # uses board.SCL and board.SDA\n bme280 = adafruit_bme280.Adafruit_BME280_I2C(i2c)\n\n # change this to match the location's pressure (hPa) at sea level\n bme280.sea_level_pressure = 1013.25\n\n while True:\n print(\"\\nTemperature: %0.1f C\" % bme280.temperature)\n print(\"Humidity: %0.1f %%\" % bme280.relative_humidity)\n print(\"Pressure: %0.1f hPa\" % bme280.pressure)\n print(\"Altitude = %0.2f meters\" % bme280.altitude)\n time.sleep(2)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bme280/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_BME280/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for the Bosch BME280 temperature/humidity/pressure sensor.",
"version": "2.6.26",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BME280"
},
"split_keywords": [
"adafruit",
" bme280",
" sensor",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9e11a5678229edf48a7f8a249b38847441a181263a552d9bf89af98e7f816fb",
"md5": "a1cefd64a899655a77f117f4b5f79579",
"sha256": "6996c685b273f27871e5e0885cc6805bb0bb7be7e73a851a66292c6745c6f51e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_bme280-2.6.26-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1cefd64a899655a77f117f4b5f79579",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12489,
"upload_time": "2024-10-07T21:38:08",
"upload_time_iso_8601": "2024-10-07T21:38:08.243957Z",
"url": "https://files.pythonhosted.org/packages/d9/e1/1a5678229edf48a7f8a249b38847441a181263a552d9bf89af98e7f816fb/adafruit_circuitpython_bme280-2.6.26-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46ddc438ce929025d09d63210aa1f264eb738ced1f1535dc0d89b8d0fd1baffb",
"md5": "d9632d4ec1e55c4611e90da87b8e086e",
"sha256": "4f4027d8b2232492c71caa15318beacbd5192119eafbb0004a2c9b0f1588619f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_bme280-2.6.26.tar.gz",
"has_sig": false,
"md5_digest": "d9632d4ec1e55c4611e90da87b8e086e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32915,
"upload_time": "2024-10-07T21:38:11",
"upload_time_iso_8601": "2024-10-07T21:38:11.332331Z",
"url": "https://files.pythonhosted.org/packages/46/dd/c438ce929025d09d63210aa1f264eb738ced1f1535dc0d89b8d0fd1baffb/adafruit_circuitpython_bme280-2.6.26.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 21:38:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_BME280",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-bme280"
}
JSON
