btaudio4 2.2.0
Loading...
Searching...
No Matches
btaudio4.h File Reference

This file contains API for BT Audio 4 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  btaudio4_t
 BT Audio 4 Click context object. More...
struct  btaudio4_cfg_t
 BT Audio 4 Click configuration object. More...

Macros

#define BTAUDIO4_CMD_ADVERTISING   "ADVERTISING"
 BT Audio 4 control commands.
#define BTAUDIO4_CMD_AVRCP_META_DATA   "AVRCP_META_DATA"
#define BTAUDIO4_CMD_AT   "AT"
#define BTAUDIO4_CMD_BATTERY_STATUS   "BATTERY_STATUS"
#define BTAUDIO4_CMD_BLE_GET_CHAR   "BLE_GET_CHAR"
#define BTAUDIO4_CMD_BCAST_REPORT   "BCAST_REPORT"
#define BTAUDIO4_CMD_BLE_GET_DES   "BLE_GET_DES"
#define BTAUDIO4_CMD_BLE_GET_SERV   "BLE_GET_SERV"
#define BTAUDIO4_CMD_BLE_INDICATION   "BLE_INDICATION"
#define BTAUDIO4_CMD_BLE_NOTIF   "BLE_NOTIF"
#define BTAUDIO4_CMD_BLE_NOTIFICATION   "BLE_NOTIFICATION"
#define BTAUDIO4_CMD_BLE_READ   "BLE_READ"
#define BTAUDIO4_CMD_BLE_READ_RES   "BLE_READ_RES"
#define BTAUDIO4_CMD_BLE_SET_DB   "BLE_SET_DB"
#define BTAUDIO4_CMD_BLE_WRITE   "BLE_WRITE"
#define BTAUDIO4_CMD_BROADCAST   "BROADCAST"
#define BTAUDIO4_CMD_BROADCODE   "BROADCODE"
#define BTAUDIO4_CMD_CALL   "CALL"
#define BTAUDIO4_CMD_CLOSE   "CLOSE"
#define BTAUDIO4_CMD_CONFIG   "CONFIG"
#define BTAUDIO4_CMD_CONNECTABLE   "CONNECTABLE"
#define BTAUDIO4_CMD_DISCOVERABLE   "DISCOVERABLE"
#define BTAUDIO4_CMD_ENTER_DATA_MODE   "ENTER_DATA_MODE"
#define BTAUDIO4_CMD_HELP   "HELP"
#define BTAUDIO4_CMD_GET   "GET"
#define BTAUDIO4_CMD_INQUIRY   "INQUIRY"
#define BTAUDIO4_CMD_LIST   "LIST"
#define BTAUDIO4_CMD_MICBIAS   "MICBIAS"
#define BTAUDIO4_CMD_MUSIC   "MUSIC"
#define BTAUDIO4_CMD_NAME   "NAME"
#define BTAUDIO4_CMD_OPEN   "OPEN"
#define BTAUDIO4_CMD_PAIR   "PAIR"
#define BTAUDIO4_CMD_PASSKEY   "PASSKEY"
#define BTAUDIO4_CMD_PIO   "PIO"
#define BTAUDIO4_CMD_POWER   "POWER"
#define BTAUDIO4_CMD_RESET   "RESET"
#define BTAUDIO4_CMD_RESTORE   "RESTORE"
#define BTAUDIO4_CMD_ROUTE   "ROUTE"
#define BTAUDIO4_CMD_RSSI   "RSSI"
#define BTAUDIO4_CMD_QUALITY   "QUALITY"
#define BTAUDIO4_CMD_SCAN   "SCAN"
#define BTAUDIO4_CMD_SCAN_UNI   "SCAN_UNI"
#define BTAUDIO4_CMD_SEND   "SEND"
#define BTAUDIO4_CMD_SEND_RAW   "SEND_RAW"
#define BTAUDIO4_CMD_SET   "SET"
#define BTAUDIO4_CMD_SRRD   "SRRD"
#define BTAUDIO4_CMD_STATUS   "STATUS"
#define BTAUDIO4_CMD_UNPAIR   "UNPAIR"
#define BTAUDIO4_CMD_TONES   "TONES"
#define BTAUDIO4_CMD_VOLUME   "VOLUME"
#define BTAUDIO4_CMD_VERSION   "VERSION"
#define BTAUDIO4_CMD_WRITE   "WRITE"
#define BTAUDIO4_PARAM_AUDIO   "AUDIO"
 BT Audio 4 control commands parameters.
#define BTAUDIO4_PARAM_AUDIO_DIGITAL   "AUDIO_DIGITAL"
#define BTAUDIO4_PARAM_AUDIO_ANALOG   "AUDIO_ANALOG"
#define BTAUDIO4_PARAM_AUTOCONN   "AUTOCONN"
#define BTAUDIO4_PARAM_AUTO_DATA   "AUTO_DATA"
#define BTAUDIO4_PARAM_BATT_CONFIG   "BATT_CONFIG"
#define BTAUDIO4_PARAM_BCAST_CONFIG   "BCAST_CONFIG"
#define BTAUDIO4_PARAM_BLE_CONFIG   "BLE_CONFIG"
#define BTAUDIO4_PARAM_BT_CONFIG   "BT_CONFIG"
#define BTAUDIO4_PARAM_CMD_TO   "CMD_TO"
#define BTAUDIO4_PARAM_COD   "COD"
#define BTAUDIO4_PARAM_CODEC   "CODEC"
#define BTAUDIO4_PARAM_DEEP_SLEEP   "DEEP_SLEEP"
#define BTAUDIO4_PARAM_GPIO_CONFIG   "GPIO_CONFIG"
#define BTAUDIO4_PARAM_HFP_CONFIG   "HFP_CONFIG"
#define BTAUDIO4_PARAM_LOCAL_ADDR   "LOCAL_ADDR"
#define BTAUDIO4_PARAM_NAME   "NAME"
#define BTAUDIO4_PARAM_NAME_BCAST   "NAME_BCAST"
#define BTAUDIO4_PARAM_NAME_SHORT   "NAME_SHORT"
#define BTAUDIO4_PARAM_MUSIC_META_DATA   "MUSIC_META_DATA"
#define BTAUDIO4_PARAM_POWERMAX   "POWERMAX"
#define BTAUDIO4_PARAM_PROFILES   "PROFILES"
#define BTAUDIO4_PARAM_SSP_CAPS   "SSP_CAPS"
#define BTAUDIO4_PARAM_SPP_UUID   "SPP_UUID"
#define BTAUDIO4_PARAM_UART_CONFIG   "UART_CONFIG"
#define BTAUDIO4_PARAM_UCAST_CONFIG   "UCAST_CONFIG"
#define BTAUDIO4_PARAM_UI_CONFIG   "UI_CONFIG"
#define BTAUDIO4_PARAM_VOLUME_CONTROL   "VOLUME_CONTROL"
#define BTAUDIO4_NOTIF_A2DP_STREAM_START   "A2DP_STREAM_START"
 BT Audio 4 command notifications.
#define BTAUDIO4_NOTIF_A2DP_STREAM_SUSPEND   "A2DP_STREAM_SUSPEND"
#define BTAUDIO4_NOTIF_ABS_VOL   "ABS_VOL"
#define BTAUDIO4_NOTIF_AT   "AT"
#define BTAUDIO4_NOTIF_AVRCP_BACKWARD   "AVRCP_BACKWARD"
#define BTAUDIO4_NOTIF_AVRCP_FORWARD   "AVRCP_FORWARD"
#define BTAUDIO4_NOTIF_AVRCP_MEDIA   "AVRCP_MEDIA"
#define BTAUDIO4_NOTIF_AVRCP_PAUSE   "AVRCP_PAUSE"
#define BTAUDIO4_NOTIF_AVRCP_PLAY   "AVRCP_PLAY"
#define BTAUDIO4_NOTIF_AVRCP_STOP   "AVRCP_STOP"
#define BTAUDIO4_NOTIF_BLE_INDICATION   "BLE_INDICATION"
#define BTAUDIO4_NOTIF_BLE_NOTIFICATION   "BLE_NOTIFICATION"
#define BTAUDIO4_NOTIF_BLE_READ   "BLE_READ"
#define BTAUDIO4_NOTIF_BLE_WRITE   "BLE_WRITE"
#define BTAUDIO4_NOTIF_CALL_ACTIVE   "CALL_ACTIVE"
#define BTAUDIO4_NOTIF_CALL_DIAL   "CALL_DIAL"
#define BTAUDIO4_NOTIF_CALL_END   "CALL_END"
#define BTAUDIO4_NOTIF_CALL_INCOMING   "CALL_INCOMING"
#define BTAUDIO4_NOTIF_CALL_OUTGOING   "CALL_OUTGOING"
#define BTAUDIO4_NOTIF_CLOSE_OK   "CLOSE_OK"
#define BTAUDIO4_NOTIF_ERROR   "ERROR"
#define BTAUDIO4_NOTIF_LINK_LOSS   "LINK_LOSS"
#define BTAUDIO4_NOTIF_OPEN_OK   "OPEN_OK"
#define BTAUDIO4_NOTIF_OPEN_ERROR   "OPEN_ERROR"
#define BTAUDIO4_NOTIF_PAIR_ERROR   "PAIR_ERROR"
#define BTAUDIO4_NOTIF_PAIR_OK   "PAIR_OK"
#define BTAUDIO4_NOTIF_PAIR_PASSKEY   "PAIR_PASSKEY"
#define BTAUDIO4_NOTIF_PAIR_PENDING   "PAIR_PENDING"
#define BTAUDIO4_NOTIF_RECV   "RECV"
#define BTAUDIO4_NOTIF_SCO_OPEN   "SCO_OPEN"
#define BTAUDIO4_NOTIF_SCO_CLOSE   "SCO_CLOSE"
#define BTAUDIO4_RSP_OK   "OK"
 BT Audio 4 device response to commands.
#define BTAUDIO4_RSP_ERROR   "ERROR"
#define BTAUDIO4_RSP_READY   "Ready"
#define BTAUDIO4_TX_DRV_BUFFER_SIZE   150
 BT Audio 4 driver buffer size.
#define BTAUDIO4_RX_DRV_BUFFER_SIZE   1000
#define BTAUDIO4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  btaudio4_return_value_t { BTAUDIO4_OK = 0 , BTAUDIO4_ERROR = -1 , BTAUDIO4_ERROR_TIMEOUT = -2 , BTAUDIO4_ERROR_CMD = -3 }
 BT Audio 4 Click return value data. More...

Functions

void btaudio4_cfg_setup (btaudio4_cfg_t *cfg)
 BT Audio 4 configuration object setup function.
err_t btaudio4_init (btaudio4_t *ctx, btaudio4_cfg_t *cfg)
 BT Audio 4 initialization function.
err_t btaudio4_generic_write (btaudio4_t *ctx, uint8_t *data_in, uint16_t len)
 BT Audio 4 data writing function.
err_t btaudio4_generic_read (btaudio4_t *ctx, uint8_t *data_out, uint16_t len)
 BT Audio 4 data reading function.
void btaudio4_set_rst_pin (btaudio4_t *ctx, uint8_t state)
 BT Audio 4 set RST pin function.
void btaudio4_reset_device (btaudio4_t *ctx)
 BT Audio 4 reset device function.
void btaudio4_set_cts_pin (btaudio4_t *ctx, uint8_t state)
 BT Audio 4 set CTS pin function.
uint8_t btaudio4_get_rts_pin (btaudio4_t *ctx)
 BT Audio 4 get RTS pin function.
void btaudio4_cmd_run (btaudio4_t *ctx, uint8_t *cmd)
 BT Audio 4 cmd run function.
void btaudio4_cmd_set (btaudio4_t *ctx, uint8_t *param, uint8_t *value)
 BT Audio 4 cmd set function.
void btaudio4_cmd_get (btaudio4_t *ctx, uint8_t *param)
 BT Audio 4 cmd get function.

Detailed Description

This file contains API for BT Audio 4 Click Driver.

Enumeration Type Documentation

◆ btaudio4_return_value_t

BT Audio 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
BTAUDIO4_OK 
BTAUDIO4_ERROR 
BTAUDIO4_ERROR_TIMEOUT 
BTAUDIO4_ERROR_CMD