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

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

.. image :: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :alt: Discord

I2C and SPI driver for the Bosch BME280 Temperature, Humidity, and Barometric Pressure sensor

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

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

.. code-block:: python

	import board
	import digitalio
	import busio
	import time
	import adafruit_bme280

	# Create library object using our Bus I2C port
	i2c = busio.I2C(board.SCL, board.SDA)
	bme280 = adafruit_bme280.Adafruit_BME280_I2C(i2c)

	# OR create library object using our Bus SPI port
	#spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
	#bme_cs = digitalio.DigitalInOut(board.D10)
	#bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, bme_cs)

	# 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.humidity)
	    print("Pressure: %0.1f hPa" % bme280.pressure)
	    print("Altitude = %0.2f meters" % bme280.altitude)
	    time.sleep(2)



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

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

API Reference
=============

.. toctree::
   :maxdepth: 2

   api