samples: bluetooth: mesh: Add HVAC Integration NLC Profile support

- Added NLC HVAC Integration support to the mesh Sensor Client sample.
- Redesigned the NLC Kconfig with BASELINE/STRICT tiers,
  individual profile options, and backward compatibility.
- Updated existing mesh NLC samples to use the new individual
  profile configurations.
- Updated documentation and release notes.

Signed-off-by: Stine Åkredalen <[email protected]>

Author: akredalen

doc/nrf/protocols/bt/bt_mesh/overview/nlc.rst

@@ -7,8 +7,18 @@ Bluetooth® Networked Lighting Control (NLC) profiles are a set of device profil
 The NLC profiles can be used to implement interoperable network controlled lighting setups, including sensors, light fixtures, energy monitoring, scene selectors and dimmer controls.
 Each of the profiles specifies a set of models and a set of performance parameters.
 
-Enable the :kconfig:option:`CONFIG_BT_MESH_NLC_PERF_CONF` Kconfig option to set the required performance configurations for the NLC profiles.
-When implementing the NLC Basic Lightness Controller profile individually or in conjunction with other NLC profiles, also enable the :kconfig:option:`CONFIG_BT_MESH_NLC_PERF_LIGHTNESS_CTRL` Kconfig option.
+Multiple NLC profiles can be combined on a single device.
+When combining profiles, the device will use the highest minimum requirements, as defined in the NLC Profile specifications.
+
+For specific profile implementations, enable the following Kconfig options:
+
+* :kconfig:option:`CONFIG_BT_MESH_NLC_PERF_AMBIENT_LIGHT_SENSOR` - for the Ambient Light Sensor NLC profile
+* :kconfig:option:`CONFIG_BT_MESH_NLC_PERF_DIMMING_CONTROL` - for the Dimming Control NLC profile
+* :kconfig:option:`CONFIG_BT_MESH_NLC_PERF_ENERGY_MONITOR` - for the Energy Monitor NLC profile
+* :kconfig:option:`CONFIG_BT_MESH_NLC_PERF_HVAC_INTEGRATION` - for the HVAC Integration NLC profile
+* :kconfig:option:`CONFIG_BT_MESH_NLC_PERF_LIGHTNESS_CTRL` - for the Basic Lightness Controller NLC profile
+* :kconfig:option:`CONFIG_BT_MESH_NLC_PERF_OCCUPANCY_SENSOR` - for the Occupancy Sensor NLC profile
+* :kconfig:option:`CONFIG_BT_MESH_NLC_PERF_SCENE_SELECTOR` - for the Basic Scene Selector NLC profile
 
 The |NCS| provides a demonstration of how to implement each of these profiles as part of the Bluetooth samples.
 An overview of the NLC profiles and the samples supporting them is provided in a table below.
@@ -29,5 +39,7 @@ An overview of the NLC profiles and the samples supporting them is provided in a
    +-----------------------------------------+--------------------------------------+
    | Energy Monitor NLC Profile              | :ref:`bluetooth_mesh_light_lc`       |
    +-----------------------------------------+--------------------------------------+
+   | HVAC Integration NLC Profile            | :ref:`bluetooth_mesh_sensor_client`  |
+   +-----------------------------------------+--------------------------------------+
    | Occupancy Sensor NLC Profile            | :ref:`bluetooth_mesh_sensor_server`  |
    +-----------------------------------------+--------------------------------------+

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -138,7 +138,11 @@ Bluetooth® LE
 Bluetooth Mesh
 --------------
 
-|no_changes_yet_note|
+* Updated the NLC profile configuration system:
+
+  * Introduced individual profile configuration options for better user control.
+  * Deprecated the ``CONFIG_BT_MESH_NLC_PERF_CONF`` and ``CONFIG_BT_MESH_NLC_PERF_DEFAULT`` Kconfig options.
+    Existing configurations continue to work but you should migrate to individual profile options.
 
 DECT NR+
 --------
@@ -278,6 +282,18 @@ Bluetooth Mesh samples
 
   * Added support for external flash memory for the ``nrf52840dk/nrf52840`` as the secondary partition for the DFU process.
 
+* :ref:`bluetooth_mesh_sensor_client` sample:
+
+  * Updated:
+
+    * To demonstrate the Bluetooth :ref:`ug_bt_mesh_nlc` HVAC Integration profile.
+    * The following Mesh samples to use individual NLC profile configurations instead of the deprecated options:
+
+      * :ref:`bluetooth_mesh_light_dim`
+      * :ref:`bluetooth_mesh_light_lc`
+      * :ref:`bluetooth_mesh_sensor_server`
+      * :ref:`bluetooth_mesh_sensor_client`
+
 Bluetooth Fast Pair samples
 ---------------------------
 

include/bluetooth/mesh/models.h

@@ -79,6 +79,8 @@
 #define BT_MESH_NLC_PROFILE_ID_ENERGY_MONITOR 0x1604
 /** Occupancy Sensor NLC Profile 1.0 */
 #define BT_MESH_NLC_PROFILE_ID_OCCUPANCY_SENSOR 0x1605
+/** HVAC Integration NLC Profile 1.0 */
+#define BT_MESH_NLC_PROFILE_ID_HVAC_INTEGRATION 0x1606
 /**
  * @}
  */

samples/bluetooth/mesh/light_ctrl/prj.conf

@@ -48,11 +48,11 @@ CONFIG_BT_MESH_PROXY_USE_DEVICE_NAME=y
 CONFIG_BT_MESH_GATT_PROXY=y
 CONFIG_BT_MESH_ADV_EXT_GATT_SEPARATE=y
 CONFIG_BT_MESH_DK_PROV=y
-CONFIG_BT_MESH_NLC_PERF_CONF=y
 CONFIG_BT_MESH_NLC_PERF_LIGHTNESS_CTRL=y
+CONFIG_BT_MESH_NLC_PERF_ENERGY_MONITOR=y
 CONFIG_BT_MESH_MODEL_EXTENSIONS=y
 CONFIG_BT_MESH_MODEL_EXTENSION_LIST_SIZE=18
-# Enabling BT_MESH_NLC_PERF_CONF enables support for 3 application keys by
+# Enabling NLC Lightness Controller profile enables support for 3 application keys by
 # default. Therefore, allow up to 3 application key bindings per model instance.
 CONFIG_BT_MESH_MODEL_KEY_COUNT=3
 

samples/bluetooth/mesh/light_dimmer/prj.conf

@@ -47,8 +47,9 @@ CONFIG_BT_MESH_PB_GATT=y
 CONFIG_BT_MESH_GATT_PROXY=y
 CONFIG_BT_MESH_PROXY_USE_DEVICE_NAME=y
 CONFIG_BT_MESH_DK_PROV=y
-CONFIG_BT_MESH_NLC_PERF_CONF=y
-# Enabling BT_MESH_NLC_PERF_CONF enables support for 3 application keys by
+CONFIG_BT_MESH_NLC_PERF_DIMMING_CONTROL=y
+CONFIG_BT_MESH_NLC_PERF_SCENE_SELECTOR=y
+# Enabling NLC Dimming Control profile enables support for 3 application keys by
 # default. Therefore, allow up to 3 application key bindings per model instance.
 CONFIG_BT_MESH_MODEL_KEY_COUNT=3
 

samples/bluetooth/mesh/sensor_client/README.rst

@@ -11,6 +11,8 @@ The Bluetooth® Mesh sensor observer sample demonstrates how to set up a basic B
 Eight different sensor types are used to showcase different ways for the server to publish data.
 In addition, the samples demonstrate usage of both :ref:`single-channel sensor types and sensor series types <bt_mesh_sensor_types_channels>`, as well as how to add and write to a sensor setting.
 
+This sample also demonstrates how to implement the HVAC Integration NLC Profile (see :ref:`ug_bt_mesh_nlc`).
+
 .. note::
    This sample must be paired with :ref:`bluetooth_mesh_sensor_server` to show any functionality.
    The observer has no sensor data, and is dependent on a mesh sensor to provide it.

samples/bluetooth/mesh/sensor_client/prj.conf

@@ -51,11 +51,10 @@ CONFIG_BT_MESH_PB_GATT=y
 CONFIG_BT_MESH_GATT_PROXY=y
 CONFIG_BT_MESH_PROXY_USE_DEVICE_NAME=y
 CONFIG_BT_MESH_DK_PROV=y
-CONFIG_BT_MESH_SUBNET_COUNT=2
-CONFIG_BT_MESH_APP_KEY_COUNT=3
+CONFIG_BT_MESH_NLC_PERF_HVAC_INTEGRATION=y
+# Enabling NLC HVAC Integration profile enables support for 3 application keys by
+# default. Therefore, allow up to 3 application key bindings per model instance.
 CONFIG_BT_MESH_MODEL_KEY_COUNT=3
-CONFIG_BT_MESH_CRPL=32
-CONFIG_BT_MESH_MSG_CACHE_SIZE=64
 CONFIG_BT_MESH_SHELL=y
 
 # Bluetooth Mesh models

samples/bluetooth/mesh/sensor_client/src/model_handler.c

@@ -142,6 +142,28 @@ static const struct bt_mesh_sensor_cli_handlers bt_mesh_sensor_cli_handlers = {
 static struct bt_mesh_sensor_cli sensor_cli =
 	BT_MESH_SENSOR_CLI_INIT(&bt_mesh_sensor_cli_handlers);
 
+#if IS_ENABLED(CONFIG_BT_MESH_NLC_PERF_CONF)
+/* HVAC Integration NLC Profile composition data page 2 */
+static const uint8_t cmp2_elem_offset_hvac[1]; /* Profile uses element 0 */
+
+static const struct bt_mesh_comp2_record comp_rec[1] = {
+	{/* HVAC Integration NLC Profile 1.0 */
+	 .id = BT_MESH_NLC_PROFILE_ID_HVAC_INTEGRATION,
+	 .version.x = 1,
+	 .version.y = 0,
+	 .version.z = 0,
+	 .elem_offset_cnt = 1,
+	 .elem_offset = cmp2_elem_offset_hvac,
+	 .data_len = 0
+	}
+};
+
+static const struct bt_mesh_comp2 comp_p2 = {
+	.record_cnt = 1,
+	.record = comp_rec
+};
+#endif
+
 static struct k_work_delayable get_data_work;
 
 static void get_data(struct k_work *work)
@@ -358,6 +380,12 @@ static const struct bt_mesh_comp comp = {
 
 const struct bt_mesh_comp *model_handler_init(void)
 {
+#if IS_ENABLED(CONFIG_BT_MESH_NLC_PERF_CONF)
+	if (bt_mesh_comp2_register(&comp_p2)) {
+		printk("Failed to register comp2\n");
+	}
+#endif
+
 	k_work_init_delayable(&attention_blink_work, attention_blink);
 	k_work_init_delayable(&get_data_work, get_data);
 	k_work_init_delayable(&motion_timeout_work, motion_timeout);

samples/bluetooth/mesh/sensor_server/prj.conf

@@ -53,10 +53,11 @@ CONFIG_BT_MESH_PB_GATT=y
 CONFIG_BT_MESH_GATT_PROXY=y
 CONFIG_BT_MESH_PROXY_USE_DEVICE_NAME=y
 CONFIG_BT_MESH_DK_PROV=y
-CONFIG_BT_MESH_NLC_PERF_CONF=y
+CONFIG_BT_MESH_NLC_PERF_AMBIENT_LIGHT_SENSOR=y
+CONFIG_BT_MESH_NLC_PERF_OCCUPANCY_SENSOR=y
 CONFIG_BT_MESH_MODEL_EXTENSIONS=y
 CONFIG_BT_MESH_MODEL_EXTENSION_LIST_SIZE=10
-# Enabling BT_MESH_NLC_PERF_CONF enables support for 3 application keys by
+# Enabling NLC Ambient Light Sensor profile enables support for 3 application keys by
 # default. Therefore, allow up to 3 application key bindings per model instance.
 CONFIG_BT_MESH_MODEL_KEY_COUNT=3
 

subsys/bluetooth/mesh/Kconfig

@@ -35,7 +35,7 @@ config BT_MESH_MBEDTLS_BACKEND_ENABLE
 # thus more HEAP is needed by MEBEDTLS to accommodate minimum number of keys.
 config MBEDTLS_HEAP_SIZE
 	default 2048 if BT_MESH_DFD_SRV
-	default 1152 if BT_MESH_NLC_PERF_CONF
+	default 1152 if BT_MESH_NLC_PERF_BASELINE
 	default 1024
 
 if BT_SETTINGS
@@ -93,68 +93,93 @@ endif # BT_MESH_RELAY
 
 endif
 
-config BT_MESH_NLC_PERF_CONF
-	bool "Enable NLC performance configurations"
+# Provides baseline performance requirements for NLC profiles.
+# Automatically enabled when any NLC profile is selected.
+config BT_MESH_NLC_PERF_BASELINE
+	bool
 	select BT_MESH_COMP_PAGE_2
 	select BT_MESH_COMP_PAGE_1
-	help
-	  Enables performance configurations required for NLC profiles.
-	  When implementing the NLC Basic Lightness Controller profile
-	  individually or in conjunction with other NLC profiles, also
-	  enable CONFIG_BT_MESH_NLC_PERF_LIGHTNESS_CTRL.
 
-choice BT_MESH_NLC_PERF_OPTIONS
-	prompt "NLC configuration options"
-	depends on BT_MESH_NLC_PERF_CONF
+# Provides strict performance requirements needed for some NLC profiles.
+# Automatically enabled when relevant NLC profiles are selected.
+# Includes all baseline requirements plus additional strict requirements.
+config BT_MESH_NLC_PERF_STRICT
+	bool
+	select BT_MESH_NLC_PERF_BASELINE
 
-config BT_MESH_NLC_PERF_DEFAULT
-	bool "Default"
-	help
-	  Enables performance configurations required for the NLC Basic Scene Selector,
-	  Dimming Control, Energy Monitor, Occupancy Sensor and Ambient Light Sensor profiles.
-	  When implementing the NLC Basic Lightness Controller profile individually or in
-	  conjunction with other NLC profiles, use CONFIG_BT_MESH_NLC_PERF_LIGHTNESS_CTRL instead.
+menu "NLC Profile performance configuration"
+
+config BT_MESH_NLC_PERF_SCENE_SELECTOR
+	bool "Basic Scene Selector NLC profile performance configuration"
+	select BT_MESH_NLC_PERF_BASELINE
+
+config BT_MESH_NLC_PERF_DIMMING_CONTROL
+	bool "Dimming Control NLC profile performance configuration"
+	select BT_MESH_NLC_PERF_BASELINE
+
+config BT_MESH_NLC_PERF_ENERGY_MONITOR
+	bool "Energy Monitor NLC profile performance configuration"
+	select BT_MESH_NLC_PERF_BASELINE
+
+config BT_MESH_NLC_PERF_OCCUPANCY_SENSOR
+	bool "Occupancy Sensor NLC profile performance configuration"
+	select BT_MESH_NLC_PERF_BASELINE
+
+config BT_MESH_NLC_PERF_AMBIENT_LIGHT_SENSOR
+	bool "Ambient Light Sensor NLC profile performance configuration"
+	select BT_MESH_NLC_PERF_BASELINE
 
 config BT_MESH_NLC_PERF_LIGHTNESS_CTRL
-	bool "Enable strict performance configurations required for the Basic Lightness Controller"
+	bool "Basic Lightness Controller NLC profile performance configuration"
+	select BT_MESH_NLC_PERF_STRICT
+
+config BT_MESH_NLC_PERF_HVAC_INTEGRATION
+	bool "HVAC Integration NLC profile performance configuration"
+	select BT_MESH_NLC_PERF_STRICT
+
+endmenu
+
+config BT_MESH_NLC_PERF_DEFAULT
+	bool "Default NLC profile performance configuration [DEPRECATED]"
+	select DEPRECATED
+	select BT_MESH_NLC_PERF_BASELINE
 	help
-	  Enables required performance configurations for the
-	  NLC Basic Lightness Controller. The NLC Basic Lightness Controller
-	  share most performance configurations with the common NLC profiles
-	  (CONFIG_BT_MESH_NLC_PERF_DEFAULT) but with more strict requirements for a
-	  subset of the configurations.
+	  This option is deprecated. Use individual profile options instead.
+	  Enables performance configurations required for the Basic Scene Selector,
+	  Dimming Control, Energy Monitor, Occupancy Sensor, and Ambient Light
+	  Sensor NLC profiles.
 
-endchoice
+config BT_MESH_NLC_PERF_CONF
+	bool "NLC performance configurations [DEPRECATED]"
+	select DEPRECATED
+	select BT_MESH_NLC_PERF_BASELINE
 
+# Note: _STRICT configs must have precedence over _BASELINE.
 config BT_MESH_CRPL
-	default 32 if BT_MESH_NLC_PERF_DEFAULT
-	default 255 if BT_MESH_NLC_PERF_LIGHTNESS_CTRL
-	range 32 65535 if BT_MESH_NLC_PERF_DEFAULT
-	range 255 65535 if BT_MESH_NLC_PERF_LIGHTNESS_CTRL
+	default 255 if BT_MESH_NLC_PERF_STRICT
+	default 32 if BT_MESH_NLC_PERF_BASELINE
+	range 255 65535 if BT_MESH_NLC_PERF_STRICT
+	range 32 65535 if BT_MESH_NLC_PERF_BASELINE
 
 config BT_MESH_MODEL_GROUP_COUNT
-	default 32 if BT_MESH_NLC_PERF_LIGHTNESS_CTRL
-	range 32 4096 if BT_MESH_NLC_PERF_LIGHTNESS_CTRL
-
-if BT_MESH_NLC_PERF_CONF
+	default 32 if BT_MESH_NLC_PERF_STRICT
+	range 32 4096 if BT_MESH_NLC_PERF_STRICT
 
 config BT_MESH_MSG_CACHE_SIZE
-	default 64
-	range 64 65535
+	default 64 if BT_MESH_NLC_PERF_BASELINE
+	range 64 65535 if BT_MESH_NLC_PERF_BASELINE
 
 config BT_MESH_APP_KEY_COUNT
-	default 3
-	range 3 4096
+	default 3 if BT_MESH_NLC_PERF_BASELINE
+	range 3 4096 if BT_MESH_NLC_PERF_BASELINE
 
 config BT_MESH_SUBNET_COUNT
-	default 2
-	range 2 4096
+	default 2 if BT_MESH_NLC_PERF_BASELINE
+	range 2 4096 if BT_MESH_NLC_PERF_BASELINE
 
 config BT_MESH_PROXY_FILTER_SIZE
-	default 8
-	range 8 32767
-
-endif
+	default 8 if BT_MESH_NLC_PERF_BASELINE
+	range 8 32767 if BT_MESH_NLC_PERF_BASELINE
 
 config BT_MESH_USES_TFM_PSA
 	bool