diff --git a/README.rst b/README.rst index 7880ad9..134772a 100644 --- a/README.rst +++ b/README.rst @@ -57,10 +57,9 @@ To install in a virtual environment in your current project: Usage Example ============= -.. code-block:: python +.. code-block:: python3 import board - import digitalio import time import adafruit_bme280 @@ -71,6 +70,8 @@ Usage Example #bme280 = adafruit_bme280.Adafruit_BME280_I2C(i2c, address=0x76) # OR create sensor object, using the board's default SPI bus. + # SPI setup + # from digitalio import DigitalInOut #spi = board.SPI() #bme_cs = digitalio.DigitalInOut(board.D10) #bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, bme_cs) diff --git a/adafruit_bme280.py b/adafruit_bme280.py index ff17407..7990d9e 100644 --- a/adafruit_bme280.py +++ b/adafruit_bme280.py @@ -16,15 +16,18 @@ **Hardware:** -* Adafruit `BME280 Temperature, Humidity and Barometric Pressure sensor +* `Adafruit BME280 Temperature, Humidity and Barometric Pressure sensor `_ (Product ID: 2652) **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases -* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice + https://circuitpython.org/downloads + +* Adafruit's Bus Device library: + https://github.com/adafruit/Adafruit_CircuitPython_BusDevice + """ import math from time import sleep @@ -564,7 +567,7 @@ class Adafruit_BME280_SPI(Adafruit_BME280): .. code-block:: python import board - from digitalio import DigitalInOut, Direction + from digitalio import DigitalInOut import adafruit_bme280 Once this is done you can define your `board.SPI` object and define your sensor object diff --git a/docs/index.rst b/docs/index.rst index d06bd75..62fb9df 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,7 +23,7 @@ Table of Contents .. toctree:: :caption: Tutorials - Adafruit BME280 I2C or SPI Temperature Humidity Pressure Sensor Learnng Guide + Adafruit BME280 I2C or SPI Temperature Humidity Pressure Sensor Learning Guide .. toctree:: :caption: Related Products diff --git a/examples/bme280_normal_mode.py b/examples/bme280_normal_mode.py index 8a2c5d2..c5f1dd2 100644 --- a/examples/bme280_normal_mode.py +++ b/examples/bme280_normal_mode.py @@ -15,6 +15,8 @@ bme280 = adafruit_bme280.Adafruit_BME280_I2C(i2c) # OR create sensor object, using the board's default SPI bus. +# SPI setup +# from digitalio import DigitalInOut # spi = board.SPI() # bme_cs = digitalio.DigitalInOut(board.D10) # bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, bme_cs)