fix: update from upstream

See https://github.com/nrfconnect/sdk-nrf/tree/b572221836e6250956b2132919e59d549e1fcbcf/applications/asset_tracker_v2

Author: GitHub Actions

doc/sensor_module.rst

@@ -20,17 +20,19 @@ Sensor types
 
 The following table lists the sensors and sensor data types supported by the module:
 
-+----------------------+-----------------+
-| Sensor data type     | External device |
-+======================+=================+
-| Humidity             | `BME680`_       |
-+----------------------+-----------------+
-| Temperature          | `BME680`_       |
-+----------------------+-----------------+
-| Atmospheric Pressure | `BME680`_       |
-+----------------------+-----------------+
-| Acceleration         | `ADXL362`_      |
-+----------------------+-----------------+
++-------------------------+-----------------+
+| Sensor data type        | External device |
++=========================+=================+
+| Humidity                | `BME680`_       |
++-------------------------+-----------------+
+| Temperature             | `BME680`_       |
++-------------------------+-----------------+
+| Atmospheric Pressure    | `BME680`_       |
++-------------------------+-----------------+
+| Air Quality (BSEC only) | `BME680`_       |
++-------------------------+-----------------+
+| Acceleration            | `ADXL362`_      |
++-------------------------+-----------------+
 
 The module controls and collects data from the sensors by interacting with their :ref:`device drivers <device_model_api>` using :ref:`Zephyr's generic sensor API <sensor_api>`.
 
@@ -74,6 +76,28 @@ The sensor module will only send out a :c:enum:`SENSOR_EVT_MOVEMENT_DATA_READY`
    This is beyond the scope of the general asset tracker framework this application provides.
    Therefore, the readings are not transmitted to the cloud and are only used to detect a binary active and inactive state.
 
+.. _bosch_software_environmental_cluster_library:
+
+Bosch Software Environmental Cluster (BSEC) library
+===================================================
+
+The sensor module supports integration with the BSEC signal processing library using the external sensors, internal convenience API.
+If enabled, the BSEC library is used instead of the BME680 Zephyr driver to provide sensor readings from the BME680 for temperature, humidity, and atmospheric pressure.
+In addition, the BSEC driver provides an additional sensor reading, indoor air quality (IAQ), which is a metric given in between 0-500 range, that estimates the air quality of the environment.
+
+As the BSEC library requires a separate license, it is not a default part of |NCS|, but can be downloaded externally and imported into the |NCS| source tree.
+
+Perform the following steps to enable BSEC:
+
+1. Download the BSEC library, using the `Bosch BSEC`_ link.
+#. Extract and store the folder containing the library contents in the path specified by :ref:`CONFIG_EXTERNAL_SENSORS_BME680_BSEC_PATH <CONFIG_EXTERNAL_SENSORS_BME680_BSEC_PATH>` option or update the path configuration to reference the library location.
+#. Disable the Zephyr BME680 driver by setting :kconfig:`CONFIG_BME680` to false.
+#. Enable the external sensors API BSEC integration layer by enabling :ref:`CONFIG_EXTERNAL_SENSORS_BME680_BSEC <CONFIG_EXTERNAL_SENSORS_BME680_BSEC>` option.
+
+Air quality readings are provided with the :c:enumerator:`SENSOR_EVT_ENVIRONMENTAL_DATA_READY` event.
+
+To check and configure the BSEC configuration options, see :ref:`external_sensor_API_BSEC_configurations` section.
+
 Configuration options
 *********************
 
@@ -82,6 +106,41 @@ Configuration options
 CONFIG_SENSOR_THREAD_STACK_SIZE - Sensor module thread stack size
    This option configures the sensor module's internal thread stack size.
 
+.. _external_sensor_API_BSEC_configurations:
+
+External sensors API BSEC configurations
+========================================
+
+.. _CONFIG_EXTERNAL_SENSORS_BME680_BSEC:
+
+CONFIG_EXTERNAL_SENSORS_BME680_BSEC
+   This option configures the Bosch BSEC library for the BME680.
+
+.. _CONFIG_EXTERNAL_SENSORS_BME680_BSEC_PATH:
+
+CONFIG_EXTERNAL_SENSORS_BME680_BSEC_PATH
+   This option sets the path for the Bosch BSEC library folder.
+
+.. _CONFIG_EXTERNAL_SENSORS_BSEC_SAMPLE_MODE_ULTRA_LOW_POWER:
+
+CONFIG_EXTERNAL_SENSORS_BSEC_SAMPLE_MODE_ULTRA_LOW_POWER
+   This option configures the BSEC ultra Low Power Mode. In this mode, the BME680 is sampled every 300 seconds.
+
+.. _CONFIG_EXTERNAL_SENSORS_BSEC_SAMPLE_MODE_LOW_POWER:
+
+CONFIG_EXTERNAL_SENSORS_BSEC_SAMPLE_MODE_LOW_POWER
+   This option configures BSEC Low Power Mode. In this mode, the BME680 is sampled every 3 seconds.
+
+.. _CONFIG_EXTERNAL_SENSORS_BSEC_SAMPLE_MODE_CONTINUOUS:
+
+CONFIG_EXTERNAL_SENSORS_BSEC_SAMPLE_MODE_CONTINUOUS
+  This option configures BSEC continuous Mode. In this mode, the BME680 is sampled every second.
+
+.. _CONFIG_EXTERNAL_SENSORS_BSEC_TEMPERATURE_OFFSET:
+
+CONFIG_EXTERNAL_SENSORS_BSEC_TEMPERATURE_OFFSET
+   This option configures BSEC temperature offset in degree celsius multiplied by 100.
+
 Module states
 *************
 

src/cloud/cloud_codec/aws_iot/json_protocol_names_aws_iot.h

@@ -36,6 +36,7 @@
 #define DATA_TEMPERATURE    "temp"
 #define DATA_HUMIDITY	    "hum"
 #define DATA_PRESSURE       "atmp"
+#define DATA_BSEC_IAQ       "bsec_iaq"
 #define DATA_ENVIRONMENTALS "env"
 #define DATA_BUTTON	    "btn"
 #define DATA_CONFIG	    "cfg"

src/cloud/cloud_codec/azure_iot_hub/json_protocol_names_azure_iot_hub.h

@@ -36,6 +36,7 @@
 #define DATA_TEMPERATURE    "temp"
 #define DATA_HUMIDITY	    "hum"
 #define DATA_PRESSURE       "atmp"
+#define DATA_BSEC_IAQ       "bsec_iaq"
 #define DATA_ENVIRONMENTALS "env"
 #define DATA_BUTTON	    "btn"
 #define DATA_CONFIG	    "cfg"

src/cloud/cloud_codec/cloud_codec.h

@@ -129,6 +129,10 @@ struct cloud_data_sensors {
 	double humidity;
 	/** Atmospheric pressure in kilopascal. */
 	double pressure;
+	/** BSEC Air quality in Indoor-Air-Quality (IAQ) index.
+	 *  If -1, the value is not provided.
+	 */
+	int bsec_air_quality;
 	/** Flag signifying that the data entry is to be encoded. */
 	bool queued : 1;
 };

src/cloud/cloud_codec/json_common.c

@@ -315,6 +315,15 @@ int json_common_sensor_data_add(cJSON *parent,
 		goto exit;
 	}
 
+	/* If air quality is negative, the value is not provided. */
+	if (data->bsec_air_quality >= 0) {
+		err = json_add_number(sensor_val_obj, DATA_BSEC_IAQ, data->bsec_air_quality);
+		if (err) {
+			LOG_ERR("Encoding error: %d returned at %s:%d", err, __FILE__, __LINE__);
+			goto exit;
+		}
+	}
+
 	json_add_obj(sensor_obj, DATA_VALUE, sensor_val_obj);
 
 	err = json_add_number(sensor_obj, DATA_TIMESTAMP, data->env_ts);

src/cloud/cloud_codec/nrf_cloud/json_protocol_names_nrf_cloud.h

@@ -23,6 +23,7 @@
 #define DATA_TEMPERATURE    "temp"
 #define DATA_HUMIDITY	    "hum"
 #define DATA_PRESSURE       "atmp"
+#define DATA_BSEC_IAQ       "bsec_iaq"
 #define DATA_ENVIRONMENTALS "env"
 #define DATA_BUTTON	    "btn"
 #define DATA_CONFIG	    "config"
@@ -42,6 +43,7 @@
 #define APP_ID_GPS	   "GPS"
 #define APP_ID_HUMIDITY	   "HUMID"
 #define APP_ID_AIR_PRESS   "AIR_PRESS"
+#define APP_ID_AIR_QUAL    "AIR_QUAL"
 #define APP_ID_TEMPERATURE "TEMP"
 #define APP_ID_RSRP	   "RSRP"
 #define APP_ID_CELL_POS    "CELL_POS"

src/cloud/cloud_codec/nrf_cloud/nrf_cloud_codec.c

@@ -165,9 +165,10 @@ static int add_batch_data(cJSON *array, enum batch_data_type type, void *buf, si
 		}
 		case ENVIRONMENTALS: {
 			int err, len;
-			char humidity[7];
-			char temperature[7];
-			char pressure[7];
+			char humidity[10];
+			char temperature[10];
+			char pressure[10];
+			char bsec_air_quality[4];
 			struct cloud_data_sensors *data = (struct cloud_data_sensors *)buf;
 
 			if (data[i].queued == false) {
@@ -184,21 +185,33 @@ static int add_batch_data(cJSON *array, enum batch_data_type type, void *buf, si
 				       data[i].humidity);
 			if ((len < 0) || (len >= sizeof(humidity))) {
 				LOG_ERR("Cannot convert humidity to string, buffer too small");
-				return -ENOMEM;
 			}
 
 			len = snprintk(temperature, sizeof(temperature), "%.2f",
 				       data[i].temperature);
 			if ((len < 0) || (len >= sizeof(temperature))) {
 				LOG_ERR("Cannot convert temperature to string, buffer too small");
-				return -ENOMEM;
 			}
 
 			len = snprintk(pressure, sizeof(pressure), "%.2f",
 				       data[i].pressure);
 			if ((len < 0) || (len >= sizeof(pressure))) {
 				LOG_ERR("Cannot convert pressure to string, buffer too small");
-				return -ENOMEM;
+			}
+
+			if (data[i].bsec_air_quality >= 0) {
+				len = snprintk(bsec_air_quality, sizeof(bsec_air_quality), "%d",
+					data[i].bsec_air_quality);
+				if ((len < 0) || (len >= sizeof(bsec_air_quality))) {
+					LOG_ERR("Cannot convert BSEC air quality to string, "
+						"buffer too small");
+				}
+
+				err = add_data(array, NULL, APP_ID_AIR_QUAL, bsec_air_quality,
+					       &data[i].env_ts, data[i].queued, NULL, false);
+				if (err && err != -ENODATA) {
+					return err;
+				}
 			}
 
 			err = add_data(array, NULL, APP_ID_HUMIDITY, humidity,

src/cloud/nrf_cloud_integration.c

@@ -68,6 +68,7 @@ static int send_service_info(void)
 #if defined(CONFIG_BOARD_THINGY91_NRF9160_NS)
 		.humidity = true,
 		.air_pressure = true,
+		.air_quality = true,
 		.temperature = true,
 #endif
 		.rsrp = true,

src/events/sensor_module_event.h

@@ -59,6 +59,10 @@ struct sensor_module_data {
 	double humidity;
 	/** Atmospheric pressure in kilopascal. */
 	double pressure;
+	/** BSEC air quality in Indoor-Air-Quality (IAQ) index.
+	 *  If -1, the value is not provided.
+	 */
+	int bsec_air_quality;
 };
 
 /** @brief Structure used to provide acceleration data. */

src/ext_sensors/CMakeLists.txt

@@ -5,5 +5,29 @@
 #
 
 target_include_directories(app PRIVATE .)
-target_sources_ifdef(CONFIG_EXTERNAL_SENSORS app PRIVATE
-                        ${CMAKE_CURRENT_SOURCE_DIR}/ext_sensors.c)
+target_sources_ifdef(CONFIG_EXTERNAL_SENSORS app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/ext_sensors.c)
+
+if (CONFIG_EXTERNAL_SENSORS_BME680_BSEC)
+        target_sources(app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/ext_sensors_bsec.c)
+        set(bsec_dir ${CONFIG_EXTERNAL_SENSORS_BME680_BSEC_PATH})
+        set(BSEC_LIB_DIR ${bsec_dir}/algo/normal_version/bin/gcc/Cortex_M33F)
+
+        if(NOT EXISTS "${BSEC_LIB_DIR}/libalgobsec.a")
+                assert(0 "Could not find BSEC library. Minimum version is 1.4.8.0_Generic_Release")
+        endif()
+
+        target_include_directories(app PRIVATE ${bsec_dir}/examples/bsec_iot_example)
+        target_include_directories(app PRIVATE ${BSEC_LIB_DIR})
+
+        target_sources(app PRIVATE ${bsec_dir}/examples/bsec_iot_example/bsec_integration.c)
+        target_sources(app PRIVATE ${bsec_dir}/examples/bsec_iot_example/bme680.c)
+
+        add_library(bsec_lib STATIC IMPORTED GLOBAL)
+        add_dependencies(bsec_lib math_lib bsec_target)
+
+        set_target_properties(bsec_lib PROPERTIES IMPORTED_LOCATION "${BSEC_LIB_DIR}/libalgobsec.a")
+        set_target_properties(bsec_lib PROPERTIES INTERFACE_INCLUDE_DIRECTORIES ${BSEC_LIB_DIR})
+
+        target_link_libraries(bsec_lib INTERFACE -L${LIBC_LIBRARY_DIR})
+        target_link_libraries(app PUBLIC bsec_lib)
+endif()