Mesh stack | High level management API for the mesh stack |
▼Application support modules | Application support modules designed to abstract complexity of common tasks in the user code |
Generic Default Transition Time server app support file | Application level Default Transition Time server behavioral structures, functions, and callbacks |
Generic Level server behaviour | This module implements the behavioral requirements of the Generic Level server model |
Light CTL Setup Server behaviour | Application Light CTL Setup Server behavioral structures, functions, and callbacks |
Light LC Setup Server behaviour | Application Light LC Setup Server behavioral structures, functions, and callbacks |
Light Lightness Setup Server behaviour | Application Light Lightness server behavioral structures, functions, and callbacks |
Generic OnOff server behaviour | Application level OnOff server behavioral structures, functions, and callbacks |
Scene Server behaviour | Application level Scene server behavioral structures, functions, and callbacks |
Sensor Server behaviour | Application level Sensor server behavioral structures, functions, and callbacks |
Generic transition module | This module implements the transitional behavior commonly required by mesh models |
BLE DFU support module | Application support module that allows to add DFU over BLE support to an application by using Buttonless Secure DFU Service |
BLE SoftDevice support module | Application support module for initializing the SoftDevice Handler, BLE stack, Generic Access Profile (GAP), and the Connection Parameters Negotiation module |
Mesh app utility functions | Utilities for use in Mesh applications and examples |
Mesh examples provisionee support module | Mesh examples support module for starting the provisioning process for a device in the provisionee role using PB-ADV and static OOB authentication |
►Application support module configuration | Configuration of the application support modules |
RTT Input module configuration (mesh examples) | Configuration for compile time |
Simple Hardware Abstraction Layer configuration (mesh examples) | Configuration for compile time |
BLE SoftDevice support module configuration | Configuration for compile time |
BLE DFU support module configuration | Configuration for compile time |
PWM utility functions | This module implements some utility functions for using PWM functionality in the application |
RTT Input example helper module | Helper module for the examples to poll the RTT input |
Simple Hardware Abstraction Layer | Simple hardware abstraction layer for the example applications |
Mesh application advertisement interface | This interface is required to support GATT proxy and PB-GATT |
▼Application configuration | Application-specific configuration file for mesh resource requirements and parameters |
Device configuration | Device global configuration parameters for the device's representation on the mesh network |
►Access layer configuration | Configuration of access layer resource usage |
Configuration of access layer reliable messages | Configuration of the application-specific parameters of the access layer reliable messages |
Device State Manager configuration | Sizes for the internal storage of the Device State Manager |
▼Mesh Models | Mesh models implemented by Nordic Semiconductor |
Common APIs for models. | Contains common defines, structures, and functions used by the Mesh Models |
Model config file entry IDs | Contains common defines for model config file (MESH_OPT_MODEL_FILE_ID) used by some of the Mesh models |
►Generic Models | Generic Models as defined in the Bluetooth Mesh Model Specification (MshMDLv1.0.1) |
►Generic Default Transition Time model | Generic Default Transition Time (dtt) model implements the message based interface required to set the Default Transition Time value on the server |
Generic Default Transition Time client model interface | |
Persistence module for the Generic Default Transition Time Server model | Related states |
Generic Default Transition Time server model interface | |
►Generic OnOff model | This model implements the message based interface required to set the OnOff value on the server |
Generic OnOff client model interface | |
Persistence module for the Generic OnOff Server model related states | This module provides APIs for handling persistence of the Generic OnOff Server model related states |
Generic OnOff server model interface | |
►Generic Level model | This model implements the message based interface required to set the Level value on the server |
Generic Level client model interface | |
Persistence module for the Generic Level Server model related states | This module provides APIs for handling persistence of the Generic Level Server model related states |
Generic Level server model interface | |
►Generic Power OnOff model | This model implements the message based interface required to set the Power OnOff value on the server |
Generic Power OnOff client model interface | |
Generic Power OnOff Setup server model interface | This model extends Generic PowerOnOff server, Generic OnOff server, and Generic Default Transition Time server |
►Scenes Models | Scene Model as defined in the Bluetooth Mesh Model Specification (MshMDLv1.0.1) |
►Scene models | This model implements the message based interface required to set the Scene Setup server states |
Scene client model interface | |
Persistence module for the Scene Setup Server model related states | This module provides APIs for handling persistence of the Scene Setup Server model related states |
Scene Setup server model interface | |
►Sensor Models | Sensor Model as defined in the Bluetooth Mesh Model Specification (MshMDLv1.0.1) |
►Sensor model | This model implements the message based interface required to set the Sensor value on the server |
Sensor client model interface | |
Sensor Setup server model interface | |
Sensor model utility functions | Implements the various utilities needed at various locations in the sensor code, from model to mid app to top app |
►Lighting Models | Lighting Models as defined in the Bluetooth Mesh Model Specification (MshMDLv1.0.1) |
►Light Lightness models | This model implements the message based interface required to set the Lightness value on the server |
Light Lightness client model interface | |
Persistence module for the Light Lightness Setup Server model related states | This module provides APIs for handling persistence of the Light Lightness Setup Server model related states |
Light Lightness Setup Server model interface | This model extends Light Lightness server, Generic Level server, Generic PowerOnOff Setup server, Generic PowerOnOff server, Generic OnOff server, and Generic Default Transition Time server |
Light Lightness model utility functions | |
►Light LC models | This model implements the message based interface required to set the LC Setup server states |
Light LC client model interface | |
Persistence module for the Light LC Setup Server model related states | This module provides APIs for handling persistence of the Light LC Setup Server model related states |
Light LC Server property constants | All the information about the format, units and allowed values of the properties can be found in Section 4.1.3 of Bluetooth mesh device properties, Bluetooth mesh device properties XML and Bluetooth mesh characteristics XML |
Light LC (Lightness Control) Setup Server model interface | This model extends Light LC server, Light Lightness server, Generic Level server, Generic PowerOnOff Setup server, Generic PowerOnOff server, Generic OnOff server, and Generic Default Transition Time server |
►Light CTL models | This model implements the message based interface required to set the Lightness, Color temperature and Delta UV value on the server |
Light CTL Client model interface | |
Persistence module for the Light CTL Setup Server model related states | This module provides APIs for handling persistence of the Light CTL Setup Server model related states |
Light CTL Setup Server model interface | This model is defined as a top level model in the SDK to enable implementation of the tunable white light |
Utility functions for the Light CTL model | These utility functions are used to handle internal 32 bit representation (temperature32) of Light CTL Temperature state values |
►Foundation Models | Foundation Models as defined in the Bluetooth Mesh Profile Specification (MshPRFv1.0.1) |
►Health Model | Implementation of the Health Model foundation model |
Health Client | Model implementing the Health Client foundation model |
Fault IDs | Bluetooth Mesh Profile Specification (MshPRFv1.0.1) defined fault IDs that can be used by self-tests to indicate specific problems |
Health model message definitions | Definitions of the various messages supported by the health model |
Health model message opcodes | Opcodes used in health model messages |
Health Server | Model implementing the Health Server foundation model |
►Configuration Model | The configuration model provides functionality that allows nodes to be configured or configure other nodes |
Composition data module | Composition data part of the config model |
Configuration client | Remotely configure a mesh device by communicating with the remote device's Config server model |
Message formats | Message format definitions for the Config models |
Opcodes | Opcode definitions for the Config models |
►Configuration server | The configuration server model implements the server side of the configuration model |
Configuration Server application events | |
Packed index list | Provides support for writing lists of packed 12-bit key indexes |
►Vendor Models | Vendor specific model(s) |
►Simple OnOff model | This model implements the message based interface required to set the 1 bit value on the server |
Simple OnOff Client | This module implements a vendor specific Simple OnOff Client |
Common Simple OnOff definitions | Types and definitions shared between the two Simple OnOff models |
Simple OnOff Server | This module implements a vendor specific Simple OnOff Server |
►RSSI monitor common | |
RSSI monitor client model interface | |
RSSI monitor server model interface | |
RSSI monitor util model interface | |
►Proprietary Models | Models with proprietary implementations |
►Provisioning over Mesh (PB-remote) | This module defines the Remote Provisioning Models |
Remote Provisioning Client | This module implements the remote provisioning client (PB-Remote client) model |
Provisioning over Mesh (PB-remote) Messages | |
Remote Provisioning Server | This module implements the remote provisioning server (PB-remote server) model |
►PB-remote Client serial interface | |
PB-MESH Client model specific serial commands | |
▼Access | The Access layer provides access to the Core Mesh for Mesh models |
►Access layer API | The access layer API is the main API for Mesh Models |
Access layer API MSCs | Access layer sequence diagrams |
Defines | Access layer defines |
Types | Access layer type definitions |
►Acknowledged messages | Acknowledged message sending for the access layer |
Message sequence charts | Acknowledged publishing sequence diagrams |
Defines | Access acknowledged message defines |
Types | Access acknowledged message types |
Utility functions | Utility functions for access layer users |
►Access layer configuration | Runtime configuration of the access layer, controlled by the Configuration Server model |
Model configuration | Configuration of model parameters |
Element configuration | Configuration of element parameters |
▼Device State Manager | The Device State Manager provides a means for storing and retrieving Bluetooth Mesh state during operation |
Defines | Device State Manager defines |
Types | Device State Manager types |
Address management | Functions for managing the set of addresses known to the device |
►Key management | Functions for managing the set of encryption keys known to the device |
Network key management | Network key management |
Device key management | Device key management |
Application key management | Application key management |
▼Core | Core mesh modules, implementing mesh message passing |
Mesh memory manager | This API provides an interface for a general purpose dynamic memory manager |
►Core Mesh API | Interface for the message sending part of the mesh stack |
►Flash Manager | The Flash Manager provides an entry-based persistent storage interface that works with the mesh |
Defines | Flash Manager definitions |
Types | Flash Manager type definitions |
►Mesh config | Common interface for operating on all mesh states |
Mesh config entry | API for managing mesh configuration entries |
Mesh config listener interface | Change-listener interface for mesh config |
Mesh friendship types | A collection of types common to both the Low Power node (LPN) and the Friend role |
Mesh Low Power node (LPN) | |
Types | Core mesh type definitions |
Assert API | Allows the framework to propagate errors that can't be recovered from |
►Defines | Core mesh definitions |
API level definitions | |
Network layer definitions | |
Transport layer definitions | |
Heartbeat definitions | |
Mesh events | Runtime events in the core mesh |
Mesh options | Configuration options for the core mesh |
Mesh section variables | Mesh wrapper for the nRF5 SDK section variables |
Utility functions | Utility functions for mesh users |
Internal event module | Module for reporting internal stack events, to help traceability and debugging |
►Core configuration | Configuration of the core mesh modules |
►Compile time configuration | Configuration of the compilation of the core mesh modules |
General configuration | |
Encryption configuration | |
Core TX configuration | |
AES-CCM module configuration | |
FIFO configuration | |
Internal event logging configuration | |
Log module configuration | |
Message cache configuration | |
Network configuration | |
Transport layer configuration | |
Packet manager configuration | |
Packet buffer configuration | |
Replay cache configuration. | |
Power down emergency cache configuration. | |
Flash manager configuration defines | |
GATT configuration defines | |
Access layer configuration defines | |
Finite State Machine configuration | |
Friendship configuration defines | |
Runtime configuration | Configuration of the core mesh during runtime |
Friend role | Mesh modules that implement the Friend feature |
▼Bearer | Bearer-layer module, providing a Bluetooth communication medium for the mesh |
AD listener | De-multiplexing of the advertising data |
Advertiser | Implements a Bluetooth LE 4.0 compliant advertiser |
Defines | Common definitions for the bearer layer |
Mesh PA/LNA interface | Controls external PA/LNA support for the mesh radio operation |
►Bearer configuration | Compile time configuration of the bearer layer |
General configuration | General compile time configuration of the bearer layer |
Bearer event configuration | Compile time configuration of the bearer event module |
Scanner | Bluetooth scanner role implementation |
►Packet filtering | Filtering support for scanners |
AD type filtering | Filtering of advertisement packets based on their AD types |
Advertisement packet type filtering | Filtering of advertisement packets based on their advertisement type |
GAP address filtering | Filtering of advertisement packets based on their GAP address |
RSSI packet filtering | Filtering of advertisement packets based on their measured RSSI upon reception |
▼DFU | Device firmware upgrade module for the mesh |
DFU configuration | Compile time configuration of the DFU module |
►DFU API | Allows for some basic control of the application-side DFU module |
Types | DFU type definitions |
Defines | DFU definitions |
▼Provisioning | Device provisioning module for the mesh |
►Provisioning configuration | Compile time configuration of the provisioning module |
Provisioning Bearer Configuration | Compile time configuration of the provisioning bearers |
Provisionee configuration | |
►Provisioning API | Functionality for supporting provisioning of a node |
►Defines | Provisioning defines |
Provisioning field lengths | Length of various provisioning fields |
Provisioning capabilities bit fields | Bitfield definitions for the provisioning capabilities fields |
Provisioning OOB information sources. | OOB information sources for the OOB info bitfield in unprovisioned beacons |
►Bearers | Bearer abstraction layer for provisioning |
Provisioning bearer interface | Defines the generic (downstream) interface any provisioning bearer should expose |
Provisioning bearer callbacks | Defines the (upstream) interface a higher layer provisioning structure should implement |
Provisioning over Advertising Bearer (PB-ADV) | This module provides support for the provisioning over advertising (PB-ADV) provisioning bearer |
►Provisioning over GATT Bearer (PB-GATT) | This module provides support for provisioning over GATT |
PB-GATT UUID definitions | |
Events | Provisioning event definitions |
Types | Provisioning type definitions |
▼Serial | Serialization of the mesh API |
►Serial configuration | Configuration of the serial interface module |
UART Hardware configuration | Compile time configuration of the serial UART hardware |
►Serial API | Target-side serial interface module, providing serialized access to all major mesh APIs |
Defines | Serial interface defines |
Types | Serial interface type definitions |
►Serial components | Internal components of the Serial subsystem |
Serial interface | |
Serial hardware abstraction layer | |
Serial commands | |
Serial Command Response definitions | |
Serial events | |
►Serial handlers | Modules for handling incoming serial commands |
Access layer serial handler | |
Application serial handler | |
Common serial handler functions | |
Config serial handler | |
Device serial handler | |
DFU serial handler | |
Mesh serial handler | |
Generic model serial handler | Helps implement model specific serial handler functionality |
OpenMesh serial handler | |
Provisioning serial handler (PB-ADV) | |
Serial packet | |
Serial status codes | This file contains serial status codes |
Serial UART bearer | |
▼Nordic-specific features | Mesh features specific to Nordic Semiconductor's nRF5 SDK for Mesh |
►Instaburst feature | The Instaburst feature implements a subset of the Bluetooth 5.0 feature "Advertising
extensions" to achieve increased throughput for Mesh traffic |
Defines | Instaburst definitions |
Instaburst RX module | The Instaburst RX module implements a subset of the required scanner functionality for the Bluetooth 5.0 feature "Advertising Extensions" |
Instaburst TX module | The Instaburst TX module acts as a replacement for the regular advertiser, providing higher throughput at the expense of breaking spec-compliance |
▼Mesh options API | Provides a consistent top-level API for runtime configuration options |
Core runtime configuration options | Runtime configuration for Mesh core functionality |
Provisioning runtime configuration options | Runtime configuration for Mesh provisioning functionality |
GATT runtime configuration options | Runtime configuration for Mesh GATT functionality |
Friend runtime configuration options | Runtime configuration for Mesh Friend feature functionality |