Revised versioning. Updated BSEC library to v1.4.7.4. Added idleTask parameter to BSEC::begin. Added support to include multiple configurations.

Author: BST-Github-Admin

README.md

@@ -2,7 +2,7 @@
 
 ## About BSEC
 
-Bosch Sensortec Environmental Cluster (BSEC) Software v1.4.7.3 released on April 10th, 2019
+Bosch Sensortec Environmental Cluster (BSEC) Software v1.4.7.4 released on July 3rd, 2019
 
 The BSEC fusion library has been conceptualized to provide a higher-level signal processing and fusion for the BME680. The library receives compensated sensor values from the sensor API. It processes the BME680 signals to provide the requested sensor outputs.
 

examples/basic_config_state/basic_config_state.ino

@@ -1,6 +1,21 @@
 #include <EEPROM.h>
 #include "bsec.h"
-#include "bsec_serialized_configurations_iaq.h"
+/* Configure the BSEC library with information about the sensor
+ *  18v/33v = Voltage at Vdd. 1.8V or 3.3V
+ *  3s/300s = BSEC operating mode, BSEC_SAMPLE_RATE_LP or BSEC_SAMPLE_RATE_ULP
+ *  4d/28d = Operating age of the sensor in days
+ *  generic_18v_3s_4d
+ *  generic_18v_3s_28d
+ *  generic_18v_300s_4d
+ *  generic_18v_300s_28d
+ *  generic_33v_3s_4d
+ *  generic_33v_3s_28d
+ *  generic_33v_300s_4d
+ *  generic_33v_300s_28d
+ */
+const uint8_t bsec_config_iaq[] = {
+  #include "config/generic_33v_3s_4d/bsec_iaq.txt"
+};
 
 #define STATE_SAVE_PERIOD	UINT32_C(360 * 60 * 1000) // 360 minutes - 4 times a day
 

examples/basic_config_state/bsec_serialized_configurations_iaq.c

@@ -1,6 +1,21 @@
 #include <EEPROM.h>
 #include "bsec.h"
-#include "bsec_serialized_configurations_iaq.h"
+/* Configure the BSEC library with information about the sensor
+ *  18v/33v = Voltage at Vdd. 1.8V or 3.3V
+ *  3s/300s = BSEC operating mode, BSEC_SAMPLE_RATE_LP or BSEC_SAMPLE_RATE_ULP
+ *  4d/28d = Operating age of the sensor in days
+ *  generic_18v_3s_4d
+ *  generic_18v_3s_28d
+ *  generic_18v_300s_4d
+ *  generic_18v_300s_28d
+ *  generic_33v_3s_4d
+ *  generic_33v_3s_28d
+ *  generic_33v_300s_4d
+ *  generic_33v_300s_28d
+ */
+const uint8_t bsec_config_iaq[] = {
+  #include "config/generic_33v_3s_4d/bsec_iaq.txt"
+};
 
 #define STATE_SAVE_PERIOD  UINT32_C(360 * 60 * 1000) // 360 minutes - 4 times a day
 
@@ -185,7 +200,7 @@ void ulp_plus_button_press()
   */
   Serial.println("Triggering ULP plus.");
   bsec_virtual_sensor_t sensorList[1] = {
-    BSEC_OUTPUT_IAQ_ESTIMATE,
+    BSEC_OUTPUT_IAQ,
   };
 
   iaqSensor.updateSubscription(sensorList, 1, BSEC_SAMPLE_RATE_ULP_MEASUREMENT_ON_DEMAND);

examples/basic_config_state/bsec_serialized_configurations_iaq.h

@@ -1,12 +1,12 @@
 name=BSEC Software Library
-version=1.4.703
+version=1.2.1474
 author=Bosch Sensortec
 maintainer=Bosch Sensortec <[email protected]>
 sentence=Bosch Sensortec Environmental Cluster (BSEC) Software library
 url=https://www.bosch-sensortec.com/en/bst/products/all_products/bsec
 paragraph=  for use with the BME680 has been conceptualized to provide higher-level signal processing and fusion for the BME680. The library receives compensated sensor values from the sensor API. It processes the BME680 signals to provide the requested sensor outputs. 
 category=Sensors
-architectures=samd,sam,esp8266,nrf52,esp32
+architectures=samd,sam,esp8266,nrf52,esp32,avr
 includes=bsec.h
 precompiled=true
 ldflags=-lalgobsec

examples/basic_config_state_ulp_plus/basic_config_state_ulp_plus.ino

@@ -40,8 +40,8 @@
  * patent rights of the copyright holder.
  *
  * @file	bsec.cpp
- * @date	20 May 2019
- * @version	1.1
+ * @date	25 July 2019
+ * @version	1.2.1474
  *
  */
 
@@ -88,13 +88,13 @@ void Bsec::begin(uint8_t devId, enum bme680_intf intf, bme680_com_fptr_t read, b
 /**
  * @brief Function to initialize the BSEC library and the BME680 sensor
  */
-void Bsec::begin(uint8_t i2cAddr, TwoWire &i2c)
+void Bsec::begin(uint8_t i2cAddr, TwoWire &i2c, bme680_delay_fptr_t idleTask)
 {
 	_bme680.dev_id = i2cAddr;
 	_bme680.intf = BME680_I2C_INTF;
 	_bme680.read = Bsec::i2cRead;
 	_bme680.write = Bsec::i2cWrite;
-	_bme680.delay_ms = Bsec::delay_ms;
+	_bme680.delay_ms = idleTask;
 	_bme680.amb_temp = 25;
 	_bme680.power_mode = BME680_FORCED_MODE;
 
@@ -106,13 +106,13 @@ void Bsec::begin(uint8_t i2cAddr, TwoWire &i2c)
 /**
  * @brief Function to initialize the BSEC library and the BME680 sensor
  */
-void Bsec::begin(uint8_t chipSelect, SPIClass &spi)
+void Bsec::begin(uint8_t chipSelect, SPIClass &spi, bme680_delay_fptr_t idleTask)
 {
 	_bme680.dev_id = chipSelect;
 	_bme680.intf = BME680_SPI_INTF;
 	_bme680.read = Bsec::spiTransfer;
 	_bme680.write = Bsec::spiTransfer;
-	_bme680.delay_ms = Bsec::delay_ms;
+	_bme680.delay_ms = idleTask;
 	_bme680.amb_temp = 25;
 	_bme680.power_mode = BME680_FORCED_MODE;
 
@@ -189,9 +189,9 @@ bool Bsec::run(void)
 		uint16_t meas_dur = 0;
 
 		bme680_get_profile_dur(&meas_dur, &_bme680);
-		delay_ms(meas_dur);
+		_bme680.delay_ms(meas_dur);
 
-		newData = readProcessData(callTimeNs, bme680Settings);	
+		newData = readProcessData(callTimeNs + (meas_dur * INT64_C(1000000)), bme680Settings);	
 	}
 
 	return newData;

examples/basic_config_state_ulp_plus/bsec_serialized_configurations_iaq.c

@@ -40,8 +40,8 @@
  * patent rights of the copyright holder.
  *
  * @file	bsec.h
- * @date	20 May 2019
- * @version	1.1
+ * @date	25 July 2019
+ * @version	1.2.1474
  *
  */
 
@@ -92,15 +92,17 @@ class Bsec
 	 * @brief Function to initialize the BSEC library and the BME680 sensor
 	 * @param i2cAddr	: I2C address
 	 * @param i2c		: Pointer to the TwoWire object
+	 * @param idleTask	: Task to be called when idling
 	 */
-	void begin(uint8_t i2cAddr, TwoWire &i2c);
+	void begin(uint8_t i2cAddr, TwoWire &i2c, bme680_delay_fptr_t idleTask = delay_ms);
 
 	/**
 	 * @brief Function to initialize the BSEC library and the BME680 sensor
 	 * @param chipSelect	: SPI chip select
 	 * @param spi			: Pointer to the SPIClass object
+	 * @param idleTask	: Task to be called when idling
 	 */
-	void begin(uint8_t chipSelect, SPIClass &spi);
+	void begin(uint8_t chipSelect, SPIClass &spi, bme680_delay_fptr_t idleTask = delay_ms);
 
 	/**
 	 * @brief Function that sets the desired sensors and the sample rates

examples/basic_config_state_ulp_plus/bsec_serialized_configurations_iaq.h

@@ -0,0 +1 @@
+4,7,4,1,61,0,0,0,0,0,0,0,174,1,0,0,48,0,1,0,0,168,19,73,64,49,119,76,0,0,225,68,137,65,0,63,205,204,204,62,0,0,64,63,205,204,204,62,0,0,0,0,216,85,0,100,0,0,0,0,0,0,0,0,28,0,2,0,0,244,1,225,0,25,0,0,128,64,0,0,32,65,144,1,0,0,112,65,0,0,0,63,16,0,3,0,10,215,163,60,10,215,35,59,10,215,35,59,9,0,5,0,0,0,0,0,1,88,0,9,0,7,240,150,61,0,0,0,0,0,0,0,0,28,124,225,61,52,128,215,63,0,0,160,64,0,0,0,0,0,0,0,0,205,204,12,62,103,213,39,62,230,63,76,192,0,0,0,0,0,0,0,0,145,237,60,191,251,58,64,63,177,80,131,64,0,0,0,0,0,0,0,0,93,254,227,62,54,60,133,191,0,0,64,64,12,0,10,0,0,0,0,0,0,0,0,0,229,0,254,0,2,1,5,48,117,100,0,44,1,112,23,151,7,132,3,197,0,92,4,144,1,64,1,64,1,144,1,48,117,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,48,117,48,117,100,0,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,100,0,100,0,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,255,255,255,255,255,255,255,255,220,5,220,5,220,5,255,255,255,255,255,255,220,5,220,5,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,48,117,0,0,0,0,133,135,0,0

library.properties

@@ -0,0 +1 @@
+4,7,4,1,61,0,0,0,0,0,0,0,174,1,0,0,48,0,1,0,0,192,168,71,64,49,119,76,0,0,225,68,137,65,0,63,205,204,204,62,0,0,64,63,205,204,204,62,0,0,0,0,216,85,0,100,0,0,0,0,0,0,0,0,28,0,2,0,0,244,1,225,0,25,0,0,128,64,0,0,32,65,144,1,0,0,112,65,0,0,0,63,16,0,3,0,10,215,163,60,10,215,35,59,10,215,35,59,9,0,5,0,0,0,0,0,1,88,0,9,0,7,240,150,61,0,0,0,0,0,0,0,0,28,124,225,61,52,128,215,63,0,0,160,64,0,0,0,0,0,0,0,0,205,204,12,62,103,213,39,62,230,63,76,192,0,0,0,0,0,0,0,0,145,237,60,191,251,58,64,63,177,80,131,64,0,0,0,0,0,0,0,0,93,254,227,62,54,60,133,191,0,0,64,64,12,0,10,0,0,0,0,0,0,0,0,0,229,0,254,0,2,1,5,48,117,100,0,44,1,112,23,151,7,132,3,197,0,92,4,144,1,64,1,64,1,144,1,48,117,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,48,117,48,117,100,0,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,100,0,100,0,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,255,255,255,255,255,255,255,255,220,5,220,5,220,5,255,255,255,255,255,255,220,5,220,5,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,48,117,0,0,0,0,166,224,0,0

src/atmega2560/libalgobsec.a

@@ -0,0 +1 @@
+4,7,4,1,61,0,0,0,0,0,0,0,174,1,0,0,48,0,1,0,0,168,19,73,64,49,119,76,0,0,225,68,137,65,0,63,205,204,204,62,0,0,64,63,205,204,204,62,0,0,0,0,216,85,0,100,0,0,0,0,0,0,0,0,28,0,2,0,0,244,1,225,0,25,0,0,128,64,0,0,32,65,144,1,0,0,112,65,0,0,0,63,16,0,3,0,10,215,163,60,10,215,35,59,10,215,35,59,9,0,5,0,0,0,0,0,1,88,0,9,0,229,208,34,62,0,0,0,0,0,0,0,0,218,27,156,62,225,11,67,64,0,0,160,64,0,0,0,0,0,0,0,0,94,75,72,189,93,254,159,64,66,62,160,191,0,0,0,0,0,0,0,0,33,31,180,190,138,176,97,64,65,241,99,190,0,0,0,0,0,0,0,0,167,121,71,61,165,189,41,192,184,30,189,64,12,0,10,0,0,0,0,0,0,0,0,0,229,0,254,0,2,1,5,48,117,100,0,44,1,112,23,151,7,132,3,197,0,92,4,144,1,64,1,64,1,144,1,48,117,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,48,117,48,117,100,0,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,100,0,100,0,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,255,255,255,255,255,255,255,255,220,5,220,5,220,5,255,255,255,255,255,255,220,5,220,5,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,48,117,0,0,0,0,59,62,0,0

src/bsec.cpp

@@ -0,0 +1 @@
+4,7,4,1,61,0,0,0,0,0,0,0,174,1,0,0,48,0,1,0,0,192,168,71,64,49,119,76,0,0,225,68,137,65,0,63,205,204,204,62,0,0,64,63,205,204,204,62,0,0,0,0,216,85,0,100,0,0,0,0,0,0,0,0,28,0,2,0,0,244,1,225,0,25,0,0,128,64,0,0,32,65,144,1,0,0,112,65,0,0,0,63,16,0,3,0,10,215,163,60,10,215,35,59,10,215,35,59,9,0,5,0,0,0,0,0,1,88,0,9,0,229,208,34,62,0,0,0,0,0,0,0,0,218,27,156,62,225,11,67,64,0,0,160,64,0,0,0,0,0,0,0,0,94,75,72,189,93,254,159,64,66,62,160,191,0,0,0,0,0,0,0,0,33,31,180,190,138,176,97,64,65,241,99,190,0,0,0,0,0,0,0,0,167,121,71,61,165,189,41,192,184,30,189,64,12,0,10,0,0,0,0,0,0,0,0,0,229,0,254,0,2,1,5,48,117,100,0,44,1,112,23,151,7,132,3,197,0,92,4,144,1,64,1,64,1,144,1,48,117,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,48,117,48,117,100,0,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,100,0,100,0,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,255,255,255,255,255,255,255,255,220,5,220,5,220,5,255,255,255,255,255,255,220,5,220,5,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,48,117,0,0,0,0,24,89,0,0

src/bsec.h

@@ -0,0 +1 @@
+4,7,4,1,61,0,0,0,0,0,0,0,174,1,0,0,48,0,1,0,0,168,19,73,64,49,119,76,0,0,225,68,137,65,0,63,205,204,204,62,0,0,64,63,205,204,204,62,0,0,0,0,216,85,0,100,0,0,0,0,0,0,0,0,28,0,2,0,0,244,1,225,0,25,0,0,128,64,0,0,32,65,144,1,0,0,112,65,0,0,0,63,16,0,3,0,10,215,163,60,10,215,35,59,10,215,35,59,9,0,5,0,0,0,0,0,1,88,0,9,0,229,208,34,62,0,0,0,0,0,0,0,0,218,27,156,62,225,11,67,64,0,0,160,64,0,0,0,0,0,0,0,0,94,75,72,189,93,254,159,64,66,62,160,191,0,0,0,0,0,0,0,0,33,31,180,190,138,176,97,64,65,241,99,190,0,0,0,0,0,0,0,0,167,121,71,61,165,189,41,192,184,30,189,64,12,0,10,0,0,0,0,0,0,0,0,0,229,0,254,0,2,1,5,48,117,100,0,44,1,112,23,151,7,132,3,197,0,92,4,144,1,64,1,64,1,144,1,48,117,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,48,117,48,117,100,0,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,100,0,100,0,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,255,255,255,255,255,255,255,255,220,5,220,5,220,5,255,255,255,255,255,255,220,5,220,5,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,44,1,0,0,0,0,169,55,0,0

src/config/generic_18v_300s_28d/bsec_iaq.txt

@@ -0,0 +1 @@
+4,7,4,1,61,0,0,0,0,0,0,0,174,1,0,0,48,0,1,0,0,192,168,71,64,49,119,76,0,0,225,68,137,65,0,63,205,204,204,62,0,0,64,63,205,204,204,62,0,0,0,0,216,85,0,100,0,0,0,0,0,0,0,0,28,0,2,0,0,244,1,225,0,25,0,0,128,64,0,0,32,65,144,1,0,0,112,65,0,0,0,63,16,0,3,0,10,215,163,60,10,215,35,59,10,215,35,59,9,0,5,0,0,0,0,0,1,88,0,9,0,229,208,34,62,0,0,0,0,0,0,0,0,218,27,156,62,225,11,67,64,0,0,160,64,0,0,0,0,0,0,0,0,94,75,72,189,93,254,159,64,66,62,160,191,0,0,0,0,0,0,0,0,33,31,180,190,138,176,97,64,65,241,99,190,0,0,0,0,0,0,0,0,167,121,71,61,165,189,41,192,184,30,189,64,12,0,10,0,0,0,0,0,0,0,0,0,229,0,254,0,2,1,5,48,117,100,0,44,1,112,23,151,7,132,3,197,0,92,4,144,1,64,1,64,1,144,1,48,117,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,48,117,48,117,100,0,100,0,100,0,100,0,48,117,48,117,48,117,100,0,100,0,100,0,48,117,48,117,100,0,100,0,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,44,1,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,8,7,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,112,23,255,255,255,255,255,255,255,255,220,5,220,5,220,5,255,255,255,255,255,255,220,5,220,5,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,44,1,0,0,0,0,138,80,0,0

src/config/generic_18v_300s_4d/bsec_iaq.txt

@@ -90,12 +90,8 @@ extern "C"
 #define BSEC_MAX_STATE_BLOB_SIZE     (139)        /*!< Maximum size (in bytes) of the data blobs returned by bsec_get_state()*/
 #define BSEC_SAMPLE_RATE_DISABLED    (65535.0f)      /*!< Sample rate of a disabled sensor */
 #define BSEC_SAMPLE_RATE_ULP         (0.0033333f)           /*!< Sample rate in case of Ultra Low Power Mode */
-#define BSEC_SAMPLE_RATE_CONTINUOUS  (1.0f)    /*!< Sample rate in case of Continuous Mode */ 
 #define BSEC_SAMPLE_RATE_LP          (0.33333f)            /*!< Sample rate in case of Low Power Mode */
-#define BSEC_SAMPLE_RATE_ULP_MEASUREMENT_ON_DEMAND         (0.0f)            /*!< Input value used to trigger an extra measurement (ULP plus) */        
-#define BSEC_SAMPLE_RATE_HIGH_PERFORMANCE         (0.055556f)            /*!< Sample rate in case of high performance */      
-#define SAMPLE_INTVL_CUSTOM_TPH      (0.066667f)            /*!< Sample rate in case of custom TPH mode */ 
-#define SAMPLE_INTVL_CUSTOM_G        (0.016667f)            /*!< Sample rate in case of custom G mode */  
+#define BSEC_SAMPLE_RATE_ULP_MEASUREMENT_ON_DEMAND         (0.0f)            /*!< Input value used to trigger an extra measurment (ULP plus) */        
 
 #define BSEC_PROCESS_PRESSURE       (1 << (BSEC_INPUT_PRESSURE-1))      /*!< process_data bitfield constant for pressure @sa bsec_bme_settings_t */
 #define BSEC_PROCESS_TEMPERATURE    (1 << (BSEC_INPUT_TEMPERATURE-1))   /*!< process_data bitfield constant for temperature @sa bsec_bme_settings_t */
@@ -165,12 +161,6 @@ typedef enum
      * Generic heat source 8
      */
 
-    /**                                                                               
-     * @brief Internal input for measure on demand                                    
-     *                                                                                
-     * Value indicates, if a measurement is a mod (measurement on demand)             
-     */                                                                               
-    BSEC_INPUT_IS_MEASUREMENT_ON_DEMAND = 22,     /*!< reserved internal debug input */ 
 
     /**
      * @brief Additional input that disables baseline tracker
@@ -181,11 +171,6 @@ typedef enum
      */
     BSEC_INPUT_DISABLE_BASELINE_TRACKER = 23, 
 
-    /**																								
-     * @brief Additional input that provides information about the state of the profile (1-9)		
-     *																								
-     */																								
-    BSEC_INPUT_PROFILE_PART = 24																	
 } bsec_physical_sensor_t;
 
 /*!