API Reference

nRF5 SDK for Mesh v5.0.0

Here is a list of all modules:
[detail level 12345]
 Mesh stackHigh level management API for the mesh stack
 Application support modulesApplication support modules designed to abstract complexity of common tasks in the user code
 Generic Default Transition Time server app support fileApplication level Default Transition Time server behavioral structures, functions, and callbacks
 Generic Level server behaviourThis module implements the behavioral requirements of the Generic Level server model
 Light CTL Setup Server behaviourApplication Light CTL Setup Server behavioral structures, functions, and callbacks
 Light LC Setup Server behaviourApplication Light LC Setup Server behavioral structures, functions, and callbacks
 Light Lightness Setup Server behaviourApplication Light Lightness server behavioral structures, functions, and callbacks
 Generic OnOff server behaviourApplication level OnOff server behavioral structures, functions, and callbacks
 Scene Server behaviourApplication level Scene server behavioral structures, functions, and callbacks
 Sensor Server behaviourApplication level Sensor server behavioral structures, functions, and callbacks
 Generic transition moduleThis module implements the transitional behavior commonly required by mesh models
 BLE DFU support moduleApplication support module that allows to add DFU over BLE support to an application by using Buttonless Secure DFU Service
 BLE SoftDevice support moduleApplication support module for initializing the SoftDevice Handler, BLE stack, Generic Access Profile (GAP), and the Connection Parameters Negotiation module
 Mesh app utility functionsUtilities for use in Mesh applications and examples
 Mesh examples provisionee support moduleMesh 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 configurationConfiguration 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 configurationConfiguration for compile time
 BLE DFU support module configurationConfiguration for compile time
 PWM utility functionsThis module implements some utility functions for using PWM functionality in the application
 RTT Input example helper moduleHelper module for the examples to poll the RTT input
 Simple Hardware Abstraction LayerSimple hardware abstraction layer for the example applications
 Mesh application advertisement interfaceThis interface is required to support GATT proxy and PB-GATT
 Application configurationApplication-specific configuration file for mesh resource requirements and parameters
 Device configurationDevice global configuration parameters for the device's representation on the mesh network
 Access layer configurationConfiguration of access layer resource usage
 Configuration of access layer reliable messagesConfiguration of the application-specific parameters of the access layer reliable messages
 Device State Manager configurationSizes for the internal storage of the Device State Manager
 Mesh ModelsMesh models implemented by Nordic Semiconductor
 Common APIs for models.Contains common defines, structures, and functions used by the Mesh Models
 Model config file entry IDsContains common defines for model config file (MESH_OPT_MODEL_FILE_ID) used by some of the Mesh models
 Generic ModelsGeneric Models as defined in the Bluetooth Mesh Model Specification (MshMDLv1.0.1)
 Generic Default Transition Time modelGeneric 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 modelRelated states
 Generic Default Transition Time server model interface
 Generic OnOff modelThis 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 statesThis module provides APIs for handling persistence of the Generic OnOff Server model related states
 Generic OnOff server model interface
 Generic Level modelThis 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 statesThis module provides APIs for handling persistence of the Generic Level Server model related states
 Generic Level server model interface
 Generic Power OnOff modelThis 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 interfaceThis model extends Generic PowerOnOff server, Generic OnOff server, and Generic Default Transition Time server
 Scenes ModelsScene Model as defined in the Bluetooth Mesh Model Specification (MshMDLv1.0.1)
 Scene modelsThis 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 statesThis module provides APIs for handling persistence of the Scene Setup Server model related states
 Scene Setup server model interface
 Sensor ModelsSensor Model as defined in the Bluetooth Mesh Model Specification (MshMDLv1.0.1)
 Sensor modelThis 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 functionsImplements the various utilities needed at various locations in the sensor code, from model to mid app to top app
 Lighting ModelsLighting Models as defined in the Bluetooth Mesh Model Specification (MshMDLv1.0.1)
 Light Lightness modelsThis 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 statesThis module provides APIs for handling persistence of the Light Lightness Setup Server model related states
 Light Lightness Setup Server model interfaceThis 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 modelsThis 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 statesThis module provides APIs for handling persistence of the Light LC Setup Server model related states
 Light LC Server property constantsAll 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 interfaceThis 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 modelsThis 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 statesThis module provides APIs for handling persistence of the Light CTL Setup Server model related states
 Light CTL Setup Server model interfaceThis 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 modelThese utility functions are used to handle internal 32 bit representation (temperature32) of Light CTL Temperature state values
 Foundation ModelsFoundation Models as defined in the Bluetooth Mesh Profile Specification (MshPRFv1.0.1)
 Health ModelImplementation of the Health Model foundation model
 Health ClientModel implementing the Health Client foundation model
 Fault IDsBluetooth Mesh Profile Specification (MshPRFv1.0.1) defined fault IDs that can be used by self-tests to indicate specific problems
 Health model message definitionsDefinitions of the various messages supported by the health model
 Health model message opcodesOpcodes used in health model messages
 Health ServerModel implementing the Health Server foundation model
 Configuration ModelThe configuration model provides functionality that allows nodes to be configured or configure other nodes
 Composition data moduleComposition data part of the config model
 Configuration clientRemotely configure a mesh device by communicating with the remote device's Config server model
 Message formatsMessage format definitions for the Config models
 OpcodesOpcode definitions for the Config models
 Configuration serverThe configuration server model implements the server side of the configuration model
 Configuration Server application events
 Packed index listProvides support for writing lists of packed 12-bit key indexes
 Vendor ModelsVendor specific model(s)
 Simple OnOff modelThis model implements the message based interface required to set the 1 bit value on the server
 Simple OnOff ClientThis module implements a vendor specific Simple OnOff Client
 Common Simple OnOff definitionsTypes and definitions shared between the two Simple OnOff models
 Simple OnOff ServerThis 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 ModelsModels with proprietary implementations
 Provisioning over Mesh (PB-remote)This module defines the Remote Provisioning Models
 Remote Provisioning ClientThis module implements the remote provisioning client (PB-Remote client) model
 Provisioning over Mesh (PB-remote) Messages
 Remote Provisioning ServerThis module implements the remote provisioning server (PB-remote server) model
 PB-remote Client serial interface
 PB-MESH Client model specific serial commands
 AccessThe Access layer provides access to the Core Mesh for Mesh models
 Access layer APIThe access layer API is the main API for Mesh Models
 Access layer API MSCsAccess layer sequence diagrams
 DefinesAccess layer defines
 TypesAccess layer type definitions
 Acknowledged messagesAcknowledged message sending for the access layer
 Message sequence chartsAcknowledged publishing sequence diagrams
 DefinesAccess acknowledged message defines
 TypesAccess acknowledged message types
 Utility functionsUtility functions for access layer users
 Access layer configurationRuntime configuration of the access layer, controlled by the Configuration Server model
 Model configurationConfiguration of model parameters
 Element configurationConfiguration of element parameters
 Device State ManagerThe Device State Manager provides a means for storing and retrieving Bluetooth Mesh state during operation
 DefinesDevice State Manager defines
 TypesDevice State Manager types
 Address managementFunctions for managing the set of addresses known to the device
 Key managementFunctions for managing the set of encryption keys known to the device
 Network key managementNetwork key management
 Device key managementDevice key management
 Application key managementApplication key management
 CoreCore mesh modules, implementing mesh message passing
 Mesh memory managerThis API provides an interface for a general purpose dynamic memory manager
 Core Mesh APIInterface for the message sending part of the mesh stack
 Flash ManagerThe Flash Manager provides an entry-based persistent storage interface that works with the mesh
 DefinesFlash Manager definitions
 TypesFlash Manager type definitions
 Mesh configCommon interface for operating on all mesh states
 Mesh config entryAPI for managing mesh configuration entries
 Mesh config listener interfaceChange-listener interface for mesh config
 Mesh friendship typesA collection of types common to both the Low Power node (LPN) and the Friend role
 Mesh Low Power node (LPN)
 TypesCore mesh type definitions
 Assert APIAllows the framework to propagate errors that can't be recovered from
 DefinesCore mesh definitions
 API level definitions
 Network layer definitions
 Transport layer definitions
 Heartbeat definitions
 Mesh eventsRuntime events in the core mesh
 Mesh optionsConfiguration options for the core mesh
 Mesh section variablesMesh wrapper for the nRF5 SDK section variables
 Utility functionsUtility functions for mesh users
 Internal event moduleModule for reporting internal stack events, to help traceability and debugging
 Core configurationConfiguration of the core mesh modules
 Compile time configurationConfiguration 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 configurationConfiguration of the core mesh during runtime
 Friend roleMesh modules that implement the Friend feature
 BearerBearer-layer module, providing a Bluetooth communication medium for the mesh
 AD listenerDe-multiplexing of the advertising data
 AdvertiserImplements a Bluetooth LE 4.0 compliant advertiser
 DefinesCommon definitions for the bearer layer
 Mesh PA/LNA interfaceControls external PA/LNA support for the mesh radio operation
 Bearer configurationCompile time configuration of the bearer layer
 General configurationGeneral compile time configuration of the bearer layer
 Bearer event configurationCompile time configuration of the bearer event module
 ScannerBluetooth scanner role implementation
 Packet filteringFiltering support for scanners
 AD type filteringFiltering of advertisement packets based on their AD types
 Advertisement packet type filteringFiltering of advertisement packets based on their advertisement type
 GAP address filteringFiltering of advertisement packets based on their GAP address
 RSSI packet filteringFiltering of advertisement packets based on their measured RSSI upon reception
 DFUDevice firmware upgrade module for the mesh
 DFU configurationCompile time configuration of the DFU module
 DFU APIAllows for some basic control of the application-side DFU module
 TypesDFU type definitions
 DefinesDFU definitions
 ProvisioningDevice provisioning module for the mesh
 Provisioning configurationCompile time configuration of the provisioning module
 Provisioning Bearer ConfigurationCompile time configuration of the provisioning bearers
 Provisionee configuration
 Provisioning APIFunctionality for supporting provisioning of a node
 DefinesProvisioning defines
 Provisioning field lengthsLength of various provisioning fields
 Provisioning capabilities bit fieldsBitfield definitions for the provisioning capabilities fields
 Provisioning OOB information sources.OOB information sources for the OOB info bitfield in unprovisioned beacons
 BearersBearer abstraction layer for provisioning
 Provisioning bearer interfaceDefines the generic (downstream) interface any provisioning bearer should expose
 Provisioning bearer callbacksDefines 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
 EventsProvisioning event definitions
 TypesProvisioning type definitions
 SerialSerialization of the mesh API
 Serial configurationConfiguration of the serial interface module
 UART Hardware configurationCompile time configuration of the serial UART hardware
 Serial APITarget-side serial interface module, providing serialized access to all major mesh APIs
 DefinesSerial interface defines
 TypesSerial interface type definitions
 Serial componentsInternal components of the Serial subsystem
 Serial interface
 Serial hardware abstraction layer
 Serial commands
 Serial Command Response definitions
 Serial events
 Serial handlersModules 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 handlerHelps implement model specific serial handler functionality
 OpenMesh serial handler
 Provisioning serial handler (PB-ADV)
 Serial packet
 Serial status codesThis file contains serial status codes
 Serial UART bearer
 Nordic-specific featuresMesh features specific to Nordic Semiconductor's nRF5 SDK for Mesh
 Instaburst featureThe Instaburst feature implements a subset of the Bluetooth 5.0 feature "Advertising extensions" to achieve increased throughput for Mesh traffic
 DefinesInstaburst definitions
 Instaburst RX moduleThe Instaburst RX module implements a subset of the required scanner functionality for the Bluetooth 5.0 feature "Advertising Extensions"
 Instaburst TX moduleThe Instaburst TX module acts as a replacement for the regular advertiser, providing higher throughput at the expense of breaking spec-compliance
 Mesh options APIProvides a consistent top-level API for runtime configuration options
 Core runtime configuration optionsRuntime configuration for Mesh core functionality
 Provisioning runtime configuration optionsRuntime configuration for Mesh provisioning functionality
 GATT runtime configuration optionsRuntime configuration for Mesh GATT functionality
 Friend runtime configuration optionsRuntime configuration for Mesh Friend feature functionality