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

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

.. image :: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :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

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 .env
    source .env/bin/activate
    pip3 install adafruit-circuitpython-bme680

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

.. code-block:: python

	from busio import I2C
	import adafruit_bme680
	import time
	import board

	# Create library object using our Bus I2C port
	i2c = I2C(board.SCL, 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.humidity)
	    print("Pressure: %0.3f hPa" % bme680.pressure)
	    print("Altitude = %0.2f meters" % bme680.altitude)

	    time.sleep(2)


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

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

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

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>`_.