diff --git a/library/CHANGELOG.txt b/library/CHANGELOG.txt index d776f15..be840d9 100644 --- a/library/CHANGELOG.txt +++ b/library/CHANGELOG.txt @@ -1,3 +1,8 @@ +1.0.5 +----- + +* New: set_temp_offset to calibrate temperature offset in degrees C + 1.0.4 ----- diff --git a/library/MANIFEST.in b/library/MANIFEST.in index e203acd..6acf331 100644 --- a/library/MANIFEST.in +++ b/library/MANIFEST.in @@ -1,5 +1,5 @@ include CHANGELOG.txt include LICENSE.txt -include README.txt +include README.rst include setup.py recursive-include bme680 *.py diff --git a/library/README.rst b/library/README.rst new file mode 100644 index 0000000..a325ea8 --- /dev/null +++ b/library/README.rst @@ -0,0 +1,68 @@ +BME680 +====== + +https://shop.pimoroni.com/products/bme680 + +The state-of-the-art BME680 breakout lets you measure temperature, +pressure, humidity, and indoor air quality. + +Installing +---------- + +Full install (recommended): +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We've created an easy installation script that will install all +pre-requisites and get your BME680 up and running with minimal efforts. +To run it, fire up Terminal which you'll find in Menu -> Accessories -> +Terminal on your Raspberry Pi desktop, as illustrated below: + +.. figure:: http://get.pimoroni.com/resources/github-repo-terminal.png + :alt: Finding the terminal + +In the new terminal window type the command exactly as it appears below +(check for typos) and follow the on-screen instructions: + +.. code:: bash + + curl https://get.pimoroni.com/bme680 | bash + +Manual install: +~~~~~~~~~~~~~~~ + +Library install for Python 3: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code:: bash + + sudo pip3 install bme680 + +Library install for Python 2: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code:: bash + + sudo pip2 install bme680 + +Development: +~~~~~~~~~~~~ + +If you want to contribute, or like living on the edge of your seat by +having the latest code, you should clone this repository, ``cd`` to the +library directory, and run: + +.. code:: bash + + sudo python3 setup.py install + +(or ``sudo python setup.py install`` whichever your primary Python +environment may be) + +In all cases you will have to enable the i2c bus. + +Documentation & Support +----------------------- + +- Guides and tutorials - https://learn.pimoroni.com/bme680 +- Get help - http://forums.pimoroni.com/c/support + diff --git a/library/README.txt b/library/README.txt deleted file mode 100644 index e69de29..0000000 diff --git a/library/bme680/__init__.py b/library/bme680/__init__.py index 64d9f16..ecc4f26 100644 --- a/library/bme680/__init__.py +++ b/library/bme680/__init__.py @@ -2,7 +2,7 @@ from .constants import * import math import time -__version__ = '1.0.4' +__version__ = '1.0.5' class BME680(BME680Data): """BOSCH BME680 diff --git a/library/setup.py b/library/setup.py index 78223c3..b47bfce 100755 --- a/library/setup.py +++ b/library/setup.py @@ -39,11 +39,11 @@ classifiers = ['Development Status :: 5 - Production/Stable', setup( name = 'bme680', - version = '1.0.4', + version = '1.0.5', author = 'Philip Howard', author_email = 'phil@pimoroni.com', description = """Python library for driving the Pimoroni BME680 Breakout""", - long_description= open('README.txt').read() + open('CHANGELOG.txt').read(), + long_description= open('README.rst').read() + "\n" + open('CHANGELOG.txt').read(), license = 'MIT', keywords = 'Raspberry Pi', url = 'http://www.pimoroni.com', diff --git a/packaging/CHANGELOG b/packaging/CHANGELOG index 231a9df..8cb1ba9 100644 --- a/packaging/CHANGELOG +++ b/packaging/CHANGELOG @@ -1,3 +1,9 @@ +bme680 (1.0.5) stable; urgency=low + + * New: set_temp_offset to calibrate temperature offset in degrees C + + -- Phil Howard Fri, 01 Jun 2018 00:00:00 +0000 + bme680 (1.0.4) stable; urgency=low * Fix to range_sw_err for extremely high gas readings diff --git a/packaging/debian/changelog b/packaging/debian/changelog index 231a9df..8cb1ba9 100644 --- a/packaging/debian/changelog +++ b/packaging/debian/changelog @@ -1,3 +1,9 @@ +bme680 (1.0.5) stable; urgency=low + + * New: set_temp_offset to calibrate temperature offset in degrees C + + -- Phil Howard Fri, 01 Jun 2018 00:00:00 +0000 + bme680 (1.0.4) stable; urgency=low * Fix to range_sw_err for extremely high gas readings