Stuce/sTodo-m5paper-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

first commit

Browse source
This commit is contained in:
stuce-bot 2025-06-30 20:47:33 +02:00
commit 5893b00dd2
1669 changed files with 1982740 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

464
libraries/bsec2/src/bsec2.cpp Normal file
View file

@ -0,0 +1,464 @@
/**
* Copyright (c) 2021 Bosch Sensortec GmbH. All rights reserved.
*
* BSD-3-Clause
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @file bsec2.cpp
* @date 18 July 2024
* @version 2.1.5
*
*/
#include "bsec2.h"
static uint8_t workBuffer[BSEC_MAX_WORKBUFFER_SIZE];
/**
* @brief Constructor of Bsec2 class
*/
Bsec2::Bsec2(void)
{
ovfCounter = 0;
lastMillis = 0;
status = BSEC_OK;
extTempOffset = 0.0f;
opMode = BME68X_SLEEP_MODE;
newDataCallback = nullptr;
bsecInstance = nullptr;
memset(&version, 0, sizeof(version));
memset(&bmeConf, 0, sizeof(bmeConf));
memset(&outputs, 0, sizeof(outputs));
}
/**
* @brief Function to initialize the sensor based on custom callbacks
*/
bool Bsec2::begin(bme68xIntf intf, bme68x_read_fptr_t read, bme68x_write_fptr_t write,
bme68x_delay_us_fptr_t idleTask, void *intfPtr, unsigned long (*millis)())
{
bsecMillis = millis;
sensor.begin(intf, read, write, idleTask, intfPtr);
if (sensor.checkStatus() == BME68X_ERROR)
return false;
return beginCommon();
}
#ifdef ARDUINO
/**
* @brief Function to initialize the sensor based on custom callbacks
*/
bool Bsec2::begin(bme68xIntf intf, bme68x_read_fptr_t read, bme68x_write_fptr_t write,
bme68x_delay_us_fptr_t idleTask, void *intfPtr)
{
bsecMillis = millis;
sensor.begin(intf, read, write, idleTask, intfPtr);
if (sensor.checkStatus() == BME68X_ERROR)
return false;
return beginCommon();
}
/**
* @brief Function to initialize the sensor based on the Wire library
*/
bool Bsec2::begin(uint8_t i2cAddr, TwoWire &i2c, bme68x_delay_us_fptr_t idleTask)
{
bsecMillis = millis;
sensor.begin(i2cAddr, i2c, idleTask);
if (sensor.checkStatus() == BME68X_ERROR)
return false;
return beginCommon();
}
/**
* @brief Function to initialize the sensor based on the SPI library
*/
bool Bsec2::begin(uint8_t chipSelect, SPIClass &spi, bme68x_delay_us_fptr_t idleTask)
{
bsecMillis = millis;
sensor.begin(chipSelect, spi, idleTask);
if (sensor.checkStatus() == BME68X_ERROR)
return false;
return beginCommon();
}
#endif
/**
* @brief Function to request/subscribe for desired virtual outputs with the supported sample rates
*/
bool Bsec2::updateSubscription(bsecSensor sensorList[], uint8_t nSensors, float sampleRate)
{
bsec_sensor_configuration_t virtualSensors[BSEC_NUMBER_OUTPUTS], sensorSettings[BSEC_MAX_PHYSICAL_SENSOR];
uint8_t nSensorSettings = BSEC_MAX_PHYSICAL_SENSOR;
for (uint8_t i = 0; i < nSensors; i++)
{
virtualSensors[i].sensor_id = sensorList[i];
virtualSensors[i].sample_rate = sampleRate;
}
/* Subscribe to library virtual sensors outputs */
status = bsec_update_subscription_m(bsecInstance, virtualSensors, nSensors, sensorSettings, &nSensorSettings);
if (status != BSEC_OK)
return false;
return true;
}
/**
* @brief Callback from the user to read data from the BME68X using parallel mode/forced mode, process and store outputs
*/
bool Bsec2::run(void)
{
uint8_t nFieldsLeft = 0;
bme68xData data;
int64_t currTimeNs = getTimeMs() * INT64_C(1000000);
opMode = bmeConf.op_mode;
if (currTimeNs >= bmeConf.next_call)
{
/* Provides the information about the current sensor configuration that is
necessary to fulfill the input requirements, eg: operation mode, timestamp
at which the sensor data shall be fetched etc */
status = bsec_sensor_control_m(bsecInstance ,currTimeNs, &bmeConf);
if (status != BSEC_OK)
return false;
switch (bmeConf.op_mode)
{
case BME68X_FORCED_MODE:
setBme68xConfigForced();
break;
case BME68X_PARALLEL_MODE:
if (opMode != bmeConf.op_mode)
{
setBme68xConfigParallel();
}
break;
case BME68X_SLEEP_MODE:
if (opMode != bmeConf.op_mode)
{
sensor.setOpMode(BME68X_SLEEP_MODE);
opMode = BME68X_SLEEP_MODE;
}
break;
}
if (sensor.checkStatus() == BME68X_ERROR)
return false;
if (bmeConf.trigger_measurement && bmeConf.op_mode != BME68X_SLEEP_MODE)
{
if (sensor.fetchData())
{
do
{
nFieldsLeft = sensor.getData(data);
/* check for valid gas data */
if (data.status & BME68X_GASM_VALID_MSK)
{
/* Convert sensor raw pressure unit from pascal to hecto pascal */
data.pressure *= 0.01f;
if (!processData(currTimeNs, data))
{
return false;
}
}
} while (nFieldsLeft);
}
}
}
return true;
}
/**
* @brief Function to get the state of the algorithm to save to non-volatile memory
*/
bool Bsec2::getState(uint8_t *state)
{
uint32_t n_serialized_state = BSEC_MAX_STATE_BLOB_SIZE;
status = bsec_get_state_m(bsecInstance, 0, state, BSEC_MAX_STATE_BLOB_SIZE, workBuffer, BSEC_MAX_WORKBUFFER_SIZE,
&n_serialized_state);
if (status != BSEC_OK)
return false;
return true;
}
/**
* @brief Function to set the state of the algorithm from non-volatile memory
*/
bool Bsec2::setState(uint8_t *state)
{
status = bsec_set_state_m(bsecInstance, state, BSEC_MAX_STATE_BLOB_SIZE, workBuffer, BSEC_MAX_WORKBUFFER_SIZE);
if (status != BSEC_OK)
return false;
memset(&bmeConf, 0, sizeof(bmeConf));
return true;
}
/**
* @brief Function to retrieve the current library configuration
*/
bool Bsec2::getConfig(uint8_t *config)
{
uint32_t n_serialized_settings = 0;
status = bsec_get_configuration_m(bsecInstance, 0, config, BSEC_MAX_PROPERTY_BLOB_SIZE, workBuffer, BSEC_MAX_WORKBUFFER_SIZE, &n_serialized_settings);
if (status != BSEC_OK)
return false;
return true;
}
/**
* @brief Function to set the configuration of the algorithm from memory
*/
bool Bsec2::setConfig(const uint8_t *config)
{
status = bsec_set_configuration_m(bsecInstance, config, BSEC_MAX_PROPERTY_BLOB_SIZE, workBuffer, BSEC_MAX_WORKBUFFER_SIZE);
if (status != BSEC_OK)
return false;
memset(&bmeConf, 0, sizeof(bmeConf));
return true;
}
/**
* @brief Function to calculate an int64_t timestamp in milliseconds
*/
int64_t Bsec2::getTimeMs(void)
{
int64_t timeMs = bsecMillis();
if (lastMillis > timeMs) /* An overflow occurred */
{
ovfCounter++;
}
lastMillis = timeMs;
return timeMs + (ovfCounter * INT64_C(0xFFFFFFFF));
}
/**
* @brief Function to assign the memory block to the bsec instance
*/
void Bsec2::allocateMemory(uint8_t (&memBlock)[BSEC_INSTANCE_SIZE])
{
/* allocating memory for the bsec instance */
bsecInstance = memBlock;
}
/**
* @brief Function to de-allocate the dynamically allocated memory
*/
void Bsec2::clearMemory(void)
{
delete[] bsecInstance;
}
/* Private functions */
/**
* @brief Reads data from the BME68X sensor and process it
*/
bool Bsec2::processData(int64_t currTimeNs, const bme68xData &data)
{
bsec_input_t inputs[BSEC_MAX_PHYSICAL_SENSOR]; /* Temp, Pres, Hum & Gas */
uint8_t nInputs = 0;
/* Checks all the required sensor inputs, required for the BSEC library for the requested outputs */
if (BSEC_CHECK_INPUT(bmeConf.process_data, BSEC_INPUT_HEATSOURCE))
{
inputs[nInputs].sensor_id = BSEC_INPUT_HEATSOURCE;
inputs[nInputs].signal = extTempOffset;
inputs[nInputs].time_stamp = currTimeNs;
nInputs++;
}
if (BSEC_CHECK_INPUT(bmeConf.process_data, BSEC_INPUT_TEMPERATURE))
{
#ifdef BME68X_USE_FPU
inputs[nInputs].signal = data.temperature;
#else
inputs[nInputs].signal = data.temperature / 100.0f;
#endif
inputs[nInputs].sensor_id = BSEC_INPUT_TEMPERATURE;
inputs[nInputs].time_stamp = currTimeNs;
nInputs++;
}
if (BSEC_CHECK_INPUT(bmeConf.process_data, BSEC_INPUT_HUMIDITY))
{
#ifdef BME68X_USE_FPU
inputs[nInputs].signal = data.humidity;
#else
inputs[nInputs].signal = data.humidity / 1000.0f;
#endif
inputs[nInputs].sensor_id = BSEC_INPUT_HUMIDITY;
inputs[nInputs].time_stamp = currTimeNs;
nInputs++;
}
if (BSEC_CHECK_INPUT(bmeConf.process_data, BSEC_INPUT_PRESSURE))
{
inputs[nInputs].sensor_id = BSEC_INPUT_PRESSURE;
inputs[nInputs].signal = data.pressure;
inputs[nInputs].time_stamp = currTimeNs;
nInputs++;
}
if (BSEC_CHECK_INPUT(bmeConf.process_data, BSEC_INPUT_GASRESISTOR) &&
(data.status & BME68X_GASM_VALID_MSK))
{
inputs[nInputs].sensor_id = BSEC_INPUT_GASRESISTOR;
inputs[nInputs].signal = data.gas_resistance;
inputs[nInputs].time_stamp = currTimeNs;
nInputs++;
}
if (BSEC_CHECK_INPUT(bmeConf.process_data, BSEC_INPUT_PROFILE_PART) &&
(data.status & BME68X_GASM_VALID_MSK))
{
inputs[nInputs].sensor_id = BSEC_INPUT_PROFILE_PART;
inputs[nInputs].signal = (opMode == BME68X_FORCED_MODE) ? 0 : data.gas_index;
inputs[nInputs].time_stamp = currTimeNs;
nInputs++;
}
if (nInputs > 0)
{
outputs.nOutputs = BSEC_NUMBER_OUTPUTS;
memset(outputs.output, 0, sizeof(outputs.output));
/* Processing of the input signals and returning of output samples is performed by bsec_do_steps() */
status = bsec_do_steps_m(bsecInstance, inputs, nInputs, outputs.output, &outputs.nOutputs);
if (status != BSEC_OK)
return false;
if(newDataCallback)
newDataCallback(data, outputs, *this);
}
return true;
}
/**
* @brief Common code for the begin function
*/
bool Bsec2::beginCommon()
{
if (!bsecInstance)
{
/* allocate memory for the instance if not allocated */
bsecInstance = new uint8_t[bsec_get_instance_size_m()];
}
if (BSEC_INSTANCE_SIZE < bsec_get_instance_size_m())
{
status = BSEC_E_INSUFFICIENT_INSTANCE_SIZE;
return false;
}
status = bsec_init_m(bsecInstance);
if (status != BSEC_OK)
return false;
status = bsec_get_version_m(bsecInstance, &version);
if (status != BSEC_OK)
return false;
memset(&bmeConf, 0, sizeof(bmeConf));
memset(&outputs, 0, sizeof(outputs));
return true;
}
/**
* @brief Set the BME68X sensor configuration to forced mode
*/
void Bsec2::setBme68xConfigForced(void)
{
/* Set the filter, odr, temperature, pressure and humidity settings */
sensor.setTPH(bmeConf.temperature_oversampling, bmeConf.pressure_oversampling, bmeConf.humidity_oversampling);
if (sensor.checkStatus() == BME68X_ERROR)
return;
sensor.setHeaterProf(bmeConf.heater_temperature, bmeConf.heater_duration);
if (sensor.checkStatus() == BME68X_ERROR)
return;
sensor.setOpMode(BME68X_FORCED_MODE);
if (sensor.checkStatus() == BME68X_ERROR)
return;
opMode = BME68X_FORCED_MODE;
}
/**
* @brief Set the BME68X sensor configuration to parallel mode
*/
void Bsec2::setBme68xConfigParallel(void)
{
uint16_t sharedHeaterDur = 0;
/* Set the filter, odr, temperature, pressure and humidity settings */
sensor.setTPH(bmeConf.temperature_oversampling, bmeConf.pressure_oversampling, bmeConf.humidity_oversampling);
if (sensor.checkStatus() == BME68X_ERROR)
return;
sharedHeaterDur = BSEC_TOTAL_HEAT_DUR - (sensor.getMeasDur(BME68X_PARALLEL_MODE) / INT64_C(1000));
sensor.setHeaterProf(bmeConf.heater_temperature_profile, bmeConf.heater_duration_profile, sharedHeaterDur,
bmeConf.heater_profile_len);
if (sensor.checkStatus() == BME68X_ERROR)
return;
sensor.setOpMode(BME68X_PARALLEL_MODE);
if (sensor.checkStatus() == BME68X_ERROR)
return;
opMode = BME68X_PARALLEL_MODE;
}

282
libraries/bsec2/src/bsec2.h Normal file
View file

@ -0,0 +1,282 @@
/**
* Copyright (c) 2021 Bosch Sensortec GmbH. All rights reserved.
*
* BSD-3-Clause
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @file bsec2.h
* @date 18 July 2024
* @version 2.1.5
*
*/
#ifndef BSEC2_H_
#define BSEC2_H_
/* Includes */
#ifdef ARDUINO
#include "Arduino.h"
#include "Wire.h"
#include "SPI.h"
#endif
/* dependent library header */
#include "bme68xLibrary.h"
#include "inc/bsec_datatypes.h"
#include "inc/bsec_interface_multi.h"
#ifndef ARRAY_LEN
#define ARRAY_LEN(array) (sizeof(array)/sizeof(array[0]))
#endif
#define BSEC_CHECK_INPUT(x, shift) (x & (1 << (shift-1)))
#define BSEC_TOTAL_HEAT_DUR UINT16_C(140)
#define BSEC_INSTANCE_SIZE 3272
#define BSEC_E_INSUFFICIENT_INSTANCE_SIZE (bsec_library_return_t)-105
/*
* The default offset provided has been determined by testing the sensor in LP and ULP mode on application board 3.0
* Please update the offset value after testing this on your product
*/
#define TEMP_OFFSET_LP (1.3255f)
#define TEMP_OFFSET_ULP (0.466f)
typedef bsec_output_t bsecData;
typedef bsec_virtual_sensor_t bsecSensor;
typedef struct
{
bsecData output[BSEC_NUMBER_OUTPUTS];
uint8_t nOutputs;
} bsecOutputs;
class Bsec2;
typedef void (*bsecCallback)(const bme68xData data, const bsecOutputs outputs, const Bsec2 bsec);
/* BSEC2 class definition */
class Bsec2
{
public:
Bme68x sensor;
/* Stores the version of the BSEC algorithm */
bsec_version_t version;
bsec_library_return_t status;
Bsec2(void);
/**
* @brief Function to initialize the sensor based on custom callbacks
* @param intf : BME68X_SPI_INTF or BME68X_I2C_INTF interface
* @param read : Read callback
* @param write : Write callback
* @param idleTask : Delay or Idle function
* @param millis : Function to get current time in milliseconds
* @param intfPtr : Pointer to the interface descriptor
* @return True if everything initialized correctly
*/
bool begin(bme68xIntf intf, bme68x_read_fptr_t read, bme68x_write_fptr_t write,
bme68x_delay_us_fptr_t idleTask, void *intfPtr, unsigned long (*millis)());
#ifdef ARDUINO
/**
* @brief Function to initialize the sensor based on custom callbacks
* @param intf : BME68X_SPI_INTF or BME68X_I2C_INTF interface
* @param read : Read callback
* @param write : Write callback
* @param idleTask : Delay or Idle function
* @param intfPtr : Pointer to the interface descriptor
* @return True if everything initialized correctly
*/
bool begin(bme68xIntf intf, bme68x_read_fptr_t read, bme68x_write_fptr_t write,
bme68x_delay_us_fptr_t idleTask, void *intfPtr);
/**
* @brief Function to initialize the sensor based on the Wire library
* @param i2cAddr : The I2C address the sensor is at
* @param i2c : The TwoWire object
* @param idleTask : Delay or Idle function
* @return True if everything initialized correctly
*/
bool begin(uint8_t i2cAddr, TwoWire &i2c, bme68x_delay_us_fptr_t idleTask = bme68xDelayUs);
/**
* @brief Function to initialize the sensor based on the SPI library
* @param chipSelect : The chip select pin for SPI communication
* @param spi : The SPIClass object
* @param idleTask : Delay or Idle function
* @return True if everything initialized correctly
*/
bool begin(uint8_t chipSelect, SPIClass &spi, bme68x_delay_us_fptr_t idleTask = bme68xDelayUs);
#endif
/**
* @brief Function that sets the desired sensors and the sample rates
* @param sensorList : The list of output sensors
* @param nSensors : Number of outputs requested
* @param sampleRate : The sample rate of requested sensors
* @return true for success, false otherwise
*/
bool updateSubscription(bsecSensor sensorList[], uint8_t nSensors, float sampleRate =
BSEC_SAMPLE_RATE_ULP);
/**
* @brief Callback from the user to read data from the BME68x using parallel/forced mode, process and store outputs
* @return true for success, false otherwise
*/
bool run(void);
void attachCallback(bsecCallback callback)
{
newDataCallback = callback;
}
/**
* @brief Function to get the BSEC outputs
* @return pointer to BSEC outputs if available else nullptr
*/
const bsecOutputs* getOutputs(void)
{
if (outputs.nOutputs)
return &outputs;
return nullptr;
}
/**
* @brief Function to get the BSEC output by sensor id
* @return pointer to BSEC output, nullptr otherwise
*/
bsecData getData(bsecSensor id)
{
bsecData emp;
memset(&emp, 0, sizeof(emp));
for (uint8_t i = 0; i < outputs.nOutputs; i++)
if (id == outputs.output[i].sensor_id)
return outputs.output[i];
return emp;
}
/**
* @brief Function to get the state of the algorithm to save to non-volatile memory
* @param state : Pointer to a memory location, to hold the state
* @return true for success, false otherwise
*/
bool getState(uint8_t *state);
/**
* @brief Function to set the state of the algorithm from non-volatile memory
* @param state : Pointer to a memory location that contains the state
* @return true for success, false otherwise
*/
bool setState(uint8_t *state);
/**
* @brief Function to retrieve the current library configuration
* @param config : Pointer to a memory location, to hold the serialized config blob
* @return true for success, false otherwise
*/
bool getConfig(uint8_t *config);
/**
* @brief Function to set the configuration of the algorithm from memory
* @param state : Pointer to a memory location that contains the configuration
* @return true for success, false otherwise
*/
bool setConfig(const uint8_t *config);
/**
* @brief Function to set the temperature offset
* @param tempOffset : Temperature offset in degree Celsius
*/
void setTemperatureOffset(float tempOffset)
{
extTempOffset = tempOffset;
}
/**
* @brief Function to calculate an int64_t timestamp in milliseconds
*/
int64_t getTimeMs(void);
/**
* @brief Function to assign the memory block to the bsec instance
*
* @param[in] memBlock : reference to the memory block
*/
void allocateMemory(uint8_t (&memBlock)[BSEC_INSTANCE_SIZE]);
/**
* @brief Function to de-allocate the dynamically allocated memory
*/
void clearMemory(void);
private:
bsec_bme_settings_t bmeConf;
bsecCallback newDataCallback;
bsecOutputs outputs;
/* operating mode of sensor */
uint8_t opMode;
float extTempOffset;
/** Global variables to help create a millisecond timestamp that doesn't overflow every 51 days.
* If it overflows, it will have a negative value. Something that should never happen.
*/
uint32_t ovfCounter;
unsigned long (*bsecMillis)();
uint32_t lastMillis;
/* Pointer to hold the address of the instance */
uint8_t *bsecInstance;
/**
* @brief Reads the data from the BME68x sensor and process it
* @param currTimeNs: Current time in ns
* @return true if there are new outputs. false otherwise
*/
bool processData(int64_t currTimeNs, const bme68xData &data);
/**
* @brief Common code for the begin function
*/
bool beginCommon();
/**
* @brief Set the BME68x sensor configuration to forced mode
*/
void setBme68xConfigForced(void);
/**
* @brief Set the BME68x sensor configuration to parallel mode
*/
void setBme68xConfigParallel(void);
};
#endif /* BSEC2_CLASS_H */

158
libraries/bsec2/src/commMux/commMux.cpp Normal file
View file

@ -0,0 +1,158 @@
/**
Copyright (c) 2021 Bosch Sensortec GmbH. All rights reserved.
BSD-3-Clause
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
@file commMux.cpp
@date 18 Jul 2024
@version 2.1.5
*/
#ifdef ARDUINO
#include "commMux.h"
#define CLOCK_FREQUENCY UINT32_C(400000)
#define COMM_SPEED UINT32_C(8000000)
const uint8_t I2C_EXPANDER_ADDR = 0x20;
const uint8_t I2C_EXPANDER_OUTPUT_REG_ADDR = 0x01;
const uint8_t I2C_EXPANDER_OUTPUT_DESELECT = 0xFF;
const uint8_t I2C_EXPANDER_CONFIG_REG_ADDR = 0x03;
const uint8_t I2C_EXPANDER_CONFIG_REG_MASK = 0x00;
/**
* @brief Function to configure the communication across sensors
*/
comm_mux comm_mux_set_config(TwoWire &wireobj, SPIClass &spiobj, uint8_t idx, comm_mux &comm)
{
comm.select = ((0x01 << idx) ^ 0xFF);
comm.spiobj = &spiobj;
comm.wireobj = &wireobj;
return comm;
}
/**
* @brief Function to trigger the communication
*/
void comm_mux_begin(TwoWire &wireobj, SPIClass &spiobj)
{
wireobj.begin();
wireobj.setClock(CLOCK_FREQUENCY);
wireobj.beginTransmission(I2C_EXPANDER_ADDR);
wireobj.write(I2C_EXPANDER_CONFIG_REG_ADDR);
wireobj.write(I2C_EXPANDER_CONFIG_REG_MASK);
wireobj.endTransmission();
spiobj.begin();
}
/**
* @brief Function to set the ship select pin of the SPI
*/
static void set_chip_select(TwoWire *wireobj, uint8_t mask)
{
// send I2C-Expander device address
wireobj->beginTransmission(I2C_EXPANDER_ADDR);
// send I2C-Expander output register address
wireobj->write(I2C_EXPANDER_OUTPUT_REG_ADDR);
// send mask to set output level of GPIO pins
wireobj->write(mask);
// end communication
wireobj->endTransmission();
}
/**
* @brief Function to write the sensor data to the register
*/
int8_t comm_mux_write(uint8_t reg_addr, const uint8_t *reg_data, uint32_t length, void *intf_ptr)
{
comm_mux *comm = (comm_mux*) intf_ptr;
uint32_t i = 0;
if (comm)
{
set_chip_select(comm->wireobj, comm->select);
comm->spiobj->beginTransaction(SPISettings(COMM_SPEED, MSBFIRST, SPI_MODE0));
comm->spiobj->transfer(reg_addr);
for (i = 0; i < length; i++)
{
comm->spiobj->transfer(reg_data[i]);
}
comm->spiobj->endTransaction();
set_chip_select(comm->wireobj, I2C_EXPANDER_OUTPUT_DESELECT);
return 0;
}
return 1;
}
/**
* @brief Function to read the sensor data from the register
*/
int8_t comm_mux_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t length, void *intf_ptr)
{
comm_mux *comm = (comm_mux*) intf_ptr;
uint32_t i = 0;
if (comm)
{
set_chip_select(comm->wireobj, comm->select);
comm->spiobj->beginTransaction(SPISettings(COMM_SPEED, MSBFIRST, SPI_MODE0));
comm->spiobj->transfer(reg_addr);
for (i = 0; i < length; i++)
{
reg_data[i] = comm->spiobj->transfer(0xFF);
}
comm->spiobj->endTransaction();
set_chip_select(comm->wireobj, I2C_EXPANDER_OUTPUT_DESELECT);
return 0;
}
return 1;
}
/**
* @brief Function to maintain a delay between communication
*/
void comm_mux_delay(uint32_t period_us, void *intf_ptr)
{
(void) intf_ptr;
delayMicroseconds(period_us);
}
#endif

100
libraries/bsec2/src/commMux/commMux.h Normal file
View file

@ -0,0 +1,100 @@
/**
Copyright (c) 2021 Bosch Sensortec GmbH. All rights reserved.
BSD-3-Clause
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
@file commMux.h
@date 18 Jul 2024
@version 2.1.5
*/
#ifdef ARDUINO
#ifndef COMM_MUX_H
#define COMM_MUX_H
#include "Arduino.h"
#include "Wire.h"
#include "SPI.h"
/**
* Datatype working as an interface descriptor
*/
typedef struct {
TwoWire *wireobj;
SPIClass *spiobj;
uint8_t select;
} comm_mux;
/**
* @brief Function to configure the communication across sensors
* @param wireobj : The TwoWire object
* @param spiobj : The SPIClass object
* @param idx : Selected sensor for communication interface
* @param comm : Structure for selected sensor
* @return : Structure holding the communication setup
*/
comm_mux comm_mux_set_config(TwoWire &wireobj, SPIClass &spiobj, uint8_t idx, comm_mux &comm);
/**
* @brief Function to trigger the communication
* @param wireobj : The TwoWire object
* @param spiobj : The SPIClass object
*/
void comm_mux_begin(TwoWire &wireobj, SPIClass &spiobj);
/**
* @brief Function to write the sensor data to the register
* @param reg_addr : Address of the register
* @param reg_data : Pointer to the data to be written
* @param length : length of the register data
* @param intf_ptr : Pointer to the interface descriptor
* @return 0 if successful, non-zero otherwise
*/
int8_t comm_mux_write(uint8_t reg_addr, const uint8_t *reg_data, uint32_t length, void *intf_ptr);
/**
* @brief Function to read the sensor data from the register
* @param reg_addr : Address of the register
* @param reg_data : Pointer to the data to be read from the sensor
* @param length : length of the register data
* @param intf_ptr : Pointer to the interface descriptor
* @return 0 if successful, non-zero otherwise
*/
int8_t comm_mux_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t length, void *intf_ptr);
/**
* @brief Function to maintain a delay between communication
* @param period_us : Time delay in micro secs
* @param intf_ptr : Pointer to the interface descriptor
*/
void comm_mux_delay(uint32_t period_us, void *intf_ptr);
#endif /* COMM_MUX_H */
#endif

BIN
libraries/bsec2/src/config/FieldAir_HandSanitizer/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/FieldAir_HandSanitizer/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/FieldAir_HandSanitizer/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme680/bme680_iaq_18v_300s_28d/bsec_iaq.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme680/bme680_iaq_18v_300s_28d/bsec_iaq.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme680/bme680_iaq_18v_300s_28d/bsec_iaq.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme680/bme680_iaq_18v_300s_4d/bsec_iaq.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme680/bme680_iaq_18v_300s_4d/bsec_iaq.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme680/bme680_iaq_18v_300s_4d/bsec_iaq.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme680/bme680_iaq_18v_3s_28d/bsec_iaq.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme680/bme680_iaq_18v_3s_28d/bsec_iaq.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme680/bme680_iaq_18v_3s_28d/bsec_iaq.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme680/bme680_iaq_18v_3s_4d/bsec_iaq.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme680/bme680_iaq_18v_3s_4d/bsec_iaq.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme680/bme680_iaq_18v_3s_4d/bsec_iaq.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme680/bme680_iaq_33v_300s_28d/bsec_iaq.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme680/bme680_iaq_33v_300s_28d/bsec_iaq.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme680/bme680_iaq_33v_300s_28d/bsec_iaq.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme680/bme680_iaq_33v_300s_4d/bsec_iaq.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme680/bme680_iaq_33v_300s_4d/bsec_iaq.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme680/bme680_iaq_33v_300s_4d/bsec_iaq.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme680/bme680_iaq_33v_3s_28d/bsec_iaq.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme680/bme680_iaq_33v_3s_28d/bsec_iaq.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme680/bme680_iaq_33v_3s_28d/bsec_iaq.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme680/bme680_iaq_33v_3s_4d/bsec_iaq.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme680/bme680_iaq_33v_3s_4d/bsec_iaq.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme680/bme680_iaq_33v_3s_4d/bsec_iaq.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme688/bme688_reg_18v_300s_4d/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme688/bme688_reg_18v_300s_4d/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme688/bme688_reg_18v_300s_4d/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme688/bme688_sel_18v_300s_28d/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme688/bme688_sel_18v_300s_28d/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme688/bme688_sel_18v_300s_28d/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme688/bme688_sel_18v_300s_4d/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme688/bme688_sel_18v_300s_4d/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme688/bme688_sel_18v_300s_4d/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme688/bme688_sel_18v_3s_28d/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme688/bme688_sel_18v_3s_28d/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme688/bme688_sel_18v_3s_28d/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme688/bme688_sel_18v_3s_4d/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme688/bme688_sel_18v_3s_4d/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme688/bme688_sel_18v_3s_4d/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme688/bme688_sel_33v_300s_28d/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme688/bme688_sel_33v_300s_28d/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme688/bme688_sel_33v_300s_28d/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme688/bme688_sel_33v_300s_4d/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme688/bme688_sel_33v_300s_4d/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme688/bme688_sel_33v_300s_4d/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme688/bme688_sel_33v_3s_28d/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme688/bme688_sel_33v_3s_28d/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme688/bme688_sel_33v_3s_28d/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/config/bme688/bme688_sel_33v_3s_4d/bsec_selectivity.config Normal file
View file

Binary file not shown.

1
libraries/bsec2/src/config/bme688/bme688_sel_33v_3s_4d/bsec_selectivity.csv Normal file
View file

File diff suppressed because one or more lines are too long

1
libraries/bsec2/src/config/bme688/bme688_sel_33v_3s_4d/bsec_selectivity.txt Normal file
View file

File diff suppressed because one or more lines are too long

BIN
libraries/bsec2/src/cortex-m0plus/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/cortex-m0plus/libalgobsec.a.size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
34849 0 3888 38737 9751 (TOTALS)

BIN
libraries/bsec2/src/cortex-m3/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/cortex-m3/libalgobsec.a.size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
31677 0 3888 35565 8aed (TOTALS)

BIN
libraries/bsec2/src/cortex-m33/fpv5-sp-d16-hard/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/cortex-m33/fpv5-sp-d16-hard/libalgobsec.a.Size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
32254 0 3888 36142 8d2e (TOTALS)

BIN
libraries/bsec2/src/cortex-m33/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/cortex-m33/libalgobsec.a.Size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
31697 0 3888 35585 8b01 (TOTALS)

BIN
libraries/bsec2/src/cortex-m4/fpv4-sp-d16-hard/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/cortex-m4/fpv4-sp-d16-hard/libalgobsec.a.size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
32390 0 3888 36278 8db6 (TOTALS)

BIN
libraries/bsec2/src/cortex-m4/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/cortex-m4/libalgobsec.a.size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
31625 0 3888 35513 8ab9 (TOTALS)

BIN
libraries/bsec2/src/esp32/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/esp32/libalgobsec.a.size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
37320 0 3888 41208 a0f8 (TOTALS)

BIN
libraries/bsec2/src/esp32c3/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/esp32c3/libalgobsec.a.Size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
43733 0 3888 47621 ba05 (TOTALS)

BIN
libraries/bsec2/src/esp32s2/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/esp32s2/libalgobsec.a.Size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
39802 0 3888 43690 aaaa (TOTALS)

BIN
libraries/bsec2/src/esp32s3/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/esp32s3/libalgobsec.a.Size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
37043 0 3888 40931 9fe3 (TOTALS)

BIN
libraries/bsec2/src/esp8266/libalgobsec.a Normal file
View file

Binary file not shown.

2
libraries/bsec2/src/esp8266/libalgobsec.a.size.log Normal file
View file

@ -0,0 +1,2 @@
text data bss dec hex filename
42222 0 3888 46110 b41e (TOTALS)

12
libraries/bsec2/src/esp8266/modlib.sh Normal file
View file

@ -0,0 +1,12 @@
ar t libalgobsec.a | awk '{
old=$1;
new=$1;
sub(/\.o/, ".c.o", new);
system("ar x libalgobsec.a "old);
system("ar dS libalgobsec.a "old);
system("mv "old" "new);
system("ar q libalgobsec.a "new);
system("rm "new)
} END {
system("ar s libalgobsec.a")
}'

BIN
libraries/bsec2/src/esp8266/org_libalgobsec.a Normal file
View file

Binary file not shown.

540
libraries/bsec2/src/inc/bsec_datatypes.h Normal file
View file

@ -0,0 +1,540 @@
/**
* Copyright (C) Bosch Sensortec GmbH. All Rights Reserved. Confidential.
*
* Disclaimer
*
* Common:
* Bosch Sensortec products are developed for the consumer goods industry. They may only be used
* within the parameters of the respective valid product data sheet. Bosch Sensortec products are
* provided with the express understanding that there is no warranty of fitness for a particular purpose.
* They are not fit for use in life-sustaining, safety or security sensitive systems or any system or device
* that may lead to bodily harm or property damage if the system or device malfunctions. In addition,
* Bosch Sensortec products are not fit for use in products which interact with motor vehicle systems.
* The resale and/or use of products are at the purchaser's own risk and his own responsibility. The
* examination of fitness for the intended use is the sole responsibility of the Purchaser.
*
* The purchaser shall indemnify Bosch Sensortec from all third party claims, including any claims for
* incidental, or consequential damages, arising from any product use not covered by the parameters of
* the respective valid product data sheet or not approved by Bosch Sensortec and reimburse Bosch
* Sensortec for all costs in connection with such claims.
*
* The purchaser must monitor the market for the purchased products, particularly with regard to
* product safety and inform Bosch Sensortec without delay of all security relevant incidents.
*
* Engineering Samples are marked with an asterisk (*) or (e). Samples may vary from the valid
* technical specifications of the product series. They are therefore not intended or fit for resale to third
* parties or for use in end products. Their sole purpose is internal client testing. The testing of an
* engineering sample may in no way replace the testing of a product series. Bosch Sensortec
* assumes no liability for the use of engineering samples. By accepting the engineering samples, the
* Purchaser agrees to indemnify Bosch Sensortec from all claims arising from the use of engineering
* samples.
*
* Special:
* This software module (hereinafter called "Software") and any information on application-sheets
* (hereinafter called "Information") is provided free of charge for the sole purpose to support your
* application work. The Software and Information is subject to the following terms and conditions:
*
* The Software is specifically designed for the exclusive use for Bosch Sensortec products by
* personnel who have special experience and training. Do not use this Software if you do not have the
* proper experience or training.
*
* This Software package is provided `` as is `` and without any expressed or implied warranties,
* including without limitation, the implied warranties of merchantability and fitness for a particular
* purpose.
*
* Bosch Sensortec and their representatives and agents deny any liability for the functional impairment
* of this Software in terms of fitness, performance and safety. Bosch Sensortec and their
* representatives and agents shall not be liable for any direct or indirect damages or injury, except as
* otherwise stipulated in mandatory applicable law.
*
* The Information provided is believed to be accurate and reliable. Bosch Sensortec assumes no
* responsibility for the consequences of use of such Information nor for any infringement of patents or
* other rights of third parties which may result from its use. No license is granted by implication or
* otherwise under any patent or patent rights of Bosch. Specifications mentioned in the Information are
* subject to change without notice.
*
* It is not allowed to deliver the source code of the Software to any third party without permission of
* Bosch Sensortec.
*
* @file bsec_datatypes.h
*
* @brief
* Contains the data types used by BSEC
*
*/
#ifndef __BSEC_DATATYPES_H__
#define __BSEC_DATATYPES_H__
#ifdef __cplusplus
extern "C"
{
#endif
/*!
* @addtogroup bsec_datatypes BSEC Enumerations and Definitions
* @brief
* @{*/
#ifdef __KERNEL__
#include <linux/types.h>
#endif
#include <stdint.h>
#include <stddef.h>
#define BSEC_MAX_WORKBUFFER_SIZE (4096) /*!< Maximum size (in bytes) of the work buffer */
#define BSEC_MAX_PHYSICAL_SENSOR (8) /*!< Number of physical sensors that need allocated space before calling bsec_update_subscription() */
#define BSEC_MAX_PROPERTY_BLOB_SIZE (1943) /*!< Maximum size (in bytes) of the data blobs returned by bsec_get_configuration() */
#define BSEC_MAX_STATE_BLOB_SIZE (238) /*!< 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_CONT (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 measurment (ULP plus) */
#define BSEC_SAMPLE_RATE_SCAN (0.055556f) /*!< Sample rate in case of scan mode */
#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 */
#define BSEC_PROCESS_HUMIDITY (1 << (BSEC_INPUT_HUMIDITY-1)) /*!< process_data bitfield constant for humidity @sa bsec_bme_settings_t */
#define BSEC_PROCESS_GAS (1 << (BSEC_INPUT_GASRESISTOR-1)) /*!< process_data bitfield constant for gas sensor @sa bsec_bme_settings_t */
#define BSEC_PROCESS_PROFILE_PART (1 << (BSEC_INPUT_PROFILE_PART-1)) /*!< process_data bitfield constant for gas sensor @sa bsec_bme_settings_t */
#define BSEC_NUMBER_OUTPUTS (23) /*!< Number of outputs, depending on solution */
#define BSEC_OUTPUT_INCLUDED (1072855535) /*!< bitfield that indicates which outputs are included in the solution */
/*!
* @brief Enumeration for input (physical) sensors.
*
* Used to populate bsec_input_t::sensor_id. It is also used in bsec_sensor_configuration_t::sensor_id structs
* returned in the parameter required_sensor_settings of bsec_update_subscription().
*
* @sa bsec_sensor_configuration_t @sa bsec_input_t
*/
typedef enum
{
/**
* @brief Pressure sensor output of BME68x [Pa]
*/
BSEC_INPUT_PRESSURE = 1,
/**
* @brief Humidity sensor output of BME68x [%]
*
* @note Relative humidity strongly depends on the temperature (it is measured at). It may require a conversion to
* the temperature outside of the device.
*
* @sa bsec_virtual_sensor_t
*/
BSEC_INPUT_HUMIDITY = 2,
/**
* @brief Temperature sensor output of BME68x [degrees Celsius]
*
* @note The BME68x is factory trimmed, thus the temperature sensor of the BME68x is very accurate.
* The temperature value is a very local measurement value and can be influenced by external heat sources.
*
* @sa bsec_virtual_sensor_t
*/
BSEC_INPUT_TEMPERATURE = 3,
/**
* @brief Gas sensor resistance output of BME68x [Ohm]
*
* The resistance value changes due to varying VOC concentrations (the higher the concentration of reducing VOCs,
* the lower the resistance and vice versa).
*/
BSEC_INPUT_GASRESISTOR = 4, /*!< */
/**
* @brief Additional input for device heat compensation
*
* IAQ solution: The value is subtracted from ::BSEC_INPUT_TEMPERATURE to compute
* ::BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_TEMPERATURE.
*
* ALL solution: Generic heat source 1
*
* @sa bsec_virtual_sensor_t
*/
BSEC_INPUT_HEATSOURCE = 14,
/**
* @brief Additional input that disables baseline tracker
*
* 0 - Normal,
* 1 - Event 1,
* 2 - Event 2
*/
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;
/*!
* @brief Enumeration for output (virtual) sensors
*
* Used to populate bsec_output_t::sensor_id. It is also used in bsec_sensor_configuration_t::sensor_id structs
* passed in the parameter requested_virtual_sensors of bsec_update_subscription().
*
* @sa bsec_sensor_configuration_t @sa bsec_output_t
*/
typedef enum
{
/**
* @brief Indoor-air-quality estimate [0-500]
*
* Indoor-air-quality (IAQ) gives an indication of the relative change in ambient TVOCs detected by BME68x.
*
* @note The IAQ scale ranges from 0 (clean air) to 500 (heavily polluted air). During operation, algorithms
* automatically calibrate and adapt themselves to the typical environments where the sensor is operated
* (e.g., home, workplace, inside a car, etc.).This automatic background calibration ensures that users experience
* consistent IAQ performance. The calibration process considers the recent measurement history (typ. up to four
* days) to ensure that IAQ=50 corresponds to typical good air and IAQ=200 indicates typical polluted air.
*/
BSEC_OUTPUT_IAQ = 1,
BSEC_OUTPUT_STATIC_IAQ = 2, /*!< Unscaled indoor-air-quality estimate */
BSEC_OUTPUT_CO2_EQUIVALENT = 3, /*!< CO2 equivalent estimate [ppm] */
BSEC_OUTPUT_BREATH_VOC_EQUIVALENT = 4, /*!< Breath VOC concentration estimate [ppm] */
/**
* @brief Temperature sensor signal [degrees Celsius]
*
* Temperature directly measured by BME68x in degree Celsius.
*
* @note This value is cross-influenced by the sensor heating and device specific heating.
*/
BSEC_OUTPUT_RAW_TEMPERATURE = 6,
/**
* @brief Pressure sensor signal [Pa]
*
* Pressure directly measured by the BME68x in Pa.
*/
BSEC_OUTPUT_RAW_PRESSURE = 7,
/**
* @brief Relative humidity sensor signal [%]
*
* Relative humidity directly measured by the BME68x in %.
*
* @note This value is cross-influenced by the sensor heating and device specific heating.
*/
BSEC_OUTPUT_RAW_HUMIDITY = 8,
/**
* @brief Gas sensor signal [Ohm]
*
* Gas resistance measured directly by the BME68x in Ohm.The resistance value changes due to varying VOC
* concentrations (the higher the concentration of reducing VOCs, the lower the resistance and vice versa).
*/
BSEC_OUTPUT_RAW_GAS = 9,
/**
* @brief Gas sensor stabilization status [boolean]
*
* Indicates initial stabilization status of the gas sensor element: stabilization is ongoing (0) or stabilization
* is finished (1).
*/
BSEC_OUTPUT_STABILIZATION_STATUS = 12,
/**
* @brief Gas sensor run-in status [boolean]
*
* Dynamicaly tracks the power-on stabilization of the gas sensor element: stabilization is ongoing (0) or stabilization
* is finished (1). It depends on how long the sensor has been turn off. A power-on conditioning has been employed for early stabilization of BME sensors.
*/
BSEC_OUTPUT_RUN_IN_STATUS = 13,
/**
* @brief Sensor heat compensated temperature [degrees Celsius]
*
* Temperature measured by BME68x which is compensated for the influence of sensor (heater) in degree Celsius.
* The self heating introduced by the heater is depending on the sensor operation mode and the sensor supply voltage.
*
*
* @note In addition, the temperature output can be compensated by an user defined value
* (::BSEC_INPUT_HEATSOURCE in degrees Celsius), which represents the device specific self-heating.
*
* Thus, the value is calculated as follows:
* * ```BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_TEMPERATURE = ::BSEC_INPUT_TEMPERATURE - function(sensor operation mode, sensor supply voltage) - ::BSEC_INPUT_HEATSOURCE```
*
*
* The self-heating in operation mode BSEC_SAMPLE_RATE_ULP is negligible.
* The self-heating in operation mode BSEC_SAMPLE_RATE_LP is supported for 1.8V by default (no config file required). If the BME68x sensor supply voltage is 3.3V, the corresponding config file shall be used.
*/
BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_TEMPERATURE = 14,
/**
* @brief Sensor heat compensated humidity [%]
*
* Relative humidity measured by BME68x which is compensated for the influence of sensor (heater) in %.
*
* It converts the ::BSEC_INPUT_HUMIDITY from temperature ::BSEC_INPUT_TEMPERATURE to temperature
* ::BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_TEMPERATURE.
*
* @note If ::BSEC_INPUT_HEATSOURCE is used for device specific temperature compensation, it will be
* effective for ::BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_HUMIDITY too.
*/
BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_HUMIDITY = 15,
/**
* @brief Raw gas resistance compensated by temperature and humidity influences [ohm].
*
* The effect of temperature and humidity on the gas resistance is eleminated to a good extend and it is further linearized
* to log scale for estimation of the compensated gas resistance.
*
*/
BSEC_OUTPUT_COMPENSATED_GAS = 18,
BSEC_OUTPUT_GAS_PERCENTAGE = 21, /*!< Percentage of min and max filtered gas value [%] */
/**
* @brief Gas estimate output channel 1 [0-1]
*
* The gas scan result is given in probability for each of the used gases.
* In standard scan mode, the probability of H2S and non-H2S is provided by the variables BSEC_OUTPUT_GAS_ESTIMATE_1 & BSEC_OUTPUT_GAS_ESTIMATE_2 respectively. A maximum of 4 classes can be used by configuring using BME AI-studio.
*/
BSEC_OUTPUT_GAS_ESTIMATE_1 = 22,
BSEC_OUTPUT_GAS_ESTIMATE_2 = 23, /*!< Gas estimate output channel 2 [0-1] */
BSEC_OUTPUT_GAS_ESTIMATE_3 = 24, /*!< Gas estimate output channel 3 [0-1] */
BSEC_OUTPUT_GAS_ESTIMATE_4 = 25, /*!< Gas estimate output channel 4 [0-1] */
BSEC_OUTPUT_RAW_GAS_INDEX = 26, /*!< Gas index cyclically running from 0 to heater_profile_length-1, range of heater profile length is from 1 to 10, default being 10 */
/**
* @brief Regression estimate output channel 1
*
* The regression estimate gives the quantitative measurement of the gases used.
* In standard scan mode, quantification of the gas is provided by the variables BSEC_OUTPUT_REGRESSION_ESTIMATE_1. A maximum of 4 gas targets can be used by configuring using BME AI-studio.
*/
BSEC_OUTPUT_REGRESSION_ESTIMATE_1 = 27,
BSEC_OUTPUT_REGRESSION_ESTIMATE_2 = 28, /*!< Regression estimate output channel 2 */
BSEC_OUTPUT_REGRESSION_ESTIMATE_3 = 29, /*!< Regression estimate output channel 3 */
BSEC_OUTPUT_REGRESSION_ESTIMATE_4 = 30 /*!< Regression estimate output channel 4 */
} bsec_virtual_sensor_t;
/*!
* @brief Enumeration for function return codes
*/
typedef enum
{
BSEC_OK = 0, /*!< Function execution successful */
BSEC_E_DOSTEPS_INVALIDINPUT = -1, /*!< Input (physical) sensor id passed to bsec_do_steps() is not in the valid range or not valid for requested virtual sensor */
BSEC_E_DOSTEPS_VALUELIMITS = -2, /*!< Value of input (physical) sensor signal passed to bsec_do_steps() is not in the valid range */
BSEC_W_DOSTEPS_TSINTRADIFFOUTOFRANGE = 4, /*!< Past timestamps passed to bsec_do_steps() */
BSEC_E_DOSTEPS_DUPLICATEINPUT = -6, /*!< Duplicate input (physical) sensor ids passed as input to bsec_do_steps() */
BSEC_I_DOSTEPS_NOOUTPUTSRETURNABLE = 2, /*!< No memory allocated to hold return values from bsec_do_steps(), i.e., n_outputs == 0 */
BSEC_W_DOSTEPS_EXCESSOUTPUTS = 3, /*!< Not enough memory allocated to hold return values from bsec_do_steps(), i.e., n_outputs < maximum number of requested output (virtual) sensors */
BSEC_W_DOSTEPS_GASINDEXMISS = 5, /*!< Gas index not provided to bsec_do_steps() */
BSEC_E_SU_WRONGDATARATE = -10, /*!< The sample_rate of the requested output (virtual) sensor passed to bsec_update_subscription() is zero */
BSEC_E_SU_SAMPLERATELIMITS = -12, /*!< The sample_rate of the requested output (virtual) sensor passed to bsec_update_subscription() does not match with the sampling rate allowed for that sensor */
BSEC_E_SU_DUPLICATEGATE = -13, /*!< Duplicate output (virtual) sensor ids requested through bsec_update_subscription() */
BSEC_E_SU_INVALIDSAMPLERATE = -14, /*!< The sample_rate of the requested output (virtual) sensor passed to bsec_update_subscription() does not fall within the global minimum and maximum sampling rates */
BSEC_E_SU_GATECOUNTEXCEEDSARRAY = -15, /*!< Not enough memory allocated to hold returned input (physical) sensor data from bsec_update_subscription(), i.e., n_required_sensor_settings ::BSEC_MAX_PHYSICAL_SENSOR */
BSEC_E_SU_SAMPLINTVLINTEGERMULT = -16, /*!< The sample_rate of the requested output (virtual) sensor passed to bsec_update_subscription() is not correct */
BSEC_E_SU_MULTGASSAMPLINTVL = -17, /*!< The sample_rate of the requested output (virtual), which requires the gas sensor, is not equal to the sample_rate that the gas sensor is being operated */
BSEC_E_SU_HIGHHEATERONDURATION = -18, /*!< The duration of one measurement is longer than the requested sampling interval */
BSEC_W_SU_UNKNOWNOUTPUTGATE = 10, /*!< Output (virtual) sensor id passed to bsec_update_subscription() is not in the valid range; e.g., n_requested_virtual_sensors > actual number of output (virtual) sensors requested */
BSEC_W_SU_MODINNOULP = 11, /*!< ULP plus can not be requested in non-ulp mode */ /*MOD_ONLY*/
BSEC_I_SU_SUBSCRIBEDOUTPUTGATES = 12, /*!< No output (virtual) sensor data were requested via bsec_update_subscription() */
BSEC_I_SU_GASESTIMATEPRECEDENCE = 13, /*!< GAS_ESTIMATE is suscribed and take precedence over other requested outputs */
BSEC_W_SU_SAMPLERATEMISMATCH = 14, /*!< Subscriped sample rate of the output is not matching with configured sample rate. For example if user used the configuration of ULP and outputs subscribed for LP mode this warning will inform the user about this mismatch*/
BSEC_E_PARSE_SECTIONEXCEEDSWORKBUFFER = -32, /*!< n_work_buffer_size passed to bsec_set_[configuration/state]() not sufficient */
BSEC_E_CONFIG_FAIL = -33, /*!< Configuration failed */
BSEC_E_CONFIG_VERSIONMISMATCH = -34, /*!< Version encoded in serialized_[settings/state] passed to bsec_set_[configuration/state]() does not match with current version */
BSEC_E_CONFIG_FEATUREMISMATCH = -35, /*!< Enabled features encoded in serialized_[settings/state] passed to bsec_set_[configuration/state]() does not match with current library implementation or subscribed outputs*/
BSEC_E_CONFIG_CRCMISMATCH = -36, /*!< serialized_[settings/state] passed to bsec_set_[configuration/state]() is corrupted */
BSEC_E_CONFIG_EMPTY = -37, /*!< n_serialized_[settings/state] passed to bsec_set_[configuration/state]() is to short to be valid */
BSEC_E_CONFIG_INSUFFICIENTWORKBUFFER = -38, /*!< Provided work_buffer is not large enough to hold the desired string */
BSEC_E_CONFIG_INVALIDSTRINGSIZE = -40, /*!< String size encoded in configuration/state strings passed to bsec_set_[configuration/state]() does not match with the actual string size n_serialized_[settings/state] passed to these functions */
BSEC_E_CONFIG_INSUFFICIENTBUFFER = -41, /*!< String buffer insufficient to hold serialized data from BSEC library */
BSEC_E_SET_INVALIDCHANNELIDENTIFIER = -100, /*!< Internal error code, size of work buffer in setConfig must be set to #BSEC_MAX_WORKBUFFER_SIZE */
BSEC_E_SET_INVALIDLENGTH = -104, /*!< Internal error code */
BSEC_W_SC_CALL_TIMING_VIOLATION = 100, /*!< Difference between actual and defined sampling intervals of bsec_sensor_control() greater than allowed */
BSEC_W_SC_MODEXCEEDULPTIMELIMIT = 101, /*!< ULP plus is not allowed because an ULP measurement just took or will take place */ /*MOD_ONLY*/
BSEC_W_SC_MODINSUFFICIENTWAITTIME = 102 /*!< ULP plus is not allowed because not sufficient time passed since last ULP plus */ /*MOD_ONLY*/
} bsec_library_return_t;
/*!
* @brief Structure containing the version information
*
* Please note that configuration and state strings are coded to a specific version and will not be accepted by other
* versions of BSEC.
*
*/
typedef struct
{
uint8_t major; /**< @brief Major version */
uint8_t minor; /**< @brief Minor version */
uint8_t major_bugfix; /**< @brief Major bug fix version */
uint8_t minor_bugfix; /**< @brief Minor bug fix version */
} bsec_version_t;
/*!
* @brief Structure describing an input sample to the library
*
* Each input sample is provided to BSEC as an element in a struct array of this type. Timestamps must be provided
* in nanosecond resolution. Moreover, duplicate timestamps for subsequent samples are not allowed and will results in
* an error code being returned from bsec_do_steps().
*
* The meaning unit of the signal field are determined by the bsec_input_t::sensor_id field content. Possible
* bsec_input_t::sensor_id values and and their meaning are described in ::bsec_physical_sensor_t.
*
* @sa bsec_physical_sensor_t
*
*/
typedef struct
{
/**
* @brief Time stamp in nanosecond resolution [ns]
*
* Timestamps must be provided as non-repeating and increasing values. They can have their 0-points at system start or
* at a defined wall-clock time (e.g., 01-Jan-1970 00:00:00)
*/
int64_t time_stamp;
float signal; /*!< @brief Signal sample in the unit defined for the respective sensor_id @sa bsec_physical_sensor_t */
uint8_t signal_dimensions; /*!< @brief Signal dimensions (reserved for future use, shall be set to 1) */
uint8_t sensor_id; /*!< @brief Identifier of physical sensor @sa bsec_physical_sensor_t */
} bsec_input_t;
/*!
* @brief Structure describing an output sample of the library
*
* Each output sample is returned from BSEC by populating the element of a struct array of this type. The contents of
* the signal field is defined by the supplied bsec_output_t::sensor_id. Possible output
* bsec_output_t::sensor_id values are defined in ::bsec_virtual_sensor_t.
*
* @sa bsec_virtual_sensor_t
*/
typedef struct
{
int64_t time_stamp; /*!< @brief Time stamp in nanosecond resolution as provided as input [ns] */
float signal; /*!< @brief Signal sample in the unit defined for the respective bsec_output_t::sensor_id @sa bsec_virtual_sensor_t */
uint8_t signal_dimensions; /*!< @brief Signal dimensions (reserved for future use, shall be set to 1) */
uint8_t sensor_id; /*!< @brief Identifier of virtual sensor @sa bsec_virtual_sensor_t */
/**
* @brief Accuracy status 0-3
*
* Some virtual sensors provide a value in the accuracy field. If this is the case, the meaning of the field is as
* follows:
*
* | Name | Value | Accuracy description |
* |----------------------------|-------|-------------------------------------------------------------------------------------------------------------|
* | UNRELIABLE | 0 | Sensor data is unreliable, the sensor must be calibrated |
* | LOW_ACCURACY | 1 | Reliability of virtual sensor is low, sensor should be calibrated |
* | MEDIUM_ACCURACY | 2 | Medium reliability, sensor calibration or training may improve performance |
* | HIGH_ACCURACY | 3 | High reliability |
*
* For example:
*
* - IAQ accuracy indicator will notify the user when she/he should initiate a calibration process. Calibration is
* performed automatically in the background if the sensor is exposed to clean and polluted air for approximately
* 30 minutes each.
*
* | Virtual sensor | Value | Accuracy description |
* |----------------------------|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
* | IAQ | 0 | Stabilization / run-in ongoing |
* | | 1 | Low accuracy,to reach high accuracy(3),please expose sensor once to good air (e.g. outdoor air) and bad air (e.g. box with exhaled breath) for auto-trimming |
* | | 2 | Medium accuracy: auto-trimming ongoing |
* | | 3 | High accuracy
*
* - Gas estimator accuracy indicator will notify the user when she/he gets valid gas prediction output.
*
* | Virtual sensor | Value | Accuracy description |
* |----------------------------|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
* | GAS_ESTIMATE_x* | 0 | No valid gas estimate found - BSEC collecting gas features |
* | | 3 | Gas estimate prediction available |
*
* <sup>*</sup> GAS_ESTIMATE_1, GAS_ESTIMATE_2, GAS_ESTIMATE_3, GAS_ESTIMATE_4
* - Regression estimate accuracy will notify the user when she/he gets valid regression estimate output.
*
* | Virtual sensor | Value | Accuracy description |
* |----------------------------|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
* | REGRESSION_ESTIMATE_x* | 0 | No valid regression estimate output found - BSEC collecting gas features |
* | | 2 | Predicted regression estimate output is not within the value of the label present in the training data |
* | | 3 | Predicted regression estimate output is within the the value of the label present in the training data |
*
* <sup>*</sup> REGRESSION_ESTIMATE_1, REGRESSION_ESTIMATE_2, REGRESSION_ESTIMATE_3, REGRESSION_ESTIMATE_4
*/
uint8_t accuracy;
} bsec_output_t;
/*!
* @brief Structure describing sample rate of physical/virtual sensors
*
* This structure is used together with bsec_update_subscription() to enable BSEC outputs and to retrieve information
* about the sample rates used for BSEC inputs.
*/
typedef struct
{
/**
* @brief Sample rate of the virtual or physical sensor in Hertz [Hz]
*
* Only supported sample rates are allowed.
*/
float sample_rate;
/**
* @brief Identifier of the virtual or physical sensor
*
* The meaning of this field changes depending on whether the structs are as the requested_virtual_sensors argument
* to bsec_update_subscription() or as the required_sensor_settings argument.
*
* | bsec_update_subscription() argument | sensor_id field interpretation |
* |-------------------------------------|--------------------------------|
* | requested_virtual_sensors | ::bsec_virtual_sensor_t |
* | required_sensor_settings | ::bsec_physical_sensor_t |
*
* @sa bsec_physical_sensor_t
* @sa bsec_virtual_sensor_t
*/
uint8_t sensor_id;
} bsec_sensor_configuration_t;
/*!
* @brief Structure returned by bsec_sensor_control() to configure BME68x sensor
*
* This structure contains settings that must be used to configure the BME68x to perform a forced-mode measurement.
* A measurement should only be executed if bsec_bme_settings_t::trigger_measurement is 1. If so, the oversampling
* settings for temperature, humidity, and pressure should be set to the provided settings provided in
* bsec_bme_settings_t::temperature_oversampling, bsec_bme_settings_t::humidity_oversampling, and
* bsec_bme_settings_t::pressure_oversampling, respectively.
*
* In case of bsec_bme_settings_t::run_gas = 1, the gas sensor must be enabled with the provided
* bsec_bme_settings_t::heater_temperature and bsec_bme_settings_t::heating_duration settings.
*/
typedef struct
{
int64_t next_call; /*!< @brief Time stamp of the next call of the sensor_control*/
uint32_t process_data; /*!< @brief Bit field describing which data is to be passed to bsec_do_steps() @sa BSEC_PROCESS_GAS, BSEC_PROCESS_TEMPERATURE, BSEC_PROCESS_HUMIDITY, BSEC_PROCESS_PRESSURE */
uint16_t heater_temperature; /*!< @brief Heater temperature [degrees Celsius] */
uint16_t heater_duration; /*!< @brief Heater duration [ms] */
uint16_t heater_temperature_profile[10];/*!< @brief Heater temperature profile [degrees Celsius] */
uint16_t heater_duration_profile[10]; /*!< @brief Heater duration profile [ms] */
uint8_t heater_profile_len; /*!< @brief Heater profile length [0-10] */
uint8_t run_gas; /*!< @brief Enable gas measurements [0/1] */
uint8_t pressure_oversampling; /*!< @brief Pressure oversampling settings [0-5] */
uint8_t temperature_oversampling; /*!< @brief Temperature oversampling settings [0-5] */
uint8_t humidity_oversampling; /*!< @brief Humidity oversampling settings [0-5] */
uint8_t trigger_measurement; /*!< @brief Trigger a forced measurement with these settings now [0/1] */
uint8_t op_mode; /*!< @brief Sensor operation mode [0/1] */
} bsec_bme_settings_t;
/* internal defines and backward compatibility */
#define BSEC_STRUCT_NAME Bsec /*!< Internal struct name */
/*@}*/
#ifdef __cplusplus
}
#endif
#endif

563
libraries/bsec2/src/inc/bsec_interface.h Normal file
View file

@ -0,0 +1,563 @@
/**
* Copyright (C) Bosch Sensortec GmbH. All Rights Reserved. Confidential.
*
* Disclaimer
*
* Common:
* Bosch Sensortec products are developed for the consumer goods industry. They may only be used
* within the parameters of the respective valid product data sheet. Bosch Sensortec products are
* provided with the express understanding that there is no warranty of fitness for a particular purpose.
* They are not fit for use in life-sustaining, safety or security sensitive systems or any system or device
* that may lead to bodily harm or property damage if the system or device malfunctions. In addition,
* Bosch Sensortec products are not fit for use in products which interact with motor vehicle systems.
* The resale and/or use of products are at the purchaser's own risk and his own responsibility. The
* examination of fitness for the intended use is the sole responsibility of the Purchaser.
*
* The purchaser shall indemnify Bosch Sensortec from all third party claims, including any claims for
* incidental, or consequential damages, arising from any product use not covered by the parameters of
* the respective valid product data sheet or not approved by Bosch Sensortec and reimburse Bosch
* Sensortec for all costs in connection with such claims.
*
* The purchaser must monitor the market for the purchased products, particularly with regard to
* product safety and inform Bosch Sensortec without delay of all security relevant incidents.
*
* Engineering Samples are marked with an asterisk (*) or (e). Samples may vary from the valid
* technical specifications of the product series. They are therefore not intended or fit for resale to third
* parties or for use in end products. Their sole purpose is internal client testing. The testing of an
* engineering sample may in no way replace the testing of a product series. Bosch Sensortec
* assumes no liability for the use of engineering samples. By accepting the engineering samples, the
* Purchaser agrees to indemnify Bosch Sensortec from all claims arising from the use of engineering
* samples.
*
* Special:
* This software module (hereinafter called "Software") and any information on application-sheets
* (hereinafter called "Information") is provided free of charge for the sole purpose to support your
* application work. The Software and Information is subject to the following terms and conditions:
*
* The Software is specifically designed for the exclusive use for Bosch Sensortec products by
* personnel who have special experience and training. Do not use this Software if you do not have the
* proper experience or training.
*
* This Software package is provided `` as is `` and without any expressed or implied warranties,
* including without limitation, the implied warranties of merchantability and fitness for a particular
* purpose.
*
* Bosch Sensortec and their representatives and agents deny any liability for the functional impairment
* of this Software in terms of fitness, performance and safety. Bosch Sensortec and their
* representatives and agents shall not be liable for any direct or indirect damages or injury, except as
* otherwise stipulated in mandatory applicable law.
*
* The Information provided is believed to be accurate and reliable. Bosch Sensortec assumes no
* responsibility for the consequences of use of such Information nor for any infringement of patents or
* other rights of third parties which may result from its use. No license is granted by implication or
* otherwise under any patent or patent rights of Bosch. Specifications mentioned in the Information are
* subject to change without notice.
*
* It is not allowed to deliver the source code of the Software to any third party without permission of
* Bosch Sensortec.
*
* @file bsec_interface.h
*
* @brief
* Contains the API for BSEC
*
*/
#ifndef __BSEC_INTERFACE_H__
#define __BSEC_INTERFACE_H__
#include "bsec_datatypes.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! @addtogroup bsec_interface BSEC Standard Interfaces
* @brief Standard interfaces of BSEC signal processing library.
* These interfaces supports in interfacing single BME68x sensor with the BSEC library.
*
* ### Interface usage
*
* The following provides a short overview on the typical operation sequence for BSEC.
*
* - Initialization of the library
*
* | Steps | Function |
* |---------------------------------------------------------------------|--------------------------|
* | Initialization of library | bsec_init() |
* | Update configuration settings (optional) | bsec_set_configuration() |
* | Restore the state of the library (optional) | bsec_set_state() |
*
*
* - The following function is called to enable output signals and define their sampling rate / operation mode.
*
* | Steps | Function |
* |---------------------------------------------|----------------------------|
* | Enable library outputs with specified mode | bsec_update_subscription() |
*
*
* - This table describes the main processing loop.
*
* | Steps | Function |
* |-------------------------------------------|----------------------------------|
* | Retrieve sensor settings to be used | bsec_sensor_control() |
* | Configure sensor and trigger measurement | [See BME68x API and example codes](https://github.com/BoschSensortec/BME68x-Sensor-API) |
* | Read results from sensor | [See BME68x API and example codes](https://github.com/BoschSensortec/BME68x-Sensor-API) |
* | Perform signal processing | bsec_do_steps() |
*
*
* - Before shutting down the system, the current state of BSEC can be retrieved and can then be used during
* re-initialization to continue processing.
*
* | Steps | Function |
* |---------------------------------------------|-------------------|
* | Retrieve the current library state | bsec_get_state() |
* | Retrieve the current library configuration | bsec_get_configuration() |
*
*
* ### Configuration and state
*
* Values of variables belonging to a BSEC instance are divided into two groups:
* - Values **not updated by processing** of signals belong to the **configuration group**. If available, BSEC can be
* configured before use with a customer specific configuration string.
* - Values **updated during processing** are member of the **state group**. Saving and restoring of the state of BSEC
* is necessary to maintain previously estimated sensor models and baseline information which is important for best
* performance of the gas sensor outputs.
*
* @note BSEC library consists of adaptive algorithms which models the gas sensor which improves its performance over
* the time. These will be lost if library is initialized due to system reset. In order to avoid this situation
* library state shall be stored in non volatile memory so that it can be loaded after system reset.
*
*
* @{
*/
/*!
* @brief Return the version information of BSEC library
*
* @param [out] bsec_version_p pointer to struct which is to be populated with the version information
*
* @return Zero if successful, otherwise an error code
*
* See also: bsec_version_t
*
\code{.c}
// Example //
bsec_version_t version;
bsec_get_version(&version);
printf("BSEC version: %d.%d.%d.%d",version.major, version.minor, version.major_bugfix, version.minor_bugfix);
\endcode
*/
bsec_library_return_t bsec_get_version(bsec_version_t * bsec_version_p);
/*!
* @brief Initialize the library
*
* Initialization and reset of BSEC is performed by calling bsec_init(). Calling this function sets up the relation
* among all internal modules, initializes run-time dependent library states and resets the configuration and state
* of all BSEC signal processing modules to defaults.
*
* Before any further use, the library must be initialized. This ensure that all memory and states are in defined
* conditions prior to processing any data.
*
* @return Zero if successful, otherwise an error code
*
\code{.c}
// Initialize BSEC library before further use
bsec_init();
\endcode
*/
bsec_library_return_t bsec_init(void);
/*!
* @brief Subscribe to library virtual sensors outputs
*
* Use bsec_update_subscription() to instruct BSEC which of the processed output signals are requested at which sample rates.
* See ::bsec_virtual_sensor_t for available library outputs.
*
* Based on the requested virtual sensors outputs, BSEC will provide information about the required physical sensor input signals
* (see ::bsec_physical_sensor_t) with corresponding sample rates. This information is purely informational as bsec_sensor_control()
* will ensure the sensor is operated in the required manner. To disable a virtual sensor, set the sample rate to ::BSEC_SAMPLE_RATE_DISABLED.
*
* The subscription update using bsec_update_subscription() is apart from the signal processing one of the the most
* important functions. It allows to enable the desired library outputs. The function determines which physical input
* sensor signals are required at which sample rate to produce the virtual output sensor signals requested by the user.
* When this function returns with success, the requested outputs are called subscribed. A very important feature is the
* retaining of already subscribed outputs. Further outputs can be requested or disabled both individually and
* group-wise in addition to already subscribed outputs without changing them unless a change of already subscribed
* outputs is requested.
*
* @note The state of the library concerning the subscribed outputs cannot be retained among reboots.
*
* The interface of bsec_update_subscription() requires the usage of arrays of sensor configuration structures.
* Such a structure has the fields sensor identifier and sample rate. These fields have the properties:
* - Output signals of virtual sensors must be requested using unique identifiers (Member of ::bsec_virtual_sensor_t)
* - Different sets of identifiers are available for inputs of physical sensors and outputs of virtual sensors
* - Identifiers are unique values defined by the library, not from external
* - Sample rates must be provided as value of
* - An allowed sample rate for continuously sampled signals
* - 65535.0f (BSEC_SAMPLE_RATE_DISABLED) to turn off outputs and identify disabled inputs
*
* @note The same sensor identifiers are also used within the functions bsec_do_steps().
*
* The usage principles of bsec_update_subscription() are:
* - Differential updates (i.e., only asking for outputs that the user would like to change) is supported.
* - Invalid requests of outputs are ignored. Also if one of the requested outputs is unavailable, all the requests
* are ignored. At the same time, a warning is returned.
* - To disable BSEC, all outputs shall be turned off. Only enabled (subscribed) outputs have to be disabled while
* already disabled outputs do not have to be disabled explicitly.
*
* @param[in] requested_virtual_sensors Pointer to array of requested virtual sensor (output) configurations for the library
* @param[in] n_requested_virtual_sensors Number of virtual sensor structs pointed by requested_virtual_sensors
* @param[out] required_sensor_settings Pointer to array of required physical sensor configurations for the library
* @param[in,out] n_required_sensor_settings [in] Size of allocated required_sensor_settings array, [out] number of sensor configurations returned
*
* @return Zero when successful, otherwise an error code
*
* @sa bsec_sensor_configuration_t
* @sa bsec_physical_sensor_t
* @sa bsec_virtual_sensor_t
*
\code{.c}
// Example //
// Change 3 virtual sensors (switch IAQ and raw temperature -> on / pressure -> off)
bsec_sensor_configuration_t requested_virtual_sensors[3];
uint8_t n_requested_virtual_sensors = 3;
requested_virtual_sensors[0].sensor_id = BSEC_OUTPUT_IAQ;
requested_virtual_sensors[0].sample_rate = BSEC_SAMPLE_RATE_ULP;
requested_virtual_sensors[1].sensor_id = BSEC_OUTPUT_RAW_TEMPERATURE;
requested_virtual_sensors[1].sample_rate = BSEC_SAMPLE_RATE_ULP;
requested_virtual_sensors[2].sensor_id = BSEC_OUTPUT_RAW_PRESSURE;
requested_virtual_sensors[2].sample_rate = BSEC_SAMPLE_RATE_DISABLED;
// Allocate a struct for the returned physical sensor settings
bsec_sensor_configuration_t required_sensor_settings[BSEC_MAX_PHYSICAL_SENSOR];
uint8_t n_required_sensor_settings = BSEC_MAX_PHYSICAL_SENSOR;
// Call bsec_update_subscription() to enable/disable the requested virtual sensors
bsec_update_subscription(requested_virtual_sensors, n_requested_virtual_sensors, required_sensor_settings, &n_required_sensor_settings);
\endcode
*
*/
bsec_library_return_t bsec_update_subscription(const bsec_sensor_configuration_t * const requested_virtual_sensors,
const uint8_t n_requested_virtual_sensors, bsec_sensor_configuration_t * required_sensor_settings,
uint8_t * n_required_sensor_settings);
/*!
* @brief Main signal processing function of BSEC
*
*
* Processing of the input signals and returning of output samples is performed by bsec_do_steps().
* - The samples of all library inputs must be passed with unique identifiers representing the input signals from
* physical sensors where the order of these inputs can be chosen arbitrary. However, all input have to be provided
* within the same time period as they are read. A sequential provision to the library might result in undefined
* behavior.
* - The samples of all library outputs are returned with unique identifiers corresponding to the output signals of
* virtual sensors where the order of the returned outputs may be arbitrary.
* - The samples of all input as well as output signals of physical as well as virtual sensors use the same
* representation in memory with the following fields:
* - Sensor identifier:
* - For inputs: required to identify the input signal from a physical sensor
* - For output: overwritten by bsec_do_steps() to identify the returned signal from a virtual sensor
* - Time stamp of the sample
*
* Calling bsec_do_steps() requires the samples of the input signals to be provided along with their time stamp when
* they are recorded and only when they are acquired. Repetition of samples with the same time stamp are ignored and
* result in a warning. Repetition of values of samples which are not acquired anew by a sensor result in deviations
* of the computed output signals. Concerning the returned output samples, an important feature is, that a value is
* returned for an output only when a new occurrence has been computed. A sample of an output signal is returned only
* once.
*
*
* @param[in] inputs Array of input data samples. Each array element represents a sample of a different physical sensor.
* @param[in] n_inputs Number of passed input data structs.
* @param[out] outputs Array of output data samples. Each array element represents a sample of a different virtual sensor.
* @param[in,out] n_outputs [in] Number of allocated output structs, [out] number of outputs returned
*
* @return Zero when successful, otherwise an error code
*
\code{.c}
// Example //
// Allocate input and output memory
bsec_input_t input[3];
uint8_t n_input = 3;
bsec_output_t output[2];
uint8_t n_output=2;
bsec_library_return_t status;
// Populate the input structs, assuming the we have timestamp (ts),
// gas sensor resistance (R), temperature (T), and humidity (rH) available
// as input variables
input[0].sensor_id = BSEC_INPUT_GASRESISTOR;
input[0].signal = R;
input[0].time_stamp= ts;
input[1].sensor_id = BSEC_INPUT_TEMPERATURE;
input[1].signal = T;
input[1].time_stamp= ts;
input[2].sensor_id = BSEC_INPUT_HUMIDITY;
input[2].signal = rH;
input[2].time_stamp= ts;
// Invoke main processing BSEC function
status = bsec_do_steps( input, n_input, output, &n_output );
// Iterate through the BSEC output data, if the call succeeded
if(status == BSEC_OK)
{
for(int i = 0; i < n_output; i++)
{
switch(output[i].sensor_id)
{
case BSEC_OUTPUT_IAQ:
// Retrieve the IAQ results from output[i].signal
// and do something with the data
break;
case BSEC_OUTPUT_STATIC_IAQ:
// Retrieve the static IAQ results from output[i].signal
// and do something with the data
break;
}
}
}
\endcode
*/
bsec_library_return_t bsec_do_steps(const bsec_input_t * const inputs, const uint8_t n_inputs, bsec_output_t * outputs, uint8_t * n_outputs);
/*!
* @brief Reset a particular virtual sensor output
*
* This function allows specific virtual sensor outputs to be reset. The meaning of "reset" depends on the specific
* output. In case of the IAQ output, reset means zeroing the output to the current ambient conditions.
*
* @param[in] sensor_id Virtual sensor to be reset
*
* @return Zero when successful, otherwise an error code
*
*
\code{.c}
// Example //
bsec_reset_output(BSEC_OUTPUT_IAQ);
\endcode
*/
bsec_library_return_t bsec_reset_output(uint8_t sensor_id);
/*!
* @brief Update algorithm configuration parameters
*
* BSEC uses a default configuration for the modules and common settings. The initial configuration can be customized
* by bsec_set_configuration(). This is an optional step.
*
* @note A work buffer with sufficient size is required and has to be provided by the function caller to decompose
* the serialization and apply it to the library and its modules.
*
* Please use #BSEC_MAX_PROPERTY_BLOB_SIZE for allotting the required size.
*
* @param[in] serialized_settings Settings serialized to a binary blob
* @param[in] n_serialized_settings Size of the settings blob
* @param[in,out] work_buffer Work buffer used to parse the blob
* @param[in] n_work_buffer_size Length of the work buffer available for parsing the blob
*
* @return Zero when successful, otherwise an error code
*
\code{.c}
// Example //
// Allocate variables
uint8_t serialized_settings[BSEC_MAX_PROPERTY_BLOB_SIZE];
uint32_t n_serialized_settings_max = BSEC_MAX_PROPERTY_BLOB_SIZE;
uint8_t work_buffer[BSEC_MAX_WORKBUFFER_SIZE];
uint32_t n_work_buffer = BSEC_MAX_WORKBUFFER_SIZE;
// Here we will load a provided config string into serialized_settings
// Apply the configuration
bsec_set_configuration(serialized_settings, n_serialized_settings_max, work_buffer, n_work_buffer);
\endcode
*/
bsec_library_return_t bsec_set_configuration(const uint8_t * const serialized_settings,
const uint32_t n_serialized_settings, uint8_t * work_buffer,
const uint32_t n_work_buffer_size);
/*!
* @brief Restore the internal state of the library
*
* BSEC uses a default state for all signal processing modules and the BSEC module. To ensure optimal performance,
* especially of the gas sensor functionality, it is recommended to retrieve the state using bsec_get_state()
* before unloading the library, storing it in some form of non-volatile memory, and setting it using bsec_set_state()
* before resuming further operation of the library.
*
* @note A work buffer with sufficient size is required and has to be provided by the function caller to decompose the
* serialization and apply it to the library and its modules.
*
* Please use #BSEC_MAX_STATE_BLOB_SIZE for allotting the required size.
*
* @param[in] serialized_state States serialized to a binary blob
* @param[in] n_serialized_state Size of the state blob
* @param[in,out] work_buffer Work buffer used to parse the blob
* @param[in] n_work_buffer_size Length of the work buffer available for parsing the blob
*
* @return Zero when successful, otherwise an error code
*
\code{.c}
// Example //
// Allocate variables
uint8_t serialized_state[BSEC_MAX_PROPERTY_BLOB_SIZE];
uint32_t n_serialized_state = BSEC_MAX_PROPERTY_BLOB_SIZE;
uint8_t work_buffer_state[BSEC_MAX_WORKBUFFER_SIZE];
uint32_t n_work_buffer_size = BSEC_MAX_WORKBUFFER_SIZE;
// Here we will load a state string from a previous use of BSEC
// Apply the previous state to the current BSEC session
bsec_set_state(serialized_state, n_serialized_state, work_buffer_state, n_work_buffer_size);
\endcode
*/
bsec_library_return_t bsec_set_state(const uint8_t * const serialized_state, const uint32_t n_serialized_state,
uint8_t * work_buffer, const uint32_t n_work_buffer_size);
/*!
* @brief Retrieve the current library configuration
*
* BSEC allows to retrieve the current configuration using bsec_get_configuration(). Returns a binary blob encoding
* the current configuration parameters of the library in a format compatible with bsec_set_configuration().
*
* @note The function bsec_get_configuration() is required to be used for debugging purposes only.
* @note A work buffer with sufficient size is required and has to be provided by the function caller to decompose the
* serialization and apply it to the library and its modules.
*
* Please use #BSEC_MAX_PROPERTY_BLOB_SIZE for allotting the required size.
*
* @param[in] config_id Identifier for a specific set of configuration settings to be returned;
* shall be zero to retrieve all configuration settings.
* @param[out] serialized_settings Buffer to hold the serialized config blob
* @param[in] n_serialized_settings_max Maximum available size for the serialized settings
* @param[in,out] work_buffer Work buffer used to parse the binary blob
* @param[in] n_work_buffer Length of the work buffer available for parsing the blob
* @param[out] n_serialized_settings Actual size of the returned serialized configuration blob
*
* @return Zero when successful, otherwise an error code
*
\code{.c}
// Example //
// Allocate variables
uint8_t serialized_settings[BSEC_MAX_PROPERTY_BLOB_SIZE];
uint32_t n_serialized_settings_max = BSEC_MAX_PROPERTY_BLOB_SIZE;
uint8_t work_buffer[BSEC_MAX_WORKBUFFER_SIZE];
uint32_t n_work_buffer = BSEC_MAX_WORKBUFFER_SIZE;
uint32_t n_serialized_settings = 0;
// Configuration of BSEC algorithm is stored in 'serialized_settings'
bsec_get_configuration(0, serialized_settings, n_serialized_settings_max, work_buffer, n_work_buffer, &n_serialized_settings);
\endcode
*/
bsec_library_return_t bsec_get_configuration(const uint8_t config_id, uint8_t * serialized_settings, const uint32_t n_serialized_settings_max,
uint8_t * work_buffer, const uint32_t n_work_buffer, uint32_t * n_serialized_settings);
/*!
*@brief Retrieve the current internal library state
*
* BSEC allows to retrieve the current states of all signal processing modules and the BSEC module using
* bsec_get_state(). This allows a restart of the processing after a reboot of the system by calling bsec_set_state().
*
* @note A work buffer with sufficient size is required and has to be provided by the function caller to decompose the
* serialization and apply it to the library and its modules.
*
* Please use #BSEC_MAX_STATE_BLOB_SIZE for allotting the required size.
*
* @param[in] state_set_id Identifier for a specific set of states to be returned; shall be
* zero to retrieve all states.
* @param[out] serialized_state Buffer to hold the serialized config blob
* @param[in] n_serialized_state_max Maximum available size for the serialized states
* @param[in,out] work_buffer Work buffer used to parse the blob
* @param[in] n_work_buffer Length of the work buffer available for parsing the blob
* @param[out] n_serialized_state Actual size of the returned serialized blob
*
* @return Zero when successful, otherwise an error code
*
\code{.c}
// Example //
// Allocate variables
uint8_t serialized_state[BSEC_MAX_STATE_BLOB_SIZE];
uint32_t n_serialized_state_max = BSEC_MAX_STATE_BLOB_SIZE;
uint32_t n_serialized_state = BSEC_MAX_STATE_BLOB_SIZE;
uint8_t work_buffer_state[BSEC_MAX_WORKBUFFER_SIZE];
uint32_t n_work_buffer_size = BSEC_MAX_WORKBUFFER_SIZE;
// Algorithm state is stored in 'serialized_state'
bsec_get_state(0, serialized_state, n_serialized_state_max, work_buffer_state, n_work_buffer_size, &n_serialized_state);
\endcode
*/
bsec_library_return_t bsec_get_state(const uint8_t state_set_id, uint8_t * serialized_state,
const uint32_t n_serialized_state_max, uint8_t * work_buffer, const uint32_t n_work_buffer,
uint32_t * n_serialized_state);
/*!
* @brief Retrieve BMExxx sensor instructions
*
* The bsec_sensor_control() interface is a key feature of BSEC, as it allows an easy way for the signal processing
* library to control the operation of the BME sensor. This is important since gas sensor behaviour is mainly
* determined by how the integrated heater is configured. To ensure an easy integration of BSEC into any system,
* bsec_sensor_control() will provide the caller with information about the current sensor configuration that is
* necessary to fulfill the input requirements derived from the current outputs requested via
* bsec_update_subscription().
*
* In practice the use of this function shall be as follows:
* - Call bsec_sensor_control() which returns a bsec_bme_settings_t struct.
* - Based on the information contained in this struct, the sensor is configured and a forced-mode measurement is
* triggered if requested by bsec_sensor_control().
* - Once this forced-mode measurement is complete, the signals specified in this struct shall be passed to
* bsec_do_steps() to perform the signal processing.
* - After processing, the process should sleep until the bsec_bme_settings_t::next_call timestamp is reached.
*
*
* @param [in] time_stamp Current timestamp in [ns]
* @param[out] sensor_settings Settings to be passed to API to operate sensor at this time instance
*
* @return Zero when successful, otherwise an error code
*/
bsec_library_return_t bsec_sensor_control(const int64_t time_stamp, bsec_bme_settings_t *sensor_settings);
/*@}*/ //BSEC Interface
#ifdef __cplusplus
}
#endif
#endif /* __BSEC_INTERFACE_H__ */

334
libraries/bsec2/src/inc/bsec_interface_multi.h Normal file
View file

@ -0,0 +1,334 @@
/**
* Copyright (C) Bosch Sensortec GmbH. All Rights Reserved. Confidential.
*
* Disclaimer
*
* Common:
* Bosch Sensortec products are developed for the consumer goods industry. They may only be used
* within the parameters of the respective valid product data sheet. Bosch Sensortec products are
* provided with the express understanding that there is no warranty of fitness for a particular purpose.
* They are not fit for use in life-sustaining, safety or security sensitive systems or any system or device
* that may lead to bodily harm or property damage if the system or device malfunctions. In addition,
* Bosch Sensortec products are not fit for use in products which interact with motor vehicle systems.
* The resale and/or use of products are at the purchaser's own risk and his own responsibility. The
* examination of fitness for the intended use is the sole responsibility of the Purchaser.
*
* The purchaser shall indemnify Bosch Sensortec from all third party claims, including any claims for
* incidental, or consequential damages, arising from any product use not covered by the parameters of
* the respective valid product data sheet or not approved by Bosch Sensortec and reimburse Bosch
* Sensortec for all costs in connection with such claims.
*
* The purchaser must monitor the market for the purchased products, particularly with regard to
* product safety and inform Bosch Sensortec without delay of all security relevant incidents.
*
* Engineering Samples are marked with an asterisk (*) or (e). Samples may vary from the valid
* technical specifications of the product series. They are therefore not intended or fit for resale to third
* parties or for use in end products. Their sole purpose is internal client testing. The testing of an
* engineering sample may in no way replace the testing of a product series. Bosch Sensortec
* assumes no liability for the use of engineering samples. By accepting the engineering samples, the
* Purchaser agrees to indemnify Bosch Sensortec from all claims arising from the use of engineering
* samples.
*
* Special:
* This software module (hereinafter called "Software") and any information on application-sheets
* (hereinafter called "Information") is provided free of charge for the sole purpose to support your
* application work. The Software and Information is subject to the following terms and conditions:
*
* The Software is specifically designed for the exclusive use for Bosch Sensortec products by
* personnel who have special experience and training. Do not use this Software if you do not have the
* proper experience or training.
*
* This Software package is provided `` as is `` and without any expressed or implied warranties,
* including without limitation, the implied warranties of merchantability and fitness for a particular
* purpose.
*
* Bosch Sensortec and their representatives and agents deny any liability for the functional impairment
* of this Software in terms of fitness, performance and safety. Bosch Sensortec and their
* representatives and agents shall not be liable for any direct or indirect damages or injury, except as
* otherwise stipulated in mandatory applicable law.
*
* The Information provided is believed to be accurate and reliable. Bosch Sensortec assumes no
* responsibility for the consequences of use of such Information nor for any infringement of patents or
* other rights of third parties which may result from its use. No license is granted by implication or
* otherwise under any patent or patent rights of Bosch. Specifications mentioned in the Information are
* subject to change without notice.
*
* It is not allowed to deliver the source code of the Software to any third party without permission of
* Bosch Sensortec.
*
* @file bsec_interface_multi.h
*
* @brief
* Contains the multi-instance API for BSEC
*
*/
#ifndef __BSEC_INTERFACE_MULTI_H__
#define __BSEC_INTERFACE_MULTI_H__
#include "bsec_datatypes.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! @addtogroup bsec_lib_interface BSEC Multi-instance Interfaces
* @brief The multi-instance interface of BSEC signal processing library is used for interfacing multiple sensors with BSEC library.
*
* # Multi-instance interface usage
*
* The following provides a short overview on the typical operation sequence for BSEC.
*
* - Initialization of the library
*
* | Steps | Function |
* |---------------------------------------------------------------------|--------------------------|
* | Initialization of library | bsec_init_m() |
* | Update configuration settings (optional) | bsec_set_configuration_m() |
* | Restore the state of the library (optional) | bsec_set_state_m() |
*
*
* - The following function is called to enable output signals and define their sampling rate / operation mode.
*
* | Steps | Function |
* |---------------------------------------------|----------------------------|
* | Enable library outputs with specified mode | bsec_update_subscription_m() |
*
*
* - This table describes the main processing loop.
*
* | Steps | Function |
* |-------------------------------------------|----------------------------------|
* | Retrieve sensor settings to be used | bsec_sensor_control_m() |
* | Configure sensor and trigger measurement | See BME688 API and example codes |
* | Read results from sensor | See BME688 API and example codes |
* | Perform signal processing | bsec_do_steps_m() |
*
*
* - Before shutting down the system, the current state of BSEC can be retrieved and can then be used during
* re-initialization to continue processing.
*
* | Steps | Function |
* |---------------------------------------------|-------------------|
* | Retrieve the current library state | bsec_get_state_m() |
* | Retrieve the current library configuration | bsec_get_configuration_m() |
*
*
* ### Configuration and state
*
* Values of variables belonging to a BSEC instance are divided into two groups:
* - Values **not updated by processing** of signals belong to the **configuration group**. If available, BSEC can be
* configured before use with a customer specific configuration string.
* - Values **updated during processing** are member of the **state group**. Saving and restoring of the state of BSEC
* is necessary to maintain previously estimated sensor models and baseline information which is important for best
* performance of the gas sensor outputs.
*
* @note BSEC library consists of adaptive algorithms which models the gas sensor which improves its performance over
* the time. These will be lost if library is initialized due to system reset. In order to avoid this situation
* library state shall be stored in non volatile memory so that it can be loaded after system reset.
*
*
* @{
*/
/********************************************************/
/* function prototype declarations */
/*!
* @brief Function that provides the size of the internal instance in bytes.
* To be used for allocating memory for struct BSEC_STRUCT_NAME
* @return Size of the internal instance in bytes
*/
size_t bsec_get_instance_size_m(void);
/*!
* @brief Return the version information of BSEC library instance
* @param[in,out] inst Reference to the pointer containing the instance
* @param [out] bsec_version_p pointer to struct which is to be populated with the version information
*
* @return Zero if successful, otherwise an error code
*
* See also: bsec_version_t
*
*/
bsec_library_return_t bsec_get_version_m(void *inst, bsec_version_t *bsec_version_p);
/*!
* @brief Initialize the library instance
*
* Initialization and reset of BSEC library instance is performed by calling bsec_init_m() as done with bsec_init() for standard interface.
*
* @param[in,out] inst Reference to the pointer containing the instance
*
* @return Zero if successful, otherwise an error code
*
*/
bsec_library_return_t bsec_init_m(void *inst);
/*!
* @brief Subscribe to library virtual sensors outputs
*
* Like bsec_update_subscription(), bsec_update_subscription_m() is used to instruct BSEC which of the processed output signals
* of the library instance are requested at which sample rates.
*
* @param[in,out] inst Reference to the pointer containing the instance
* @param[in] requested_virtual_sensors Pointer to array of requested virtual sensor (output) configurations for the library
* @param[in] n_requested_virtual_sensors Number of virtual sensor structs pointed by requested_virtual_sensors
* @param[out] required_sensor_settings Pointer to array of required physical sensor configurations for the library
* @param[in,out] n_required_sensor_settings [in] Size of allocated required_sensor_settings array, [out] number of sensor configurations returned
*
* @return Zero when successful, otherwise an error code
*
* @sa bsec_sensor_configuration_t
* @sa bsec_physical_sensor_t
* @sa bsec_virtual_sensor_t
*
*/
bsec_library_return_t bsec_update_subscription_m(void *inst, const bsec_sensor_configuration_t *const requested_virtual_sensors,
const uint8_t n_requested_virtual_sensors, bsec_sensor_configuration_t *required_sensor_settings,
uint8_t *n_required_sensor_settings);
/*!
* @brief Main signal processing function of BSEC library instance
*
*
* Processing of the input signals and returning of output samples for each instances of BSEC library is performed by bsec_do_steps_m().
* bsec_do_steps_m() processes multiple instaces of BSEC library simillar to how bsec_do_steps() handles single instance.
*
* @param[in,out] inst Reference to the pointer containing the instance
* @param[in] inputs Array of input data samples. Each array element represents a sample of a different physical sensor.
* @param[in] n_inputs Number of passed input data structs.
* @param[out] outputs Array of output data samples. Each array element represents a sample of a different virtual sensor.
* @param[in,out] n_outputs [in] Number of allocated output structs, [out] number of outputs returned
*
* @return Zero when successful, otherwise an error code
*
*/
bsec_library_return_t bsec_do_steps_m(void *inst, const bsec_input_t *const inputs, const uint8_t n_inputs, bsec_output_t *outputs, uint8_t *n_outputs);
/*!
* @brief Reset a particular virtual sensor output of the library instance
*
* This function allows specific virtual sensor outputs of each library instance to be reset.
* It processes in same way as bsec_reset_output().
*
* @param[in,out] inst Reference to the pointer containing the instance
* @param[in] sensor_id Virtual sensor to be reset
*
* @return Zero when successful, otherwise an error code
*
*/
bsec_library_return_t bsec_reset_output_m(void *inst, uint8_t sensor_id);
/*!
* @brief Update algorithm configuration parameters of the library instance
*
* As done with bsec_set_configuration(), the initial configuration of BSEC libray instance can be customized
* by bsec_set_configuration_m(). This is an optional step.
*
* Please use #BSEC_MAX_PROPERTY_BLOB_SIZE for allotting the required size.
*
* @param[in,out] inst Reference to the pointer containing the instance
* @param[in] serialized_settings Settings serialized to a binary blob
* @param[in] n_serialized_settings Size of the settings blob
* @param[in,out] work_buffer Work buffer used to parse the blob
* @param[in] n_work_buffer_size Length of the work buffer available for parsing the blob
*
* @return Zero when successful, otherwise an error code
*
*/
bsec_library_return_t bsec_set_configuration_m(void *inst, const uint8_t *const serialized_settings,
const uint32_t n_serialized_settings, uint8_t *work_buffer,
const uint32_t n_work_buffer_size);
/*!
* @brief Restore the internal state of the library instance
*
* BSEC uses a default state for all signal processing modules and the BSEC module for each instance. To ensure optimal performance,
* especially of the gas sensor functionality, it is recommended to retrieve the state using bsec_get_state_m()
* before unloading the library, storing it in some form of non-volatile memory, and setting it using bsec_set_state_m()
* before resuming further operation of the library.
*
* Please use #BSEC_MAX_STATE_BLOB_SIZE for allotting the required size.
*
* @param[in,out] inst Reference to the pointer containing the instance
* @param[in] serialized_state States serialized to a binary blob
* @param[in] n_serialized_state Size of the state blob
* @param[in,out] work_buffer Work buffer used to parse the blob
* @param[in] n_work_buffer_size Length of the work buffer available for parsing the blob
*
* @return Zero when successful, otherwise an error code
*
*/
bsec_library_return_t bsec_set_state_m(void *inst, const uint8_t *const serialized_state, const uint32_t n_serialized_state,
uint8_t *work_buffer, const uint32_t n_work_buffer_size);
/*!
* @brief Retrieve the current library instance configuration
*
* BSEC allows to retrieve the current configuration of the library instance using bsec_get_configuration_m().
* In the same way as bsec_get_configuration(), this API returns a binary blob encoding
* the current configuration parameters of the library in a format compatible with bsec_set_configuration_m().
*
* Please use #BSEC_MAX_PROPERTY_BLOB_SIZE for allotting the required size.
*
* @param[in,out] inst Reference to the pointer containing the instance
* @param[in] config_id Identifier for a specific set of configuration settings to be returned;
* shall be zero to retrieve all configuration settings.
* @param[out] serialized_settings Buffer to hold the serialized config blob
* @param[in] n_serialized_settings_max Maximum available size for the serialized settings
* @param[in,out] work_buffer Work buffer used to parse the binary blob
* @param[in] n_work_buffer Length of the work buffer available for parsing the blob
* @param[out] n_serialized_settings Actual size of the returned serialized configuration blob
*
* @return Zero when successful, otherwise an error code
*
*/
bsec_library_return_t bsec_get_configuration_m(void *inst, const uint8_t config_id, uint8_t *serialized_settings, const uint32_t n_serialized_settings_max,
uint8_t *work_buffer, const uint32_t n_work_buffer, uint32_t *n_serialized_settings);
/*!
*@brief Retrieve the current internal library instance state
*
* BSEC allows to retrieve the current states of all signal processing modules and the BSEC module of the library instance using
* bsec_get_state_m(). As done by bsec_get_state(), this allows a restart of the processing after a reboot of the system by calling bsec_set_state_m().
*
* Please use #BSEC_MAX_STATE_BLOB_SIZE for allotting the required size.
*
* @param[in,out] inst Reference to the pointer containing the instance
* @param[in] state_set_id Identifier for a specific set of states to be returned; shall be
* zero to retrieve all states.
* @param[out] serialized_state Buffer to hold the serialized config blob
* @param[in] n_serialized_state_max Maximum available size for the serialized states
* @param[in,out] work_buffer Work buffer used to parse the blob
* @param[in] n_work_buffer Length of the work buffer available for parsing the blob
* @param[out] n_serialized_state Actual size of the returned serialized blob
*
* @return Zero when successful, otherwise an error code
*
*/
bsec_library_return_t bsec_get_state_m(void *inst, const uint8_t state_set_id, uint8_t *serialized_state,
const uint32_t n_serialized_state_max, uint8_t *work_buffer, const uint32_t n_work_buffer,
uint32_t *n_serialized_state);
/*!
* @brief Retrieve BMExxx sensor instructions for the library instance
*
* The bsec_sensor_control_m() allows an easy way for the signal processing library to control the operation of the
* BME sensor which uses the correspodning BSEC library instance. Operation of bsec_sensor_control_m() is simillar to bsec_sensor_control()
* except that former API supports multiples library instances.
*
* @param[in,out] inst Reference to the pointer containing the instance
* @param [in] time_stamp Current timestamp in [ns]
* @param[out] sensor_settings Settings to be passed to API to operate sensor at this time instance
*
* @return Zero when successful, otherwise an error code
*/
bsec_library_return_t bsec_sensor_control_m(void *inst, const int64_t time_stamp, bsec_bme_settings_t *sensor_settings);
/*@}*/ //BSEC Interface
#ifdef __cplusplus
}
#endif
#endif /* __BSEC_INTERFACE_MULTI_H__ */