Skip to content

Commit

Permalink
Merge pull request #19 from SV-Zanshin/v1.0.6_development
Browse files Browse the repository at this point in the history 
V1.0.6 development
  • Loading branch information
Arnd authored May 27, 2020
2 parents 39bb840 + 6ec9d92 commit 49002b5
Show file tree
Hide file tree
Showing 12 changed files with 535 additions and 144 deletions.
9 changes: 5 additions & 4 deletions .gitattributes
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@
# #
# Date Author Comments #
# ========== ============================= =========================== #
# 2020-05-22 https://github.com/SV-Zanshin Aligned columns with tabs #
# 2018-06-24 https://github.com/SV-Zanshin Changed file #
# #
########################################################################
examples/ linguist-documentation=false
examples/ linguist-documentation=false
*.c linguist-language=c++
*.ino linguist-language=c++
*.pde linguist-language=c++
*.ino linguist-language=c++
*.pde linguist-language=c++
*.c linguist-language=c++
*.h linguist-language=c++
*.cpp linguist-language=c++
*.cpp linguist-language=c++

########################################################################
# Auto detect text files and perform LF normalization #
Expand Down
12 changes: 6 additions & 6 deletions .github/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# 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)
<img src="https://cdn.sparkfun.com//assets/parts/1/5/3/2/9/16466-SparkFun_Environmental_Sensor_Breakout_-_BME680__Qwiic_-01a.jpg" width="175" align="left"/><img src="https://github.com/SV-Zanshin/BME680/blob/master/Images/BlueDotBME680.jpg" width="175" align="right"/> *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:
*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 | Instructions | Comments |
| --------- | ------------ | -------- |
| [Sparkfun](https://www.sparkfun.com/products/16466) | [Guide](https://learn.sparkfun.com/tutorials/sparkfun-environmental-sensor-breakout---bme680-qwiic-hookup-guide) | 3V only, Qwiic System|
| [Bluedot](https://www.bluedot.space/sensor-boards/bme680/) | [Guide](https://www.bluedot.space/sensor-boards/bme680/) | 3-5V |
| [Adafruit](https://www.adafruit.com/product/3660) | [Guide](https://learn.adafruit.com/adafruit-bme680-humidity-temperature-barometic-pressure-voc-gas/) | 3-5V |
| 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="150" /> | [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 level-shifting integrated and can therefore be run on both 3V and 5V systems. |

A complete description of the BME680 sensor can be found in the [BME680 Datasheet](https://ae-bst.resource.bosch.com/media/_tech/media/datasheets/BST-BME680-DS001-00.pdf).

Expand Down
28 changes: 20 additions & 8 deletions .travis.yml
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
######################################################################################################
## Travis-CI control file ##
## ##
## Date Developer Comments ##
## ========== =================== ================================================================= ##
## 2020-05-09 Arnd@SV-Zanshin Removed unnecessary install libraries ##
## 2019-01-23 Arnd@SV-Zanshin Corrected PRETTYNAME ##
## 2019-01-20 Arnd@SV-Zanshin Linked to Adafruit script rather than manually defining all tests ##
## 2019-01-19 Arnd@SV-Zanshin Initial coding ##
## This YML file controls the way that TRAVIS-CI works for testing the compilability of the library ##
## and example programs for all supported platforms. Rather than re-invent the wheel, the public ##
## scripts written by the folks at www.adafruit.com are used; as they will add new platforms as ##
## needed and thus the continuous integration process for this library will be kept up-to-date. ##
## ##
## Date Developer Comments ##
## ========== ============================= ======================================================= ##
## 2020-05-23 https://github.com/SV-Zanshin Cleaned up documentation format ##
## 2020-05-09 https://github.com/SV-Zanshin Removed unnecessary install libraries ##
## 2019-01-23 https://github.com/SV-Zanshin Corrected PRETTYNAME ##
## 2019-01-20 https://github.com/SV-Zanshin Linked to Adafruit script rather than defining all of ##
## the tests locally and maintaining them ##
## 2019-01-19 https://github.com/SV-Zanshin Initial coding ##
## ##
######################################################################################################
language: c
sudo: false

# Blacklist
#########################################################
# Keep the gh-pages from being included in the CI runs ##
#########################################################
branches:
except:
- gh-pages
Expand All @@ -22,7 +31,7 @@ git:
quiet: true
env:
global:
- PRETTYNAME="SV-Zanshin Bosch BME680 Arduino Library"
- PRETTYNAME="Bosch BME680 Arduino Library"
- DOXYFILE: $TRAVIS_BUILD_DIR/Doxyfile

before_install:
Expand All @@ -38,5 +47,8 @@ notifications:
on_success: change
on_failure: change

###########################################################
# Generate the Doxygen documentation upon successful run ##
###########################################################
after_success:
- source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/doxy_gen_and_deploy.sh)
15 changes: 8 additions & 7 deletions Doxyfile
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
######################################################################################################
## Doxygen control file for Version 1.8.16 ##
## ##
## Date Developer Comments ##
## ========== =================== ================================================================= ##
## 2020-05-21 Arnd@SV-Zanshin Updated "PROJECT_NUMBER" value to 1.0.5 ##
## 2020-05-17 Arnd@SV-Zanshin Updated "PROJECT_NUMBER" value to 1.0.4 ##
## 2020-05-10 Arnd@SV-Zanshin Removed all comments in order to compact this file ##
## Date Developer Comments ##
## ========== ============================= ======================================================= ##
## 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 ##
## 2020-05-10 https://github.com/SV-Zanshin Removed all comments in order to compact this file ##
## ##
######################################################################################################
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = BME680
PROJECT_NUMBER = "Version 1.0.5"
PROJECT_BRIEF = "Arduino Library for Bosch BME680 Temperature, Humidity, Pressure and Gas sensor"
PROJECT_NUMBER = "Version 1.0.6"
PROJECT_BRIEF = "Arduino Library for the Bosch BME680 Temperature, Humidity, Pressure and Gas sensor"
PROJECT_LOGO =
OUTPUT_DIRECTORY =
CREATE_SUBDIRS = NO
Expand Down
15 changes: 15 additions & 0 deletions Images/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# BME680 Images<br>
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 |
| --------- | ----- |
| adafruit-bme680.jpg | <img src="https://github.com/SV-Zanshin/BME680/blob/master/Images/adafruit-bme680.jpg" width="50%"/> |
| BlueDotBME680.jpg | <img src="https://github.com/SV-Zanshin/BME680/blob/master/Images/BlueDotBME680.jpg" width="50%"/> |
| Mega_HW_SPI_BME280_bb.png | <img src="https://github.com/SV-Zanshin/BME680/blob/master/Images/Mega_HW_SPI_BME280_bb.png" width="50%"/> |
| Mega_SW_SPI_BME280_bb.png | <img src="https://github.com/SV-Zanshin/BME680/blob/master/Images/Mega_SW_SPI_BME280_bb.png" width="50%"/> |
| Micro_BME280_bb.png |<img src="https://github.com/SV-Zanshin/BME680/blob/master/Images/Micro_BME280_bb.png" width="50%"/> |
| TwoBME680.jpg | <img src="https://github.com/SV-Zanshin/BME680/blob/master/Images/TwoBME680.jpg" width="50%"/> |


![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"/>
13 changes: 13 additions & 0 deletions examples/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Example programs for the 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)

Various example programs illustrating the use of the *Arduino* BME680 library are included in this directory and sub-directories.

| Example Name | Wiki Link | Comments |
| ------------------- | ---------------------------------------------------------------------------------------- | -------- |
| I2C Demo | [I2CDemo.ino](https://github.com/SV-Zanshin/BME680/wiki/I2CDemo.ino) | Program to set up and continuously read from a BME680 connected via the I2C pins (SDA and SCL) |
| SPI Demo | [SPIDemo.ino](https://github.com/SV-Zanshin/BME680/wiki/SPIDemo.ino) | Program to set up and continuously read from a BME680 connected using the default hardware SPI pins (SCL,MOSI, MISO and SS) |
| software SPI Demo | [SoftSPIDemo.ino](https://github.com/SV-Zanshin/BME680/wiki/SoftSPIDemo.ino) | Identical to the I2C Demo program, but using SPI connectivity emulated in software |
| Two I2C BME680s | [TwoDevicesI2CDemo.ino](https://github.com/SV-Zanshin/BME680/wiki/TwoDevicesI2CDemo.ino) | Example to illustrate attaching 2 BME680 devices with different addresses using I2C |
| SD-Card Logging | [SDLoggerSPIDemo.ino](https://github.com/SV-Zanshin/BME680/wiki/SDLoggerSPIDemo.ino) | Example sketch using SPI for the BME680 and a SD-Card to log data at variable rates - faster logging when the measurements change rapidly and less frequent measurements when there is little change. |

![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"/>
Loading

0 comments on commit 49002b5

Please sign in to comment.