API Reference

nRF5 SDK v9.0.0
nRF51 SDK v9.0.0
Here is a list of all modules:
[detail level 1 2 3 4 5 6 ]
o ANT+ Profiles
| \ Heart Rate Monitor Profile This module implements the Heart Rate Monitor Profile
|   o Heart Rate Monitor Profile pages This module implements functions for the HRM data pages
|   | o HRM Profile page 0
|   | o HRM Profile page 1
|   | o HRM Profile page 2
|   | o HRM Profile page 3
|   | \ HRM Profile page 4
|   \ Heart Rate Monitor Profile utilities This module implements utilities for the Heart Rate Monitor Profile
o ANT utilities
| o ANT channel configuration ANT channel configuration module
| o ANT pulse simulator ANT pulse simulator module
| o ANT stack configuration Configuration of resources used in the ANT stack
| \ ANT channel state indicator ANT channel state indicator module
o BLE libraries
| o Device Manager Device Manager Application Interface Abstraction
| | o Device Manager Sequence Charts
| | | o Security Set-Up & Status Related
| | | | o Fresh Bonding & Context Store
| | | | | o GAP Central
| | | | | \ GAP Peripheral
| | | | \ Link Encryption with Bonded Device
| | | |   o GAP Central
| | | |   \ GAP Peripheral
| | | o Device Manager Context Management MSCs
| | | | \ Deleting one or all device context
| | | |   o GAP Peripheral/GAP Central: Delete one bonded device
| | | |   \ GAP Peripheral/GAP Central: Delete all bonded devices
| | | \ Initialization and Setup
| | o Service/Protocol Types Describes the possible types of Service/Protocol Contexts for a bonded/peer device
| | o Device Manager Events This section describes the device manager events that are notified to the application
| | | o General Events General or miscellaneous events
| | | o Link Status Events Link Status Events
| | | \ Context Management Events Context Management Events
| | o Device Manager Data Types This section describes all the data types exposed by the module to the application
| | \ Device Module APIs This section describes APIs exposed by the module
| |   o Device Module Set-up APIs Initialization & registration APIs that are pre-requisite for all other module procedures
| |   o APIs to set up or read status of security on a link. This section describes APIs to set up Security. These APIs require that the peer is connected before the procedures can be requested
| |   o Context Management APIs Utility APIs offered by the device manager to get information about the peer if and when needed
| |   \ Utility APIs This section describes the utility APIs offered by the module
| o Database Discovery Database discovery module
| | o Defines
| | o Enumerations
| | o Structures
| | o Types
| | \ Functions
| o Assert Handler for debug purposes. Module for handling of assert during application development when debugging
| o DTM - Direct Test Mode Module for testing RF/PHY using DTM commands
| o Error Log Module Module for writing error and stack to flash memory
| o Radio Notification Event Handler Module for propagating Radio Notification events to the application
| o BLE Date Time characteristic type Definition of ble_date_time_t type
| o Advertising Module Module for handling connectable BLE advertising
| o Record Access Control Point Record Access Control Point library
| o Advertising Data Encoder Function for encoding the advertising data and/or scan response data, and passing them to the stack
| o Connection Parameters Negotiation Module for initiating and executing a connection parameters negotiation procedure
| o Sensor Data Simulator Functions for simulating sensor data
| \ Flash Manager Module for accessing flash memory
o BLE serialization
| o Serialization Application Hardware Abstraction Layer Functions which set up hardware on Application board and perform the reset of the Connectivity Board
| o Serialization HAL Transport HAL Transport layer for serialization
| o Serialization PHY PHY layer layer for serialization
| o HCI Serialization PHY HCI PHY layer for serialization
| o Serialization codecs
| | o Application common codecs
| | | \ DTM Application command request encoders and command response decoders DTM Application command request encoders and command response decoders
| | o Application s110 codecs
| | | o GAP Functions for managing memory for security keys in application device. GAP Application auxiliary functions for synchronizing GAP security keys with the ones stored in the connectivity device
| | | o Functions for managing memory for user memory request in application device. Application auxiliary functions for synchronizing user memory with the one stored in the connectivity device
| | | o Application command request encoders and command response decoders Application command request encoders and command response decoders
| | | o Application event decoders Application event decoders
| | | o GAP Application command request encoders and command response decoders GAP Application command request encoders and command response decoders
| | | o GAP Application event decoders GAP Application event decoders
| | | o GATTC Application command request encoders and command response decoders GATTC Application command request encoders and command response decoders
| | | o GATTC Application event decoders GATTC Application event decoders
| | | o GATTS Application command request encoders and command response decoders GATTS Application command request encoders and command response decoders
| | | o GATTS Application event decoders GATTS Application event decoders
| | | o L2CAP Application command request encoders and command response decoders L2CAP Application command request encoders and command response decoders
| | | o L2CAP Application event decoders L2CAP Application event decoders
| | | \ SOC Application command request encoders and command response decoders SOC Application command request encoders and command response decoders
| | o Application s120 codecs
| | | o GAP Functions for managing memory for security keys in application device. GAP Application auxiliary functions for synchronizing GAP security keys with the ones stored in the connectivity device
| | | o Functions for managing memory for user memory request in application device. Application auxiliary functions for synchronizing user memory with the one stored in the connectivity device
| | | o Application command request encoders and command response decoders Application command request encoders and command response decoders
| | | o Application event decoders Application event decoders
| | | o GAP Application command request encoders and command response decoders GAP Application command request encoders and command response decoders
| | | o GAP Application event decoders GAP Application event decoders
| | | o GATTC Application command request encoders and command response decoders GATTC Application command request encoders and command response decoders
| | | o GATTC Application event decoders GATTC Application event decoders
| | | o GATTS Application command request encoders and command response decoders GATTS Application command request encoders and command response decoders
| | | o GATTS Application event decoders GATTS Application event decoders
| | | o L2CAP Application command request encoders and command response decoders L2CAP Application command request encoders and command response decoders
| | | o L2CAP Application event decoders L2CAP Application event decoders
| | | \ SOC Application command request encoders and command response decoders SOC Application command request encoders and command response decoders
| | o Application s130 codecs
| | | o GAP Functions for managing memory for security keys in application device. GAP Application auxiliary functions for synchronizing GAP security keys with the ones stored in the connectivity device
| | | o Functions for managing memory for user memory request in application device. Application auxiliary functions for synchronizing user memory with the one stored in the connectivity device
| | | o Application command request encoders and command response decoders Application command request encoders and command response decoders
| | | o Application event decoders Application event decoders
| | | o GAP Application command request encoders and command response decoders GAP Application command request encoders and command response decoders
| | | o GAP Application event decoders GAP Application event decoders
| | | o GATTC Application command request encoders and command response decoders GATTC Application command request encoders and command response decoders
| | | o GATTC Application event decoders GATTC Application event decoders
| | | o GATTS Application command request encoders and command response decoders GATTS Application command request encoders and command response decoders
| | | o GATTS Application event decoders GATTS Application event decoders
| | | o L2CAP Application command request encoders and command response decoders L2CAP Application command request encoders and command response decoders
| | | o L2CAP Application event decoders L2CAP Application event decoders
| | | \ SOC Application command request encoders and command response decoders SOC Application command request encoders and command response decoders
| | o Connectivity common codecs
| | | \ DTM Connectivity command request decoder and command response encoder DTM Connectivity command request decoder and command response encoder
| | o Connectivity s110 codecs
| | | o Connectivity command request decoders and command response encoders Connectivity command request decoders and command response encoders
| | | o Connectivity event encoders Connectivity event encoders
| | | o GAP Connectivity command request decoders and command response encoders GAP Connectivity command request decoders and command response encoders
| | | o GAP Connectivity event encoders GAP Connectivity event encoders
| | | o GATTC Connectivity command request decoders and command response encoders GATTC Connectivity command request decoders and command response encoders
| | | o GATTC Connectivity event encoders GATTC Connectivity event encoders
| | | o GATTS Connectivity command request decoders and command response encoders GATTS Connectivity command request decoders and command response encoders
| | | o GATTS Connectivity event encoders GATTS Connectivity event encoders
| | | o L2CAP Connectivity command request decoders and command response encoders L2CAP Connectivity command request decoders and command response encoders
| | | o L2CAP Connectivity event encoders L2CAP Connectivity event encoders
| | | o GAP Functions for managing memory for security keys on connectivity device. GAP Connectivity auxiliary functions for providing static memory required by Soft Device. This memory is used to store GAP security keys
| | | o Functions for managing memory for user memory request on connectivity device. Connectivity auxiliary functions for providing static memory required by Soft Device
| | | \ SOC Connectivity command request decoders and command response encoders SOC Connectivity command request decoders and command response encoderss
| | o Connectivity s120 codecs
| | | o Connectivity command request decoders and command response encoders Connectivity command request decoders and command response encoders
| | | o Connectivity event encoders Connectivity event encoders
| | | o GAP Connectivity command request decoders and command response encoders GAP Connectivity command request decoders and command response encoders
| | | o GAP Connectivity event encoders GAP Connectivity event encoders
| | | o GATTC Connectivity command request decoders and command response encoders GATTC Connectivity command request decoders and command response encoders
| | | o GATTC Connectivity event encoders GATTC Connectivity event encoders
| | | o GATTS Connectivity command request decoders and command response encoders GATTS Connectivity command request decoders and command response encoders
| | | o GATTS Connectivity event encoders GATTS Connectivity event encoders
| | | o L2CAP Connectivity command request decoders and command response encoders L2CAP Connectivity command request decoders and command response encoders
| | | o L2CAP Connectivity event encoders L2CAP Connectivity event encoders
| | | o GAP Functions for managing memory for security keys on connectivity device. GAP Connectivity auxiliary functions for providing static memory required by Soft Device. This memory is used to store GAP security keys
| | | o Functions for managing memory for user memory request on connectivity device. Connectivity auxiliary functions for providing static memory required by Soft Device
| | | \ SOC Connectivity command request decoders and command response encoders SOC Connectivity command request decoders and command response encoderss
| | \ Connectivity s130 codecs
| |   o Connectivity command request decoders and command response encoders Connectivity command request decoders and command response encoders
| |   o Connectivity event encoders Connectivity event encoders
| |   o GAP Connectivity command request decoders and command response encoders GAP Connectivity command request decoders and command response encoders
| |   o GAP Connectivity event encoders GAP Connectivity event encoders
| |   o GATTC Connectivity command request decoders and command response encoders GATTC Connectivity command request decoders and command response encoders
| |   o GATTC Connectivity event encoders GATTC Connectivity event encoders
| |   o GATTS Connectivity command request decoders and command response encoders GATTS Connectivity command request decoders and command response encoders
| |   o GATTS Connectivity event encoders GATTS Connectivity event encoders
| |   o L2CAP Connectivity command request decoders and command response encoders L2CAP Connectivity command request decoders and command response encoders
| |   o L2CAP Connectivity event encoders L2CAP Connectivity event encoders
| |   o GAP Functions for managing memory for security keys on connectivity device. GAP Connectivity auxiliary functions for providing static memory required by Soft Device. This memory is used to store GAP security keys
| |   \ SOC Connectivity command request decoders and command response encoders SOC Connectivity command request decoders and command response encoderss
| o Application side code
| | o Serialization SoftDevice Transport Serialization SoftDevice Transport on application side
| | \ Serialization SoftDevice Handler Serialization SoftDevice Handler on application side
| \ Connectivity application code
|   o Command decoder in the connectivity chip Decoder for serialized commands from an Application Chip
|   o DTM Command Decoder in the connectivity chip Decoder for serialized DTM commands from an Application Chip
|   o Events encoder in the connectivity chip Events encoder for BLE SoftDevice
|   o Events handlers in the connectivity chip Events handlers used to process high level events in the connectivity application
|   \ Packets decoder in the connectivity chip Decoder for serialized packets from an Application Chip
o BLE Services
| o Common service definitions Constants, type definitions, and functions that are common to all services
| | o Service UUID definitions
| | o Characteristic UUID definitions
| | \ Definitions for the Alert Level characteristic values
| o Apple Notification Service client Apple Notification Center Service Client Module
| o Alert Notification Service Client Alert Notification module
| o Battery Service Battery Service module
| o Battery Service Client Battery Service Client module
| | o Enumerations
| | o Structures
| | o Types
| | \ Functions
| o Blood Pressure Service Blood Pressure Service module
| o Cycling Speed and Cadence Service Cycling Speed and Cadence Service module
| | \ Cycling Speed and Cadence Service feature bits
| o Speed and Cadence Control Point Speed and Cadence Control Point module
| | \ Control point functionalities.
| o Device Firmware Update Service Device Firmware Update Service
| o Device Information Service Device Information Service module
| | \ Vendor ID Source values
| o Glucose Service Glucose Service module
| o Glucose Database Service Glucose Service module
| o Human Interface Device Service Human Interface Device Service module
| o Heart Rate Service Heart Rate Service module
| o Heart Rate Service Client Heart Rate Service Client module
| | o Enumerations
| | o Structures
| | o Types
| | \ Functions
| o Health Thermometer Service Health Thermometer Service module
| o Immediate Alert Service Immediate Alert Service module
| o Immediate Alert Service Client Immediate Alert Service Client module
| o Link Loss Service Link Loss Service module
| o Running Speed and Cadence Service Running Speed and Cadence Service module
| o Running Speed and Cadence Service Client
| o TX Power Service TX Power Service module
| o Current Time Service client Current Time Service client module
| \ Nordic UART Service Nordic UART Service implementation
o Bootloader/DFU API
| o HCI Transport Layer Configuration Definition of HCI Transport Layer configurable parameters
| o Bootloader API. Bootloader module interface
| | \ Types and definitions. Bootloader module type and definitions
| o Bootloader settings API. Bootloader settings module interface
| o DFU BLE packet handling in application Handling of DFU BLE packets in the application
| o Device Firmware Update API. Device Firmware Update module interface
| | \ Types and definitions. Device Firmware Update module type and definitions
| o Init packet handling in DFU. Device Firmware Update module type and function declaration for init packet handling
| o DFU transport API. DFU transport module interface
| o Bootloader util API. Bootloader util module interface
| o Device Firmware Update internal header for bank handling in DFU. Device Firmware Update Bank handling module interface
| o Ble_sdk_app_bootloader_main
| o DFU BLE SVC DFU BLE SVC in bootloader. The DFU BLE SuperVisor Calls allow an application to execute functions in the installed bootloader
| | \ DFU BLE SVC internal DFU BLE SVC internal functions in bootloader. The DFU BLE SuperVisor Calls allow an application to execute functions in the installed bootloader. This interface provides internal Bootloader DFU functions for retrieving data exchanged through SuperVisor Calls
| \ DFU BLE SVC internal DFU BLE SVC internal functions in bootloader. The DFU BLE SuperVisor Calls allow an application to execute functions in the installed bootloader. This interface provides internal Bootloader DFU functions for retrieving data exchanged through SuperVisor Calls
o Peripheral drivers
| o ADNS2080 driver ADNS2080 mouse sensor driver
| o Cherry 8x16 keyboard matrix driver Cherry 8x16 keyboard matrix driver
| o DS1624 digital temperature sensor driver DS1624 digital temperature sensor driver
| o MPU6050 gyro/accelerometer driver MPU6050 gyro/accelerometer driver
| o Synaptics Touchpad driver. Synaptics Touchpad driver
| o ADC HAL Hardware abstraction layer for managing the analog-to-digital converter
| o AES ECB encryption Driver for the nRF51 AES Electronic Code Book (ECB) peripheral
| o GPIO abstraction GPIO pin abstraction and port abstraction for reading and writing byte-wise to GPIO ports
| o Non-volatile memory controller Driver for the nRF51 NVMC peripheral
| o TEMP (temperature) abstraction Temperature module init and read functions
| o Timer HAL and driver Timer APIs
| | o Timer HAL Hardware abstraction layer for accessing the timer peripheral
| | \ Timer driver Multi-instance timer driver
| o QDEC HAL and driver Quadrature decoder (QDEC) APIs
| | o QDEC HAL Hardware abstraction layer for accessing the quadrature decoder (QDEC) peripheral
| | \ QDEC driver Quadrature decoder (QDEC) driver
| o Clock HAL and driver Clock APIs
| | o Clock HAL Hardware abstraction layer for managing the low-frequency clock (LFCLK) and the high-frequency clock (HFCLK)
| | \ Clock driver Driver for managing the low-frequency clock (LFCLK) and the high-frequency clock (HFCLK)
| o GPIOTE abstraction and driver GPIOTE APIs
| | o GPIOTE abstraction GPIOTE abstraction for configuration of channels
| | \ GPIOTE driver GPIOTE driver for managing input and output pins
| o LPCOMP HAL and driver Low Power Comparator (LPCOMP) APIs
| | o LPCOMP HAL Hardware abstraction layer for managing the Low Power Comparator (LPCOMP)
| | \ LPCOMP driver Low Power Comparator (LPCOMP) driver
| o WDT HAL and driver
| | o WDT HAL Hardware abstraction layer for accessing the watchdog timer (WDT) peripheral
| | \ WDT driver WDT driver
| o RTC HAL and driver Real timer counter (RTC) APIs
| | o RTC HAL Hardware abstraction layer for managing the real time counter (RTC)
| | \ RTC driver Real timer counter (RTC) driver
| o SDIO driver 2-wire serial interface driver
| o SPI Master driver SPI master driver
| o Software controlled SPI Slave driver. Software controlled SPI Slave driver
| o Software controlled TWI Master driver Software controlled TWI Master driver
| o TWI HAL and driver TWI APIs
| | o TWI HAL Hardware access layer for the two-wire interface (TWI) peripheral
| | \ TWI driver Driver for managing the TWI
| o RNG HAL and driver Random number generator (RNG) APIs
| | o RNG HAL Hardware abstraction layer for managing the random number generator (RNG)
| | \ RNG driver Driver for managing the random number generator (RNG)
| o PPI HAL and driver Programmable Peripheral Interconnect (PPI) APIs
| | o PPI HAL Hardware abstraction layer for setting up Programmable Peripheral Interconnect (PPI) channels
| | \ PPI driver Programmable Peripheral Interconnect (PPI) driver
| \ SWI driver Driver for software interrupts (SWI)
o SDK common libraries
| o Board Support Package: BLE Button Module Module for controlling BLE behavior through button actions
| o Persistent Storage Interface Abstracted flash interface
| | o Persistent Storage Access Operation Codes Persistent Storage Access Operation Codes
| | o Persistent Memory Interface Data Types Data Types needed for interfacing with persistent memory
| | \ Persistent Storage Access Routines Functions/Interface SDK modules used to persistently store data
| o UART module UART module interface
| o Button Handler Buttons handling module
| o FIFO implementation FIFO implementation
| o Memory Manager Memory Manager for the nRF51 SDK
| o GPIOTE Handler GPIOTE handler module
| o Memory pool Memory pool implementation
| | \ Memory Pool Internal Memory pool internal definitions
| o SLIP module SLIP layer for supporting packet framing in HCI transport
| o HCI Transport HCI transport module implementation
| | \ CRC compute This module implements the CRC-16 calculation in the blocks
| o Pulse-width modulation (PWM) Module for generating a pulse-width modulated output signal
| | \ Auxiliary internal types declarations
| o Scheduler The scheduler is used for transferring execution from the interrupt context to the main context
| o SHA-256 hash library This module calculates SHA-256 (SHA-2, FIPS-180) hashes
| o Simple Timer Simple timer module
| o Application Timer Application timer functionality
| o Debug Logger Enables debug logs/ trace over UART
| o Common application error handler Common application error handler and macros for utilizing a common error handler
| o Utility Functions and Definitions Various types and definitions available to all applications
| o Utility Functions and Definitions (Platform) Various types and definitions available to all applications when using SoftDevice
| o SDK Error codes
| | o Base defined for SDK Modules
| | o Codes reserved as identification for module where the error occurred.
| | o Codes reserved as identification for IoT errors.
| | o Codes reserved as identification for common errors.
| | \ Error / status codes specific to device manager.
| o SoftDevice Event Handler API for initializing and disabling the SoftDevice
| | o Types definitions for ANT support in SoftDevice handler. This file contains the declarations of types required for ANT stack support. These types will be defined when the preprocessor define ANT_STACK_SUPPORT_REQD is defined
| | \ Types definitions for BLE support in SoftDevice handler. This file contains the declarations of types required for BLE stack support. These types will be defined when the preprocessor define BLE_STACK_SUPPORT_REQD is defined
| \ Board Support Package BSP module
\ Proprietary stacks Application Programming Interface for proprietary protocols
  o Common Type definitions, macros, error codes, common to all proprietary modules
  o Enhanced ShockBurst Enhanced ShockBurst Application Programming Interface (API)
  o Gazell Link Layer Gazell Link Layer Application Programming Interface (API)
  \ Gazell Pairing Gazell Pairing API

Please send us your feedback about the documentation! For technical questions, visit the Nordic Developer Zone .