API Reference

Provides the list of API Reference

BLE Common API	The common API act as a general interface between the BLE application and the BLE Stack module
BLE Common Core Functions	The common core API are used for general BLE configuration
Whitelist API	The API are used for enable user to use Whitelist feature of BLE Stack
Link Layer Privacy API	The API are used for enable user to use Link Layer Privacy feature of BLE Stack
Data Length Extension (DLE) API	The API are used for enable user to use Data Length Extension (DLE) feature of BLE Stack
2Mbps Feature API	The API are used for enable user to use 2Mbps feature of BLE Stack
LE Ping API	The API are used for enable user to use LE Ping feature of BLE Stack
AES Engine API	BLE sub system AES Engine is exposed through this API
BLE HCI API	API exposes BLE Stack’s Host HCI to user, if they want to do DTM testing or use BLE Controller alone
BLE Interrupt Notification Callback	API exposes BLE interrupt notifications to the application which indicates a different link layer and radio state transitions to the user from the BLESS interrupt context
GAP Functions	The GAP APIs allow access to the Generic Access Profile (GAP) layer of the BLE Stack
GAP Central and Peripheral Functions	These are APIs common to both GAP Central role and GAP Peripheral role
GAP Central Functions	APIs unique to designs configured as a GAP Central role
GAP Peripheral Functions	APIs unique to designs configured as a GAP Peripheral role
GATT Functions	The GATT APIs allow access to the Generic Attribute Profile (GATT) layer of the BLE Stack
GATT Client and Server Functions	These are APIs common to both GATT Client role and GATT Server role
GATT Client Functions	APIs unique to designs configured as a GATT Client role
GATT Server Functions	APIs unique to designs configured as a GATT Server role
L2CAP Functions	The L2CAP APIs allow access to the Logical link control and adaptation protocol (L2CAP) layer of the BLE Stack
BLE Common Events	The BLE Stack generates events to notify the application on various status alerts concerning the stack
BLE Common Definitions and Data Structures	Contains definitions and structures that are common to all BLE common API
BLE Error Code	Contains definitions for all the spec defined error code in Core Spec 5.0, Vol2, Part D
Macros
Common	BLE Common macros
BLE GATT Database	BLE GATT Database macros
BLE Services UUID	BLE Services Universal Unique Identifier (UUID) macros
BLE GATT Attribute Types UUID	BLE GATT Attribute Types defined by GATT Profile UUID macros
BLE GATT Characteristic Descriptors UUID	BLE GATT Attribute Types defined by GATT Profile UUID macros
BLE GATT Characteristic Types UUID	BLE GATT Characteristic Types UUID macros
BLE Appearance values	BLE Appearance values macros
Data Structures
Common	Contains the common definitions and data structures used in the BLE
GAP	Contains the GAP specific definitions and data structures used in the GAP APIs
GATT	Contains the GATT specific definitions and data structures used in the GATT APIs
L2 CAP	Contains the L2CAP specific definitions and data structures used in the L2CAP APIs
Global Variables
BLE Service-Specific API	This section describes BLE Service-specific API
BLE Service-Specific Events	The BLE Stack generates service-specific events to notify the application that a service-specific status change needs attention
Apple Notification Center Service (ANCS)	The Apple Notification Center Service provides iOS notifications from Apple devices for accessories
ANCS Server and Client Function	These are API common to both GATT Client role and GATT Server role
ANCS Server Functions	API unique to ANCS designs configured as a GATT Server role
ANCS Client Functions	API unique to ANCS designs configured as a GATT Client role
ANCS Definitions and Data Structures	Contains the ANCS specific definitions and data structures used in the ANCS API
Alert Notification Service (ANS)	The Alert Notification Service exposes alert information in a device
ANS Server and Client Function	These are API common to both GATT Client role and GATT Server role
ANS Server Functions	API unique to ANS designs configured as a GATT Server role
ANS Client Functions	API unique to ANS designs configured as a GATT Client role
ANS Definitions and Data Structures	Contains the ANS specific definitions and data structures used in the ANS API
Automation IO Service (AIOS)	The Automation IO Service enables a device to connect and interact with an Automation IO Module (IOM) in order to access digital and analog signals
AIOS Server and Client Function	These are API common to both GATT Client role and GATT Server role
AIOS Server Functions	API unique to AIOS designs configured as a GATT Server role
AIOS Client Functions	API unique to AIOS designs configured as a GATT Client role
AIOS Definitions and Data Structures	Contains the AIOS specific definitions and data structures used in the AIOS API
Battery Service (BAS)	The Battery Service exposes the battery level of a single battery or set of batteries in a device
BAS Server and Client Function	These are API common to both GATT Client role and GATT Server role
BAS Server Functions	API unique to BAS designs configured as a GATT Server role
BAS Client Functions	API unique to BAS designs configured as a GATT Client role
BAS Definitions and Data Structures	Contains the BAS specific definitions and data structures used in the BAS API
Body Composition Service (BCS)	The Body Composition Service exposes data related to body composition from a body composition analyzer (Server) intended for consumer healthcare as well as sports/fitness applications
BCS Server and Client Function	These are API common to both GATT Client role and GATT Server role
BCS Server Functions	API unique to BCS designs configured as a GATT Server role
BCS Client Functions	API unique to BCS designs configured as a GATT Client role
BCS Definitions and Data Structures	Contains the BCS specific definitions and data structures used in the BCS API
Blood Pressure Service (BLS)	The Blood Pressure Service exposes blood pressure and other data related to a non-invasive blood pressure monitor for consumer and professional healthcare applications
BLS Server and Client Function	These are API common to both GATT Client role and GATT Server role
BLS Server Functions	API unique to BLS designs configured as a GATT Server role
BLS Client Functions	API unique to BLS designs configured as a GATT Client role
BLS Definitions and Data Structures	Contains the BLS specific definitions and data structures used in the BLS API
Bond Management Service (BMS)	The Bond Management Service defines how a peer Bluetooth device can manage the storage of bond information, especially the deletion of it, on the Bluetooth device supporting this service
BMS Server and Client Function	These are API common to both GATT Client role and GATT Server role
BMS Server Functions	API unique to BMS designs configured as a GATT Server role
BMS Client Functions	API unique to BMS designs configured as a GATT Client role
BMS Definitions and Data Structures	Contains the BMS specific definitions and data structures used in the BMS API
Continuous Glucose Monitoring Service (CGMS)	The Continuous Glucose Monitoring Service exposes glucose measurement and other data related to a personal CGM sensor for healthcare applications
CGMS Server and Client Function	These are API common to both GATT Client role and GATT Server role
CGMS Server Functions	API unique to CGMS designs configured as a GATT Server role
CGMS Client Functions	API unique to CGMS designs configured as a GATT Client role
CGMS Definitions and Data Structures	Contains the CGMS specific definitions and data structures used in the CGMS API
Cycling Power Service (CPS)	The Cycling Power Service (CPS) exposes power- and force-related data and optionally speed- and cadence-related data from a Cycling Power sensor (GATT Server) intended for sports and fitness applications
CPS Server and Client Function	These are API common to both GATT Client role and GATT Server role
CPS Server Functions	API unique to CPS designs configured as a GATT Server role
CPS Client Functions	API unique to CPS designs configured as a GATT Client role
CPS Definitions and Data Structures	Contains the CPS specific definitions and data structures used in the CPS API
Cycling Speed and Cadence Service (CSCS)	The Cycling Speed and Cadence (CSC) Service exposes speed-related data and/or cadence-related data while using the Cycling Speed and Cadence sensor (Server)
CSCS Server and Client Function	These are API common to both GATT Client role and GATT Server role
CSCS Server Functions	API unique to CSCS designs configured as a GATT Server role
CSCS Client Functions	API unique to CSCS designs configured as a GATT Client role
CSCS Definitions and Data Structures	Contains the CSCS specific definitions and data structures used in the CSCS API
Current Time Service (CTS)	The Current Time Service defines how a Bluetooth device can expose time information to other Bluetooth devices
CTS Server and Client Function	These are API common to both GATT Client role and GATT Server role
CTS Server Functions	API unique to CTS designs configured as a GATT Server role
CTS Client Functions	API unique to CTS designs configured as a GATT Client role
CTS Definitions and Data Structures	Contains the CTS specific definitions and data structures used in the CTS API
Device Information Service (DIS)	The Device Information Service exposes manufacturer and/or vendor information about a device
DIS Server and Client Function	These are API common to both GATT Client role and GATT Server role
DIS Server Functions	API unique to DIS designs configured as a GATT Server role
DIS Client Functions	API unique to DIS designs configured as a GATT Client role
DIS Definitions and Data Structures	Contains the DIS specific definitions and data structures used in the DIS API
Environmental Sensing Service (ESS)	The Environmental Sensing Service exposes measurement data from an environmental sensor intended for sports and fitness applications
ESS Server and Client Function	These are API common to both GATT Client role and GATT Server role
ESS Server Functions	API unique to ESS designs configured as a GATT Server role
ESS Client Functions	API unique to ESS designs configured as a GATT Client role
ESS Definitions and Data Structures	Contains the ESS specific definitions and data structures used in the ESS API
Glucose Service (GLS)	The Glucose Service exposes glucose and other data related to a personal glucose sensor for consumer healthcare applications and is not designed for clinical use
GLS Server and Client Function	These are API common to both GATT Client role and GATT Server role
GLS Server Functions	API unique to GLS designs configured as a GATT Server role
GLS Client Functions	API unique to GLS designs configured as a GATT Client role
GLS Definitions and Data Structures	Contains the GLS specific definitions and data structures used in the GLS API
HID Service (HIDS)	The HID Service exposes data and associated formatting for HID Devices and HID Hosts
HIDS Server and Client Functions	These are API common to both GATT Client role and GATT Server role
HIDS Server Functions	API unique to HID designs configured as a GATT Server role
HIDS Client Functions	API unique to HID designs configured as a GATT Client role
HIDS Definitions and Data Structures	Contains the HID specific definitions and data structures used in the HID API
Heart Rate Service (HRS)	The Heart Rate Service exposes heart rate and other data related to a heart rate sensor intended for fitness applications
HRS Server and Client Function	These are API common to both GATT Client role and GATT Server role
HRS Server Functions	API unique to HRS designs configured as a GATT Server role
HRS Client Functions	API unique to HRS designs configured as a GATT Client role
HRS Definitions and Data Structures	Contains the HRS specific definitions and data structures used in the HRS API
HTTP Proxy Service (HPS)	The HTTP Proxy Service allows a Client device, typically a sensor, to communicate with a Web Server through a gateway device
HPS Server and Client Function	These are API common to both GATT Client role and GATT Server role
HPS Server Functions	API unique to HPS designs configured as a GATT Server role
HPS Client Functions	API unique to HPS designs configured as a GATT Client role
HPS Definitions and Data Structures	Contains the HPS specific definitions and data structures used in the HPS API
Health Thermometer Service (HTS)	The Health Thermometer Service exposes temperature and other data related to a thermometer used for healthcare applications
HTS Server and Client Function	These are API common to both GATT Client role and GATT Server role
HTS Server Functions	API unique to HTS designs configured as a GATT Server role
HTS Client Functions	API unique to HTS designs configured as a GATT Client role
HTS Definitions and Data Structures	Contains the HTS specific definitions and data structures used in the HTS API
Immediate Alert Service (IAS)	The Immediate Alert Service exposes a control point to allow a peer device to cause the device to immediately alert
IAS Server and Client Function	These are API common to both GATT Client role and GATT Server role
IAS Server Functions	API unique to IAS designs configured as a GATT Server role
IAS Client Functions	API unique to IAS designs configured as a GATT Client role
IAS Definitions and DataStructures	Contains the IAS specific definitions and data structures used in the IAS API
Indoor Positioning Service (IPS)	The Indoor Positioning exposes coordinates and other location related information via an advertisement or indicates that the device address can be used for location look-up, enabling mobile devices to find their position
IPS Server and Client Function	These are API common to both GATT Client role and GATT Server role
IPS Server Functions	API unique to IPS designs configured as a GATT Server role
IPS Client Functions	API unique to IPS designs configured as a GATT Client role
IPS Definitions and Data Structures	Contains the IPS specific definitions and data structures used in the IPS API
Link Loss Service (LLS)	The Link Loss Service uses the Alert Level Characteristic to cause an alert in the device when the link is lost
LLS Server and Client Function	These are API common to both GATT Client role and GATT Server role
LLS Server Functions	API unique to LLS designs configured as a GATT Server role
LLS Client Functions	API unique to LLS designs configured as a GATT Client role
LLS Definitions and Data Structures	Contains the LLS specific definitions and data structures used in the LLS API
Location and Navigation Service (LNS)	The Location and Navigation Service exposes location and navigation-related data from a Location and Navigation sensor (Server) intended for outdoor activity applications
LNS Server and Client Function	These are API common to both GATT Client role and GATT Server role
LNS Server Functions	API unique to LNS designs configured as a GATT Server role
LNS Client Functions	API unique to LNS designs configured as a GATT Client role
LNS Definitions and Data Structures	Contains the LNS specific definitions and data structures used in the LNS API
Next DST Change Service (NDCS)	The Next DST Change Service enables a BLE device that has knowledge about the next occurrence of a DST change to expose this information to another Bluetooth device
NDCS Server and Client Functions	These are API common to both GATT Client role and GATT Server role
NDCS Server Functions	API unique to NDCS designs configured as a GATT Server role
NDCS Client Functions	API unique to NDCS designs configured as a GATT Client role
NDCS Definitions and Data Structures	Contains the NDCS specific definitions and data structures used in the NDCS API
Phone Alert Status Service (PASS)	The Phone Alert Status Service uses the Alert Status Characteristic and Ringer Setting Characteristic to expose the phone alert status and uses the Ringer Control Point Characteristic to control the phone’s ringer into mute or enable
PASS Server and Client Function	These are API common to both GATT Client role and GATT Server role
PASS Server Functions	API unique to PASS designs configured as a GATT Server role
PASS Client Functions	API unique to PASS designs configured as a GATT Client role
PASS Definitions and Data Structures	Contains the PASS specific definitions and data structures used in the PASS API
Pulse Oximeter Service (PLXS)	The Pulse Oximeter Service enables a Collector device to connect and interact with a pulse oximeter intended for healthcare applications
PLXS Server and Client Function	These are API common to both GATT Client role and GATT Server role
PLXS Server Functions	API unique to PLXS designs configured as a GATT Server role
PLXS Client Functions	API unique to PLXS designs configured as a GATT Client role
PLXS Definitions and Data Structures	Contains the PLXS specific definitions and data structures used in the PLXS API
Running Speed and Cadence Service (RSCS)	The Running Speed and Cadence (RSC) Service exposes speed, cadence and other data related to fitness applications such as the stride length and the total distance the user has travelled while using the Running Speed and Cadence sensor (Server)
RSCS Server and Client Functions	These are API common to both GATT Client role and GATT Server role
RSCS Server Functions	API unique to RSCS designs configured as a GATT Server role
RSCS Client Functions	API unique to RSCS designs configured as a GATT Client role
RSCS Definitions and Data Structures	Contains the RSCS specific definitions and data structures used in the RSCS API
Reference Time Update Service (RTUS)	The Reference Time Update Service enables a Bluetooth device that can update the system time using the reference time such as a GPS receiver to expose a control point and expose the accuracy (drift) of the local system time compared to the reference time source
RTUS Server and Client Function	These are API common to both GATT Client role and GATT Server role
RTUS Server Functions	API unique to RTUS designs configured as a GATT Server role
RTUS Client Functions	API unique to RTUS designs configured as a GATT Client role
RTUS Definitions and Data Structures	Contains the RTUS specific definitions and data structures used in the RTUS API
Scan Parameters Service (ScPS)	The Scan Parameters Service enables a Server device to expose a Characteristic for the GATT Client to write its scan interval and scan window on the Server device, and enables a Server to request a refresh of the GATT Client scan interval and scan window
ScPS Server and Client Functions	These are API common to both GATT Client role and GATT Server role
ScPS Server Functions	API unique to ScPS designs configured as a GATT Server role
ScPS Client Functions	API unique to ScPS designs configured as a GATT Client role
ScPS Definitions and Data Structures	Contains the ScPS specific definitions and data structures used in the ScPS API
TX Power Service (TPS)	The Tx Power Service uses the Tx Power Level Characteristic to expose the current transmit power level of a device when in a connection
TPS Server and Client Function	These are API common to both GATT Client role and GATT Server role
TPS Server Functions	API unique to TPS designs configured as a GATT Server role
TPS Client Functions	API unique to TPS designs configured as a GATT Client role
TPS Definitions and Data Structures	Contains the TPS specific definitions and data structures used in the TPS API
User Data Service (UDS)	The User Data Service exposes user-related data in the sports and fitness environment
UDS Server and Client Function	These are API common to both GATT Client role and GATT Server role
UDS Server Functions	API unique to UDS designs configured as a GATT Server role
UDS Client Functions	API unique to UDS designs configured as a GATT Client role
UDS Definitions and Data Structures	Contains the UDS specific definitions and data structures used in the UDS API
Wireless Power Transfer Service (WPTS)	The Wireless Power Transfer Service enables communication between Power Receiver Unit and Power Transmitter Unit in the Wireless Power Transfer systems
WPTS Server and Client Function	These are API common to both GATT Client role and GATT Server role
WPTS Server Functions	API unique to WPTS designs configured as a GATT Server role
WPTS Client Functions	API unique to WPTS designs configured as a GATT Client role
WPTS Definitions and Data Structures	Contains the WPTS specific definitions and data structures used in the WPTS API
Weight Scale Service (WSS)	The Weight Scale Service exposes weight and related data from a weight scale (Server) intended for consumer healthcare as well as sports/fitness applications
WSS Server and Client Function	These are API common to both GATT Client role and GATT Server role
WSS Server Functions	API unique to WSS designs configured as a GATT Server role
WSS Client Functions	API unique to WSS designs configured as a GATT Client role
WSS Definitions and Data Structures	Contains the WSS specific definitions and data structures used in the WSS API
Custom Service	This section contains the data structures used for Custom Services