adafruit-circuitpython-bme680


Nameadafruit-circuitpython-bme680 JSON
Version 3.7.11 PyPI version JSON
download
home_pageNone
SummaryCircuitPython driver for BME680 sensor over I2C
upload_time2024-11-19 00:26:56
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython bme680 hardware temperature pressure humidity gas
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bme680/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/bme680/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_BME680/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_BME680/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 driver for BME680 sensor over I2C

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

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

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

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-bme680/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-bme680

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-bme680

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-bme680

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

.. code-block:: python3

    import adafruit_bme680
    import time
    import board

    # Create sensor object, communicating over the board's default I2C bus
    i2c = board.I2C()   # uses board.SCL and board.SDA
    bme680 = adafruit_bme680.Adafruit_BME680_I2C(i2c)

    # change this to match the location's pressure (hPa) at sea level
    bme680.sea_level_pressure = 1013.25

    while True:
        print("\nTemperature: %0.1f C" % bme680.temperature)
        print("Gas: %d ohm" % bme680.gas)
        print("Humidity: %0.1f %%" % bme680.relative_humidity)
        print("Pressure: %0.3f hPa" % bme680.pressure)
        print("Altitude = %0.2f meters" % bme680.altitude)

        time.sleep(2)


Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bme680/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_bme680/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-bme680",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, bme680, hardware, temperature, pressure, humidity, gas",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/f4/3b/3617ad337ce77d69d09f7d503fbfb94deaca4655eb7e23855c571609306e/adafruit_circuitpython_bme680-3.7.11.tar.gz",
    "platform": null,
    "description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bme680/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/bme680/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_BME680/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_BME680/actions/\n    :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n    :target: https://github.com/astral-sh/ruff\n    :alt: Code Style: Ruff\n\nCircuitPython driver for BME680 sensor over I2C\n\nDependencies\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 all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-bme680/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-bme680\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-bme680\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-bme680\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n    import adafruit_bme680\n    import time\n    import board\n\n    # Create sensor object, communicating over the board's default I2C bus\n    i2c = board.I2C()   # uses board.SCL and board.SDA\n    bme680 = adafruit_bme680.Adafruit_BME680_I2C(i2c)\n\n    # change this to match the location's pressure (hPa) at sea level\n    bme680.sea_level_pressure = 1013.25\n\n    while True:\n        print(\"\\nTemperature: %0.1f C\" % bme680.temperature)\n        print(\"Gas: %d ohm\" % bme680.gas)\n        print(\"Humidity: %0.1f %%\" % bme680.relative_humidity)\n        print(\"Pressure: %0.3f hPa\" % bme680.pressure)\n        print(\"Altitude = %0.2f meters\" % bme680.altitude)\n\n        time.sleep(2)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bme680/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_bme680/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython driver for BME680 sensor over I2C",
    "version": "3.7.11",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BME680"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " bme680",
        " hardware",
        " temperature",
        " pressure",
        " humidity",
        " gas"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bfd0377b05340076095da7433a4c47919c69b44318a4c13141c1ebea8b67db99",
                "md5": "db43a4bbd39dc7056cf3c638ed8220d4",
                "sha256": "7dfb01cc7c3638e5186a7b9e5ae456fe58b3adb93699416cf69fc661e4525285"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_bme680-3.7.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "db43a4bbd39dc7056cf3c638ed8220d4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 10626,
            "upload_time": "2024-11-19T00:26:54",
            "upload_time_iso_8601": "2024-11-19T00:26:54.990838Z",
            "url": "https://files.pythonhosted.org/packages/bf/d0/377b05340076095da7433a4c47919c69b44318a4c13141c1ebea8b67db99/adafruit_circuitpython_bme680-3.7.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f43b3617ad337ce77d69d09f7d503fbfb94deaca4655eb7e23855c571609306e",
                "md5": "16c0918198af0ca763b4d824f797f7dc",
                "sha256": "70a490c95e1d8d087b5837bf1f9dd551187be641e6a81baf8db176125e16cb43"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_bme680-3.7.11.tar.gz",
            "has_sig": false,
            "md5_digest": "16c0918198af0ca763b4d824f797f7dc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 30825,
            "upload_time": "2024-11-19T00:26:56",
            "upload_time_iso_8601": "2024-11-19T00:26:56.365591Z",
            "url": "https://files.pythonhosted.org/packages/f4/3b/3617ad337ce77d69d09f7d503fbfb94deaca4655eb7e23855c571609306e/adafruit_circuitpython_bme680-3.7.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-19 00:26:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_BME680",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-bme680"
}
        
Elapsed time: 0.58839s