Merge pull request #32 from adafruit/temp-offset

Added temperature offset

.github/workflows/build.yml

@@ -0,0 +1,57 @@
+name: Build CI
+
+on: [pull_request, push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Dump GitHub context
+      env:
+        GITHUB_CONTEXT: ${{ toJson(github) }}
+      run: echo "$GITHUB_CONTEXT"
+    - name: Translate Repo Name For Build Tools filename_prefix
+      id: repo-name
+      run: |
+        echo ::set-output name=repo-name::$(
+        echo ${{ github.repository }} |
+        awk -F '\/' '{ print tolower($2) }' |
+        tr '_' '-'
+        )
+    - name: Set up Python 3.6
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.6
+    - name: Versions
+      run: |
+        python3 --version
+    - name: Checkout Current Repo
+      uses: actions/checkout@v1
+      with:
+        submodules: true
+    - name: Checkout tools repo
+      uses: actions/checkout@v2
+      with:
+        repository: adafruit/actions-ci-circuitpython-libs
+        path: actions-ci
+    - name: Install dependencies
+      # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
+      run: |
+        source actions-ci/install.sh
+    - name: Pip install pylint, black, & Sphinx
+      run: |
+        pip install pylint black==19.10b0 Sphinx sphinx-rtd-theme
+    - name: Library version
+      run: git describe --dirty --always --tags
+    - name: Check formatting
+      run: |
+        black --check --target-version=py35 .
+    - name: PyLint
+      run: |
+        pylint $( find . -path './adafruit*.py' )
+        ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" ))
+    - name: Build assets
+      run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
+    - name: Build docs
+      working-directory: docs
+      run: sphinx-build -E -W -b html . _build/html

.github/workflows/release.yml

@@ -0,0 +1,81 @@
+name: Release Actions
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  upload-release-assets:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Dump GitHub context
+      env:
+        GITHUB_CONTEXT: ${{ toJson(github) }}
+      run: echo "$GITHUB_CONTEXT"
+    - name: Translate Repo Name For Build Tools filename_prefix
+      id: repo-name
+      run: |
+        echo ::set-output name=repo-name::$(
+        echo ${{ github.repository }} |
+        awk -F '\/' '{ print tolower($2) }' |
+        tr '_' '-'
+        )
+    - name: Set up Python 3.6
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.6
+    - name: Versions
+      run: |
+        python3 --version
+    - name: Checkout Current Repo
+      uses: actions/checkout@v1
+      with:
+        submodules: true
+    - name: Checkout tools repo
+      uses: actions/checkout@v2
+      with:
+        repository: adafruit/actions-ci-circuitpython-libs
+        path: actions-ci
+    - name: Install deps
+      run: |
+        source actions-ci/install.sh
+    - name: Build assets
+      run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
+    - name: Upload Release Assets
+      # the 'official' actions version does not yet support dynamically
+      # supplying asset names to upload. @csexton's version chosen based on
+      # discussion in the issue below, as its the simplest to implement and
+      # allows for selecting files with a pattern.
+      # https://github.com/actions/upload-release-asset/issues/4
+      #uses: actions/upload-release-asset@v1.0.1
+      uses: csexton/release-asset-action@master
+      with:
+        pattern: "bundles/*"
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+
+  upload-pypi:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check For setup.py
+      id: need-pypi
+      run: |
+        echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
+    - name: Set up Python
+      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      env:
+        TWINE_USERNAME: ${{ secrets.pypi_username }}
+        TWINE_PASSWORD: ${{ secrets.pypi_password }}
+      run: |
+        python setup.py sdist
+        twine upload dist/*

.gitignore

@@ -1,6 +1,3 @@
 __pycache__
 _build
 *.pyc
-.env
-build*
-bundles

.pylintrc

@@ -18,6 +18,7 @@ ignore-patterns=
 #init-hook=
 
 # Use multiple processes to speed up Pylint.
+# jobs=1
 jobs=2
 
 # List of plugins (as comma separated values of python modules names) to load,
@@ -50,7 +51,8 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error
+# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
+disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -117,7 +119,8 @@ spelling-store-unknown-words=no
 [MISCELLANEOUS]
 
 # List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
+# notes=FIXME,XXX,TODO
+notes=FIXME,XXX
 
 
 [TYPECHECK]
@@ -153,7 +156,7 @@ ignored-classes=optparse.Values,thread._local,_thread._local
 # (useful for modules/projects where namespaces are manipulated during runtime
 # and thus existing member attributes cannot be deduced by static analysis. It
 # supports qualified module names, as well as Unix pattern matching.
-ignored-modules=
+ignored-modules=board
 
 # Show a hint with possible names when a member name was not found. The aspect
 # of finding the hint is based on edit distance.
@@ -200,6 +203,7 @@ redefining-builtins-modules=six.moves,future.builtins
 [FORMAT]
 
 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+# expected-line-ending-format=
 expected-line-ending-format=LF
 
 # Regexp for a line that is allowed to be longer than the limit.
@@ -272,9 +276,11 @@ class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
 
 # Naming hint for class names
+# class-name-hint=[A-Z_][a-zA-Z0-9]+$
 class-name-hint=[A-Z_][a-zA-Z0-9_]+$
 
 # Regular expression matching correct class names
+# class-rgx=[A-Z_][a-zA-Z0-9]+$
 class-rgx=[A-Z_][a-zA-Z0-9_]+$
 
 # Naming hint for constant names
@@ -294,7 +300,8 @@ function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
 # Good variable names which should always be accepted, separated by a comma
-good-names=r,g,b,i,j,k,n,ex,Run,_
+# good-names=i,j,k,ex,Run,_
+good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
 
 # Include a hint for the correct naming format with invalid-name
 include-naming-hint=no
@@ -391,6 +398,7 @@ valid-metaclass-classmethod-first-arg=mcs
 max-args=5
 
 # Maximum number of attributes for a class (see R0902).
+# max-attributes=7
 max-attributes=11
 
 # Maximum number of boolean expressions in a if statement
@@ -415,7 +423,7 @@ max-returns=6
 max-statements=50
 
 # Minimum number of public methods for a class (see R0903).
-min-public-methods=2
+min-public-methods=1
 
 
 [EXCEPTIONS]

.travis.yml

@@ -1,30 +0,0 @@
-# This is a common .travis.yml for generating library release zip files for
-# CircuitPython library releases using circuitpython-build-tools.
-# See https://github.com/adafruit/circuitpython-build-tools for detailed setup
-# instructions.
-
-dist: trusty
-sudo: false
-language: python
-python:
-    - "3.6"
-
-cache:
-    pip: true
-
-deploy:
-  provider: releases
-  api_key: $GITHUB_TOKEN
-  file_glob: true
-  file: bundles/*
-  skip_cleanup: true
-  on:
-    tags: true
-
-install:
-  - pip install pylint circuitpython-build-tools
-
-script:
-  - pylint adafruit_bme680.py
-  - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py)
-  - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bme680 --library_location .

CODE_OF_CONDUCT.md

@@ -1,74 +1,129 @@
-# Contributor Covenant Code of Conduct
+# Adafruit Community Code of Conduct
 
 ## Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
+contributors and leaders pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
+size, disability, ethnicity, gender identity and expression, level or type of
-nationality, personal appearance, race, religion, or sexual identity and
+experience, education, socio-economic status, nationality, personal appearance,
-orientation.
+race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
+We are committed to providing a friendly, safe and welcoming environment for
+all.
+
 Examples of behavior that contributes to creating a positive environment
 include:
 
+* Be kind and courteous to others
 * Using welcoming and inclusive language
 * Being respectful of differing viewpoints and experiences
+* Collaborating with other community members
 * Gracefully accepting constructive criticism
 * Focusing on what is best for the community
 * Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+* The use of sexualized language or imagery and sexual attention or advances
-advances
+* The use of inappropriate images, including in a community member's avatar
+* The use of inappropriate language, including in a community member's nickname
+* Any spamming, flaming, baiting or other attention-stealing behavior
+* Excessive or unwelcome helping; answering outside the scope of the question
+  asked
 * Trolling, insulting/derogatory comments, and personal or political attacks
+* Promoting or spreading disinformation, lies, or conspiracy theories against
+  a person, group, organisation, project, or community
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+* Other conduct which could reasonably be considered inappropriate
-  professional setting
+
+The goal of the standards and moderation guidelines outlined here is to build
+and maintain a respectful community. We ask that you don’t just aim to be
+"technically unimpeachable", but rather try to be your best self. 
+
+We value many things beyond technical expertise, including collaboration and
+supporting others within our community. Providing a positive experience for
+other community members can have a much more significant impact than simply
+providing the correct answer.
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
+Project leaders are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
 response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or
+Project leaders have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
+reject messages, comments, commits, code, issues, and other contributions
 that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
+permanently any community member for other behaviors that they deem
-threatening, offensive, or harmful.
+inappropriate, threatening, offensive, or harmful.
+
+## Moderation
+
+Instances of behaviors that violate the Adafruit Community Code of Conduct
+may be reported by any member of the community. Community members are
+encouraged to report these situations, including situations they witness
+involving other community members.
+
+You may report in the following ways:
+
+In any situation, you may send an email to <support@adafruit.com>.
+
+On the Adafruit Discord, you may send an open message from any channel
+to all Community Moderators by tagging @community moderators. You may 
+also send an open message from any channel, or a direct message to 
+@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, 
+@sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175.
+
+Email and direct message reports will be kept confidential.
+
+In situations on Discord where the issue is particularly egregious, possibly
+illegal, requires immediate action, or violates the Discord terms of service,
+you should also report the message directly to Discord.
+
+These are the steps for upholding our community’s standards of conduct.
+
+1. Any member of the community may report any situation that violates the
+Adafruit Community Code of Conduct. All reports will be reviewed and
+investigated.
+2. If the behavior is an egregious violation, the community member who
+committed the violation may be banned immediately, without warning.
+3. Otherwise, moderators will first respond to such behavior with a warning.
+4. Moderators follow a soft "three strikes" policy - the community member may
+be given another chance, if they are receptive to the warning and change their
+behavior.
+5. If the community member is unreceptive or unreasonable when warned by a
+moderator, or the warning goes unheeded, they may be banned for a first or
+second offense. Repeated offenses will result in the community member being
+banned.
 
 ## Scope
 
+This Code of Conduct and the enforcement policies listed above apply to all
+Adafruit Community venues. This includes but is not limited to any community
+spaces (both public and private), the entire Adafruit Discord server, and
+Adafruit GitHub repositories. Examples of Adafruit Community spaces include
+but are not limited to meet-ups, audio chats on the Adafruit Discord, or
+interaction at a conference.
+
 This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
+when an individual is representing the project or its community. As a community
-representing a project or community include using an official project e-mail
+member, you are representing our community, and are expected to behave
-address, posting via an official social media account, or acting as an appointed
+accordingly.
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at support@adafruit.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-available at [http://contributor-covenant.org/version/1/4][version]
+version 1.4, available at
+<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>,
+and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
 
-[homepage]: http://contributor-covenant.org
+For other projects adopting the Adafruit Community Code of
-[version]: http://contributor-covenant.org/version/1/4/
+Conduct, please contact the maintainers of those projects for enforcement.
+If you wish to use this code of conduct for your own project, consider
+explicitly mentioning your moderation policy or making a copy with your
+own moderation policy so as to avoid confusion.

README.rst

@@ -7,9 +7,13 @@ Introduction
     :alt: Documentation Status
 
 .. image :: https://img.shields.io/discord/327254708534116352.svg
-    :target: https://discord.gg/nBQh6qu
+    :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
+
 CircuitPython driver for BME680 sensor over I2C
 
 Dependencies
@@ -23,20 +27,40 @@ 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
 
-	import gc
 	from busio import I2C
 	import adafruit_bme680
 	import time
 	import board
 
-	gc.collect()
-	print("Free mem:",gc.mem_free())
-
 	# Create library object using our Bus I2C port
 	i2c = I2C(board.SCL, board.SDA)
 	bme680 = adafruit_bme680.Adafruit_BME680_I2C(i2c)
@@ -61,10 +85,7 @@ 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.
 
-API Reference
+Documentation
 =============
 
-.. toctree::
+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>`_.
-   :maxdepth: 2
-
-   api

adafruit_bme680.py

@@ -25,21 +25,41 @@
 
 """
 `adafruit_bme680`
-====================================================
+================================================================================
 
-CircuitPython driver from BME680 air quality sensor
+CircuitPython library for BME680 temperature, pressure and humidity sensor.
 
-* Author(s): ladyada
+
+* Author(s): Limor Fried
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit BME680 Temp, Humidity, Pressure and Gas Sensor <https://www.adafruit.com/product/3660>`_
+
+**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
 """
 
+
 import time
 import math
 from micropython import const
+
 try:
     import struct
 except ImportError:
     import ustruct as struct
 
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BME680.git"
+
+
 #    I2C ADDRESS/BITS/SETTINGS
 #    -----------------------------------------------------------------------
 _BME680_CHIPID = const(0x61)
@@ -47,16 +67,17 @@ _BME680_CHIPID = const(0x61)
 _BME680_REG_CHIPID = const(0xD0)
 _BME680_BME680_COEFF_ADDR1 = const(0x89)
 _BME680_BME680_COEFF_ADDR2 = const(0xE1)
-_BME680_BME680_RES_WAIT_0 = const(0x5A)
+_BME680_BME680_RES_HEAT_0 = const(0x5A)
+_BME680_BME680_GAS_WAIT_0 = const(0x64)
 
 _BME680_REG_SOFTRESET = const(0xE0)
 _BME680_REG_CTRL_GAS = const(0x71)
 _BME680_REG_CTRL_HUM = const(0x72)
-_BME280_REG_STATUS = const(0xF3)
+_BME680_REG_STATUS = const(0x73)
 _BME680_REG_CTRL_MEAS = const(0x74)
 _BME680_REG_CONFIG = const(0x75)
 
-_BME680_REG_STATUS = const(0x1D)
+_BME680_REG_MEAS_STATUS = const(0x1D)
 _BME680_REG_PDATA = const(0x1F)
 _BME680_REG_TDATA = const(0x22)
 _BME680_REG_HDATA = const(0x25)
@@ -66,20 +87,49 @@ _BME680_FILTERSIZES = (0, 1, 3, 7, 15, 31, 63, 127)
 
 _BME680_RUNGAS = const(0x10)
 
-_LOOKUP_TABLE_1 = (2147483647.0, 2147483647.0, 2147483647.0, 2147483647.0, 2147483647.0,
+_LOOKUP_TABLE_1 = (
-                   2126008810.0, 2147483647.0, 2130303777.0, 2147483647.0, 2147483647.0,
+    2147483647.0,
-                   2143188679.0, 2136746228.0, 2147483647.0, 2126008810.0, 2147483647.0,
+    2147483647.0,
-                   2147483647.0)
+    2147483647.0,
+    2147483647.0,
+    2147483647.0,
+    2126008810.0,
+    2147483647.0,
+    2130303777.0,
+    2147483647.0,
+    2147483647.0,
+    2143188679.0,
+    2136746228.0,
+    2147483647.0,
+    2126008810.0,
+    2147483647.0,
+    2147483647.0,
+)
 
-_LOOKUP_TABLE_2 = (4096000000.0, 2048000000.0, 1024000000.0, 512000000.0, 255744255.0, 127110228.0,
+_LOOKUP_TABLE_2 = (
-                   64000000.0, 32258064.0, 16016016.0, 8000000.0, 4000000.0, 2000000.0, 1000000.0,
+    4096000000.0,
-                   500000.0, 250000.0, 125000.0)
+    2048000000.0,
+    1024000000.0,
+    512000000.0,
+    255744255.0,
+    127110228.0,
+    64000000.0,
+    32258064.0,
+    16016016.0,
+    8000000.0,
+    4000000.0,
+    2000000.0,
+    1000000.0,
+    500000.0,
+    250000.0,
+    125000.0,
+)
 
 
 def _read24(arr):
     """Parse an unsigned 24-bit value as a floating point and return it."""
     ret = 0.0
-    #print([hex(i) for i in arr])
+    # print([hex(i) for i in arr])
     for b in arr:
         ret *= 256.0
         ret += float(b & 0xFF)
@@ -87,28 +137,36 @@ def _read24(arr):
 
 
 class Adafruit_BME680:
-    """Driver from BME680 air quality sensor"""
+    """Driver from BME680 air quality sensor
-    def __init__(self):
+
+       :param int refresh_rate: Maximum number of readings per second. Faster property reads
+         will be from the previous reading."""
+
+    def __init__(self, *, refresh_rate=10):
         """Check the BME680 was found, read the coefficients and enable the sensor for continuous
-           reads"""
+           reads."""
         self._write(_BME680_REG_SOFTRESET, [0xB6])
-        time.sleep(0.5)
+        time.sleep(0.005)
 
         # Check device ID.
         chip_id = self._read_byte(_BME680_REG_CHIPID)
-        if _BME680_CHIPID != chip_id:
+        if chip_id != _BME680_CHIPID:
-            raise RuntimeError('Failed to find BME680! Chip ID 0x%x' % id)
+            raise RuntimeError("Failed to find BME680! Chip ID 0x%x" % chip_id)
 
         self._read_calibration()
 
         # set up heater
-        self._write(_BME680_BME680_RES_WAIT_0, [0x73, 0x64, 0x65])
+        self._write(_BME680_BME680_RES_HEAT_0, [0x73])
+        self._write(_BME680_BME680_GAS_WAIT_0, [0x65])
+
         self.sea_level_pressure = 1013.25
-        """Pressure in hectoPascals at sea level. Used to calibrate `altitude`."""
+        """Pressure in hectoPascals at sea level. Used to calibrate ``altitude``."""
-        self.pressure_oversample = 4
+
-        self.temperature_oversample = 8
+        # Default oversampling and filter register values.
-        self.humidity_oversample = 2
+        self._pressure_oversample = 0b011
-        self.filter_size = 3
+        self._temp_oversample = 0b100
+        self._humidity_oversample = 0b010
+        self._filter = 0b010
 
         self._adc_pres = None
         self._adc_temp = None
@@ -116,7 +174,9 @@ class Adafruit_BME680:
         self._adc_gas = None
         self._gas_range = None
         self._t_fine = None
-        self._status = 0
+
+        self._last_reading = 0
+        self._min_refresh_time = 1 / refresh_rate
 
     @property
     def pressure_oversample(self):
@@ -145,7 +205,7 @@ class Adafruit_BME680:
     @property
     def temperature_oversample(self):
         """The oversampling for temperature sensor"""
-        return _BME680_SAMPLERATES[self._pressure_oversample]
+        return _BME680_SAMPLERATES[self._temp_oversample]
 
     @temperature_oversample.setter
     def temperature_oversample(self, sample_rate):
@@ -162,7 +222,7 @@ class Adafruit_BME680:
     @filter_size.setter
     def filter_size(self, size):
         if size in _BME680_FILTERSIZES:
-            self._filter = _BME680_FILTERSIZES[size]
+            self._filter = _BME680_FILTERSIZES.index(size)
         else:
             raise RuntimeError("Invalid size")
 
@@ -170,7 +230,7 @@ class Adafruit_BME680:
     def temperature(self):
         """The compensated temperature in degrees celsius."""
         self._perform_reading()
-        calc_temp = (((self._t_fine * 5) + 128) / 256)
+        calc_temp = ((self._t_fine * 5) + 128) / 256
         return calc_temp / 100
 
     @property
@@ -182,31 +242,49 @@ class Adafruit_BME680:
         var2 = (var2 * self._pressure_calibration[5]) / 4
         var2 = var2 + (var1 * self._pressure_calibration[4] * 2)
         var2 = (var2 / 4) + (self._pressure_calibration[3] * 65536)
-        var1 = ((var1 / 4) * (var1 / 4)) / 8192
+        var1 = (
-        var1 = (((var1 * self._pressure_calibration[2] * 32) / 8) +
+            (((var1 / 4) * (var1 / 4)) / 8192)
-                ((self._pressure_calibration[1] * var1) / 2))
+            * (self._pressure_calibration[2] * 32)
+            / 8
+        ) + ((self._pressure_calibration[1] * var1) / 2)
         var1 = var1 / 262144
         var1 = ((32768 + var1) * self._pressure_calibration[0]) / 32768
         calc_pres = 1048576 - self._adc_pres
         calc_pres = (calc_pres - (var2 / 4096)) * 3125
         calc_pres = (calc_pres / var1) * 2
-        var1 = (self._pressure_calibration[8] * (((calc_pres / 8) * (calc_pres / 8)) / 8192)) / 4096
+        var1 = (
+            self._pressure_calibration[8] * (((calc_pres / 8) * (calc_pres / 8)) / 8192)
+        ) / 4096
         var2 = ((calc_pres / 4) * self._pressure_calibration[7]) / 8192
         var3 = (((calc_pres / 256) ** 3) * self._pressure_calibration[9]) / 131072
-        calc_pres += ((var1 + var2 + var3 + (self._pressure_calibration[6] * 128)) / 16)
+        calc_pres += (var1 + var2 + var3 + (self._pressure_calibration[6] * 128)) / 16
-        return calc_pres/100
+        return calc_pres / 100
 
     @property
     def humidity(self):
         """The relative humidity in RH %"""
         self._perform_reading()
         temp_scaled = ((self._t_fine * 5) + 128) / 256
-        var1 = ((self._adc_hum - (self._humidity_calibration[0] * 16)) -
+        var1 = (self._adc_hum - (self._humidity_calibration[0] * 16)) - (
-                ((temp_scaled * self._humidity_calibration[2]) / 200))
+            (temp_scaled * self._humidity_calibration[2]) / 200
-        var2 = (self._humidity_calibration[1] *
+        )
-                (((temp_scaled * self._humidity_calibration[3]) / 100) +
+        var2 = (
-                 (((temp_scaled * ((temp_scaled * self._humidity_calibration[4]) / 100)) /
+            self._humidity_calibration[1]
-                   64) / 100) + 16384)) / 1024
+            * (
+                ((temp_scaled * self._humidity_calibration[3]) / 100)
+                + (
+                    (
+                        (
+                            temp_scaled
+                            * ((temp_scaled * self._humidity_calibration[4]) / 100)
+                        )
+                        / 64
+                    )
+                    / 100
+                )
+                + 16384
+            )
+        ) / 1024
         var3 = var1 * var2
         var4 = self._humidity_calibration[5] * 128
         var4 = (var4 + ((temp_scaled * self._humidity_calibration[6]) / 100)) / 16
@@ -223,16 +301,18 @@ class Adafruit_BME680:
 
     @property
     def altitude(self):
-        """The altitude based on current `pressure` vs the sea level pressure
+        """The altitude based on current ``pressure`` vs the sea level pressure
-           (`sea_level_pressure`) - which you must enter ahead of time)"""
+           (``sea_level_pressure``) - which you must enter ahead of time)"""
-        pressure = self.pressure # in Si units for hPascal
+        pressure = self.pressure  # in Si units for hPascal
         return 44330 * (1.0 - math.pow(pressure / self.sea_level_pressure, 0.1903))
 
     @property
     def gas(self):
         """The gas resistance in ohms"""
         self._perform_reading()
-        var1 = ((1340 + (5 * self._sw_err)) * (_LOOKUP_TABLE_1[self._gas_range])) / 65536
+        var1 = (
+            (1340 + (5 * self._sw_err)) * (_LOOKUP_TABLE_1[self._gas_range])
+        ) / 65536
         var2 = ((self._adc_gas * 32768) - 16777216) + var1
         var3 = (_LOOKUP_TABLE_2[self._gas_range] * var1) / 512
         calc_gas_res = (var3 + (var2 / 2)) / var2
@@ -241,36 +321,36 @@ class Adafruit_BME680:
     def _perform_reading(self):
         """Perform a single-shot reading from the sensor and fill internal data structure for
            calculations"""
+        if time.monotonic() - self._last_reading < self._min_refresh_time:
+            return
 
         # set filter
         self._write(_BME680_REG_CONFIG, [self._filter << 2])
         # turn on temp oversample & pressure oversample
-        self._write(_BME680_REG_CTRL_MEAS,
+        self._write(
-                    [(self._temp_oversample << 5)|(self._pressure_oversample << 2)])
+            _BME680_REG_CTRL_MEAS,
+            [(self._temp_oversample << 5) | (self._pressure_oversample << 2)],
+        )
         # turn on humidity oversample
         self._write(_BME680_REG_CTRL_HUM, [self._humidity_oversample])
         # gas measurements enabled
         self._write(_BME680_REG_CTRL_GAS, [_BME680_RUNGAS])
 
-        ctrl = self._read(_BME680_REG_CTRL_MEAS, 1)[0]
+        ctrl = self._read_byte(_BME680_REG_CTRL_MEAS)
         ctrl = (ctrl & 0xFC) | 0x01  # enable single shot!
         self._write(_BME680_REG_CTRL_MEAS, [ctrl])
-        time.sleep(0.5)
+        new_data = False
-        data = self._read(_BME680_REG_STATUS, 15)
+        while not new_data:
-        self._status = data[0] & 0x80
+            data = self._read(_BME680_REG_MEAS_STATUS, 15)
-        #gas_idx = data[0] & 0x0F
+            new_data = data[0] & 0x80 != 0
-        #meas_idx = data[1]
+            time.sleep(0.005)
-        #print("status 0x%x gas_idx %d meas_idx %d" % (self._status, gas_idx, meas_idx))
+        self._last_reading = time.monotonic()
 
-        #print([hex(i) for i in data])
         self._adc_pres = _read24(data[2:5]) / 16
         self._adc_temp = _read24(data[5:8]) / 16
-        self._adc_hum = struct.unpack('>H', bytes(data[8:10]))[0]
+        self._adc_hum = struct.unpack(">H", bytes(data[8:10]))[0]
-        self._adc_gas = int(struct.unpack('>H', bytes(data[13:15]))[0] / 64)
+        self._adc_gas = int(struct.unpack(">H", bytes(data[13:15]))[0] / 64)
         self._gas_range = data[14] & 0x0F
-        #print(self._adc_hum)
-        #print(self._adc_gas)
-        self._status |= data[14] & 0x30     # VALID + STABILITY mask
 
         var1 = (self._adc_temp / 8) - (self._temp_calibration[0] * 2)
         var2 = (var1 * self._temp_calibration[1]) / 2048
@@ -283,11 +363,13 @@ class Adafruit_BME680:
         coeff = self._read(_BME680_BME680_COEFF_ADDR1, 25)
         coeff += self._read(_BME680_BME680_COEFF_ADDR2, 16)
 
-        coeff = list(struct.unpack('<hbBHhbBhhbbHhhBBBHbbbBbHhbb', bytes(coeff[1:])))
+        coeff = list(struct.unpack("<hbBHhbBhhbbHhhBBBHbbbBbHhbb", bytes(coeff[1:39])))
-        #print("\n\n",coeff)
+        # print("\n\n",coeff)
         coeff = [float(i) for i in coeff]
         self._temp_calibration = [coeff[x] for x in [23, 0, 1]]
-        self._pressure_calibration = [coeff[x] for x in [3, 4, 5, 7, 8, 10, 9, 12, 13, 14]]
+        self._pressure_calibration = [
+            coeff[x] for x in [3, 4, 5, 7, 8, 10, 9, 12, 13, 14]
+        ]
         self._humidity_calibration = [coeff[x] for x in [17, 16, 18, 19, 20, 21, 22]]
         self._gas_calibration = [coeff[x] for x in [25, 24, 26]]
 
@@ -296,36 +378,9 @@ class Adafruit_BME680:
         self._humidity_calibration[1] += self._humidity_calibration[0] % 16
         self._humidity_calibration[0] /= 16
 
-        self._heat_range = (self._read(0x02, 1)[0] & 0x30) / 16
+        self._heat_range = (self._read_byte(0x02) & 0x30) / 16
-        self._heat_val = self._read(0x00, 1)[0]
+        self._heat_val = self._read_byte(0x00)
-        self._sw_err = (self._read(0x04, 1)[0] & 0xF0) / 16
+        self._sw_err = (self._read_byte(0x04) & 0xF0) / 16
-
-        """
-        print("T1-3: %d %d %d" % (self._temp_calibration[0],
-                                  self._temp_calibration[1],
-                                  self._temp_calibration[2]))
-        print("P1-3: %d %d %d" % (self._pressure_calibration[0],
-                                  self._pressure_calibration[1],
-                                  self._pressure_calibration[2]))
-        print("P4-6: %d %d %d" % (self._pressure_calibration[3],
-                                  self._pressure_calibration[4],
-                                  self._pressure_calibration[5]))
-        print("P7-9: %d %d %d" % (self._pressure_calibration[6],
-                                  self._pressure_calibration[7],
-                                  self._pressure_calibration[8]))
-        print("P10: %d" % self._pressure_calibration[9])
-        print("H1-3: %d %d %d" % (self._humidity_calibration[0],
-                                  self._humidity_calibration[1],
-                                  self._humidity_calibration[2]))
-        print("H4-7: %d %d %d %d" % (self._humidity_calibration[3],
-                                     self._humidity_calibration[4],
-                                     self._humidity_calibration[5],
-                                     self._humidity_calibration[6]))
-        print("G1-3: %d %d %d" % (self._gas_calibration[0],
-                                  self._gas_calibration[1],
-                                  self._gas_calibration[2]))
-        print("HR %d HV %d SWERR %d" % (self._heat_range, self._heat_val, self._sw_err))
-        """
 
     def _read_byte(self, register):
         """Read a byte register value and return it"""
@@ -337,14 +392,24 @@ class Adafruit_BME680:
     def _write(self, register, values):
         raise NotImplementedError()
 
+
 class Adafruit_BME680_I2C(Adafruit_BME680):
-    """Driver for I2C connected BME680."""
+    """Driver for I2C connected BME680.
-    def __init__(self, i2c, address=0x77, debug=False):
+
+        :param int address: I2C device address
+        :param bool debug: Print debug statements when True.
+        :param int refresh_rate: Maximum number of readings per second. Faster property reads
+          will be from the previous reading."""
+
+    def __init__(self, i2c, address=0x77, debug=False, *, refresh_rate=10):
         """Initialize the I2C device at the 'address' given"""
-        import adafruit_bus_device.i2c_device as i2c_device
+        from adafruit_bus_device import (  # pylint: disable=import-outside-toplevel
+            i2c_device,
+        )
+
         self._i2c = i2c_device.I2CDevice(i2c, address)
         self._debug = debug
-        super().__init__()
+        super().__init__(refresh_rate=refresh_rate)
 
     def _read(self, register, length):
         """Returns an array of 'length' bytes from the 'register'"""
@@ -359,7 +424,67 @@ class Adafruit_BME680_I2C(Adafruit_BME680):
     def _write(self, register, values):
         """Writes an array of 'length' bytes to the 'register'"""
         with self._i2c as i2c:
-            values = [(v & 0xFF) for v in [register]+values]
+            buffer = bytearray(2 * len(values))
-            i2c.write(bytes(values))
+            for i, value in enumerate(values):
+                buffer[2 * i] = register + i
+                buffer[2 * i + 1] = value
+            i2c.write(buffer)
             if self._debug:
                 print("\t$%02X <= %s" % (values[0], [hex(i) for i in values[1:]]))
+
+
+class Adafruit_BME680_SPI(Adafruit_BME680):
+    """Driver for SPI connected BME680.
+
+        :param busio.SPI spi: SPI device
+        :param digitalio.DigitalInOut cs: Chip Select
+        :param bool debug: Print debug statements when True.
+        :param int baudrate: Clock rate, default is 100000
+        :param int refresh_rate: Maximum number of readings per second. Faster property reads
+          will be from the previous reading.
+      """
+
+    def __init__(self, spi, cs, baudrate=100000, debug=False, *, refresh_rate=10):
+        from adafruit_bus_device import (  # pylint: disable=import-outside-toplevel
+            spi_device,
+        )
+
+        self._spi = spi_device.SPIDevice(spi, cs, baudrate=baudrate)
+        self._debug = debug
+        super().__init__(refresh_rate=refresh_rate)
+
+    def _read(self, register, length):
+        if register != _BME680_REG_STATUS:
+            # _BME680_REG_STATUS exists in both SPI memory pages
+            # For all other registers, we must set the correct memory page
+            self._set_spi_mem_page(register)
+
+        register = (register | 0x80) & 0xFF  # Read single, bit 7 high.
+        with self._spi as spi:
+            spi.write(bytearray([register]))  # pylint: disable=no-member
+            result = bytearray(length)
+            spi.readinto(result)  # pylint: disable=no-member
+            if self._debug:
+                print("\t$%02X => %s" % (register, [hex(i) for i in result]))
+            return result
+
+    def _write(self, register, values):
+        if register != _BME680_REG_STATUS:
+            # _BME680_REG_STATUS exists in both SPI memory pages
+            # For all other registers, we must set the correct memory page
+            self._set_spi_mem_page(register)
+        register &= 0x7F  # Write, bit 7 low.
+        with self._spi as spi:
+            buffer = bytearray(2 * len(values))
+            for i, value in enumerate(values):
+                buffer[2 * i] = register + i
+                buffer[2 * i + 1] = value & 0xFF
+            spi.write(buffer)  # pylint: disable=no-member
+            if self._debug:
+                print("\t$%02X <= %s" % (values[0], [hex(i) for i in values[1:]]))
+
+    def _set_spi_mem_page(self, register):
+        spi_mem_page = 0x00
+        if register < 0x80:
+            spi_mem_page = 0x10
+        self._write(_BME680_REG_STATUS, [spi_mem_page])

docs/conf.py

@@ -2,7 +2,8 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ------------------------------------------------
 
@@ -10,36 +11,41 @@ sys.path.insert(0, os.path.abspath('.'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
+    "sphinx.ext.autodoc",
-    'sphinx.ext.intersphinx',
+    "sphinx.ext.intersphinx",
-    'sphinx.ext.viewcode',
+    "sphinx.ext.viewcode",
 ]
 
-autodoc_mock_imports = ['micropython']
+intersphinx_mapping = {
-
+    "python": ("https://docs.python.org/3.4", None),
-intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/bus_device/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
+    "BusDevice": (
+        "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
+        None,
+    ),
+    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
+}
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'README'
+master_doc = "index"
 
 # General information about the project.
-project = u'Adafruit BME680 Library'
+project = "Adafruit BME680 Library"
-copyright = u'2017 ladyada'
+copyright = "2017 ladyada"
-author = u'ladyada'
+author = "ladyada"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'1.0'
+version = "1.0"
 # The full version, including alpha/beta/rc tags.
-release = u'1.0'
+release = "1.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -51,7 +57,7 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -63,64 +69,76 @@ default_role = "any"
 add_function_parentheses = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+# If this is True, todo emits a warning for each TODO entries. The default is False.
+todo_emit_warnings = True
+
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
     try:
         import sphinx_rtd_theme
-        html_theme = 'sphinx_rtd_theme'
+
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
+        html_theme = "sphinx_rtd_theme"
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
     except:
-        html_theme = 'default'
+        html_theme = "default"
-        html_theme_path = ['.']
+        html_theme_path = ["."]
 else:
-    html_theme_path = ['.']
+    html_theme_path = ["."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+html_favicon = "_static/favicon.ico"
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'AdafruitBME680Librarydoc'
+htmlhelp_basename = "AdafruitBME680Librarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
+    # The paper size ('letterpaper' or 'a4paper').
-     #
+    #
-     # 'papersize': 'letterpaper',
+    # 'papersize': 'letterpaper',
-
+    # The font size ('10pt', '11pt' or '12pt').
-     # The font size ('10pt', '11pt' or '12pt').
+    #
-     #
+    # 'pointsize': '10pt',
-     # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
-
+    #
-     # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
-     #
+    # Latex figure (float) alignment
-     # 'preamble': '',
+    #
-
+    # 'figure_align': 'htbp',
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'AdafruitBME680Library.tex', u'Adafruit BME680 Library Documentation',
+    (
-     author, 'manual'),
+        master_doc,
+        "AdafruitBME680Library.tex",
+        "Adafruit BME680 Library Documentation",
+        author,
+        "manual",
+    ),
 ]
 
 # -- Options for manual page output ---------------------------------------
@@ -128,8 +146,13 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'adafruitBME680library', u'Adafruit BME680 Library Documentation',
+    (
-     [author], 1)
+        master_doc,
+        "adafruitBME680library",
+        "Adafruit BME680 Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -138,7 +161,13 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitBME680Library', u'Adafruit BME680 Library Documentation',
+    (
-     author, 'AdafruitBME680Library', 'One line description of project.',
+        master_doc,
-     'Miscellaneous'),
+        "AdafruitBME680Library",
+        "Adafruit BME680 Library Documentation",
+        author,
+        "AdafruitBME680Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

docs/examples.rst

@@ -0,0 +1,8 @@
+Simple test
+------------
+
+Ensure your device works with this simple test.
+
+.. literalinclude:: ../examples/bme680_simpletest.py
+    :caption: examples/bme680_simpletest.py
+    :linenos:

docs/index.rst

@@ -0,0 +1,47 @@
+.. include:: ../README.rst
+
+Table of Contents
+=================
+
+.. toctree::
+    :maxdepth: 4
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: Examples
+
+    examples
+
+.. toctree::
+    :caption: API Reference
+    :maxdepth: 3
+
+    api
+
+.. toctree::
+    :caption: Tutorials
+
+.. toctree::
+    :caption: Related Products
+
+    Adafruit BME680 - Temperature, Humidity, Pressure and Gas Sensor <https://www.adafruit.com/product/3660>
+
+.. toctree::
+    :caption: Other Links
+
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_BME680/releases/latest>
+    CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
+    CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
+    Discord Chat <https://adafru.it/discord>
+    Adafruit Learning System <https://learn.adafruit.com>
+    Adafruit Blog <https://blog.adafruit.com>
+    Adafruit Store <https://www.adafruit.com>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

examples/bme680_simpletest.py

@@ -1,8 +1,7 @@
-import gc
-from busio import I2C
-import adafruit_bme680
 import time
 import board
+from busio import I2C
+import adafruit_bme680
 
 # Create library object using our Bus I2C port
 i2c = I2C(board.SCL, board.SDA)
@@ -11,8 +10,13 @@ bme680 = adafruit_bme680.Adafruit_BME680_I2C(i2c, debug=False)
 # change this to match the location's pressure (hPa) at sea level
 bme680.sea_level_pressure = 1013.25
 
+# You will usually have to add an offset to account for the temperature of
+# the sensor. This is usually around 5 degrees but varies by use. Use a
+# separate temperature sensor to calibrate this one.
+temperature_offset = -5
+
 while True:
-    print("\nTemperature: %0.1f C" % bme680.temperature)
+    print("\nTemperature: %0.1f C" % bme680.temperature + temperature_offset)
     print("Gas: %d ohm" % bme680.gas)
     print("Humidity: %0.1f %%" % bme680.humidity)
     print("Pressure: %0.3f hPa" % bme680.pressure)

requirements.txt

@@ -1 +1,2 @@
-adafruit-circuitpython-bus-device
+Adafruit-Blinka
+adafruit-circuitpython-busdevice

setup.py

@@ -0,0 +1,53 @@
+"""A setuptools based setup module.
+
+See:
+https://packaging.python.org/en/latest/distributing.html
+https://github.com/pypa/sampleproject
+"""
+
+# Always prefer setuptools over distutils
+from setuptools import setup, find_packages
+
+# To use a consistent encoding
+from codecs import open
+from os import path
+
+here = path.abspath(path.dirname(__file__))
+
+# Get the long description from the README file
+with open(path.join(here, "README.rst"), encoding="utf-8") as f:
+    long_description = f.read()
+
+setup(
+    name="adafruit-circuitpython-bme680",
+    use_scm_version=True,
+    setup_requires=["setuptools_scm"],
+    description="CircuitPython library for BME680 temperature, pressure and humidity sensor.",
+    long_description=long_description,
+    long_description_content_type="text/x-rst",
+    # The project's main homepage.
+    url="https://github.com/adafruit/Adafruit_CircuitPython_BME680",
+    # Author details
+    author="Adafruit Industries",
+    author_email="circuitpython@adafruit.com",
+    install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
+    # Choose your license
+    license="MIT",
+    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries",
+        "Topic :: System :: Hardware",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+    ],
+    # What does your project relate to?
+    keywords="adafruit blinka circuitpython micropython bme680 hardware temperature pressure "
+    "humidity gas",
+    # You can just specify the packages manually here if your project is
+    # simple. Or you can use find_packages().
+    py_modules=["adafruit_bme680"],
+)