▼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 | |
Macros | |
AIROC NVRAM Coredump | Defines coredump nvram management interface |
►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 |
AIROC Trace Utilities | Trace Utilities |
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 |
►Memory Management | The following APIs provides the memory buffer management used by the application and the upper layer stack of the AIROC Bluetooth Stack |
Data Structures | |
Functions | |
GKI | Defines the interfaces for Buffer , Timer and Event Management Services |
▼Bluetooth | AIROC Bluetooth Framework 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 (A2DP) | Advanced Audio Distribution Profile |
A2DP Helper Functions | Advanced Audio Distribution Profile |
A2DP SBC Support | |
Audio / Video Distribution (AVDTP) | APIs to enable the upper layers to stream audio/video data over Bluetooth |
►Audio / Video Remote Control (AVRCP) | This section describes the API's to use Audio/Video Remote Control Profile |
AVRCP Common | This section contains the API's that are common for both target and controller functionality |
AVRCP Controller Role (CT) | AIROC Bluetooth AVRC Remote Control CT Functions |
AVRCP Target Role (TG) | AVRC remote control functions |
Audio Codec Interface | |
Synchronous Connection Oriented (SCO) Channel | SCO Definitions and 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 |
►Device Management | AIROC Device Management APIs |
►Bluetooth Classic (BR/EDR) | |
Data Structures | |
Enumerated Types | |
►Functions | |
Bluetooth Classic Host Stack Management | |
Device Control | |
Security | |
Macro | |
►Bluetooth Low Energy | Bluetooth Low Energy (LE) Functions |
Data Structures | |
Enumerated Types | |
►Functions | |
Advertising | |
Background Connections | |
LE Controller Settings | |
Multi Advertising | Multi advertisements allow the device to advertise as if it is multiple LE broadcast devices |
Scanning | |
Security | |
Macro | |
Framework | Framework Management Functions |
►Generic Attribute (GATT) | Generic Attribute (GATT) Functions |
Client | GATT Profile Client Functions |
Common | GATT Profile Common Functions |
GATT Database | GATT Database Access Functions |
GATT Utilities | Generic Attribute (GATT) Utility Functions |
Server | GATT Profile Server Functions |
HIDD Library API | HIDD Functions |
HIDD over BR/EDR | HIDD Functions |
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) | Bluetooth L2CAP Application Programming Interface |
API Functions | API Functions module for L2CAP |
Callback Functions | Callback functions for Logical Link Control and Adaptation Layer Protocol (L2CAP) |
Data Types | Data Types for Logical Link Control and Adaptation Layer Protocol (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 | RFCOMM Functions |
SPP Library API | SPP library of the AIROC BTSDK provide a simple method for an application to integrate SPP functionality |
►Service Discovery Protocol (SDP) | |
SDP API Functions | Service Discovery (SDP) Functions |
SDP Data Types | |
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 | This driver provides simplified access to the AIROC sleep framework on the CYW20819 device |
Group_sleep_data_structures | |
Group_sleep_defines | |
Group_sleep_enums | |
►AIROC Transport | Defines the transport utilities for configuring the transport, sending data and receiving data |
Callback Functions | |
Data Structures | |
Enumerations | |
Functions | |
AesCalculation | Defines a driver for the AES calculation with Hardware acceleration |
►Analog-to-Digital Converter (ADC) | Defines a driver to facilitate interfacing with the Analog-to-Digital Converter (ADC) driver |
Data Structures | |
Functions | |
►Auxiliary Clock (ACLK) | Defines a driver to facilitate interfacing with the auxiliary clock |
Group_ACLK_enum | |
Battery Monitor | Defines a driver to facilitate interfacing with the Battery Monitor |
Embedded Flash Interface | Defines a driver for the Embedded Flash interface |
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) |
I2C EEPROM Interface | Defines a driver for the I2C EEPROM interface |
►Keyscan Interface | |
Keyscan Button | |
Keyscan Interface Queue | |
Multiple Interface Adapter (MIA) | Defines a Multiple Interface Adapter (MIA) driver to facilitate interfacing with various components of the hardware The MIA driver controls aspects such as GPIO pin muxing, interrupt managment, and timing |
►NVRAM | This driver provides simplified access to the volatile section ("VS") of memory |
Enumerated Types | |
Functions | |
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 |
►PeripheralSpiDriver | Defines an SPI driver to facilitate communication with other devices on an SPI bus (such as a temperature sensor, etc) |
Group_PeripheralSpiDriver_enums | |
Group_PeripheralSpiDriver_macro | |
►Pulse Width Modulation (PWM) | Defines a driver to facilitate interfacing with the Pulse-Width Modulation (PWM) driver |
Functions | PWM Functions |
Structures | PWM Structures |
Quadrature | |
RTCDriver | |
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 | Provides the API declarations for Timer services |
Group_timer_data_structures | |
Group_timer_enums | |
Watchdog Timer | This driver manages the hardware watchdog countdown timer |
▼RTOS | |
Application Thread Serialization | |
Data Structures | |
Enumerated Types | |
►Functions | |
Event Flag | Defines a group of APIs to expose the event flags RTOS functionality |
Mutex | Defines a group of APIs, which interface to RTOS mutex functionality |
Queue | Defines a group of APIs, which interface to RTOS queues functionality contained in ROM |
Semaphore | Defines a group of APIs, which interface to RTOS semaphore functionality contained in ROM |
Thread | Defines a group of APIs, which interface to RTOS multithreading functionality contained in ROM |
Worker Thread | Defines a group of APIs which enable the use of worker threads |
Global Variables | |
Macros | |