nRF5 SDK for Mesh v3.2.0  08c60f6
Release Notes

This page contains all the notes for the major and minor production releases of the nRF5 SDK for Mesh.

Table of contents

  • BLE Mesh v3.2.0
    • New features and highlights
    • Changes
    • Bugfixes
  • BLE Mesh v3.1.0
  • BLE Mesh v3.0.0
  • BLE Mesh v2.2.0
  • BLE Mesh v2.1.1
  • BLE Mesh v2.0.0
  • BLE Mesh v1.0.1
  • BLE Mesh v1.0.0
  • BLE Mesh v0.10.1-Alpha
  • BLE Mesh v0.10.0-Alpha
  • BLE Mesh v0.9.2-Alpha
  • BLE Mesh v0.9.1-Alpha
  • BLE Mesh v0.9.0
  • BLE Mesh v0.8.1
  • BLE Mesh v0.8.0
  • BLE Mesh v0.7.7

Check Migration guide for mandatory changes to your projects caused by the release of new features and updates.


BLE Mesh v3.2.0 @anchor release_notes_320

Release Date: Week 30, 2019

This is a minor feature release. It adds Friend feature support, the RSSI monitoring model, support for nRF5 SDK v15.3.0, significant changes to the DFU documentation, and fixes to several bugs.

New features and highlights @anchor release_notes_320_highlights

  • Added an experimental support for the Friend feature.
    • The Friend feature is enabled with the MESH_FEATURE_FRIEND_ENABLED define.
    • It is enabled by default for the Light switch server example.
    • For the list of the most relevant changes introduced with this feature, see Changes > Friendship feature.
  • Added the vendor-specific RSSI monitoring model.
  • Added experimental support for the S113 SoftDevice.
  • Added support for the nRF5 SDK v15.3.0 and the GNU ARM Embedded Toolchain v7.3.1.

Changes @anchor release_notes_320_changes

Documentation

Friendship feature

  • Made changes to the transport layer to support the Friendship feature. The layer now has a new RX address logic and additional SAR RX complete logic.
  • Modified the network_packet_alloc API to allow packets in the friend queue to be sent without modification to the network metadata fields.
  • Introduced a new MESH_FEATURE_LPN_ACT_AS_REGULAR_NODE_OUT_OF_FRIENDSHIP define to the LPN functionality that allows a node with the LPN feature to participate in a mesh network as a regular node when the friendship is not established by keeping scanner and net beacon modules enabled.
  • Implemented the core loopback mechanism and modified the upper transport layer as part of the core loopback mechanism, so that the Friend nodes can send messages to LPNs.
  • Removed Friend and Low Power RX sources. Scanner source is now used for both.

Provisioning

  • Made examples re-generate provisioning private and public keys for every run.
  • Updated the static provisioner example to set the Network Transmit count to 2 for newly provisioned devices.
  • Added support to only allow secure provisioning if required. This can be enabled by setting NRF_MESH_PROV_FORCE_SECURE_PROVISIONING compile time option to 1.

Other changes

  • Aligned the secure network beacon update logic with the latest minor version update of the specification.
  • Fixed a bug that would cause asserts in the extended model initialization. Additionally, to maintain integrity of the device composition, new models cannot be initialized during runtime after the mesh stack has been initialized when persistent storage is used.
  • Made changes at the scanner level to ignore the non-mesh packets and reduce memory footprint.
  • Added APIs to the Config Client model for sending Network Transmit Set and Network Transmit Get messages.
  • Started using nRF5 SDK as a backend for static asserts.
  • Implemented a change to the bootloader. It now explicitly disables the radio before moving to the application.
  • Improved the bank address selection of the Mesh DFU example.
  • Added the possibility to set CMock and Unity paths through environment variables on Windows and Linux.
  • Added a log message to the BLE DFU support module module if the ble_dfu_support_init function fails to initialize the Buttonless DFU Service due to the missing bootloader.

Bugfixes @anchor release_notes_320_bugfixes

  • Removed outdated information about setting SDK_ROOT macro from command line.
  • Introduced a new NRF_MESH_EVT_PROXY_STOPPED event to fix a bug that would cause the node reset to get stuck when using GATT.
  • Fixed a Health Server issue that would cause the server to return from fast period back to regular publish period without taking any configuration server updates into account, or report a wrong publish period value while publishing with fast cadence.
  • Fixed a bug that would prevent the Health Server model from supporting subscriptions. See Migration guide for details.
  • Fixed wrong opcodes used in the Generic Power OnOff model.
  • Fixed a bug that would cause level behavior module to not accept all transition time values provided by the level server model for the move speed calculation, and fixed some behavioral corner cases.
  • Fixed a bug that would cause the access layer to use a non-zero TTL value when replying to a message received with the TTL set to zero.
  • Fixed an issue that would cause the provisioning process to take around 10 seconds more than in the nRF5 SDK for Mesh v2.2.0.
  • Implemented a fix that makes the generic default transition time server model validate set message parameters.
  • Fixed a bug that would cause the nrf_mesh_disable() function to take several seconds to disable the mesh.
  • Fixed a bug that would prevent erasing of the application-specific flash data in the EnOcean switch translator client example.
  • Fixed a bug that would cause the model_timer_elapsed_ticks_get() function to return a wrong value when called from inside of the callback.
  • Fixed a bug that would cause the transport decrypt to hardfault if someone sent a packet to a virtual address with a device key.
  • Fixed an issue where the public key was transmitted before rejecting an invalid public key from the peer. The invalid public key is now rejected immediately.
  • Added a change to the transport layer that will now reject old, failed SAR sessions.
  • Fixed a bug that would break receiving on ALL_FRIEND_ADDRESS when the Friend feature is active.
  • Fixed incorrect DSM API usage in the provisioner example.
  • Fixed a bug in PB remote server and client examples that would cause examples to stop working when they were power cycled after provisioning a device.
  • Fixed a bug in the Config Server model that would cause the Config Server to send a wrong status code in response to the Config Model Publication Set message when the target model does not support publish mechanism.
  • Fixed the pyACI company ID endianness in the opcode parsing.

BLE Mesh v3.1.0 @anchor release_notes_310

Release Date: Week 2, 2019

This is a minor feature release. In addition to several minor and major bugfixes, it brings DFU support for the LPN example, publish re-transmission support in the access layer, improvements in the heartbeat module, and a major rework of example documentation.

As part of this release, several files have been modified. See Migration guide for details and update your projects accordingly.

New features and highlights @anchor release_notes_310_highlights

  • Added Device Firmware Upgrade (DFU) support for the LPN example. You can now upgrade the LPN device firmware using the solution from nRF5 SDK.
  • Implemented publish re-transmission support in the access layer. You can now re-transmit published messages according to the Publish Retransmit Count and the Publish Retransmit Interval Steps states.

Changes @anchor release_notes_310_changes

Identifier changes

  • Updated example UUIDs. See the Migration guide page for details and required changes.
  • Implemented URI hash usage. All examples now advertise the URI hash in the unprovisioned device beacon, and static provisioner example uses this URI hash during the provisioning process.

Heartbeat module improvements

  • The subscription address no longer needs to be owned by any model.
  • Moved parameter sanitation from configuration server to Heartbeat.
  • Heartbeat now can trigger when friendship is established.
  • Fixed upper boundary of publication count value.

OOB-related updates

Documentation

  • Reworked documentation pages for Examples.
    • All pages now follow the same layout, which makes them more readable. This new structure is similar to the nRF5 SDK examples.
    • Contents of the pages have been reviewed and updated.
    • Remote provisioning client and server examples are now described on one page: Remote provisioning example (experimental).
  • Edited the Compatibility page structure for clarity.
  • Expanded information about interacting with examples using SEGGER RTT Viewer.

Other changes

  • Implemented stricter rules for transaction number handling in PB-ADV to avoid unexpected behavior when paired with misbehaving nodes. See Migration guide page for details and required changes.
  • Added support for clearing the state in mesh config.
  • Added upper boundaries to the number of keys, models, and addresses to avoid unexpected behavior when configuration messages exceed maximum access layer message size.
  • Simplified Generic Power OnOff client initialization API. See Migration guide for details and required changes.
  • Made replay protection more flexible and cut its RAM requirements by half.

Bugfixes @anchor release_notes_310_bugfixes

Low Power node bugfixes

  • Fixed a bug that would cause the LPN to terminate friendship after getting 5 data packets in a row.
  • Added missing PB-ADV bearer in the LPN example compilation unit. See Migration guide for details.

Other bugfixes

  • Fixed issues related to beaconing interval calculation for secure network beacons.
  • Fixed a bug that would cause the relay and originator packets to have the same repeat count by default. They now have different repeat counts once again.
  • Fixed a bug with the serial interface. It now propagates the SERIAL_OPCODE_EVT_MESH_TX_COMPLETE events as advertised.
  • Fixed a bug in the app_timer that caused the LEDs to stop blinking.
  • Fixed an assert when setting the GATT proxy state in the configuration server with the same value twice.
  • Fixed a bug with the Health Server attention state. It no longer disables publication if the fast intervals are shorter than 100 ms.
  • Fixed the incorrect scaling of advertisement timeout interval parameter provided to the mesh_adv_params_set() API.
  • Fixed the light switch provisioner example. Invalid packets no longer cause the light switch server configuration to fail.

Known issues and limitations @anchor release_notes_310_known_issues

  • Stack applies only 20 seconds delay if secure network beacons from the other devices are transmitted unevenly.
  • Due to a bug in the GNU ARM Embedded Toolchain 8-2018-q4-major release, building with CMake on Windows is not working correctly when you use this latest version. A warning note was added to Installing the toolchain.

BLE Mesh v3.0.0 @anchor release_notes_300

Release Date: Week 48, 2018

This is a major release that brings integration with the latest version of the nRF5 SDK and experimental support for the Low Power feature and GenericOnOff models. It also introduces changes to API, core, and examples, several important bugfixes, and the first step in a major documentation re-work.

As part of this release, several files have been added and removed. See Migration guide for details and update your projects accordingly.

New features and highlights @anchor release_notes_300_highlights

  • Added integration with the nRF5 SDK v15.2. The nRF5 SDK for Mesh is now incompatible with all older releases of the nRF5 SDK. See the Migration guide page for required changes.
  • Added experimental support for Low Power node feature. See Low Power node feature and Integrating Low Power node feature for documentation.
  • Implemented experimental support for Generic PowerOnOff models.

Changes @anchor release_notes_300_changes

API changes

  • Changed NRF_MESH_IRQ_PRIORITY_LOWEST IRQ priority level in accordance to nRF5 SDK 15.2. See Migration guide for details.
  • Added new argument attention_duration_s to nrf_mesh_prov_provision() in mesh/prov/api/nrf_mesh_prov.h. This is required in the provisioning process. See Migration guide for details.
  • Added enforcement of a spec rule that disallows simultaneous segmented transmissions between a source and a destination address by returning NRF_MESH_ERROR_INVALID_STATE on publish calls. See Migration guide for details.
  • Added new event NRF_MESH_EVT_DISABLED.
  • Added a function to get the Health Server structure from the Mesh Stack module for usage in the Health Server API.
  • Unified compile time flags for enabling and disabling mesh features. See Migration guide for details.

Core changes

  • The mesh stack scheduler now runs on app_timer.
    • Some modifications to the SDK 15.2 version are required. More information can be found in the Migration guide.
      • The modified version can be found in external/app_timer/app_timer_mesh.c.
      • The modified implementation is added by default in the example projects.
    • There are no changes to the API and existing code using the app_timer will work without modification.
  • Flash Manager now supports reading entries while in the defragmentation state.
  • Updated subscription_list_share() to ensure there is only one allocated list at a time.
    • When the extended model now shares the subscription list across all of its models, the access deallocates any excess allocated lists.
  • Removed all uses of Variable Length Arrays (VLAs). If compiled with ARMCC, the program will use heap allocated memory for the array and will hardfault if the allocation fails.
  • Unified all dynamic memory management in the mesh stack into one Mesh memory manager module.

Example changes

  • GATT Provisioning and Proxy features are now enabled in the Light Switch Server, Light Switch Client, Dimming Server, Dimming Client, and EnOcean examples.
    • Due to this change, the Light Switch Proxy Server and the Light Switch Proxy Client examples were removed.
  • Lowered the default Node Identity advertisement interval.
    • Lowering the interval allows the provisioner to re-connect to the device more quickly after the provisioning is complete. This in turn makes the provisioning and configuration process faster when using the nRF Mesh mobile app.
  • The mesh_softdevice_init module is replaced with the BLE SoftDevice support module.

Documentation changes

  • Updated the documentation. This is the first step in a longer process of improving the quality of the documentation.
    • Modified the structure of documentation on the nRF5 SDK for Mesh documentation website and in the nRF5 SDK for Mesh GitHub repository, including:
      • Moved several pages between sections. For example, Interrupt priority levels is now featured in the Overview section.
      • Removed Scripts section on the nRF5 SDK for Mesh documentation website that contained a duplicated page about Interactive PyACI. This page is now available at Libraries > Serial interface.
      • Removed the standalone deprecated list page. Deprecated functions are still marked as _DEPRECATED in the code.
      • Removed the standalone Simple OnOff model page. Its contents are now integrated in the model's header file and the Configuring new models page.
      • Renamed Introduction to Overview. This section now includes conceptual, descriptive documentation.
      • Updated Getting started section. It now includes instructional documentation.
      • Grouped experimental examples in the Experimental examples subsection.
      • Grouped provisioning-related pages in the Enabling provisioning subsection.
    • Created new pages by splitting content on already existing pages (for example, Compatibility or Repository structure). These new pages will be expanded in the future.
    • Edited Installing the toolchain page for clarity. It now better lists required tools for each operating system.
    • Edited Building the mesh stack and examples page, so that it lists building instructions for both SEGGER Embedded Studio and CMake on one page. The instructions were updated.
    • Created new Running examples page. It includes expanded contents from the main Examples page.
    • Changed names of several pages for consistency. For example, "How to add PA/LNA support" is now "Enabling PA/LNA support".
    • Fixed typos and various language issues on several pages.
    • Added table of contents and horizontal section separators to several pages. This formatting will be extended to other pages in the future.
  • Edited documentation of several APIs for typos, clarity, and consistency.

Bugfixes @anchor release_notes_300_bugfixes

Core bugfixes

  • Fixed a bug that could cause the transport layer to not re-schedule retries for segmented messages if the sequence number allocation failed.
  • Fixed a bug that would cause Timer Events Scheduler to be unable to reschedule events more than 65536 times.

Flash Manager bugfixes

  • Fixed Flash Manager init behavior.
    • Timeslots are now started before the calls to flash_manager_add to prevent an init-deadlock.
    • Fixed a bug that would report Flash Manager as stable when it wasn't. packet_buffer now has an additional packet_buffer_is_empty() API for checking whether the queue is completely empty. The flash_manager_is_stable() function makes use of this API to make the flash_manager_wait() correctly start blocking.
  • Fixed a bug that would block flash operations that can't fit between two Softdevice events (for example, Proxy connection events).

Model bugfixes

  • Fixed a bug concerning Company ID in Vendor Model Opcode (see access_opcode_t). Company ID is now correctly packed in little-endian order.
    Note
    Due to this fix, vendor specific models are now incompatible with BLE Mesh v2.2.0 and older.
  • Fixed a bug that would make it impossible to add models that only send messages.

PyACI bugfixes

  • Fixed a bug in PyACI that would accept 0xFFFF as a valid subscription address for "Config model subscription add". Now, Invalid Address error is returned.
  • Fixed a bug that would trigger PyACI assert when loading Retransmit values from the provisioning database.
  • Fixed a bug in PyACI that caused asserts when unpacking AppKey/NetKey Lists in multiple places.
  • Fixed a bug that would cause a PyACI assert when unpacking some status replies in the PyACI Configuration Client.

Assertion and crash fixes

  • Fixed a bug that would cause the mesh devices to hardfault because of misformed packets. Network packets are now subject to length checks.
  • Fixed a bug that caused GATT to assert when in connection, if the network ran out of sequence numbers.
  • Fixed some rare asserts in the transition from provisioning to configuration when adding a device with the nRF Mesh App.

Known issues and limitations @anchor release_notes_300_known_issues

  • If the mesh stack is configured with IRQ priority NRF_MESH_IRQ_PRIORITY_THREAD and run in the main loop with app_scheduler, there might be delays of ~15 ms.
  • Publish re-transmission settings are not supported

BLE Mesh v2.2.0 @anchor release_notes_220

  • This is a minor production release.

New features

  • Generic server/client model interfaces for OnOff, Default Transition Time, and Level models
  • Sample generic OnOff server behavior implementation
  • New Mesh Config module that provides high-level access to persistent storage. This module uses the existing Flash Manager and aims to enable multiple flash backends (including nRF5 SDK fstorage) in the future.
  • Moved mesh runtime configuration options to a new, type-safe mesh_opt_* API in their respective submodules. The options are stored in persistent memory through the new mesh_config module.
  • Added persistent storage to several internal states:
    • Heartbeat publication
    • Net beacon
    • GATT proxy

Other

  • Updated model directory structure:
    • Foundation models have been moved to models/foundation
    • Generic models are present in models/model_spec
    • Vendor specific models have been moved to models/vendor
    • Experimental models have been moved to models/experimental
  • Updated examples to support Generic OnOff models
  • Simplified EnOcean, Light Switch Client, and SDK coexistence examples to use only two Generic OnOff client model instances
  • Marked the old nrf_mesh_opt API deprecated (it will be removed in the next major production release)
  • Updated the mesh to use the section variables module from the nRF5 SDK (see the migration guide for details)
  • Updated various parts of the documentation (added documentation for GATT Proxy example and for PA/LNA support)

Bugfixes

  • EnOcean example was not supporting multiple enocean switches
  • Mesh GATT asserted if other services uses HVX (MBTLE-2623)
  • Serial interface driver does no longer block on packet allocation (MBTLE-1844)
  • Made access address definition explicitly unsigned (MBTLE-2453)
  • bootloader_verify.py did not recognize nRF52840 (MBTLE-2610)
  • Fixed parsing error in PyACI heartbeat_subscription_get() (MBTLE-2690)

Known issues and limitations

  • Softdevice S140 v6.0.0 sets the event IRQ priority into the wrong value 6 (should be 7). That might cause an internal stack memory corruption. To avoid the issue the file from Mesh SDK <Mesh SDK folder>/external/sdk_fix/nrf_sdh.c shall be used. Otherwise the examples which use GATT will generate assertion Mesh error 3 at <address> (examples/common/include/mesh_app_utils.h:100)
  • If the mesh stack is configured with IRQ priority NRF_MESH_IRQ_PRIORITY_THREAD and run in the main loop with app_scheduler, there might be delays of ~15 ms.

BLE Mesh v2.1.1 @anchor release_notes_211

  • This is a minor production release.

New features

  • Add PA/LNA support for timeslot projects

Bugfixes

  • Access loopback needs context switch
  • Config server: send_publication_status() always sends status code as ACCESS_STATUS_SUCCESS or it Asserts
  • Sending a reliable message via internal loop causes to double sending with opposite results
  • Don't allow provisioner to use OOB public key if we don't support it
  • Fix static assertions for flash size
  • Config server replies to feature set when it shouldn't
  • light_switch_proxy_client SES project imports app_error.c twice, leads to compile error
  • Light switch client requires all buttons to be configured
  • Heartbeat Publication Set message duplicates count value
  • Mesh GATT asserts on MTU requests
  • In-place modification of event list during event handling
  • Device page generator outputs file for nrf52832 no matter platform chosen
  • Mesh timeslot extension is prohibiting softdevice advertising (GATT)
  • Mesh proxy sets advertising timing in wrong order
  • Invalid handling of service changed attribute
  • Application defined softdevice settings are lost during GATT dabase reset
  • Core TX alloc rejected by GATT proxy bearer
  • Provisioner stops provisioning new nodes prematurely
  • No support for reserved groups (all-nodes, all-proxies, ...)
  • Heartbeat does not include all active features in published message
  • Segger Embedded Studio projects have invalid memory configurations
  • Connecting and disconnecting from PB-GATT leaves provisioning bearers in undefined state
  • Persistent storage is turned off for proxy client
  • Mesh GATT module does not propagate ADV timeout event
  • hal_led_blink_ms call is blocking and used in IRQs
  • device_page_generator.py key parsing errors
  • device_page_generator.py wrong output filename

Known issues and limitations

  • Publish re-transmission settings are not supported
  • Some Config server and Health server model states are not persistent
  • Setting device in attention state during provisioning is not supported
  • Light switch provisioner example: During the configuration of a node, the static provisioner example may sometimes consider a status response of a previous configuration step as the status response of the current configuration step. This may cause a node configuration to remain incomplete, without the provisioner noticing. If this happens, provisioned client or server nodes will not respond to user inputs as expected. This occurs due to mesh message re-transmissions logic built into the stack causing responses to SET messages to arrive out of order. This scenario is most likely to manifest itself in situations when the mesh stack is not scanning for the majority of the time. For example, while running other BLE connections with a short connection interval.

Verification Notices / Test Errata

  • Test Configurations: – nrf52832 || s132_6.0.0 || pca10040 – nrf52840 || s140_6.0.0 || pca10056

BLE Mesh v2.0.1 @anchor release_notes_201

  • This is a minor bugfix release

Bugfixes

  • Ignore Config Proxy Set and Config Friend Set messages with invalid parameters

BLE Mesh v2.0.0 @anchor release_notes_200

  • This is a major production release.

New features

  • GATT Proxy (experimental)
  • PB-GATT bearer (server) (experimental)
  • Generic GATT interface for PB-GATT and Proxy (experimental)
  • Interactive Configuration client for the Interactive PyACI
  • Concurrent provisioning link listening
  • Third party BLE device integration example: Integrating EnOcean switch with Mesh networks
  • Separate Light switch provisioner example

Other

  • Integrates with nRF5 SDK 15 (NOTE: nRF5 SDK is now a separate download from nRF5 SDK for Mesh)
  • Examples more aligned with the nRF5 SDK examples
  • Separated out provisioner role from Light switch client example

Bugfixes

  • No SLIP bytes before responses when using SLIP mode for the serial interface
  • Buffer handling does not reset head and tail when buffer is empty
  • Various asserts in Light switch example
  • Stack doesn't send Provisioning Failed PDU in certain cases
  • Transport layer sends ACK for timed-out message
  • No way to stop IV update procedure in test mode
  • Heartbeat subscription does not check destination state
  • Provisionee does not sanitize input in provisioning start message
  • access_reliable_cancel_all() and access_model_reliable_cancel() does not actually cancel pending reliable transfers
  • Access status codes does not align with Mesh Profile v1.0 values
  • Config server doesn't reply to Composition Data Get message requesting page 0xFF
  • Config server reports error for duplicate NetKey Add command
  • Config server send_publication_status() always sends status code as ACCESS_STATUS_SUCCESS or it asserts
  • Config server resets the device before reset response goes out
  • Device key is bound to only one network key (primary)
  • Access layer does not allow user to stop periodic publication by setting Unassigned (0x0000) publish address (or any other event which disabled model publication)
  • Vendor Model IDs reversed according to the Mesh Profile specification v1.0
  • Redundant advertiser in beacon module
  • Wrong IRQ level used for button GPIO and UART

Known issues and limitations

  • Publish re-transmission settings are not supported
  • Some Config server and Health server model states are not persistent
  • Setting device in attention state during provisioning is not supported
  • Light switch provisioner example: During the configuration of a node, the static provisioner example may sometimes consider a status response of a previous configuration step as the status response of the current configuration step. This may cause a node configuration to remain incomplete, without the provisioner noticing. If this happens, provisioned client or server nodes will not respond to user inputs as expected. This occurs due to mesh message re-transmissions logic built into the stack causing responses to SET messages to arrive out of order. This scenario is most likely to manifest itself in situations when the mesh stack is not scanning for the majority of the time. For example, while running other BLE connections with a short connection interval.
  • device_page_generator.py
    • The script will not parse the public_key property of bootloader_config_default.json when using Python 2. A workaround for the issue is to call bytearray.fromhex() on the public_key in device_page_generator.py:99.
    • The script will store the new device page to bin/device_page_nrf52832_xxAA_s132_5.0.0.hex regardless of SoftDevice and platform setting. A workaround for the issue is to specify the path manually with the --output-file option, i.e., --output-file bin/device_page.hex.

BLE Mesh v1.0.1 @anchor release_notes_101

This is a hotfix release with documentation/bug fixes.

New features

  • None

Bugfixes

  • Provisionee support added to Beacon example
  • Beacon Example: Fixed beacon enable serial command
  • Provisioner: Fixed OOB authentication procedure
  • Device Reset: Fixed 1 dropped packet on startup

Other / Documentation

  • SDK coexistence guide updated for better explanation of coexistence with other Nordic SDKs for concurrent GATT/GAP (and other usage)
  • DFU quick start guide fixed along with device_page_generator.py script
  • SDK patch file updated
  • Serial Example documentation updated
  • Mesh Assert cleanup

Verification / Test Errata

  • nRF51 platform testing has been put on hold

BLE Mesh v1.0.0 @anchor release_notes_100

This is the first production release of Nordic's nRF5 SDK for Mesh. This release implements mandatory features for the Mesh Profile 1.0 specification and also some proprietary features (PB-remote and Nordic Advertiser Extensions) in experimental state.

New features

  • Key refresh has been implemented
  • Heartbeat support has been added
  • DFU bootloader source code added
  • Support for nRF52840_xxAA
  • Proprietary Nordic Advertiser Extensions ("InstaBurst!") feature for improved throughput
  • AD-listener module for simplified subscription to advertisement data
  • IRQ levels are now aligned with the nRF5 SDK
    • All API-functions are expected to be called from NRF_MESH_IRQ_PRIORITY_LOWEST
  • Node de-provisioning supported through the Config Server Node Reset message

Bugfixes

  • Fixed beacon advertiser not enabled in example
  • Fixed trailing garbage data in Composition Data
  • Build fails if the path to the repo has spaces
  • Fixed issue where the serial interface gets corrupted memory or hangs on an incoming serial packet that is too long
  • Fixed issue where the Config Server used the application key index and not the DSM handle when deleting key
  • Removed duplication of Company ID
  • Fixed assertion on invalid length for unprovisioned beacons
  • Removed warnings and errors from documentation build

Other

  • Provisioning API changed slightly to de-couple the upper and lower layers more cleanly

Known limitations

  • Optional features of the Mesh Profile 1.0 Specification are not part of this release.

Test Errata

  • DFU : replacing Softdevice live while running app is not tested.

BLE Mesh v0.10.1-Alpha @anchor release_notes_0101

This is a hotfix release with no new features.

Bugfixes

  • Segger Embedded Studio Projects have devkit BOARD defines now instead of dongles.
  • Standard BLE Access Address now used for all binary artifacts (.hex/.lib)

BLE Mesh v0.10.0-Alpha @anchor release_notes_0100

This is a minor feature release for the experimental nRF5 SDK for Mesh

New features

  • Health Model
  • Reworked build system
    • Support for nRF52840 (but not part of the integration testing)
    • Support for new SoftDevices S132 versions 4.0.4 and 5.0.0 and S140 version 5.0.0-3.alpha
    • Aligned with the nRF5 SDK version 14. Note: A subset of the nRF5 SDK is included in the nRF5 SDK for Mesh with some minor changes. See external/nRF5_SDK_14.0.0_3bcc1f7/nRF5_SDK_14.0.0_3bcc1f7.patch for the changes made.
  • Refactored Bearer Layer and Core for increased bandwidth and robustness
    • Any number of concurrent advertisers
    • Custom radio implementations possible
    • Improved SAR reliability and throughput
    • TX Complete events fully supported
    • Significant reduction in packet processing time
    • More efficient radio code, major throughput improvements in noisy conditions
  • Access Layer loopback, messages sent between models on the same device will now be short-circuited through the access layer
  • RSSI and timestamp information is now available in the access_message_rx_meta_t and used in the Light switch example
  • New filter engine for scanner
  • Scanner filters: AD type, advertisement packet type, GAP address, RSSI
  • Support for user-defined packet filters
  • Each example project now has its own Segger Embedded Studio project file

Bugfixes

  • SAR receiving segments with TTL=0 should reply with SegAck TTL=0
  • Bug in validation of command line options in device_page.py
  • "family" undefined in reset_device() in bootloader_verify.py
  • Access application key bitfield needs to hold device keys also
  • DSM clears regular address when deleting virtual address
  • Reliable parameter unset in access:packet_tx()
  • Various bugfixes

Document updates

  • Revised documentation for better distinction between implementation-specific information and concepts defined by the Bluetooth Mesh Profile Specification, updated references to the latter
  • Updated DFU Quick Start guide
  • Added more detailed installation instructions

Other

Known limitations

  • Heartbeat feature is not supported

BLE Mesh v0.9.2-Alpha @anchor release_notes_092

This is a hotfix release, providing critical bug fixes and improvements.

New features

  • nrf_mesh_packet_send() now supports the reliable feature. I.e., it is possible to send single segments messages using the transport layer SAR.
  • Interactive PyACI has support for an interactive provisioner and provisionee
  • New serial interface event "Prov Failed"

Bug fixes

  • Provisionee not handling invalid provisioning data properly
  • Problems using "Release" configuration in SES examples
  • Incorrect usage of hal_led_blink_ms() in light control server
  • Serial buffers must be word aligned
  • Number of elements not handled in Serial interface's "Capabilities set" command
  • S110 build failure
  • Default build type is set in CMake
  • Word alignment problems caused by high optimization levels when using Segger Embedded Studio
  • PB-remote opcodes overlapping with Configuration model opcodes
  • Advertisement bearer used timer_scheduler contexts dangerously, potentially corrupting its internal linked list
  • PB-remote server would get confused about out-of-order ACKs from the client
  • Documentation has been updated

Document updates

  • Rename "Bluetooth Mesh SDK" to "nRF5 SDK for Bluetooth Mesh"
  • How to create a model document updated to current API
  • Minor fixes to cryptography section in the "Bluetooth Mesh basic concepts" document
  • Added installation instructions for CMake, Ninja and ARM toolchain
  • Added information on how to select compile target

Other

  • Serial handlers split into separate source file
  • Fix unit tests to work with the public CMock
  • Fix packet formats and application nonce for compliance
    • Update unit tests with new sample data
  • Several minor bugfixes
  • Serial interface "Init Context" command removed. Provisioning context initialization is managed automatically.

Known limitations of this release

  • Heartbeat and Health model not implemented
  • Source for bootloader must be downloaded from OpenMesh gitHub repo
  • No power down state storage

BLE Mesh v0.9.1-Alpha @anchor release_notes_091

This is an experimental release for exploration of the BLE Mesh stack on the nRF5 device family. It is not intended for commercial use.

Key Features

  • Bluetooth Mesh software core stack
    • Based on Bluetooth 4.0 PHY
    • Bearer, network, transport, and access layers
    • Foundation models
  • Support for Node and Relay Node roles
    • Configurable scanning interval and duty cycle (from 3ms-10240ms)
    • Configurable advertisement interval (from 20ms-10240ms
  • Example applications and proprietary models
  • Broadcast flooding mesh
    • Theoretically up to 32,000 nodes
    • No routing tables
    • No single point of failure
    • Node-to-node and node-to-group communication
  • Two-layer 128-bit AES-CCM network and node-to-node security
  • Provisioning support
    • Standard "local" provisioning over advertisement bearer
    • Proprietary "remote" provisioning via relaying nodes (implemented as proprietary model)
  • Persistent (flash) storage of configuration data
  • Support for concurrent beaconing (separate API, Eddystone, iBeacon)
  • Python shell-based test and demo framework for PC
  • Support for over-the-air secure background DFU
    • Application and/or stacks
  • Cross-platform toolchain support
    • Segger Embedded Studio
    • GCC and armcc
    • Windows, Linux and macOS

Bugfixes in this release

  • AD types updated to use Bluetooth SIG allocated numbers
  • Proprietary On/Off model example renamed from "Generic On/Off" to "Simple On/Off"
  • Minor DFU bugfixes and improvements

Other

  • Revised and reorganized documentation.

Compatibility

  • nRF51 and nRF52
  • Recommended >= 200 kB Flash and >= 32 kB RAM
  • nRF5 SDK (v10.0.0 for S110, v12.1.0 for S130 and S132)
  • Segger Embedded Studio v3.22

Known limitations of this release

  • Packet format in Alpha is not entirely BLE Mesh compatible
  • Heartbeat and Health model not implemented
  • ASZMIC field is missing from application/device nonce for segmented access messages
  • Source for bootloader must be downloaded from OpenMesh GitHub repo
  • No power down state storage

BLE Mesh v0.9.0 @anchor release_notes_090

Bugfixes

  • DSM for-loop overflow bug. Looped over number of application keys rather than network keys. Caused fault on reception of secure mesh network beacons.
  • IRQ level for nRF52 set too low in light control example. Caused hardfault on button press.
  • Debounce algorithm for button presses in light control example used TIMER_OLDER_THAN() when it should have used TIMER_DIFF(). Made buttons unresponsive after ~1h.
  • Replay protection cache checking wrong address
  • Network cache not caching messages if transport layer fails
  • Serial provisioning interface not setting all parameters of the provisioning struct

New features

  • Configuration server
  • Configuration client
  • light control example uses configuration client+server to configure the newly provisioned devices.
    • Also supports group addressing
  • New host scripts for Serial ACI. Auto-generated the same way as documentation is.
  • Persistent storage manager
    • Integrates with access layer and the Device State Manager
  • Persistent storage integration with examples
  • Node configuration module for provisionee applications
  • Use asynchronous event flags with bearer event module

Other

  • Updated documentation for PB-remote example
  • Added README for light control example
  • Added Howto for creating proprietary models

Known limitations

  • No generated documentation or host scripts for model specific commands in the Serial ACI. This affects mostly the PB-remote client.
  • In bootloader mode all DFU transfers will be accepted regardless of the FWID.
  • BLE Mesh non-compliance (will be fixed in upcoming releases):
    • "Generic OnOff" model example is not complete nor spec compliant
    • Opcodes do not follow specification
    • Bluetooth SIG assigned numbers for AD_Types, Service UUIDs and Characteristic UUIDs are not up-to-date
    • Health Model and Heartbeat features are not implemented
    • Packet format changes related to removal of MD bit are not implemented

BLE Mesh v0.8.1 @anchor release_notes_081

Release notes

  • PB-remote server and client updated for new access layer
  • Bugfixes for new access layer and device state manager
  • Asynchronous event flags
    • Timer scheduler
    • Serial
  • Serial integration
    • Device state manager
    • Access layer
  • Transport layer device key decryption bug fix
  • Adds support for PB-remote server disabling (issue #66)
  • Adds a Simple OnOff demo model
  • Network beacon initialization added (was missing in v 0.8.0)

Known issues

  • Per-beacon TX power settings are not yet functional for the serial interface
  • The transport layer still defaults to +malloc()+ to allocate SAR buffers
  • IV update will trigger without checking the value of the received iv index
  • Interactive_pyaci is not up-to-date with the latest serial interface

BLE Mesh v0.8.0 @anchor release_notes_080

This release features a preview of the refactored nRF Mesh API and new key modules.

Release highlights

  • Device State Manager
    • Manages all mesh-related keys and addresses for the user
    • Reduces key-storage memory footprint
  • Access layer
    • Reworked API to fit more usage scenarios
    • Reduced memory footprint
    • Now takes ownership of the model database, in preparation for persistent storage support
  • New application configuration module for the Device State Manager and access layer pool sizes
    • Application specified compile-time configuration of memory usage for the upper layers
  • Reworked serial interface for use with the Device State Manager
    • Added optional SLIP encoding for serial UART packets
    • Support for setting custom beacon data over serial
    • Improved documentation generator, now including command responses
    • Implemented GAP address get command (issue #38)
    • Reduced memory footprint
  • Improved IV update procedure
    • Improved quality of service for mesh messages
    • Fully spec compliant
  • DFU procedure improvements
    • Improved reliability
    • Packet loss recovery procedure has lower impact on the rest of the transfer
    • Fix for GitHub issue #77: Timeout in DFU ready phase

Known issues and limitations

  • Serial opcodes are not backwards compatible
  • PB-Remote is not integrated with the new access layer
    • It is not supported by the serial interface either
  • Per-beacon TX power settings are not yet functional for the serial interface
  • The transport layer still defaults to +malloc()+ to allocate SAR buffers

BLE Mesh v0.7.7 @anchor release_notes_077

  • Documentation improvements
  • Renamed some modules to prevent using Bluetooth SIG's confidential identifiers
  • Bug fixes
    • A corner-case bug where the provisioning complete ACK is lost but a successful close packet is sent is now fixed
    • Fixed incorrect endianness in address check (issue #74)

Notes

The transport SAR uses +malloc()+ to allocate buffers for SAR transactions. This behaviour can be overridden using +transport_sar_mem_funcs_set()+, otherwise +__HEAPSIZE+ needs to be defined.

WARNING: SoftDevice needs to be Flashed without memory protection