SILICON LABS 8.0.0.0 Bluetooth Mesh SDK User Guide

User Guide for SILICON LABS models including: 8.0.0.0 Bluetooth Mesh SDK, 8.0.0.0, Bluetooth Mesh SDK, Mesh SDK, SDK

Silicon Labs Blluetooth Mesh Release Notes

Silicon Labs Silicon Labs

Release Notes

Releases · SiliconLabs/simplicity sdk · GitHub

File Info : application/pdf, 11 Pages, 496.80KB

bt-mesh-software-release-notes-8.0.0.0

Bluetooth® mesh SDK 8.0.0.0 GA
Simplicity SDK Suite 2024.12.0 December 16, 2024

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. Our software and SDK for Bluetooth development supports Bluetooth Mesh and Bluetooth 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 so Bluetooth mesh can 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:

KEY FEATURES
· Support added for Micrium and FreeRTOS.
· Bug fixes and minor enhancements.

8.0.0.0 released December 16, 2024

Compatibility and Use Notices
For more information about security updates and notices, see the Security chapter of the 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.

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0

Contents
Contents
1 New Items .......................................................................................................................................................................................... 3 1.1 New Features ............................................................................................................................................................................. 3 1.2 New APIs.................................................................................................................................................................................... 3
2 Improvements..................................................................................................................................................................................... 4 3 Fixed Issues ....................................................................................................................................................................................... 5 4 Known Issues in the Current Release ................................................................................................................................................ 6 5 Deprecated Items ............................................................................................................................................................................... 7 6 Removed Items .................................................................................................................................................................................. 8 7 Using This Release ............................................................................................................................................................................ 9
7.1 Installation and Use .................................................................................................................................................................... 9 7.2 Security Information.................................................................................................................................................................... 9 7.3 Support ..................................................................................................................................................................................... 10 7.4 SDK Release and Maintenance Policy ..................................................................................................................................... 10

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0 | 2

1 New Items
1.1 New Features
Added in release 8.0.0.0 New examples: Support for RTOS(Micrium and FreeRTOS) has been added for several examples. Micrium and FreeRTOS variants were made for the following applications:
· btmesh_ncp_empty · btmesh_soc_empty · btmesh_soc_nlc_basic_scene_selector · btmesh_soc_nlc_dimming_control · btmesh_soc_switch_ctl FreeRTOS variant was made for the following applications: · btmesh_soc_nlc_sensor_ambient_light · btmesh_soc_nlc_sensor_occupancy · btmesh_soc_sensor_client · btmesh_soc_sensor_thermometer Note that Device Firmware update is not yet supported in RTOS variant applications. New components: · btmesh_solicitation_config_client
A component was added for Proxy Service Solicitation. · App_rta and App_btmesh_rta
Application runtime adaptor layer for bare metal and RTOS related services. · Btmesh_lcd_server
A component for Large Composition Data Models Metadata Page 0 generation. Other new features:
· Models Metatdata Page 0 is supported and automatically generated for the examples. · App_button_press supports software debouncing. · Mesh Configurator tool supports generating Composition Data Page 1 and Page 2 for Vendor Models. · Network Analyzer tool supports Bluetooth Mesh 1.1 specification.
1.2 New APIs
Added in release 8.0.0.0 Changes in application components: Sli_sensor_server_cadence.c was renamed to Sl_sensor_server_cadence.c

New Items

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0 | 3

Improvements
2 Improvements
Changed in release 8.0.0.0 API documentation for OOB authentication data handling on provisioner and provisionee has been corrected and clarified.

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0 | 4

Fixed Issues

3 Fixed Issues

Fixed in release 8.0.0.0

ID # 348529
1337570 1339163 1345085, 1345650 1356050 1378339 1378639

Description Replay protection checks to discard messages were too strict for a corner case related to segments arriving out of order. Fixed a potential null pointer reference in DFU Client model. Removed stale outgoing advertisements from Tx queue to help manage overload situations. Fixed synchronization and thread safety issues with BGAPI command and event handling when RTOS is in use.
Improved the previous fix by eliminating unnecessary GATT service setup operations that could potentially fail. Fixed a periodic task running issue that affected embedded provisioners with GATT functionality. Fixed DFU Standalone Updater deinitialization sequence.

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0 | 5

Known Issues in the Current Release

4 Known Issues in the Current Release

Issues in bold were added since the previous release.

ID # 401550 454059 454061 624514 841360
1121605 1226127 1204017

Description No BGAPI event for segmented message handling failure.
A large number of key refresh state change events are generated at the end of KR process, and that may flood NCP queue. Slight performance degradation compared to 1.5 in round-trip latency tests was observed. Issue with re-establishing connectable advertising if all connections have been active and GATT proxy is in use. Poor performance of segmented message transmission over GATT bearer.
Rounding errors may cause scheduled events to trigger at very slightly different times than expected. Host provisioner example can be stuck when it starts to provision a second node. Distributor is not able to handle parallel self FW Update and FW Upload.

Workaround Application needs to deduce failure from timeout / lack of application layer response; for vendor models an API has been provided. Increase NCP queue length in the project.
Allocate one more connection than is needed.
Ensure that the underlying BLE connection's Connection interval is short; ensure that ATT MTU is large enough to fit a full Mesh PDU; tune the minimum connection event length to allow multiple LL packets to be transmitted per connection event.
Restart the host provisioner app before provisioning the second node. Don't run self FW update and FW upload in parallel.

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0 | 6

5 Deprecated Items
Deprecated in release 8.0.0.0 None.

Deprecated Items

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0 | 7

6 Removed Items
Removed in release 8.0.0.0 None.

Removed Items

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0 | 8

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.

Using This Release

7.1 Installation and Use
The Bluetooth mesh SDK is provided as part of the Simplicity SDK (GSDK), the suite of Silicon Labs SDKs. To quickly get started with the Simplicity SDK, install Simplicity Studio 5, which will set up your development environment and walk you through Simplicity SDK installation. Simplicity Studio 5 includes everything needed for IoT product development with Silicon Labs devices, including a resource and project launcher, software configuration tools, full IDE with GNU toolchain, and analysis tools. Installation instructions are provided in the online Simplicity Studio 5 User's Guide.
Alternatively, Simplicity SDK may be installed manually by downloading or cloning the latest from GitHub. See https://github.com/SiliconLabs/simplicity_sdk for more information .
Simplicity Studio installs the Simplicity SDK by default in: · Windows: C:\Users\<NAME>\SimplicityStudio\SDKs\simplicity_sdk · MacOS: /Users/<NAME>/SimplicityStudio/SDKs/simplicity_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.

Key
Network key Application key Device key

Exportability on a node
Exportable
Non-exportable
Non-exportable

Exportability on Provisioner
Exportable
Exportable
Exportable

Notes
Derivations of the network key exist only in RAM while network keys are stored on flash
In Provisioner's case, applied to Provisionerr's own device key as well as other devices' keys

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.

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0 | 9

Using This Release
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.

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.
7.4 SDK Release and Maintenance Policy
For details, see SDK Release and Maintenance Poilcy.

silabs.com | Building a more connected world.

Bluetooth Mesh 8.0.0.0 | 10

Simplicity Studio
One-click access to MCU and wireless tools, documentation, software, source code libraries & more. Available for Windows, Mac and Linux!

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.
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, 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

References

Silicon Labs Adobe PDF Library 24.4.48