Skip to content

Commit

Permalink
Merge pull request #21 from SV-Zanshin/v1.0.7_development
Browse files Browse the repository at this point in the history
V1.0.7 development
  • Loading branch information
Arnd authored Jun 11, 2020
2 parents 44e500f + 967b1bd commit 0c20225
Show file tree
Hide file tree
Showing 20 changed files with 543 additions and 27 deletions.
2 changes: 1 addition & 1 deletion LICENSE → .github/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -671,4 +671,4 @@ into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
9 changes: 5 additions & 4 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# BME680 library<br>[![Build Status](https://travis-ci.org/SV-Zanshin/BME680.svg?branch=master)](https://travis-ci.org/SV-Zanshin/BME680) [![DOI](https://zenodo.org/badge/139349456.svg)](https://zenodo.org/badge/latestdoi/139349456) [![arduino-library-badge](https://www.ardu-badge.com/badge/BME680.svg?)](https://www.ardu-badge.com/BME680)
*Arduino* library for using the [Bosch BME680](https://www.bosch-sensortec.com/bst/products/all_products/bme680) sensor which senses temperature, humidity, pressure and air quality. The BME680 is a tiny package and no hobbyist is going to be breadboarding this sensor directly, so one will be part of a breakout board. Here are some breakout board examples:
# BME680 library <img src="https://github.com/SV-Zanshin/BME680/blob/master/Images/bosch-bme680.jpg" alt="Bosch BME680" align="right" height="60px"><br>[![License: GPL v3](https://zanduino.github.io/Badges/GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Build Status](https://travis-ci.org/SV-Zanshin/BME680.svg?branch=master)](https://travis-ci.org/SV-Zanshin/BME680) [![arduino-library-badge](https://www.ardu-badge.com/badge/BME680.svg?)](https://www.ardu-badge.com/BME680) [![DOI](https://zenodo.org/badge/139349456.svg)](https://zenodo.org/badge/latestdoi/139349456) [![Doxygen](https://zanduino.github.io/Badges/Doxygen-Badge.svg)](https://sv-zanshin.github.io/BME680/html/index.html) [![Wiki](https://zanduino.github.io/Badges/Documentation-Badge.svg)](https://github.com/SV-Zanshin/BME680/wiki)

*Arduino* library for using the [Bosch BME680](https://www.bosch-sensortec.com/bst/products/all_products/bme680) sensor which senses temperature, humidity and pressure. The BME680 is a tiny package and no hobbyist is going to be breadboarding this sensor directly, so one will be part of a breakout board. Here are some breakout board examples:

| Supplier | Image | Instructions | Comments |
| --------- | ----- |------------ | -------- |
| [Sparkfun](https://www.sparkfun.com/products/16466) | <img src="https://cdn.sparkfun.com//assets/parts/1/5/3/2/9/16466-SparkFun_Environmental_Sensor_Breakout_-_BME680__Qwiic_-01a.jpg" width="200" /> | [Guide](https://learn.sparkfun.com/tutorials/sparkfun-environmental-sensor-breakout---bme680-qwiic-hookup-guide) | The Sparkfun board has pinouts for both SPI and I2C, one interface along one edge and other on the opposing side. The board is designed as part of the SparkFun [Qwiic Connect System](https://www.sparkfun.com/qwiic) that uses standardized plugs to daisy-chain I2C breakout boards together quickly. This package is designed to work with 3V systems and has no on-board 5V level shifting. |
| [Sparkfun](https://www.sparkfun.com/products/16466) | <img src="https://cdn.sparkfun.com//assets/parts/1/5/3/2/9/16466-SparkFun_Environmental_Sensor_Breakout_-_BME680__Qwiic_-01a.jpg" width="150px" /> | [Guide](https://learn.sparkfun.com/tutorials/sparkfun-environmental-sensor-breakout---bme680-qwiic-hookup-guide) | The Sparkfun board has pinouts for both SPI and I2C, one interface along one edge and other on the opposing side. The board is designed as part of the SparkFun [Qwiic Connect System](https://www.sparkfun.com/qwiic) that uses standardized plugs to daisy-chain I2C breakout boards together quickly. This package is designed to work with 3V systems and has no on-board 5V level shifting. |
| [Bluedot](https://www.bluedot.space/sensor-boards/bme680/) | <img src="https://github.com/SV-Zanshin/BME680/blob/master/Images/BlueDotBME680.jpg" width="150" /> | [Guide](https://www.bluedot.space/sensor-boards/bme680/) | This was my initial BME680 breakout board, purchased locally in Germany where it is manufactured. It has on-board level shifting and is therefore able to run on both 3V and 5V systems. There are fewer pinouts on this board than on the Sparkfun one, several of the pins have different uses depending upon whether I2C or SPI is selected |
| [Adafruit](https://www.adafruit.com/product/3660) | <img src="https://cdn-shop.adafruit.com/970x728/3660-01.jpg" width="150" /> | [Guide](https://learn.adafruit.com/adafruit-bme680-humidity-temperature-barometic-pressure-voc-gas/) | This breakout board is the most compact of the three, with the pinouts having different uses depending upon which communications method (I2C or SPI) is used. As with the Bluedot breakout board above, the Adafruit breakout board has integrated level-shifting and can therefore be run on both 3V and 5V systems. |

Expand All @@ -27,4 +28,4 @@ The pressure sensor works in temperatures between -40°C and +85°C although the
### Environment gas sensing
The gas sensor works by heating a small surface internally and measuring the resistance of the gas layer. This indicates the amount of volatile components in the air and can be used as an indirect means of measuring of air quality. The actual computation of "indoor air quality" is more complex than measuring the resistance, as the relative humidity, temperature, and element heating all play a role in determining that value. These calculations not only require the use of floating-point math, but are quite complex and memory-intensive and are not included in the library. If IAQ measurements are required, then the best solution is to use Bosch's [BSEC](https://www.bosch-sensortec.com/software-tools/software/bsec/) software - but keep in mind that it won't run on most smaller Arduino platforms.

![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,3 @@ Release
# Files and directories from Doxygen #
########################################################################
html

4 changes: 3 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ env:
- DOXYFILE: $TRAVIS_BUILD_DIR/Doxyfile

before_install:
- source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/install.sh)
# - source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/install.sh)
- source <(curl -SLs https://zanduino.github.io/Travis/install.sh)


install:

Expand Down
8 changes: 5 additions & 3 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
## ##
## Date Developer Comments ##
## ========== ============================= ======================================================= ##
## 2020-06-08 https://github.com/SV-Zanshin Updated version to 1.0.7 ##
## 2020-06-01 https://github.com/SV-Zanshin Added "PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS" ##
## 2020-05-23 https://github.com/SV-Zanshin Removed e-mail addresses from file and updated version ##
## 2020-05-21 https://github.com/SV-Zanshin Updated "PROJECT_NUMBER" value to 1.0.5 ##
## 2020-05-17 https://github.com/SV-Zanshin Updated "PROJECT_NUMBER" value to 1.0.4 ##
Expand All @@ -11,7 +13,7 @@
######################################################################################################
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = BME680
PROJECT_NUMBER = "Version 1.06"
PROJECT_NUMBER = "Version 1.0.7"
PROJECT_BRIEF = "Arduino Library for the Bosch BME680 Temperature, Humidity, Pressure and Gas sensor"
PROJECT_LOGO =
OUTPUT_DIRECTORY =
Expand Down Expand Up @@ -116,7 +118,7 @@ FILE_PATTERNS = *.ino \
*.cpp \
*.h
RECURSIVE = YES
EXCLUDE =
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
Expand Down Expand Up @@ -244,7 +246,7 @@ EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
TAGFILES =
Expand Down
2 changes: 1 addition & 1 deletion Images/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BME680 Images<br>
This directory contains the images used in the library documentation and wiki pages.
This directory contains the images used in the library documentation and wiki pages.
The [Fritzing](https://fritzing.org/home/) sources are also included in the directory

| File Name | Image |
Expand Down
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Loading

0 comments on commit 0c20225

Please sign in to comment.