API Reference

Here is a list of all modules:

[detail level 123456]

Mesh PA/LNA interface	Controls external PA/LNA support for the mesh radio operation
Mesh stack	High level initialization API for the mesh stack
▼Application support modules	Application support modules designed to abstract complexity of common tasks in the user code
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
SoftDevice initialization helper module	Application support module for performing a typical SoftDevice initialization
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	Access layer resource usage configuration
Access reliable messages configuration	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
►Health Model	Implementation of the Health Model foundation model
Health Client	Model implementing the Health Client foundation model
Fault IDs	Mesh Profile Specification v1.0 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
►Simple OnOff model	This example model implements the messages and corresponding behaviour 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
►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
▼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
►Reliable messages	Reliable message sending for the access layer
Message sequence charts	Reliable publishing sequence diagrams
Defines	Access reliable message defines
Types	Access reliable 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
►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
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
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.
Flash manager configuration defines
GATT configuration defines
Runtime configuration	Configuration of the core mesh during runtime
▼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
►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
►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
►Provisioning over Mesh (PB-remote) (experimental)	This module defines the Remote Provisioning Models
Provisioning over Mesh MSCs	Remote provisioning sequence diagrams
Remote Provisioning Client (experimental)	This module implements the remote provisioning client (PB-Remote client) model
Provisioning over Mesh (PB-remote) Messages
Remote Provisioning Server (experimental)	This module implements the remote provisioning server (PB-remote server) model
►PB-remote Client serial interface
PB-MESH Client model specific serial commands
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
▼Experimental features	Experimental Mesh features
►Experimental Instaburst feature	The experimental Instaburst feature implements a subset of the Bluetooth 5.0 feature "Advertising extensions" to achieve increased throughput for Mesh traffic
Defines	Instaburst definitions
Experimental Instaburst RX module	The Instaburst RX module implements a subset of the required scanner functionality for the Bluetooth 5.0 feature "Advertising Extensions"
Experimental Instaburst TX module	The Instaburst TX module acts as an experimental replacement for the regular advertiser, providing higher throughput at the expense of breaking spec-compliance