| ▼AIROC System | |
| AIROC Firmware Upgrade | |
| ▼AIROC HCI Firmware Upgrade | The AIROC HCI Firmware Upgrade Service is used by peer applications to upgrade firmware on AIROC Bluetooth devices over an HCI connection |
| ►Callback Functions | |
| Functions | |
| Functions | |
| Macros | |
| ▼AIROC OTA Firmware Upgrade | The AIROC OTA Firmware Upgrade Service is used by peer applications to upgrade firmware on AIROC Bluetooth devices over a GATT connection |
| Callback Functions | |
| Functions | |
| Macros | |
| Structs | |
| AIROC Result Codes | AIROC Result list for Bluetooth BR/EDR and LE |
| Factory Config Library API | The Factory Config library of the AIROC BTSDK provides a simple method for an application to read from the static section of the flash items that has been typically programmed in the factory |
| GKI | Defines the interfaces for Buffer , Timer and Event Management Services |
| Generic Helper Macros | |
| Memory Management | Helper APIs to create heaps and pools and allocate/free buffers from those pools or heaps |
| ▼Bluetooth | AIROC Bluetooth AVRC Remote Control Functions |
| ANC Library API | ANC library of the AIROC BTSDK provide a simple method for an application to integrate ANC service functionality |
| ANS Library API | The ANS library of the AIROC BTSDK provide a simple method for an application to integrate the ANS service functionality |
| ▼Audio / Video | This section describes the API to use various audio/video profiles, such as A2DP, AVDTP, AVRCP, HFP |
| AIROC Audio Utilities | |
| ►Advanced Audio Distribution Profile (A2DP) Sink | |
| ►Audio Insertion | Bluetooth Audio Insert Application Programming Interface |
| API Functions | API Functions module for Audio Insert |
| ►Helper Functions | |
| A2DP SBC Support | This section describes A2DP Low complexity subband codec (SBC) API |
| MPEG-1,2 Support | This section describes A2DP MPEG-1,2 Audio codec API |
| MPEG-2,4 AAC Support | This section describes A2DP MPEG-2,4 AAC Audio codec API |
| Audio/Video Distribution Transport (AVDT) | This section describes the API's of Audio/Video Distribution Transport protocol |
| ►Audio/Video Remote Control (AVRC) | This section describes the API's to use Audio/Video Remote Control Profile commands which use underlying AVCT protocol |
| AVRCP Controller Role (CT) | AVRC remote control functions |
| AVRCP Target Role (TG) | AVRC remote control functions |
| ►SCO Hook | Bluetooth SCO Hook Application Programming Interface |
| API Functions | API Functions module for SCO Hook |
| ►Data Types | Data Types for SCO Hook |
| API Functions | API Functions module for SCO Hook |
| ▼Audio/Video Remote Control (AVRC) | This section describes the API's to use Audio/Video Remote Control Profile commands which use underlying AVCT protocol |
| AVRCP Controller Role (CT) | AVRC remote control functions |
| AVRCP Target Role (TG) | AVRC remote control functions |
| BAC Library API | The BAC library of the AIROC BTSDK provide a simple method for an application to integrate the BAC service functionality |
| BAS Library API | The BAS library of the AIROC BTSDK provide a simple method for an application to integrate the battery service functionality |
| Bluetooth Stack Initialize & Configuration | This section describes API and Data structures required to initialize and configure the Bluetooth stack |
| Bluetooth Stack Platform Interface | Interface between Stack and platform |
| ▼Common Bluetooth types | |
| AIROC Bluetooth Types | AIROC Bluetooth Types |
| ▼Device Management | This section consists of several management entities: |
| ►BR/EDR (Bluetooth Basic Rate / Enhanced Data Rate) | BR/EDR (Bluetooth Basic Rate / Enhanced Data Rate) Functions |
| ►BR/EDR Security Function | This module provided various Bluetooth BR/EDR security functionality such as authorisation, authentication and encryption |
| Generic Security API | Bluetooth generic security API |
| Bluetooth BR/EDR API | This module provided various Bluetooth security functionality such as authorisation, authentication and encryption |
| ►Bluetooth Low Energy | This section describes the API's to use LE functionality such as advertisement, scanning LE Connection, Data transfer, LE Security etc |
| Advertisement & Scan | This section provides functions for LE advertisement and LE scan operations |
| Connection and Filter Accept List | This section provides functions for LE connection related and Filter Accept List operations |
| ►LE Security | Bluetooth LE security API (authorisation, authentication and encryption) |
| Generic Security API | Bluetooth generic security API |
| MultiAdv | This section describes Multiple Advertisement API, using this interface application can enable more than one advertisement train |
| Phy | This section provides functionality to read and update PHY |
| Utilities | This sections provides Bluetooth utilities functions related to trace, local bda, tx power etc |
| ▼Generic Attribute (GATT) | Generic Attribute (GATT) Functions |
| Client API | GATT Profile Client Functions |
| ►Connection API | GATT Profile Connection Functions |
| BR/EDR (Bluetooth Basic Rate / Enhanced Data Rate) | BR/EDR (Bluetooth Basic Rate / Enhanced Data Rate) Specific functions |
| EATT | EATT API |
| LE (Bluetooth Low Energy) | LE (Bluetooth Low Energy) Specific functions |
| GATT Utilities | Generic Attribute (GATT) Utility Functions |
| ►Server API | GATT Profile Server Functions |
| GATT Database | GATT Database Access Functions |
| GATT Robust Caching | GATT Robust Caching API |
| GATT Server Data API | GATT Server Data API |
| HID Device Role (HIDD) over BR/EDR | HIDD Functions This component maps features from the USB Human Interface Definition onto Bluetooth as a profile |
| HID Device Role (HIDD) over LE | This component maps features from the USB Human Interface Definition onto Bluetooth low energy GATT characteristics and descriptors |
| HRC Library API | HRC library of the AIROC BTSDK provides a simple method for an application to integrate Heart Rate Client functionality |
| HRS Library API | HRS library of the AIROC BTSDK provides a simple method for an application to integrate Heart Rate server functionality |
| ▼LE Mesh | Mesh API provides a developer a simple way to incorporate LE mesh functionality in an AIROC application |
| Mesh Client Library API | The mesh client API |
| Mesh Core Library API | Mesh Core library of the AIROC BTSDK provide a simple method for an application to integrate Bluetooth Mesh functionality |
| ►Mesh Models Library API | Mesh Models library of the AIROC BTSDK provide a simple method for an application to use various Mesh models defined in the Bluetooth Mesh Model specification |
| Mesh Battery Client | The AIROC Mesh Battery Client module provides a way for an application to retrieve the battery status of a mesh node |
| Mesh Battery Server | The AIROC Mesh Battery Server module provides a way for a client to retrieve the Battery status of this device |
| Mesh Default Transition Time Client | The AIROC Mesh Default Transition Time Client module of the Mesh Models library provides a way for a controlling device to set default transition time for the devices in the mesh network |
| Mesh Default Transition Time Server | The AIROC Mesh Default Transition Time Server module of the Mesh Models library provides implementation of the Default Transition Time model |
| Mesh Level Client | The AIROC Mesh Level Client module of the Mesh Models library provides a way for an application to send Level commands (set, delta and move) to the server and optionally receive status information |
| Mesh Level Server | The AIROC Mesh Level Server module of the Mesh Models library provides a way to implement functionality for the devices that can be controlled using a simple level slider, aka Level client |
| Mesh Light CTL Client | The AIROC Mesh Light CTL Client module of the Mesh Models library provides a way for an application to configure and control color lights that support Color Temperature adjustments |
| Mesh Light CTL Server | The AIROC Mesh Color Temperature Lightness (CTL) Server module provides a way for an application to implement a dimmable light device with color temperature support |
| Mesh Light HSL Client | The AIROC Mesh Light HSL Client module of the Mesh Models library provides a way for an application to configure and control color lights that support Hue/Saturation control |
| Mesh Light HSL Server | The AIROC Mesh Hue Saturation Lightness (HSL) Server module provides a way for an application to implement a dimmable light device with hue/saturation support |
| Mesh Light LC Client | The AIROC Mesh Light LC Client module of the Mesh Models library provides a way for an application to configure and control lights that support LC control |
| Mesh Light LC Server | The AIROC Mesh Light LC Server module provides a way for an application to implement a Light Control Server device which can be a client to a Sensor Server model and controls the Light Lightness Actual state via defined state bindings |
| Mesh Light Lightness Client | The AIROC Mesh Light Lightness Client module of the Mesh Models library provides a way for an application to control brightness level of the Light Lightness Servers in the mesh network optionally receive status information |
| Mesh Light Lightness Server | The AIROC Mesh Light Lightness Server module provides a way for an application to implement a dimmable light device which can be controlled specifically by setting the brightness, but also can be can be controlled using a Level slider (Generic Level client) and On/Off switch (Generic On/Off client) |
| Mesh Light xyL Client | The AIROC Mesh Light XYL Client module of the Mesh Models library provides a way for an application to configure and control color lights that support xyL control |
| Mesh Light xyL Server | The AIROC Mesh Light xyL Server module provides a way for an application to implement a dimmable light device with x and y chromaticity coordinates support |
| Mesh Location Client | The AIROC Mesh Location Client module provides a way for an application to configure the device with a Global or a Local Location data or to retrieve this data |
| Mesh Location Server | The AIROC Mesh Location Server module provides a way for a client to set the Global and Local location for a mesh device |
| Mesh OnOff Client | The AIROC Mesh On/Off Client module of the Mesh Models library provides a way for an application to send OnOff commands to the server and optionally receive status information |
| Mesh OnOff Server | The AIROC Mesh OnOff Server module of the Mesh Models library provides a way to implement functionality for the devices that can be controlled using a simple On/Off switch, aka On/Off client |
| Mesh Power Level Client | The AIROC Mesh Power Level Client module of the Mesh Models library provides a way for an application to control power level of the Power Level Servers in the mesh network optionally receive status information |
| Mesh Power Level Server | The AIROC Mesh Power Level Server module of the Mesh Models library provides a way to implement functionality of a power plug type of a device that can be controlled using a Level slider (Generic Level client) and On/Off switch (Generic On/Off client) |
| Mesh Power OnOff Client | The AIROC Mesh Power On/Off Client module of the Mesh Models library provides a way for an application to manage the On Power Up behavior of other mesh devices |
| Mesh Power OnOff Server | The AIROC Mesh Power OnOff Server module of the Mesh Models library provides a way to implement functionality for the devices that can be controlled using a simple On/Off switch, aka On/Off client |
| Mesh Scene Client | The AIROC Mesh Scene Client module provides a way for an application to control Scene Servers in the mesh network |
| Mesh Scene Server | The AIROC Mesh Scene Server module provides a way for an application to implement a functionality for the devices that support scene state |
| Mesh Scheduler Client | The AIROC Mesh Scheduler Client module provides a way for an application to control Scheduler Servers in the mesh network |
| Mesh Scheduler Server | The AIROC Mesh Scheduler Server module provides a way for an application to implement a functionality for the devices that support Scheduler |
| Mesh Sensor Client | The AIROC Mesh Sensor Client module provides a way for an application to control Sensor Servers in the mesh network |
| Mesh Sensor Server | The AIROC Mesh Sensor Server module provides a way for an application to implement a functionality for the devices that can be controlled using sensor |
| Mesh Time Client | The AIROC Mesh Time Client module provides a way for an application to control Time Servers in the mesh network |
| Mesh Time Server | The AIROC Mesh Time Server module provides a way for an application to implement a functionality for the devices that support time state |
| Mesh Provisioning Library API | Mesh provisioning is split into two parts |
| ▼Logical Link Control and Adaptation Protocol (L2CAP) | Logical Link Control and Adaptation Layer Protocol, referred to as L2CAP, provides connection oriented and connectionless data services to upper layer protocols with protocol multiplexing capability and segmentation and reassembly operation |
| BR/EDR | API's used for BR/EDR L2CAP |
| Common | Commonly used API's for both BE/EDR and LE L2CAP |
| LE | API's used for LE L2CAP |
| ▼OBEX | OBEX API Functions |
| ►Client | OBEX Client Functions |
| Header Operations | OBEX Header Operations |
| Header Operations | OBEX Header Operations |
| ►Server | OBEX Server Functions |
| ►Client | OBEX Client Functions |
| Header Operations | OBEX Header Operations |
| RFCOMM | The RFCOMM protocol provides emulation of serial ports over the L2CAP protocol |
| SPP Library API | SPP library of the AIROC BTSDK provide a simple method for an application to integrate SPP functionality |
| Service Discovery Protocol (SDP) | The Service Discovery Protocol (SDP) allows a device to discover services offered by other devices, and their associated parameters |
| Synchronous Connection Oriented (SCO) Channel | |
| iAP2 Protocol Library API | IAP2 library of the AIROC BTSDK provides a simple method for an application to integrate iAP2 functionality |
| ▼Hardware Drivers | |
| AIROC Sleep Configuration | Defines functions for using the AIROC Sleep Framework |
| AIROC Transport | Defines the transport utilities for configuring the transport, send data and receive data |
| AesCalculation | Defines a driver for the AES calculation with Hardware acceleration |
| GPIO | Defines a driver to facilitate interfacing with the GPIO pins |
| I2C | Defines an I2C driver to facilitate communication with other devices on an I2C bus (such as a temperature sensor, etc) |
| NVRAM | Defines the interface for reading and writing any data to the NVRAM |
| Peripheral SPI | Defines an SPI driver to facilitate communication with other devices on an SPI bus (such as a temperature sensor, etc) |
| Peripheral UART (PUART) | Defines a driver to facilitate interfacing with the UART hardware to send and receive bytes or a stream of bytes over the UART hardware |
| Random Number Generator (RNG) | Defines a driver for the Random Number Generator (RNG) |
| Serial Flash Interface | Defines a driver for the Serial Flash interface |
| Timer Management Services | Defines the interfaces for Timer Management Services |
| Watchdog Interface | Defines a driver for the watchdog interface |
| ▼Ischoronous (ISOC) | This section describes the API's to use ISOC functionality |
| ISOC data types and macros | |
| Ischoronous (ISOC) functions | Ischoronous(ISOC) Functions |
| ▼RTOS | AIROC Real-Time Operating System Functions |
| Event Flags | Event flags management functions |
| Events | Event management functions |
| Mutexes | Mutex management functions |
| Queues | Queue management functions |
| Semaphores | Semaphore management functions |
| Sleep | Sleep management functions |
| Threads | Thread management functions |
| Worker Threads | Worker thread management functions |
