Bluetooth® mesh SDK 6.1.1.0 GA

Introduction to Bluetooth Mesh

Bluetooth mesh is a new topology available for Bluetooth Low Energy (LE) devices that enables many-to-many (m:m) communication. It's optimized for creating large-scale device networks, and is ideally suited for building automation, sensor networks, and asset tracking. Silicon Labs' software and SDK for Bluetooth development supports Bluetooth Mesh and Bluetooth 5.3 functionality. Developers can add mesh networking communication to LE devices such as connected lights, home automation, and asset tracking systems. The software also supports Bluetooth beaconing, beacon scanning, and GATT connections, allowing Bluetooth mesh to connect to smart phones, tablets, and other Bluetooth LE devices.

This release includes features supported by the Bluetooth mesh specification version 1.1.

These release notes cover SDK versions:

• 6.1.1.0 released May 2, 2024
• 6.1.0.0 released April 10, 2024
• 6.0.1.0 released February 14, 2024
• 6.0.0.0 released December 13, 2023

Key Features

• ✔️ Qualified implementation of Mesh 1.1
• ✔️ Added Network Lighting Control (NLC) profiles

Compatibility and Use Notices

For more information about security updates and notices, see the Security chapter of the Gecko Platform Release notes installed with this SDK or on the Silicon Labs Release Notes page. Silicon Labs also strongly recommends that you subscribe to Security Advisories for up-to-date information. For instructions, or if you are new to the Silicon Labs Bluetooth mesh SDK, see Using This Release.

Compatible Compilers:

• IAR Embedded Workbench for ARM (IAR-EWARM) version 9.40.1
  Using wine to build with the IARBuild.exe command line utility or IAR Embedded Workbench GUI on macOS or Linux could result in incorrect files being used due to collisions in wine's hashing algorithm for generating short file names. Customers on macOS or Linux are advised not to build with IAR outside of Simplicity Studio. Customers who do should carefully verify that the correct files are being used.
• GCC (The GNU Compiler Collection) version 12.2.1, provided with Simplicity Studio
  Link-time optimization feature of GCC has been disabled, resulting in a slight increase of image size.

1 New Items

This release of the Gecko SDK (GSDK) will be the last with combined support for all EFM and EFR devices, except for patches to this version as needed. Starting in mid-2024, Silicon Labs will introduce separate SDKs: The existing Gecko SDK will continue with support for Series 0 and 1 devices. A new SDK will cater specifically to Series 2 and 3 devices. The Gecko SDK will continue to support all Series 0 and 1 devices with no change to the long-term support, maintenance, quality, and responsiveness provided under the software policy. The new SDK will branch from Gecko SDK and begin to offer new features that help developers take advantage of the advanced capabilities of Series 2 and 3 products. This decision aligns with customer feedback, reflecting Silicon Labs' commitment to elevate quality, ensure stability, and enhance performance for an exceptional user experience across its software SDKs.

1.1 New Features

Added in release 6.0.1.0

Changes in SLC components:

A third BT Mesh Role was added beside Provisioner and Provisionee role – a Custom BT Mesh Role, where the application gets the freedom to implement a custom role. For example, the Provisioner or Provisionee role could be selected at runtime.

Added in release 6.0.0.0

New Networked Lighting Control (NLC) example apps:

• btmesh_soc_nlc_basic_lightness_controller for demonstration of the BT Mesh NLC Basic Lightness Controller Profile
• btmesh_soc_nlc_basic_scene_selector for demonstration of the BT Mesh NLC Basic Scene Selector Profile
• btmesh_soc_nlc_dimming_control for demonstration of the BT Mesh NLC Dimming Controller Profile
• btmesh_soc_nlc_sensor_ambient_light for demonstration of the BT Mesh NLC Ambient Light Sensor Profile
• btmesh_soc_nlc_sensor_occupancy for demonstration of the BT Mesh NLC Occupancy Sensor Profile (People count)

Changes in example apps:

• btmesh_soc_sensor_server was deleted and its functionality was split into 3 examples:
• btmesh_soc_sensor_thermometer for demonstration of Sensor Server Model with a thermometer
• btmesh_soc_nlc_sensor_occupancy for demonstration of the BT Mesh NLC Occupancy Sensor Profile (people count)
• btmesh_soc_nlc_sensor_ambient_light for demonstration of the BT Mesh NLC Ambient Light Sensor Profile
• btmesh_soc_switch was renamed to btmesh_soc_switch_ctl, whose purpose is to demonstrate the usage of the Light CTL Client Model. The example no longer controls scenes (Scene Client).
• btmesh_soc_light was renamed to btmesh_soc_light_ctl. The example no longer demonstrates the LC Server model and Scene Server, Scheduler Server, and Time Server Models.
• btmesh_soc_hsl was renamed to btmesh_soc_light_hsl. The example no longer demonstrates the LC Server model and Scene Server, Scheduler Server, and Time Server Models.

Changes in all example apps:

• DFU image updates are generated by a Python script instead of create_bl_files.bat/.sh files.
• Support for Mesh Composition Data Pages 1, 2, 128, 129, 130 was added for all examples. These pages are automatically generated by the BT Mesh Configurator tool.

New SLC components:

• btmesh_nlc_basic_lightness_controller for demonstration of the BT Mesh NLC Basic Lightness Controller Profile
• btmesh_nlc_basic_lightness_controller_profile_metadata for Composition Data Page 2 NLC support for Basic Lightness Controller Profile
• btmesh_nlc_basic_scene_selector for demonstration of the BT Mesh NLC Basic Scene Selector Profile
• btmesh_nlc_basic_scene_selector_profile_metadata for Composition Data Page 2 NLC support for Basic Scene Selector Profile
• btmesh_nlc_dimming_control for demonstration of the BT Mesh NLC Dimming Controller Profile
• btmesh_nlc_dimming_control_profile_metadata for Composition Data Page 2 NLC support for Dimming Controller Profile
• btmesh_nlc_ambient_light_sensor for demonstration of the BT Mesh NLC Ambient Light Sensor Profile
• btmesh_nlc_ambient_light_sensor_profile_metadata for Composition Data Page 2 NLC support for Ambient Light Sensor Profile
• btmesh_nlc_occupancy_sensor for demonstration of the BT Mesh NLC Occupancy Sensor Profile (People count)
• btmesh_nlc_occupancy_sensor_profile_metadata for Composition Data Page 2 NLC support for Occupancy Sensor Profile
• btmesh_generic_level_client_ext for extending the Generic Base component with Generic Move Unacknowledged and Generic Delta Unacknowledged messages
• ncp_btmesh_ae_server for enabling the Silabs Configuration Server vendor model for the node to allow data transfer over Advertisement Extension
• ncp_btmesh_ae_server for enabling the Silabs Configuration Client vendor model for the node.
• ncp_btmesh_user_cmd for demonstrating the communication between an NCP host and NCP target using BGAPI user messages, responses, and events.

1.2 New APIs

Added in release 6.1.0.0

BGAPI additions:

New commands have been added to the node class to associate scan response data with Mesh provisioning and Mesh proxy service advertisements. The scan response data associated with Mesh proxy service advertisements can be set individually for each network key, so it can contain data encrypted with that key, but it is up to the application to manage that. The new commands are:

• sl_btmesh_node_set_proxy_service_scan_response: Set scan response data for proxy service advertisement
• sl_btmesh_node_clear_proxy_service_scan_response: Clear scan response data for proxy service advertisement
• sl_btmesh_node_set_provisioning_service_scan_response: Set scan response data for provisioning service advertisement
• sl_btmesh_node_clear_provisioning_service_scan_response: Clear scan response data for provisioning service advertisement

A new command has been added to the vendor model class to set model behavior options. Currently, there is one option that controls whether a work buffer is allocated from the heap for each vendor model for message reception reporting. The default value (1) allocates a buffer, which increases event reporting resilience when a device is under high load at the expense of additional heap memory usage. The new command is:

• sl_btmesh_vendor_model_set_option: Set a vendor model behavior option

New commands have been added to the diagnostic class to report friendship-related events. The new commands are:

• sl_btmesh_diagnostic_enable_friend: Enable generation of friendship-related diagnostic events
• sl_btmesh_diagnostic_disable_friend: Disable generation of friendship-related diagnostic events
• sl_btmesh_diagnostic_get_friend: Retrieve friendship-related diagnostic counters

New events added to the diagnostic class are as follows:

• sl_btmesh_diagnostic_friend_queue: Event for message being added to friendship message queue
• sl_btmesh_diagnostic_friend_relay: Event for message being relayed to an LPN
• sl_btmesh_diagnostic_friend_remove: Event for message being removed from friendship message queue

Added in release 6.0.0.0

Changes in SLC components:

• The ncp_btmesh_dfu component's ncp_btmesh_dfu.h has a new API: void sl_btmesh_ncp_dfu_handle_cmd(void *data, bool *cmd_handled);
• btmesh_provisioning_decorator component no longer restarts provisioning after provisioning fails.
• btmesh_lighting_server's sl_btmesh_lighting_server.h has a new API: void sl_btmesh_update_lightness(uint16_t lightness, uint32_t remaining_ms);
• btmesh_event_log has more granular configurability options.
• btmesh_ctl_client's sl_btmesh_ctl_client.h has an API change: instead of void sl_btmesh_set_temperature(uint8_t new_color_temperature_percentage);, the new API is void sl_btmesh_ctl_client_set_temperature(uint8_t temperature_percent); and void sl_btmesh_ctl_client_set_lightness(uint8_t lightness_percent);

BGAPI additions:

A new BGAPI class for device diagnostics has been added. It provides the application with Mesh stack statistics counters and an event-based reporting of network PDU relaying and proxying, which can be activated and deactivated as needed. The BGAPI commands in the diagnostic class are:

• sl_btmesh_diagnostic_init: Initialize the diagnostic component
• sl_btmesh_diagnostic_deinit: Deinitialize the diagnostic component
• sl_btmesh_diagnostic_enable_relay: Enable event-based reporting of network PDU relaying/proxying activity
• sl_btmesh_diagnostic_disable_relay: Disable event-based reporting of network PDU relaying/proxying activity
• sl_btmesh_diagnostic_get_relay: Get the number of relayed/proxied network PDUs so far
• sl_btmesh_diagnostic_get_statistics: Get mesh stack statistics counters
• sl_btmesh_diagnostic_clear_statistics: Zero mesh stack statistics counters

The BGAPI event in the diagnostic class is:

• sl_btmesh_diagnostic_relay: Event reporting that a network PDU has been relayed or proxied by the stack.

2 Improvements

Changed in release 6.1.0.0

The diagnostic class BGAPI command for retrieving statistics has been changed to retrieve chunks of data instead of retrieving all data at once. The caller should supply the size of the chunk it requests along with the offset of the chunk in the statistics data, and the call will return with as much data as can be supplied, given the request constraints.

Changed in release 6.0.0.0

• A provisioner or a node can now configure itself using the configuration client model and its own primary address as the destination for the messages. This can replace self-configuration by test BGAPI commands.
• Code optimization can result in slightly smaller firmware images than before, depending on the feature set used.
• Code optimization can result in slightly smaller RAM usage than before, depending on the feature set used.
• The Mesh stack no longer requires or supports the deprecated BLE advertiser and scanner components. Instead, it uses the current versions of each (legacy advertiser and legacy scanner for non-extended advertisements, and extended advertiser and extended scanner for extended advertisements). Applications that use both the BLE and the Mesh BGAPIs should no longer use the deprecated BLE advertiser and scanner components either.

3 Fixed Issues

Fixed in release 6.1.0.0

Fixed in release 6.0.0.1

Fixed in release 6.0.0.0

4 Known Issues in the Current Release

Issues in bold were added since the previous release.

5 Deprecated Items

Deprecated in release 6.0.0.0

The BGAPI command sl_btmesh_node_get_networks() has been deprecated. Use sl_btmesh_node_key_key_count() and sl_btmesh_node_get_key() instead.

The BGAPI commands sl_btmesh_test_set_segment_send_delay() and sl_btmesh_test_set_sar_config() have been deprecated. Use sl_btmesh_sar_config_set_sar_transmitter() and sl_btmesh_sar_config_server_set_sar_receiver() instead.

6 Removed Items

Removed in release 6.0.0.0

The BGAPI commands sl_btmesh_test_set_local_config() and sl_btmesh_test_get_local_config() have been removed.

The BGAPI commands sl_btmesh_node_get_statistics() and sl_btmesh_node_clear_statistics() have been removed.

7 Using This Release

This release contains the following:

• Silicon Labs Bluetooth mesh stack library
• Bluetooth mesh sample applications

If you are a first-time user, see QSG176: Silicon Labs Bluetooth Mesh SDK v2.x Quick-Start Guide.

7.1 Installation and Use

The Bluetooth mesh SDK is provided as part of the Gecko SDK (GSDK), the suite of Silicon Labs SDKs. To quickly get started with the GSDK, install Simplicity Studio 5, which will set up your development environment and walk you through GSDK installation. Simplicity Studio 5 includes everything needed for IoT product development with Silicon Labs devices, including a resource and project launcher, software configuration tools, a full IDE with GNU toolchain, and analysis tools. Installation instructions are provided in the online Simplicity Studio 5 User's Guide.

Alternatively, Gecko SDK may be installed manually by downloading or cloning the latest from GitHub. See https://github.com/SiliconLabs/gecko_sdk for more information.

The GSDK default install location has changed with Simplicity Studio 5.3 and higher:

• Windows: C:\Users\<NAME>\SimplicityStudio\SDKs\gecko_sdk
• MacOS: /Users/<NAME>/SimplicityStudio/SDKs/gecko_sdk

Documentation specific to the SDK version is installed with the SDK. Additional information can often be found in the knowledge base articles (KBAs). API references and other information about this and earlier releases is available on https://docs.silabs.com/.

7.2 Security Information

Secure Vault Integration

This version of the stack is integrated with Secure Vault Key Management. When deployed to Secure Vault High devices, mesh encryption keys are protected using the Secure Vault Key Management functionality. The table below shows the protected keys and their storage protection characteristics.

Keys that are marked as "Non-Exportable" can be used but cannot be viewed or shared at runtime. Keys that are marked as "Exportable" can be used or shared at runtime but remain encrypted while stored in flash.

For more information on Secure Vault Key Management functionality, see AN1271: Secure Key Storage.

Security Advisories

To subscribe to Security Advisories, log in to the Silicon Labs customer portal, then select Account Home. Click HOME to go to the portal home page and then click the Manage Notifications tile. Make sure that 'Software/Security Advisory Notices & Product Change Notices (PCNs)' is checked, and that you are subscribed at minimum for your platform and protocol. Click Save to save any changes.

The screenshot shows the Silicon Labs customer portal's 'Update Preference' section, highlighting options for subscribing to Software/Security Advisory Notices & Product Change Notices (PCNs) and selecting product categories like Bluetooth Low Energy.

7.3 Support

Development Kit customers are eligible for training and technical support. Use the Silicon Labs Bluetooth mesh web page to obtain information about all Silicon Labs Bluetooth products and services, and to sign up for product support.

Contact Silicon Laboratories support at http://www.silabs.com/support.

Simplicity Studio Overview

Simplicity Studio provides one-click access to MCU and wireless tools, documentation, software, source code libraries & more. It is available for Windows, Mac, and Linux!

Explore Silicon Labs' offerings:

• IoT Portfolio: www.silabs.com/IoT
• SW/HW: www.silabs.com/simplicity
• Quality: www.silabs.com/quality
• Support & Community: www.silabs.com/community

Disclaimer

Silicon Labs intends to provide customers with the latest, accurate, and in-depth documentation of all peripherals and modules available for system and software implementers using or intending to use the Silicon Labs products. Characterization data, available modules and peripherals, memory sizes, and memory addresses refer to each specific device, and "Typical" parameters provided can and do vary in different applications. Application examples described herein are for illustrative purposes only. Silicon Labs reserves the right to make changes without further notice to the product information, specifications, and descriptions herein, and does not give warranties as to the accuracy or completeness of the included information. Without prior notification, Silicon Labs may update product firmware during the manufacturing process for security or reliability reasons. Such changes will not alter the specifications or the performance of the product. Silicon Labs shall have no liability for the consequences of use of the information supplied in this document. This document does not imply or expressly grant any license to design or fabricate any integrated circuits. The products are not designed or authorized to be used within any FDA Class III devices, applications for which FDA premarket approval is required, or Life Support Systems without the specific written consent of Silicon Labs. A "Life Support System" is any product or system intended to support or sustain life and/or health, which, if it fails, can be reasonably expected to result in significant personal injury or death. Silicon Labs products are not designed or authorized for military applications. Silicon Labs products shall under no circumstances be used in weapons of mass destruction including (but not limited to) nuclear, biological or chemical weapons, or missiles capable of delivering such weapons. Silicon Labs disclaims all express and implied warranties and shall not be responsible or liable for any injuries or damages related to use of a Silicon Labs product in such unauthorized applications.

Note: This content may contain offensive terminology that is now obsolete. Silicon Labs is replacing these terms with inclusive language wherever possible. For more information, visit www.silabs.com/about-us/inclusive-lexicon-project.

Trademark Information

Silicon Laboratories Inc.®, Silicon Laboratories®, Silicon Labs®, SiLabs® and the Silicon Labs logo®, Bluegiga®, Bluegiga Logo®, EFM®, EFM32®, EFR, Ember®, Energy Micro, Energy Micro logo and combinations thereof, "the world's most energy friendly microcontrollers", Redpine Signals®, WiSeConnect, n-Link, ThreadArch®, EZLink®, EZRadio®, EZRadioPRO®, Gecko®, Gecko OS, Gecko OS Studio, Precision32®, Simplicity Studio®, Telegesis, the Telegesis Logo®, USBXpress®, Zentri, the Zentri logo and Zentri DMS, Z-Wave®, and others are trademarks or registered trademarks of Silicon Labs. ARM, CORTEX, Cortex-M3 and THUMB are trademarks or registered trademarks of ARM Holdings. Keil is a registered trademark of ARM Limited. Wi-Fi is a registered trademark of the Wi-Fi Alliance. All other products or brand names mentioned herein are trademarks of their respective holders.

Silicon Laboratories Inc.
400 West Cesar Chavez
Austin, TX 78701
USA
www.silabs.com