Merge pull request #35 from boschsensortec/feature/regression

Algorithm feature release for regression targets.
Library name changed to bsec2 to comply with arduino linting guidelines.
All the bsec configuration releases are now added as part of the reposirotry.

README.md

@@ -2,7 +2,7 @@
 
 ## About BSEC
 
-Bosch Sensortec Environmental Cluster (BSEC) Software v2.4.0.0 released on January 23rd, 2023
+Bosch Sensortec Environmental Cluster (BSEC) Software v2.5.0.2 released on December, 18th 2023
 
 The BSEC fusion library has been conceptualized to provide a higher-level signal processing and fusion for the BME688. The library receives compensated sensor values from the sensor API. It processes the BME688 signals to provide the requested sensor outputs.
 
@@ -32,13 +32,15 @@ Available binaries for download:
 
 | Platform | Compiler | TYPE |
 |----------|----------|------|
-| Cortex-ARM | GCC | Cortex-M0+, M3, M4, M4_FPU, M33_FPU |
+| Cortex-ARM | GCC | Cortex-M0+, M3, M4, M4_FPU, M33, M33_FPU |
 | ESP8266 | xtensa-lx106-elf-gcc | ESP8266 |
 | ESP32 | xtensa-esp32-elf-gcc | ESP32 |
 | ESP32 | xtensa-esp32s2-elf-gcc | ESP32-S2 |
 | ESP32 | xtensa-esp32s3-elf-gcc | ESP32-S3 |
 | ESP32 | riscv32-esp-elf-gcc | ESP32-C3 |
 
+Note: The following libraries are not tested - M4 and M33
+
 The library size information above doesn't include additional dependencies based on the embedded system project & platform.
 
 For other platforms, please contact your local Bosch Sensortec representative
@@ -93,7 +95,7 @@ Select your board and COM port. Upload the example. Open the Serial monitor. You
 
 - basic_config_state.ino: This is an example for illustrating the BSEC feature using desired configuration setting.
 
-- bme68x_demo_sample.ino: This demonstrator application running on an x8 board has the feature of sensor data logging and BSEC algorithm illustrated. Please refer [BME688 Development Kit-Firmware-Quick-Start-Guide](examples/bme68x_demo_sample/Quick_Start_Guide.md) for installing dependent libraries and how to flash.
+- bme68x_demo_sample.ino: This demonstrator application running on an x8 board has the feature of sensor data logging and BSEC algorithm illustration. Please refer [BME688 Development Kit-Firmware-Quick-Start-Guide](examples/bme68x_demo_sample/Quick_Start_Guide.md) for installing dependent libraries and how to flash.
 
 	**Note:** Please ensure to use the bsec_interface_multi.h header file specifically, for demonstrating the multi instance feature
 

examples/bme68x_demo_sample/Quick_Start_Guide.md

@@ -57,21 +57,25 @@ The example code will primarily operate in two modes-
 
 **b. DEMO_TEST_ALGORITHM_MODE**
 
+- Multi sensor support is available in DEMO_RECORDING_MODE upto 8 sensors.
+- Modify NUM_BME68X_UNITS between 0 to 8, where 0 to 7 is for sensor numbers 1 to 8 respectively and 8 is for running all 8 sensors parallely.
+- Multi sensor support is available in DEMO_TEST_ALGORITHM_MODE upto 4 sensors.
+- Modify NUM_BME68X_UNITS between 0 to 4, where 0 to 3 is for sensor numbers 1 to 4 respectively and 4 is for running all 4 sensors parallely.
+
 ### Note:
 
 - After successfully flashing the firmware, "DEMO_RECORDING_MODE" is the default mode set in the example.
 
-- An initial check for the availability of sensor board configuration file (.bmeconfig) inside SD card
-is performed.
+- An initial check for the availability of sensor board configuration file (.bmeconfig) inside SD card is performed.
 
 - For DEMO_RECORDING_MODE, once .bmeconfig file has been detected, it will initialize and set the heater profiles for all the bme688 sensors with the provided configuration and create bme68x datalogger output file (with '.bmerawdata' extension).
 
-- Until the user connects the board to the BME688 demo application through Bluetooth LE, it will continuously collect the data in DEMO_RECORDING_MODE.
+- Until the user connects the board to the BME688 demo application through Bluetooth LE and switches to "DEMO_TEST_ALGORITHM_MODE", it will continue to collect the data in DEMO_RECORDING_MODE.
 
-- When it comes to 'DEMO_TEST_ALGORITHM_MODE' (connecting over bluetooth), initialization of sensor and BSEC library is undertaken.
+- When it comes to 'DEMO_TEST_ALGORITHM_MODE' (connecting over bluetooth and set to "DEMO_TEST_ALGORITHM_MODE"), initialization of sensor and BSEC library is undertaken.
 
-- Furthermore, configuring with the BSEC config file (generated out of training through BME AI Studio or a default configuration from the BSEC website release package) and subscribing for the desired virtual outputs with the supported sample rate is complete, an output data file is created with the '.bsecdata' extension.
+- Furthermore, configuring with the BSEC config file (generated out of training through BME AI Studio or a default configuration from the BSEC website release package) and subscribing for the desired virtual outputs with the supported sample rate is complete, an output data file is created with the '.aiprediction' extension.
 
-- While the bluetooth connection is active, it will continue to operate in the 'DEMO_TEST_ALGORITHM_MODE' and collect the sensor data from one of the sensors in the board for processing and stores the outputs in the output datalog file.
+- If the Bluetooth is disconnected, the board continuous to work in the existing mode unless power is reset.
 
-- Once bluetooth is disconnected, the device switches to the 'DEMO_RECORDING_MODE', where the data is logged into a new  output file (.bmerawdata).
+- The default bootup mode is "DEMO_RECORDING_MODE".