Application Controller Interface
This chapter introduces the functional specifications for the Application Controller interface (ACI), which provides a uniform command method for the Host to access Device capabilities and control connections with other Devices. The commands (Host -> Device) and events (Device -> Host) are sent between the Host and the Device.
Retransmission
To enhance the reliability of packet transmission and reception, a retransmission mechanism has been implemented on the Device side. When the Device sends an event (Excluding ACI_EVENT_ACK) to the Host, the Host shall respond with an ACI_CMD_ACK failure to do so will trigger retransmission, with the number of retries determined by the DT_RESEND_NUM
parameter. This feature is enabled by default in sdk\src\mcu\module\data_transfer\data_transfer.c
.
#define DT_RESEND_NUM 20
Similarly, when the Host sends a command (Excluding ACI_CMD_ACK) to the Device, the Device responds with an ACI_EVENT_ACK. If the ACI_EVENT_ACK is not received, the decision to trigger retransmission and the number of retransmissions are determined by the Host.
ACI Data Formats
The ACI Command packet is used to send commands to the Device from the Host. The ACI Event packet is used to send events to the Host from the Device. The format of the ACI Command and Event packet is shown below, and the definition of each field is explained below:

ACI Command and Event Packet Format
SyncWord: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xAA |
Sync word. |
SeqN: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Sequence number (Range: 1~255). |
Length: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX |
The total length of the opcode field and the Parameter field in octets (Range: 1~255). |
Opcode: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX |
Opcode of ACI Command and Events. |
Parameter 0 - N: (Size: Parameter_Total_Length)
Value |
Parameter Description |
---|---|
0xXX |
Each command or event has a specific number of parameters associated with it. These parameters and the size of each of the parameters are defined for each command or event. Each parameter is an integer number of octets in size. |
CheckSum: (Size: 1)
Value |
Parameter Description |
---|---|
0xXX |
The CheckSum is obtained by calculating through and the data between SeqN and Parameter N shall be involved in the operation. |
Note
In this packet model, it is recommended that the length of the Parameter does not exceed 1024 bytes.
uint8_t app_util_calc_checksum(uint8_t *dataPtr, uint16_t len)
{
uint8_t check_sum;
check_sum = 0;
while (len)
{
check_sum += *dataPtr;
dataPtr++;
len--;
}
return (0xff - check_sum + 1); //((~check_sum)+1);
}
Example: ACI_CMD_MMI
ACI Command data packet:
AA 04 04 00 04 00 00 54 A0
AA 04 04 00 04 00 00 54 A0
AA 04 04 00 04 00 00 54 A0
ACI Commands and Events
ACI Commands
Summary of ACI Commands
Opcode |
Command |
Available |
---|---|---|
0x0000 |
Y |
|
0x0002 |
Y |
|
0x0003 |
Y |
|
0x0004 |
Y |
|
0x0005 |
Y |
|
0x0006 |
Y |
|
0x0009 |
Y |
|
0x0012 |
Y |
|
0x0017 |
Y |
|
0x0018 |
Y |
|
0x001B |
Y |
|
0x001C |
Y |
|
0x001E |
Y |
|
0x001F |
Y |
|
0x0020 |
Y |
|
0x0022 |
Y |
|
0x0030 |
Y |
|
0x0040 |
Y |
|
0x0102 |
Y |
|
0x0103 |
Y |
|
0x0104 |
Y |
|
0x0109 |
Y |
|
0x010E |
Y |
|
0x0111 |
Y |
|
0x0112 |
Y |
|
0x0113 |
Y |
|
0x0115 |
Y |
|
0x0116 |
Y |
|
0x0161 |
Y |
|
0x0162 |
Y |
|
0x0163 |
Y |
|
0x0164 |
Y |
|
0x020A |
Y |
|
0x0308 |
Y |
|
0x0309 |
Y |
|
0x030F |
Y |
|
0x0310 |
Y |
|
0x0400 |
Y |
|
0x0403 |
Y |
|
0x0404 |
Y |
|
0x0480 |
Y |
|
0x0481 |
Y |
|
0x0482 |
Y |
|
0x0483 |
Y |
|
0x0484 |
Y |
|
0x0488 |
Y |
|
0x0489 |
Y |
|
0x0420 |
Y |
|
0x0423 |
Y |
|
0x0426 |
Y |
|
0x0A0E |
Y |
|
0x2300 |
Y |
|
0x2400 |
Y |
|
0x3200 |
Y |
|
0x3201 |
Y |
|
0x3220 |
Y |
|
0x3223 |
Y |
|
0x3020 |
Y |
|
0x3021 |
Y |
|
0x3022 |
Y |
|
0x3023 |
Y |
|
0x3024 |
Y |
|
0x3025 |
Y |
|
0x3026 |
Y |
|
0x3027 |
Y |
|
0x3028 |
Y |
|
0x3029 |
Y |
|
0x302A |
Y |
|
0x302B |
Y |
|
0x302C |
Y |
|
0x302D |
Y |
|
0x302E |
Y |
|
0x302F |
Y |
|
0x3030 |
Y |
|
0x3031 |
Y |
|
0x3032 |
Y |
|
0x3033 |
Y |
|
0x3034 |
Y |
|
0x3250 |
Y |
|
0x3251 |
Y |
|
0x3252 |
Y |
|
0x3253 |
Y |
|
0x3254 |
Y |
|
0x3255 |
Y |
|
0x3256 |
Y |
|
0x3270 |
Y |
|
0x3300 |
Y |
|
0x3301 |
Y |
|
0x3302 |
Y |
|
0x3303 |
Y |
|
0x3304 |
Y |
|
0x3305 |
Y |
|
0x3306 |
Y |
|
0x3307 |
Y |
|
0x3312 |
Y |
|
0x3313 |
Y |
|
0x3801 |
Y |
|
0x3802 |
Y |
|
0x3803 |
Y |
|
0x3805 |
Y |
|
0x3809 |
Y |
|
0x380A |
Y |
|
0x3810 |
Y |
|
0x5008 |
N |
|
0x5009 |
N |
|
0x8000 |
Y |
|
0x8001 |
Y |
|
0x8004 |
Y |
|
0x8005 |
Y |
|
0x8006 |
Y |
|
0x8007 |
Y |
|
0x8009 |
Y |
|
0x80C3 |
Y |
|
0x8013 |
Y |
|
0x8040 |
Y |
|
0x8041 |
Y |
|
0x8042 |
Y |
|
0x8043 |
Y |
|
0x8044 |
Y |
|
0x8045 |
Y |
|
0x8046 |
Y |
|
0x8047 |
Y |
|
0x8048 |
Y |
|
0x8049 |
Y |
|
0x804A |
Y |
|
0x804B |
Y |
|
0x804C |
Y |
|
0x8080 |
Y |
|
0x8081 |
Y |
|
0x8082 |
Y |
|
0x8083 |
Y |
|
0x8084 |
Y |
|
0x8085 |
Y |
|
0x8086 |
Y |
|
0x8088 |
Y |
|
0x8089 |
Y |
|
0x808A |
Y |
|
0x80C0 |
Y |
|
0x8100 |
Y |
ACI_CMD_ACK
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_ACK |
0x0000 |
event_id, status |
None |
Description
This command is used for the Host to acknowledge the received event.
Command Parameters
event_id: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX |
The acknowledged event_id. |
status: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Command complete: MCU can handle this command. |
0x01 |
Command disallow: MCU cannot handle this command. |
0x02 |
Unknown CMD. |
0x03 |
Parameters error. |
0x04 |
Busy. |
0x05 |
Process fail. |
0x06 |
One wire extend. |
0x08 |
Music req. |
ACI_CMD_BT_CREATE_CONNECTION
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_BT_CREATE_CONNECTION |
0x0002 |
profile, bd_addr |
Description
This command is used to trigger the linkback behavior for specific profiles.
Command Parameters
profile: (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
Bit mask (only used for Bluetooth Audio Transceiver function). 0x00000001: A2DP_SINK. 0x00000002: AVRCP_CONTROLLER. 0x00000004: HFP_HF. 0x00000080: HSP_AG. 0x00000200: MAP_MSE. 0x00000400: A2DP_SRC. 0x00000800: AVRCP_TARGET. 0x00001000: HFP_AG. 0x00002000: PBAP_PSE. 0x00004000: HSP_HF. |
bd_addr: (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
MAC address (Little-Endian) of the dedicated device. |
ACI_CMD_BT_DISCONNECT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_BT_DISCONNECT |
0x0003 |
profile, bd_addr |
Description
This command is used to cancel the ongoing linkback procedure or disconnect the linked profiles. BTM will disconnect the ACL link if all of the profiles are disconnected.
Command Parameters
profile: (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
Bit mask (only used for Bluetooth Audio Transceiver function). 0x00000001: A2DP_SINK. 0x00000002: AVRCP_CONTROLLER. 0x00000004: HFP_HF. 0x00000080: HSP_AG. 0x00000200: MAP_MSE. 0x00000400: A2DP_SRC. 0x00000800: AVRCP_TARGET. 0x00001000: HFP_AG. 0x00002000: PBAP_PSE. 0x00004000: HSP_HF. 0xffffffff: All profile. |
bd_addr: (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXX |
MAC address (Little-Endian) of the target device. |
ACI_CMD_MMI
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_MMI |
0x0004 |
reserved, action |
None |
Description
MMI action, the user can add the corresponding MMI action according to specific needs based on sdk\src\sample\bt_audio_trx\app\app_mmi.h
.
Command Parameters
reserved: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Reserved. |
action: (Size: 1 octet)
Value |
Parameter Description |
Return Event |
---|---|---|
0x02 |
MMI_FORCE_END_OUTGOING_CALL |
|
0x03 |
MMI_ANSWER_CALL |
|
0x04 |
MMI_REJECT_CALL |
|
0x05 |
MMI_END_ACTIVE_CALL |
None |
0x0E |
MMI_QUERY_CURRENT_CALL_LIST |
None |
0x32 |
MMI_AV_PLAY_PAUSE |
None |
0x54 |
MMI_DEV_POWER_ON |
|
0x56 |
MMI_DEV_POWER_OFF |
|
0x58 |
MMI_DEV_FACTORY_RESET_TO_DEFAULT |
|
0xA1 |
MMI_DUT_TEST_MODE |
None |
0xBB |
MMI_DULT_ENTER_ID_READ_STATE |
None |
Command Detail:
MMI_FORCE_END_OUTGOING_CALL
: End call without checking SCO status.MMI_ANSWER_CALL
: Answer an incoming call.MMI_REJECT_CALL
: Reject an incoming call.MMI_END_ACTIVE_CALL
: Add SCO if SCO doesn’t exist, otherwise end the call.MMI_QUERY_CURRENT_CALL_LIST
: Query call list.MMI_AV_PLAY_PAUSE
: Play or pause the audio stream.MMI_DEV_POWER_ON
: Change the device to power on state.MMI_DEV_POWER_OFF
: Change the device to power off state.MMI_DEV_FACTORY_RESET_TO_DEFAULT
: Reset the device to factory settings.MMI_DUT_TEST_MODE
: Enter device test mode.MMI_DULT_ENTER_ID_READ_STATE
: Make the device enter ID read state.
ACI_CMD_LEGACY_DATA_TRANSFER
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEGACY_DATA_TRANSFER |
0x0005 |
link_id, type, total_length, payload_length, payload |
None |
Description
This command is used to send to SPP.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Link index, which will be informed when the link is established (ACI_EVENT_PROFILE_CONN_STATUS). |
type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Single packet. |
0x01 |
Fragmented start packet. |
0x02 |
Fragmented continue packet. |
0x03 |
Fragmented end packet. |
total_length: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Total payload length. |
payload_length: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Payload length in this packet. |
payload: (Size: N octets)
Value |
Parameter Description |
---|---|
payload |
N octets of the payload in this packet. |
ACI_CMD_ASSIGN_BUFFER_SIZE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_ASSIGN_BUFFER_SIZE |
0x0006 |
rx_buffer_size |
None |
Description
Host indicates to the Device about the max UART RX buffer size. The default value is 256 Bytes.
Command Parameters
rx_buffer_size: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The max UART RX buffer size of Host MCU. |
ACI_CMD_BT_GET_REMOTE_NAME
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_BT_GET_REMOTE_NAME |
0x0435 |
bd_addr |
None |
Description
Get the remote device name.
Command Parameters
bd_addr: (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXX |
The remote device Bluetooth address. |
ACI_CMD_SET_CFG
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SET_CFG |
0x0012 |
cfg_type, cfg_data |
None |
Description
Set device’s LE/legacy name.
Command Parameters
cfg_type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Set the LE display name. |
0x01 |
Set the BR/EDR display name. |
cfg_data: (Size: N octets)
Value |
Parameter Description |
---|---|
Name_length |
Must be less than 39. |
Name |
Name with length. |
ACI_CMD_GET_CFG_SETTING
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_GET_CFG_SETTING |
0x0017 |
get_type |
Description
Get config setting of device’s LE/legacy name.
Command Parameters
get_type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GET_CFG_LE_NAME |
0x01 |
GET_CFG_LEGACY_NAME |
ACI_CMD_GET_STATUS
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_GET_STATUS |
0x0018 |
status_index |
Description
Report some status information.
Command Parameters
status_index: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x02 |
Report device battery. |
0x04 |
Report application state. |
0x0F |
Report factory reset status. |
0x10 |
Report reject connect request status. |
0x11 |
Report radio mode. |
0x12 |
Report SCO status. |
0x13 |
Report MIC mute status. |
0xA1 |
Report device volume. |
ACI_CMD_BT_HFP_DIAL_WITH_NUMBER
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_BT_HFP_DIAL_WITH_NUMBER |
0x001B |
dial_num_payload |
None |
Description
Dial out with number to outgoing call.
Command Parameters
dial_num_payload: (Size: 25 octets)
Value |
Parameter Description |
---|---|
25 octets |
The number is in ASCII format. |
ACI_CMD_GET_BD_ADDR
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_GET_BD_ADDR |
0x001C |
None |
Description
Get Bluetooth device address.
Command Parameters
None.
ACI_CMD_STRING_MODE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_STRING_MODE |
0x001E |
None |
None |
Description
This command is used to set string mode.
Command Parameters
None.
ACI_CMD_SET_VP_VOLUME
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SET_VP_VOLUME |
0x001F |
VP volume |
None |
Description
This command is used to set voice prompt volume.
Command Parameters
VP volume: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 ~ 0x0F |
VP volume level. |
ACI_CMD_SET_AND_READ_DLPS
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SET_AND_READ_DLPS |
0x0020 |
action |
Description
Enable/disable device auto-enter DLPS.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Disable auto enter DLPS. |
0x01 |
Enable auto enter DLPS. |
ACI_CMD_XM_SET_MODE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_SET_MODE |
0x0030 |
mode |
None |
Description
Set device mode.
Command Parameters
mode: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Disable page scan and inquiry scan. |
0x01 |
Enable inquiry scan. |
0x02 |
Enable page scan. |
0x03 |
Enable page scan and inquiry scan. |
ACI_CMD_BT_HFP_SCO_MAG
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_BT_HFP_SCO_MAG |
0x0040 |
link_id, cfm |
None |
Description
SCO connection management.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Link index, this index will be informed when the link established (event: ACI_EVENT_PROFILE_CONN_STATUS). |
cfm: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Reject the SCO connection indication. |
0x01 |
Accept the SCO connection indication. |
0x02 |
Send a request to disconnect the SCO connection. |
ACI_CMD_LE_DATA_TRANSFER
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LE_DATA_TRANSFER |
0x0102 |
link_id, type, total_length, payload_length, payload |
None |
Description
This command is used to send the data to remote devices via the LE link.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Single packet. |
0x01 |
Fragmented start packet. |
0x02 |
Fragmented continue packet. |
0x03 |
Fragmented end packet. |
total_length: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Total payload length. |
payload_length: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Payload length in this packet. |
payload: (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
payload in this packet. |
ACI_CMD_LE_START_SCAN
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LE_START_SCAN |
0x0103 |
local_addr_type, phys, filter_policy, filter_duplicates, scan_type of 1M PHY, scan_interval of 1M PHY, scan_window of 1M PHY, scan_type of Coded PHY, scan_interval of Coded PHY, scan_window of Coded PHY |
None |
Description
Start LE scan.
Command Parameters
local_addr_type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_LOCAL_ADDR_LE_PUBLIC |
0x01 |
GAP_LOCAL_ADDR_LE_RANDOM |
0x02 |
GAP_LOCAL_ADDR_LE_RPA_OR_PUBLIC |
0x03 |
GAP_LOCAL_ADDR_LE_RPA_OR_RAND |
phys: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
GAP_EXT_SCAN_PHYS_1M_BIT |
0x04 |
GAP_EXT_SCAN_PHYS_CODED_BIT |
0x05 |
GAP_EXT_SCAN_PHYS_ALL |
filter_policy: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_SCAN_FILTER_ANY |
0x01 |
GAP_SCAN_FILTER_WHITE_LIST |
0x02 |
GAP_SCAN_FILTER_ANY_RPA |
0x03 |
GAP_SCAN_FILTER_WHITE_LIST_RPA |
ext_filter_duplicate: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_SCAN_FILTER_DUPLICATE_DISABLE |
0x01 |
GAP_SCAN_FILTER_DUPLICATE_ENABLE |
0x02 |
GAP_SCAN_FILTER_DUPLICATE_ENABLED_RESET_FOR_EACH_PERIOD |
scan_type of 1M PHY: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_SCAN_MODE_PASSIVE |
0x01 |
GAP_SCAN_MODE_ACTIVE |
scan_interval of 1M PHY: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
In units of 0.625ms, range: 0x0004 to 0xFFFF. |
scan_window of 1M PHY: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
In units of 0.625ms, range: 0x0004 to 0xFFFF. |
scan_type of Coded PHY: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_SCAN_MODE_PASSIVE |
0x01 |
GAP_SCAN_MODE_ACTIVE |
scan_interval of Coded PHY: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
In units of 0.625ms, range: 0x0004 to 0xFFFF. |
scan_window of Coded PHY: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
In units of 0.625ms, range: 0x0004 to 0xFFFF. |
ACI_CMD_LE_STOP_SCAN
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LE_STOP_SCAN |
0x0104 |
None |
None |
Description
Stop LE scan.
Command Parameters
None.
ACI_CMD_LE_START_PAIR
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LE_START_PAIR |
0x0109 |
link_id |
None |
Description
This command is used to pair a connected device.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
ACI_CMD_LE_CREATE_CONN
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LE_CREATE_CONN |
0x010E |
init_phys, remote_bd_type, remote_bd[6], local_bd_type, scan_timeout |
None |
Description
This command is used to initiate connection to a specific device.
Command Parameters
init_phys: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Bit0: 1M PHY. Bit1: 2M PHY. Bit2: Codec PHY. |
remote_bd_type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_REMOTE_ADDR_LE_PUBLIC |
0x01 |
GAP_REMOTE_ADDR_LE_RANDOM |
0x02 |
GAP_REMOTE_ADDR_LE_PUBLIC_IDENTITY |
0x03 |
GAP_REMOTE_ADDR_LE_RANDOM_IDENTITY |
0x10 |
GAP_REMOTE_ADDR_CLASSIC |
0xff |
GAP_REMOTE_ADDR_LE_ANONYMOUS |
remote_bd: (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
The address of device intended to connect. |
local_bd_type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_LOCAL_ADDR_LE_PUBLIC |
0x01 |
GAP_LOCAL_ADDR_LE_RANDOM |
0x02 |
GAP_LOCAL_ADDR_LE_RAP_OR_PUBLIC |
0x03 |
GAP_LOCAL_ADDR_LE_RAP_OR_RAND |
scan_timeout: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Scan timer in units of 10ms. |
ACI_CMD_ANCS_GET_NOTIFICATION_ATTR
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_ANCS_GET_NOTIFICATION_ATTR |
0x0111 |
link_id, notification_uid, attribute_ids_len, attribute_id |
Description
This command is used to get the notification attribute.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
notification_uid: (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
notification_uid |
attribute_ids_len: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
attribute_ids_len |
attribute_ids: (Size: attribute_ids_len octets)
Value |
Parameter Description |
---|---|
0xXX, … |
attribute_ids |
ACI_CMD_ANCS_GET_APP_ATTR
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_ANCS_GET_APP_ATTR |
0x0112 |
link_id, app_identifier_len, app_identifier, attribute_ids_len, attribute_id |
Description
This command is used to get the APP attribute.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
app_identifier_len: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
app_identifier_len |
app_identifier: (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
app_identifier |
attribute_ids_len: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
attribute_ids_len |
attribute_ids: (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
attribute_ids |
ACI_CMD_ANCS_PERFORM_NOTIFICATION_ACTION
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_ANCS_PERFORM_NOTIFICATION_ACTION |
0x0113 |
link_id, notification_uid, action_id |
Description
This command is used to perform the notification action.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
notification_uid: (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
notification_uid |
action_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
action_id |
ACI_CMD_AMS_WRITE_REMOTE_CMD
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_AMS_WRITE_REMOTE_CMD |
0x0115 |
link_id, cmd_id |
None |
Description
This command is used to send remote CMD to iOS media APP.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
cmd_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
RemoteCommandID_Play |
0x01 |
RemoteCommandID_Pause |
0x02 |
RemoteCommandID_TogglePlayPause |
0x03 |
RemoteCommandID_NextTrack |
0x04 |
RemoteCommandID_PreviousTrack |
0x05 |
RemoteCommandID_VolumeUp |
0x06 |
RemoteCommandID_VolumeDown |
0x07 |
RemoteCommandID_AdvanceRepeatMode |
0x08 |
RemoteCommandID_AdvanceShuffleMode |
0x09 |
RemoteCommandID_SkipForward |
0x0A |
RemoteCommandID_SkipBackward |
0x0B |
RemoteCommandID_LikeTrack |
0x0C |
RemoteCommandID_DislikeTrack |
0x0D |
RemoteCommandID_BookmarkTrack |
Others |
Reserved. |
ACI_CMD_AMS_WRITE_ENTITY_UPD_CMD
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_AMS_WRITE_ENTITY_UPD_CMD |
0x0116 |
link_id, value_len, value |
None |
Description
This command is used to send entity update CMD to iOS media APP.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
value_len: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Value_len |
value: (Size: value_len octets)
Value |
Parameter Description |
---|---|
0xXX, … |
Value |
ACI_CMD_LE_MODIFY_WHITELIST
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LE_MODIFY_WHITELIST |
0x0161 |
operation, address, address_type |
None |
Description
This command is used to modify the white list.
Command Parameters
operation: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Clear white list. |
0x01 |
Add a device to the white list. |
0x02 |
Remove a device from the white list. |
address (Needless for clear white list): (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Address |
address_type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_REMOTE_ADDR_LE_PUBLIC |
0x01 |
GAP_REMOTE_ADDR_LE_RANDOM |
0x02 |
GAP_REMOTE_ADDR_LE_PUBLIC_IDENTITY |
0x03 |
GAP_REMOTE_ADDR_LE_RANDOM_IDENTITY |
0x10 |
GAP_REMOTE_ADDR_CLASSIC |
0xff |
GAP_REMOTE_ADDR_LE_ANONYMOUS |
ACI_CMD_LE_MODIFY_WHITELIST_BY_IDX
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LE_MODIFY_WHITELIST_BY_IDX |
0x0162 |
operation, bond_idx |
None |
Description
This command is used to modify white list by bond index.
Command Parameters
operation: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Clear white list. |
0x01 |
Add a device to white list. |
0x02 |
Remove a device from white list. |
bond_idx (Needless for clear white list): (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Operate target device in the bond list by priority. |
ACI_CMD_LE_MODIFY_RESOLVELIST_BY_IDX
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LE_MODIFY_RESOLVELIST_BY_IDX |
0x0163 |
operation, bond_idx |
None |
Description
This command is used to modify the resolving list by bond index.
Command Parameters
operation: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Clear resolving list. |
0x01 |
Add a device to the resolving list. |
0x02 |
Remove a device from the resolving list. |
bond_idx (Needless for clear resolving list): (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Operate target device in the bond list by priority. |
ACI_CMD_LE_SET_RESOLUTION
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LE_SET_RESOLUTION |
0x0164 |
target_state |
None |
Description
This command is used to enable/disable resolution.
Command Parameters
target_state: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Disable resolution. |
0x01 |
Enable resolution. |
ACI_CMD_SET_VOLUME
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SET_VOLUME |
0x020A |
volume level |
Description
Set playback or voice volume depending on the scenario.
Command Parameters
volume level: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
0~maximum (Volume level). |
ACI_CMD_GET_FW_VERSION
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_GET_FW_VERSION |
0x0308 |
type |
Description
Get the firmware version.
Command Parameters
type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Get FW version. |
ACI_CMD_BT_BOND_INFO_CLEAR
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_BT_BOND_INFO_CLEAR |
0x0309 |
link_type, bd_addr |
Description
Clear the device’s link key of the target remote connection according to bd_addr.
Command Parameters
link_type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Clear BR/EDR bond info. |
Others |
Reserved. |
bd_addr: (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
MAC address of target device. |
ACI_CMD_GET_PACKAGE_ID
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_GET_PACKAGE_ID |
0x030F |
None |
Description
Get chip ID and package ID.
Command Parameters
None.
ACI_CMD_SWITCH_TO_HCI_DOWNLOAD_MODE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SWITCH_TO_HCI_DOWNLOAD_MODE |
0x0310 |
None |
None |
Description
This command is used to enter HCI download mode and then reset.
Command Parameters
None.
ACI_CMD_INQUIRY
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_INQUIRY |
0x0321 |
action, timeout |
Description
This request searches the neighbor’s Bluetooth devices.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Start inquiry. |
0x01 |
Stop inquiry. |
timeout: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 ~ 0x30 |
The maximum amount of time before the inquiry is halted. Time = N * 1.28 sec. Range: 1.28 - 61.44 sec. |
ACI_CMD_SEND_DTMF
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SEND_DTMF(abandon) |
0x0400 |
number |
None |
Description
Send DTMF.
Command Parameters
number: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
The DTMF character must be one from the set 0-9, A-D, #, *. For example, if the character is 3, the parameter number should be set to 0x33. |
ACI_CMD_SEND_VGM
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SEND_VGM |
0x0403 |
level |
None |
Description
Send VGM.
Command Parameters
level: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
VGM value, range: 0 ~ 15. |
ACI_CMD_SEND_VGS
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SEND_VGS |
0x0404 |
level |
None |
Description
Send VGS.
Command Parameters
level: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
VGS value, range: 0 ~ 15. |
ACI_CMD_HFP_AG_CONNECT_SCO
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_HFP_AG_CONNECT_SCO |
0x0480 |
link_id |
None |
Description
HFP: AG connects SCO.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Link ID. |
ACI_CMD_HFP_AG_DISCONNECT_SCO
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_HFP_AG_DISCONNECT_SCO |
0x0481 |
link_id |
None |
Description
HFP AG disconnects SCO.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Link ID. |
ACI_CMD_HFP_AG_CALL_INCOMING
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_HFP_AG_CALL_INCOMING |
0x0482 |
link_id |
None |
Description
Notify the incoming call.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Link ID. |
ACI_CMD_HFP_AG_CALL_ANSWER
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_HFP_AG_CALL_ANSWER |
0x0483 |
link_id |
None |
Description
Answer the incoming call.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Link ID. |
ACI_CMD_HFP_AG_CALL_TERMINATE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_HFP_AG_CALL_TERMINATE |
0x0484 |
link_id |
None |
Description
Terminate the call.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Link ID. |
ACI_CMD_HFP_AG_MIC_GAIN_LEVEL_SET
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_HFP_AG_MIC_GAIN_LEVEL_SET |
0x0488 |
link_id, action |
None |
Description
Mute or unmute the MIC.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Link ID. |
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
MIC_MUTE |
0x0A |
MIC_UNMUTE |
ACI_CMD_HFP_AG_SPEAKER_GAIN_LEVEL_SET
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_HFP_AG_SPEAKER_GAIN_LEVEL_SET |
0x0489 |
link_id, action |
None |
Description
Turn the SPK volume up or down.
Command Parameters
link_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Link ID. |
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
SPK_VOL_UP |
0x00 |
SPK_VOL_DOWN |
ACI_CMD_PBAP_DOWNLOAD
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_PBAP_DOWNLOAD |
0x0420 |
method |
None |
Description
PBAP download.
Command Parameters
method: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x03 ~ 0x05 |
PBAP download method, range:
|
ACI_CMD_PBAP_CONNECT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_PBAP_CONNECT |
0x0423 |
None |
None |
Description
PBAP connect.
Command Parameters
None.
ACI_CMD_PBAP_DISCONNECT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_PBAP_DISCONNECT |
0x0426 |
None |
None |
Description
PBAP disconnect.
Command Parameters
None.
ACI_CMD_TRI_DONGLE_CMD
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_TRI_DONGLE_CMD |
0x0A0E |
sub_command_id, sub_command_parameters |
Description
Command Tri dongle legacy & LE operation.
Command Parameters
sub_command_id: (Size: 1 octet)
Value |
Parameter Description |
Return Event |
---|---|---|
0x00 |
Command Tri dongle start LE scan. |
|
0x01 |
Command Tri dongle stop LE scan. |
None |
0x02 |
Command Tri dongle start BR inquiry scan. |
|
0x03 |
Command Tri dongle stop BR inquiry scan. |
None |
0x04 |
Command Tri dongle connect to target LE device. |
None |
0x05 |
Command Tri dongle disconnect to target LE device. |
None |
0x06 |
Command Tri dongle connect to target BR device. |
None |
0x07 |
Command Tri dongle disconnect to target BR device. |
None |
0x08 |
Command Tri dongle report connected LE device info. |
|
0x09 |
Command Tri dongle report connected BR device info. |
|
0x0A |
Command Tri dongle clear all bond info. |
None |
0x0B |
Command Tri dongle clear to target LE device. |
None |
0x0C |
Command Tri dongle clear to target BR device. |
None |
0x0D |
Command Tri dongle get passkey support info. |
None |
0x0E |
Command Tri dongle BAS request to target LE device. |
None |
0x0F |
Command Tri dongle DIS one UUID request to target LE device. |
None |
0x10 |
Command Tri dongle LE RSSI to target LE device. |
None |
0x11 |
Command Tri dongle BR RSSI to target LE device. |
None |
0x12 |
Command Tri dongle LE scan status. |
None |
0x13 |
Command Tri dongle BR inquiry scan status. |
None |
0x14 |
Command Tri dongle LE bondlist info. |
None |
0x15 |
Command Tri dongle DIS all UUID request to target LE device. |
None |
0x16 |
Command Tri dongle BR bondlist info. |
None |
Only the following sub command IDs are required to fill sub command parameters:
0x02 (Command Tri dongle start BR inquiry scan).
0x04 (Command Tri dongle connect to target LE device).
0x05 (Command Tri dongle disconnect to target LE device).
0x06 (Command Tri dongle connect to target BR device).
0x07 (Command Tri dongle disconnect to target BR device).
0x0B (Command Tri dongle clear to target LE device).
0x0C (Command Tri dongle clear to target BR device).
0x0E (Command Tri dongle BAS request to target LE device).
0x0F (Command Tri dongle DIS one UUID request to target LE device).
0x10 (Command Tri dongle LE RSSI to target LE device).
0x11 (Command Tri dongle BR RSSI to target LE device).
0x15 (Command Tri dongle DIS all UUID request to target LE device).
sub_command_parameters: (Size: 49 octets)
Sub Command ID |
Required Sub Command Parameter |
---|---|
0x02 |
continuous (1 octet, 0 = Disable, 1 = Enable) |
0x04 |
bd_addr (6 octets, Little-Endian), le_addr_type(1 octet), LE name length (1 octet), LE name (length correspond to LE name length) |
0x05 |
bd_addr (6 octets, Little-Endian) |
0x06 |
bd_addr (6 octets, Little-Endian) |
0x07 |
bd_addr (6 octets, Little-Endian) |
0x0B |
bd_addr (6 octets, Little-Endian) |
0x0C |
bd_addr (6 octets, Little-Endian) |
0x0E |
bd_addr (6 octets, Little-Endian) |
0x0F |
UUID (2 octets, Little-Endian), bd_addr (6 octets, Little-Endian) |
0x10 |
bd_addr (6 octets, Little-Endian) |
0x11 |
bd_addr (6 octets, Little-Endian) |
0x15 |
bd_addr (6 octets, Little-Endian) |
ACI_CMD_FINDMY_FEATURE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_FINDMY_FEATURE |
0x2300 |
action |
None |
Description
Find My action.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
ENTER_PAIRING |
0x01 |
MMI_PUT_SERIAL_NUMBER |
Command Detail
ENTER_PAIRING
: Enter Find My pairing mode.MMI_PUT_SERIAL_NUMBER
: Put the state of the serial number.
ACI_CMD_GFPS_FINDER_FEATURE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_GFPS_FINDER_FEATURE |
0x2400 |
action |
None |
Description
GFPS finder action.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GFPS_FINDER_INVALID_ACTION |
0x01 |
GFPS_FINDER_STOP_RING |
Command Detail
GFPS_FINDER_STOP_RING
: Stop ring.
ACI_CMD_SPI_INIT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SPI_INIT |
0x3200 |
role |
None |
Description
SPI role initialization.
Command Parameters
role: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
SPI_ROLE_MASTER |
0x01 |
SPI_ROLE_SLAVE |
ACI_CMD_SPI_SLAVE_TRIGGER
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SPI_SLAVE_TRIGGER |
0x3201 |
None |
None |
Description
Trigger SPI transmission by the slave. This command is for the test.
Command Parameters
None.
ACI_CMD_A2DP_XMIT_SET_ROUTE_OUT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
CMD_A2DP_XMIT_SET_ROUTE_OUT |
0x3223 |
route_path |
None |
Description
Set transparent transmission music (From SPI) output route.
Command Parameters
route_path: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
XMIT_PLAY_ROUTE_A2DP_SRC |
0x01 |
XMIT_PLAY_ROUTE_BIS |
ACI_CMD_A2DP_XMIT_ROUTE_OUT_CTRL
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_A2DP_XMIT_ROUTE_OUT_CTRL |
0x3220 |
type |
None |
Description
Enable playing transparent transmission music by A2DP Source or BIS music (From SPI).
Command Parameters
type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
XMIT_PLAY_STATE_START |
0x01 |
XMIT_PLAY_STATE_IDLE |
ACI_CMD_LEA_BSRC_INIT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_BSRC_INIT |
0x3020 |
codec_type, bis_num, encryption |
None |
Description
Broadcast initialization.
Command Parameters
codec_type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x0D |
CODEC_CFG_ITEM_48_4 |
0x03 |
CODEC_CFG_ITEM_16_2 |
bis_num: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
bis_num = 1. |
0x02 |
bis_num = 2. |
encryption: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
False. |
0x01 |
True. |
ull_mode: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
False. |
0x01 |
True. |
pd: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Presentation delay (Effective when ull_mode is enabled). |
ACI_CMD_LEA_BSRC_START
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_BSRC_START |
0x3021 |
None |
None |
Description
Start broadcasting.
Command Parameters
None.
ACI_CMD_LEA_BSRC_STOP
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_BSRC_STOP |
0x3022 |
stop_option |
None |
Description
Stop broadcasting.
Command Parameters
release: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Do not delete BIS configuration. |
0x01 |
Delete BIS configuration. |
ACI_CMD_LEA_SCAN
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_SCAN |
0x3023 |
action |
None |
Description
Start or stop scanning devices supporting LE Audio.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Start scanning. |
0x01 |
Stop scanning. |
ACI_CMD_LEA_CIS_START_MEDIA
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_CIS_START_MEDIA |
0x3024 |
group_idx |
None |
Description
Start CIS music.
Command Parameters
group_idx: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
start_group_idx_0: Start CIS media on group 0. |
0x01 |
start_group_idx_1: Start CIS media on group 1. |
ACI_CMD_LEA_CIS_STOP_STREAM
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_CIS_STOP_STREAM |
0x3025 |
group_idx and action |
None |
Description
Stop CIS streaming.
Command Parameters
group_idx and action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
stop_group_idx_0: Stop CIS media on group 0. |
0x01 |
release_group_idx_0: Stop CIS media on group 0 and release CIS. |
0x02 |
stop_group_idx_1: Stop CIS media on group 1. |
0x03 |
release_group_idx_1: Stop CIS media on group 1 and release CIS. |
ACI_CMD_LEA_CIS_ULL_MODE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_CIS_ULL_MODE |
0x3026 |
action |
None |
Description
Enable/Disable CIS media Ultra Low Latency mode. Please use this command before starting CIS media.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Disable CIS ULL. |
0x01 |
Enable CIS ULL. |
ACI_CMD_LEA_CSIS_MEMBER_SCAN
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_CSIS_MEMBER_SCAN |
0x3027 |
group_idx |
None |
Description
Scan devices belonging to the same group.
Command Parameters
group_idx: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
group_idx_0 |
0x01 |
group_idx_1 |
ACI_CMD_LEA_CSIS_GROUP_SCAN_STOP
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_CSIS_GROUP_SCAN_STOP |
0x3028 |
None |
None |
Description
Stop scanning devices that belong to the same group.
Command Parameters
None.
ACI_CMD_LEA_BST_START
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_BST_START |
0x3029 |
action |
None |
Description
Broadcast audio reception start procedure.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
group_0_sync_0: Start broadcast on group 0 and sync 0. |
0x01 |
group_0_sync_1: Start broadcast on group 0 and sync 1. |
0x02 |
group_1_sync_0: Start broadcast on group 1 and sync 0. |
0x03 |
group_1_sync_1: Start broadcast on group 1 and sync 1. |
ACI_CMD_LEA_BST_STOP
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_BST_STOP |
0x302A |
action |
None |
Description
Broadcast audio reception stop procedure.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
group_0_sync_0: Stop broadcast on group 0 and sync 0. |
0x01 |
group_0_sync_1: Stop broadcast on group 0 and sync 1. |
0x02 |
group_1_sync_0: Stop broadcast on group 1 and sync 0. |
0x03 |
group_1_sync_1: Stop broadcast on group 1 and sync 1. |
ACI_CMD_LEA_BST_REMOVE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_BST_REMOVE |
0x302B |
action |
None |
Description
Broadcast audio reception removal procedure.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
group_0_sync_0: Remove broadcast on group 0 and sync 0. |
0x01 |
group_0_sync_1: Remove broadcast on group 0 and sync 1. |
0x02 |
group_1_sync_0: Remove broadcast on group 1 and sync 0. |
0x03 |
group_1_sync_1: Remove broadcast on group 1 and sync 1. |
ACI_CMD_LEA_GVCS_VOLUME
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_GVCS_VOLUME |
0x302C |
group_idx, volume |
None |
Description
Set VCS volume.
Command Parameters
group_idx: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Group handle index. |
volume: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Set VCS volume to 0xXX. |
ACI_CMD_LEA_GVCS_MUTE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_GVCS_MUTE |
0x302D |
group_idx, mute_state |
None |
Description
Set VCP mute state.
Command Parameters
group_idx: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Group handle index. |
mute_state: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Set unmute. |
0x01 |
Set mute. |
ACI_CMD_LEA_GMIC_MUTE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_GMIC_MUTE |
0x302E |
group_idx, mute_state |
None |
Description
Set GMIC MIC mute state.
Command Parameters
group_idx: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Group handle index. |
mute_state: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Set MIC unmute. |
0x01 |
Set MIC mute. |
ACI_CMD_LEA_BAAS_SCAN
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_BAAS_SCAN |
0x302F |
None |
None |
Description
Start extended scan for BAAS.
Command Parameters
None.
ACI_CMD_LEA_PA_SYNC_DEV
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_PA_SYNC_DEV |
0x3030 |
dev_idx |
None |
Description
PA sync by device index.
Command Parameters
dev_idx: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Dev0: PA sync with device 0. |
0x01 |
Dev1: PA sync with device 1. |
0x02 |
Dev2: PA sync with device 2. |
ACI_CMD_LEA_CIS_START_CONVERSATION
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_CIS_START_CONVERSATION |
0x3031 |
group_idx |
None |
Description
Start CIS conversation.
Command Parameters
group_idx: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Start CIS media on group 0. |
0x01 |
Start CIS media on group 1. |
ACI_CMD_LEA_CCP_ACTION
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_CCP_ACTION |
0x3032 |
call_action, call_index |
None |
Description
CCP control action.
Command Parameters
call_action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x05 |
Incoming call action. |
0x12 |
Local terminate. |
0x14 |
Local accept. |
call_index: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Call index. |
ACI_CMD_LEA_MCP_STATE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_MCP_STATE |
0x3033 |
media_state |
None |
Description
Update MCP state.
Command Parameters
media_state: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
The media player starts playing the current track. |
0x02 |
The media player paused the current track. |
ACI_CMD_LEA_MCP_NOTIFY
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_MCP_NOTIFY |
0x3034 |
mcs_uuid, param |
None |
Description
Set MCP Notification.
Command Parameters
mcs_uuid: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0x2B96 |
MCS_UUID_CHAR_TRACK_CHANGED |
0x2B98 |
MCS_UUID_CHAR_TRACK_DURATION |
0x2B99 |
MCS_UUID_CHAR_TRACK_POSITION |
param: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x10 |
Track position. |
0x60 |
Track duration. |
ACI_CMD_LEA_ADV_START
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_ADV_START |
0x3250 |
None |
None |
Description
Start LE Audio advertising, allowing the device to be scanned and connected by remote device.
Command Parameters
None.
ACI_CMD_LEA_ADV_STOP
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_ADV_STOP |
0x3251 |
None |
None |
Description
Stop LE Audio advertising, preventing it from being scanned by remote device.
Command Parameters
None.
ACI_CMD_LEA_CCP_CALL_CP
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_CCP_CALL_CP |
0x3252 |
conn_id, call_cp |
Description
Control the phone call of the connected remote device.
Command Parameters
conn_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Connection identity for connected remote device. |
call_cp: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Answer incoming call. |
0x01 |
Terminate call. |
0x02 |
Move call to local hold. |
0x03 |
Move local hold call to active call. |
0x04 |
Originate call. |
0x05 |
Join calls. |
ACI_CMD_LEA_MCP_MEDIA_CP
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_MCP_MEDIA_CP |
0x3253 |
conn_id, media_cp |
Description
Control the active music player of connected remote device.
Command Parameters
conn_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Connection identity for connected remote device. |
media_cp: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
Play current track. |
0x02 |
Pause current track. |
0x03 |
Fast rewind. |
0x04 |
Fast forward. |
0x05 |
Stop current track. |
0x30 |
Move to previous track. |
0x31 |
Move to next track. |
ACI_CMD_LEA_SYNC_INIT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_SYNC_INIT |
0x3254 |
bis_mode, bis_policy, addr |
None |
Description
Initialize the BIS parameters, including BIS role and BIS policy.
The address field is only used when BIS policy is set to LEA_BIS_POLICY_SPECIFIC
.
Command Parameters
bis_mode: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
LEA_BROADCAST_DELEGATOR |
0x02 |
LEA_BROADCAST_SINK |
bis_policy: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
LEA_BIS_POLICY_RANDOM |
0x01 |
LEA_BIS_POLICY_SPECIFIC |
addr: (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
The source address that wants to sync. |
ACI_CMD_LEA_SYNC
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_SYNC |
0x3255 |
sync |
None |
Description
Start/stop syncing the broadcast audio stream.
Command Parameters
opcode: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0x00 |
Sync = true. |
0x01 |
Sync = false. |
ACI_CMD_LEA_VCS_SET
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_LEA_VCS_SET |
0x3256 |
conn_id, vol_type |
None |
Description
Change the volume of the local device’s audio and notify VCS audio volume state to the remote device.
Command Parameters
conn_id: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Connection identity for connected remote device. |
vol_type: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Volume up. |
0x01 |
Volume down. |
0x02 |
SPK mute. |
0x03 |
SPK unmute. |
ACI_CMD_UART_DFU
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_UART_DFU |
0x3270 |
opcode |
None |
Description
Start/abort UART DFU, transmit DFU Data, enable test mode, get device’s version, and reboot the device.
Command Parameters
opcode: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0x0000 |
UART_DFU_START_REQ, request to start DFU. |
0x0001 |
UART_DFU_DATA_IND, send data packet. |
0x0002 |
UART_DFU_ABORT, abort DFU. |
0x0003 |
UART_DFU_REBOOT, reboot device. |
0x0004 |
UART_DFU_TEST_EN, enable test mode. |
0x0005 |
UART_DFU_GET_VER, get version of device. |
ACI_CMD_SRC_PLAY_SET_SRC_ROUTE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_SET_SRC_ROUTE |
0x3300 |
src_route |
None |
Description
Set source route.
Command Parameters
src_route: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0x01, 0x00 |
mic |
0x02, 0x00 |
Line-in |
0x03, 0x01 |
usb_ds |
0x03, 0x02 |
usb_us |
0x03, 0x03 |
usb_ds_us |
0x04, 0x00 |
sd_card |
0x05, 0x00 |
spdif |
0x06, 0x00 |
I2S |
ACI_CMD_SRC_PLAY_GET_SRC_ROUTE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_GET_SRC_ROUTE |
0x3301 |
None |
None |
Description
Get source route.
Command Parameters
None.
ACI_CMD_SRC_PLAY_SET_PLAY_ROUTE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_SET_PLAY_ROUTE |
0x3302 |
play_route |
None |
Description
Set play route.
Command Parameters
play_route: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
a2dp |
0x02 |
hfp_ag |
0x03 |
bis |
0x04 |
cis |
0x05 |
local |
0x06 |
multi_a2dp |
ACI_CMD_SRC_PLAY_GET_PLAY_ROUTE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_GET_PLAY_ROUTE |
0x3303 |
None |
None |
Description
Get play route.
Command Parameters
None.
ACI_CMD_SRC_PLAY_ROUTE_IN_START
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_ROUTE_IN_START |
0x3304 |
None |
None |
Description
Start route in the record.
Command Parameters
None.
ACI_CMD_SRC_PLAY_ROUTE_IN_STOP
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_ROUTE_IN_STOP |
0x3305 |
None |
None |
Description
Stop route in the record.
Command Parameters
None.
ACI_CMD_SRC_PLAY_ROUTE_OUT_START
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_ROUTE_OUT_START |
0x3306 |
None |
None |
Description
Start to route out play.
Command Parameters
None.
ACI_CMD_SRC_PLAY_ROUTE_OUT_STOP
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_ROUTE_OUT_STOP |
0x3307 |
None |
None |
Description
Stop route out play.
Command Parameters
None.
ACI_CMD_SRC_PLAY_ATTACH_FEATURE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_ATTACH_FEATURE |
0x3312 |
feature_bits |
None |
Description
Configure attach feature(s).
Command Parameters
feature_bits: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Bit0: NREC, Bit1: Append LOCAL PLAY. |
ACI_CMD_SRC_PLAY_DETACH_FEATURE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SRC_PLAY_DETACH_FEATURE |
0x3313 |
feature_bits |
None |
Description
Detach attached feature(s).
Command Parameters
feature_bits: (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Bit0: NREC, Bit1: Append LOCAL PLAY. |
ACI_CMD_MAP_CONNECT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_MAP_CONNECT |
0x3801 |
None |
None |
Description
Set up MAP connection.
Command Parameters
None.
ACI_CMD_MAP_GET_FOLDER_LISTING
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_MAP_GET_FOLDER_LISTING |
0x3802 |
max_list_count, start_offset |
None |
Description
Get folder list through MAP.
Command Parameters
max_list_count: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x0A |
Max list count. |
start_offset: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Start offset. |
ACI_CMD_MAP_DISCONNECT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_MAP_DISCONNECT |
0x3803 |
None |
None |
Description
Disconnect MAP connection.
Command Parameters
None.
ACI_CMD_MAP_GET_MESSAGE_LISTING
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_MAP_GET_MESSAGE_LISTING |
0x3805 |
max_list_count, start_offset |
None |
Description
Get message list through MAP.
Command Parameters
max_list_count: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x0A |
Max list count. |
start_offset: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Start offset. |
ACI_CMD_MAP_REG_MSG_NOTIFICATION
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_MAP_REG_MSG_NOTIFICATION |
0x3809 |
enable |
None |
Description
Register message notification through MAP.
Command Parameters
enable: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
Enable. |
ACI_CMD_MAP_GET_MESSAGE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_MAP_GET_MESSAGE |
0x380A |
handle_len, msg_handle[] |
None |
Description
Get a message through MAP.
Command Parameters
handle_len: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x20 |
Length of message. |
msg_handle: (Size: handle_len)
Value |
Parameter Description |
---|---|
msg_handle[] |
Array of message handles. |
ACI_CMD_MAP_PUSH_MESSAGE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_MAP_PUSH_MESSAGE |
0x3810 |
msg_len, msg[] |
None |
Description
Push message through MAP.
Command Parameters
msg_len: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Length of a specific message to be pushed. |
msg: (Size: variable)
Value |
Parameter Description |
---|---|
msg[] |
Array of messages. |
ACI_CMD_SET_FRAME_INFO
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SET_FRAME_INFO (abandon) |
0x5008 |
format, channel, sample_counts, sampling_freq, bitrate, version, layer |
Description
Set MP3 information and trigger media playing.
Command Parameters
format: (Size: 1 octet)
Value
Parameter Description
0x30
MP3.
channel: (Size: 1 octet)
Value
Parameter Description
0x00
Stereo.
0x01
Joint stereo.
0x02
Dual.
0x03
Mono.
sample_counts: (Size: 2 octets)
Value
Parameter Description
0xXXXX
The frame size is the number of samples per frame.
sampling_freq: (Size: 4 octets)
Value
Parameter Description
48000, 44100, 32000, 24000, 22050, 16000, 11025, 12000, 8000
The sample rate for encoding or decoding.
bitrate: (Size: 4 octets)
Value
Parameter Description
8000 ~ 320000 bit/s
Bitrate for decoding.
version: (Size: 1 octet)
Value
Parameter Description
0
MPEG Version 2.5 (Unofficial).
1
Reserved.
2
MPEG Version 2 (ISO/IEC 13818-3).
3
MPEG Version 1 (ISO/IEC 11172-3).
layer: (Size: 1 octet)
Value
Parameter Description
0
Reserved.
1
Layer 3.
2
Layer 2.
3
Layer 1.
ACI_CMD_SET_FRAME_CONTENT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_SET_FRAME_CONTENT (abandon) |
0x5009 |
frame_content |
Description
Set MP3 frames to play.
Command Parameters
frame_content: (Size: N octets)
Value
Parameter Description
N octets
Each MP3 frame in the file.
ACI_CMD_XM_ENTER_HCI_MODE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_ENTER_HCI_MODE |
0x8000 |
None |
None |
Description
Set the device into the HCI mode.
Command Parameters
None.
ACI_CMD_XM_DEVICE_REBOOT
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_DEVICE_REBOOT |
0x8001 |
None |
Description
SW reboots after 1 sec.
Command Parameters
None.
ACI_CMD_XM_MMI
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_MMI |
0x8004 |
action |
None |
Description
Makes MMI actions.
Command Parameters
action: (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
XM_MMI_MODE_LOCAL_PLAY |
0x02 |
XM_MMI_MODE_A2DP_SOURCE |
0x03 |
XM_MMI_BT_BOND_CLEAR_ALL |
Command Detail:
XM_MMI_MODE_LOCAL_PLAY
: Switch music mode to local playback.XM_MMI_MODE_A2DP_SOURCE
: Switch music mode to A2DP Source mode.XM_MMI_BT_BOND_CLEAR_ALL
: Delete all bond information in bond storage.
ACI_CMD_XM_BT_SET_ADDR
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_BT_SET_ADDR |
0x8005 |
bt_addr |
None |
Description
Modify the Bluetooth address of the device (Only can be used in the power on status, and will take effect after a factory reset).
Command Parameters
bt_addr: (Size: 6 octets)
Value
Parameter Description
0xXXXXXXXXXXXX
MAC address.
ACI_CMD_XM_SPP_DATA_TRANSFER
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_SPP_DATA_TRANSFER |
0x8006 |
link_id, payload_length, payload |
None |
Description
Send vendor SPP data.
Command Parameters
link_id: (Size: 1 octet)
Value
Parameter Description
0xXX
APP layer ID for BR/EDR link.
payload_length: (Size: 2 octets)
Value
Parameter Description
0xXXXX
Payload length in this packet.
payload: (Size: N octets)
Value
Parameter Description
0xXXXX (N bytes)
N octets of the payload in this packet.
ACI_CMD_XM_GET_FACTORY_RESET
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_GET_FACTORY_RESET |
0x80C3 |
None |
Description
Get factory reset status.
Command Parameters
None.
ACI_CMD_XM_USER_CFM_REQ
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_USER_CFM_REQ |
0x8013 |
cfm_val |
None |
Description
The user confirms for BR/EDR pairing.
Command Parameters
cfm_val: (Size: 1 octet)
Value
Parameter Description
1 or 0
True or false.
ACI_CMD_XM_LE_START_ADVERTISING
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_START_ADVERTISING |
0x8040 |
duration |
None |
Description
Start LE advertising.
Command Parameters
duration: (Size: 2 octets)
Value
Parameter Description
0xXXXX
LE advertising duration in seconds, little endian.
ACI_CMD_XM_LE_STOP_ADVERTISING
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_STOP_ADVERTISING |
0x8041 |
None |
None |
Description
Stop LE advertising.
Command Parameters
None.
ACI_CMD_XM_LE_DISC
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_DISC |
0x8042 |
link_id |
None |
Description
Disconnect LE link(s).
Command Parameters
link_id: (Size: 1 octet)
Value
Parameter Description
0x00-0xfe
Disconnect APP layer ID for LE link.
0xff
Disconnect all LE links.
ACI_CMD_XM_LE_CONN_PARAM_UPDATE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_CONN_PARAM_UPDATE |
0x8043 |
link_id, conn_interval, conn_latency, conn_supervision_timeout |
None |
Description
Update LE connection params.
Command Parameters
link_id: (Size: 1 octet)
Value
Parameter Description
0xXX
APP layer ID for an LE link.
conn_interval: (Size: 2 octets)
Value
Parameter Description
0xXXXX
Set LE preferred connection interval to conn_interval * 1.25 ms, little endian.
conn_latency: (Size: 2 octets)
Value
Parameter Description
0xXXXX
Set LE preferred connection latency to conn_latency, little endian.
conn_supervision_timeout: (Size: 2 octets)
Value
Parameter Description
0xXXXX
Set LE preferred connection supervision timeout to conn_supervision_timeout * 10ms, little endian.
ACI_CMD_XM_LE_ADV_DATA_UPDATE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_ADV_DATA_UPDATE |
0x8044 |
adv_data_len, adv_data |
None |
Description
Update LE advertising data.
Command Parameters
adv_data_len: (Size: 2 octets)
Value
Parameter Description
0xXXXX
ADV data length, must be less than 31 bytes.
adv_data: (Size: adv_data_len octets)
Value
Parameter Description
0xXXXX
New advertising data payload.
ACI_CMD_XM_LE_SCAN_RSP_DATA_UPDATE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_SCAN_RSP_DATA_UPDATE |
0x8045 |
scan_rsp_data_len, scan_rsp_data |
None |
Description
Update LE scan response data.
Command Parameters
scan_rsp_data_len: (Size: 2 octets)
Value
Parameter Description
0xXXXX
Scan response data length, must be less than 31 bytes, little-endian.
scan_rsp_data: (Size: scan_rsp_data_len octets)
Value
Parameter Description
0xXXXX
New scan response data payload.
ACI_CMD_XM_LE_ADV_INTVAL_UPDATE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_ADV_INTVAL_UPDATE |
0x8046 |
adv_interval |
None |
Description
Update LE advertising interval.
Command Parameters
adv_interval: (Size: 2 octets)
Value
Parameter Description
0xXXXX
Set LE advertising interval to adv_interval * 0.625ms (Must be between 20ms and 10.25s), little endian.
ACI_CMD_XM_LE_ATT_GET_MTU
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_ATT_GET_MTU |
0x8047 |
link_id |
Description
Command Parameters
link_id: (Size: 1 octet)
Value
Parameter Description
0xXX
APP layer ID for an LE link.
ACI_CMD_XM_LE_GET_ADDR
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_GET_ADDR |
0x8048 |
None |
Description
Get LE address.
Command Parameters
None.
ACI_CMD_XM_LE_BOND_DEL
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_BOND_DEL |
0x804A |
addr_type, addr |
None |
Description
Delete LE bond with the address.
Command Parameters
addr_type: (Size: 1 octet)
Value
Parameter Description
0x00
GAP_REMOTE_ADDR_LE_PUBLIC
0x01
GAP_REMOTE_ADDR_LE_RANDOM
0x02
GAP_REMOTE_ADDR_LE_PUBLIC_IDENTITY
0x03
GAP_REMOTE_ADDR_LE_RANDOM_IDENTITY
0x10
GAP_REMOTE_ADDR_CLASSIC
0xff
GAP_REMOTE_ADDR_LE_ANONYMOUS
addr: (Size: 6 octets)
Value
Parameter Description
0xXXXXXXXXXXXX
Address for every remote device.
ACI_CMD_XM_LE_ADV_CREATE
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_ADV_CREATE |
0x804B |
adv_handle, adv_prop, interval_min, interval_max, own_addr_type, own_addr, peer_addr_type, peer_addr, adv_data_len, adv_data, scan_rsp_len, scan_rsp |
Description
Create a customized advertisement.
Command Parameters
adv_handle: (Size: 1 octet)
Value
Parameter Description
0xXX
Handle for an ADV set. For this command, it is useless.
adv_prop: (Size: 1 octet)
Value
Parameter Description
0x13
LE_EXT_ADV_LEGACY_ADV_CONN_SCAN_UNDIRECTED
0x15
LE_EXT_ADV_LEGACY_ADV_CONN_LOW_DUTY_DIRECTED
0x1D
LE_EXT_ADV_LEGACY_ADV_CONN_HIGH_DUTY_DIRECTED
0x12
LE_EXT_ADV_LEGACY_ADV_SCAN_UNDIRECTED
0x10
LE_EXT_ADV_LEGACY_ADV_NON_SCAN_NON_CONN_UNDIRECTED
interval_min, interval_max: (Size: 2 octet, in units of 0.625ms, range: 0x000020 to 0xFFFFFF)
Value
Parameter Description
0xXXXX
ADV interval.
own_addr_type: (Size: 1 octet)
Value
Parameter Description
0x00
GAP_LOCAL_ADDR_LE_PUBLIC
0x01
GAP_LOCAL_ADDR_LE_RANDOM
0x02
GAP_LOCAL_ADDR_LE_RAP_OR_PUBLIC
0x03
GAP_LOCAL_ADDR_LE_RAP_OR_RAND
own_addr: (Size: 6 octets)
Value
Parameter Description
0xXXXXXXXXXXXXXX
own_addr
peer_addr_type: (Size: 1 octet)
Value
Parameter Description
0x00
GAP_REMOTE_ADDR_LE_PUBLIC
0x01
GAP_REMOTE_ADDR_LE_RANDOM
0x02
GAP_REMOTE_ADDR_LE_PUBLIC_IDENTITY
0x03
GAP_REMOTE_ADDR_LE_RANDOM_IDENTITY
0x10
GAP_REMOTE_ADDR_CLASSIC
0xff
GAP_REMOTE_ADDR_LE_ANONYMOUS
peer_addr: (Size: 6 octets)
Value
Parameter Description
0xXXXXXXXXXXXXXX
peer_addr
adv_data_len: (Size: 2 octets)
Value
Parameter Description
0xXXXX
adv_data_len
adv_data: (Size: adv_data_len octet)
Value
Parameter Description
0xXX…
adv_data
scan_rsp_len: (Size: 2 octet)
Value
Parameter Description
0xXXXX
scan_rsp_len
scan_rsp: (Size: scan_rsp_len octet)
Value
Parameter Description
0xXX…
scan_rsp
ACI_CMD_XM_LE_BOND_DEL_ALL
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_BOND_DEL_ALL |
0x804C |
None |
None |
Description
Delete all bond info.
ACI_CMD_XM_MUSIC
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_MUSIC |
0x8080 |
type, seq, data |
Description
Control music session flow.
ACK
When the type is 0x05 (Music session send single frame), ACK status (ACI_EVENT_ACK
) would be 0x08, which means request MCU for another music frame.
Command Parameters
type: (Size: 1 octet)
Value
Parameter Description
0x00
Music session open.
0x01
Music session pause.
0x02
Music session resume.
0x03
Music session abort.
0x04
Music session close.
0x05
Music session send single frame.
Others
Reserved.
seq: (Size: 1 octet)
Value
Parameter Description
0x00 - 0xFF
Seq is fixed at 0x00 when type is:
Music session open.
Music session pause.
Music session resume.
Music session abort.
Music session close.
Music session send single frame.
data: (Size: N octets)
Value
Parameter Description
N octets
Music data.
ACI_CMD_XM_TTS
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_TTS |
0x8081 |
type, seq, len, data |
Description
Control TTS session flow.
When the type is 0x05 (TTS session send single frame) or 0x08 (TTS session send end frame), ACK status (ACI_EVENT_ACK
) would be 0x07, which means request MCU for another TTS frame.
Command Parameters
type: (Size: 1 octet)
Value
Parameter Description
0x00
TTS Session Open.
0x01
TTS session pause.
0x02
TTS session resume.
0x03
TTS session abort.
0x04
TTS session close.
0x05
TTS session send single frame.
0x06
TTS session send start frame.
0x07
TTS session send continue frame.
0x08
TTS session send end frame.
Others
Reserved.
seq: (Size: 1 octet)
Value
Parameter Description
0x00 - 0xFF
Seq is fixed at 0x00 when type is:
TTS session open.
TTS session pause.
TTS session resume.
TTS session abort.
TTS session close.
TTS session send single frame.
TTS session send start frame.
Seq is increased by 1 when type is:
TTS session send continue frame.
TTS session send end frame.
len: (Size: 2 octets)
Value
Parameter Description
0x0000-0xFFFF
TTS encoded data length.
data: (Size: len octets)
Value
Parameter Description
0xXXXX
TTS encoded data.
ACI_CMD_XM_START_RECORD
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_START_RECORD |
0x8082 |
audio_type, audio_params |
Description
Start recording.
Command Parameters
audio_type: (Size: 1 octet)
PCM Parameters
Sample Rate (Hz) [4 Bytes]
Frame Length (octets) [2 Bytes]
Channel Number [1 Byte]
Bit Width [1 Byte]
Supported values are 8000, 16000, 44100, 48000, and 96000.
1 (Mono) or 2 (Stereo).
16 or 24.
Opus Parameters
Sample Rate (Hz) [4 Bytes]
Channel Num [1 Byte]
CBR [1 byte]
CVBR [1 byte]
Supported value is 16000.
1 (Mono).
0 for VBR and 1 for CBR.
0 for VBR and 1 for CVBR.
Mode [1 byte]
Complexity [1 byte]
frame_duration [1 byte]
Bitrate [4 bytes]
The supported value is 3 for CELT-only.
From 0 to 3.
0 (2.5ms), 1 (5ms), 2 (10ms), 3 (20ms), 4 (40ms), 5 (60ms), 6 (80ms), 7 (100ms), 8 (120ms).
From 6000 bit/s to 510000 bit/s.
MSBC or SBC Parameters
Sample Rate (Hz) [4 Bytes]
Channel Number [1 Byte]
block_length [1 byte]
Supported values are 8000, 16000, 44100, and 48000 in Hz.
1 (Mono) or 2 (Stereo).
4, 8, 12, 16.
subband_num [1 byte]
allocation_method [1 byte]
Bitpool [1 byte]
4 or 8.
0 for Loudness and 1 for SNR.
from 2 to 250.
LC3 Parameters
Sample Rate (Hz) [4 Bytes]
Channel Allocation [4 Byte]
frame_length [2 byte]
Supported values are 16000, 48000.
0 (Mono).
40 for 16k and 120 for 48k.
frame_duration [1 byte]
Presentation Delay [4 byte]
0 for 7.5ms and 1 for 10ms.
From 0 to 0xFFFFFFFF in microsecond units.
ACI_CMD_XM_STOP_RECORD
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_STOP_RECORD |
0x8503 |
None |
None |
Description
Stop recording.
Command Parameters
None.
ACI_CMD_XM_START_RECORD_PLAY
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_START_RECORD_PLAY |
0x8504 |
audio_type |
None |
Description
Start record play.
Command Parameters
audio_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
PCM |
0x01 |
CVSD |
0x02 |
mSBC |
0x03 |
SBC |
0x04 |
AAC |
0x05 |
Opus |
0x06 |
FLAC |
0x07 |
MP3 |
0x08 |
LC3 |
0x09 |
LDAC |
pcm_params
Sample Rate (Hz) [4 Bytes] |
Frame Length [2 Bytes] |
Channel Number [1 Byte] |
Bit Width [1 Byte] |
---|---|---|---|
8000, 16000, 44100, 48000, 96000. |
1 (Mono) or 2 (Stereo). |
16 or 24. |
opus_params
Sample Rate (Hz) [4 Bytes] |
Channel Number [1 Byte] |
CBR [1 byte] |
CVBR [1 byte] |
---|---|---|---|
8000, 16000, 44100, 48000, 96000. |
1 (Mono) or 2 (Stereo). |
0 for VBR and 1 for CBR. |
0 for VBR and 1 for CVBR. |
Mode [1 byte] |
Complexity [1 byte] |
frame_duration [1 byte] |
Bitrate [4 bytes] |
---|---|---|---|
1 for SILK-only, 2 for Hybrid (SILK+CELT), 3 for CELT-only. |
From 0 to 10. |
0 (2.5ms), 1 (5ms), 2 (10ms), 3 (20ms), 4 (40ms), 5 (60ms), 6 (80ms), 7 (100ms), 8 (120ms). |
From 6000 bit/s to 510000 bit/s. |
ACI_CMD_XM_STOP_RECORD_PLAY
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_STOP_RECORD_PLAY |
0x8505 |
None |
None |
Description
Stop record play.
Command Parameters
None.
ACI_CMD_XM_RECORD_PLAY_DATA
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_RECORD_PLAY_DATA |
0x8086 |
record_data |
None |
Description
Send record data to play, need to start record play first.
Command Parameters
record_data (Size: 1024 octets)
Value |
Parameter Description |
---|---|
1024 |
PCM data. |
ACI_CMD_XM_SET_VOLUME_LEVEL
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_SET_VOLUME_LEVEL |
0x8088 |
volume, type |
None |
Description
Set playback or voice volume depending on the scenario.
Command Parameters
volume (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
0~15 (Volume level). |
type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
HFP_VOL |
0x01 |
LOCAL_VOL |
0x02 |
A2DP_SRC_VOL |
0x03 |
RINGTONE_VOL |
0x04 |
VP_VOL |
0x05 |
TTS_VOL |
0x06 |
RECORD_VOL |
0x07 |
RECORD_MIC_VOL |
ACI_CMD_XM_AUDIO_TEST_GET_PA_ID
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_AUDIO_TEST_GET_PA_ID |
0x8089 |
None |
Description
Get PA ID.
Command Parameters
None.
ACI_CMD_XM_AUDIO_TEST_BYPASS
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_AUDIO_TEST_BYPASS |
0x808A |
audio_mode |
None |
Description
Set audio algorithm bypass mode or normal mode.
Command Parameters
audio_mode (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Normal mode. |
0x01 |
Bypass mode. |
ACI_CMD_XM_GATT_ACI
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_GATT_ACI |
0x8007 |
conn_handle, cid, pkt_type, handle_index, total_length, payload_length, payload |
None |
Description
Transfer GATT data from UART.
Command Parameters
conn_handle (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The connection handle from HCI, 0x01 for BR/EDR and 0x13 for LE. |
cid (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The channel ID for corresponding L2CAP channel. For BR/EDR, set it to 0x0000 for test. For LE, it is fixed to 0x0004. |
pkt_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Single packet. |
0x01 |
Fragmented start packet. |
0x02 |
Fragmented continue packet. |
0x03 |
Fragmented end packet. |
handle_index (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
Service 02fd. |
0x11 |
Service unlock. |
0x12 |
Service unlock. |
0x21 |
Service factory. |
0x61 |
Service HID. |
0x71 |
Service HRS. |
0x81 |
Service goodix. |
total_length (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Total payload length. |
payload_length (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Payload length in this packet. |
payload (Size: N octets)
Value |
Parameter Description |
---|---|
0xXXXX (N bytes) |
N octets of the payload in this packet. |
ACI_CMD_XM_SNIFF_MODE_CTRL
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_SNIFF_MODE_CTRL |
0x8009 |
sniff_mode_enabled, sniff_mode_interval |
None |
Description
Enable or disable sniff mode for all BR/EDR links.
Command Parameters
sniff_mode_enabled (Size: 1 octet)
Value |
Parameter Description |
---|---|
0 or 1 |
Means false or true to enable sniff mode. |
sniff_mode_interval (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Sniff mode interval. |
ACI_CMD_XM_LE_USER_CFM_REQ
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_LE_USER_CFM_REQ |
0x8013 |
conn_id, cfm_result |
None |
Description
Confirm LE Connection.
Command Parameters
conn_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Default. |
cfm_result (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
False. |
0x01 |
True. |
ACI_CMD_XM_DISABLE_VERBOSE_LOG
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_XM_DISABLE_VERBOSE_LOG |
0x80C0 |
log_type, log_key, module, level, turnon |
None |
Description
Close/open the log.
Command Parameters
log_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
Close/Open all current logs. |
0x02 |
Close/Open different module logs. |
log_key (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Close all current logs. |
0x01 |
Open all previously closed logs. |
module (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00~0x09 |
Platform modules. |
0x0c~0x23 |
Device modules. |
0x30~0x3f |
Stack modules. |
level (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
LEVEL_ERROR |
0x01 |
LEVEL_WARN |
0x02 |
LEVEL_INFO |
0x03 |
LEVEL_TRACE |
turnon (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Turn off. |
0x01 |
Turn on. |
ACI_CMD_CHARGING_CASE_LE_CONTROL
Command |
Opcode |
Command Parameters |
Return Event |
---|---|---|---|
ACI_CMD_CHARGING_CASE_LE_CONTROL |
0x8100 |
cmd_id, cmd_data |
None |
Description
Send CMD to the headset by LE.
Command Parameters
cmd_id (Size: 2 octets)
Value |
Parameter Description |
---|---|
0x0004 |
CMD_MMI |
0x001F |
CMD_SET_VP_VOLUME |
0x0205 |
CMD_AUDIO_EQ_INDEX_SET |
0x020A |
CMD_SET_VOLUME |
0x0704 |
CMD_SET_KEY_MMI_MAP |
mmi_data (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x02 |
End an outgoing call. |
0x03 |
Answer an incoming call. |
0x04 |
Reject an incoming call. |
0x05 |
End an active call. |
0x06 |
MIC mute toggle. |
0x07 |
MIC mute. |
0x08 |
MIC unmute. |
0x30 |
Volume up. |
0x31 |
Volume down. |
0x32 |
AV play/pause. |
0x34 |
AV forward. |
0x35 |
AV backward. |
0x36 |
AV fast forward. |
0x37 |
AV rewind. |
0x80 |
Switch to gaming mode. |
0xD3 |
Light sensor on/off. |
vp_volume_data (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 ~ 0x0F |
VP volume level. |
eq_set_data (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
EQ index. |
volume_data (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
0~maximum (Volume level). |
mmi_map_data (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x30 |
Set MFB as volume up button. |
0x31 |
Set MFB as volume down button. |
ACI Events
Summary of ACI Events
Opcode |
Command |
Available |
---|---|---|
0x0000 |
Y |
|
0x0001 |
Y |
|
0x0002 |
Y |
|
0x0003 |
Y |
|
0x0004 |
Y |
|
0x0005 |
Y |
|
0x0007 |
Y |
|
0x0009 |
Y |
|
0x000A |
Y |
|
0x000B |
Y |
|
0x0013 |
Y |
|
0x0014 |
Y |
|
0x0018 |
Y |
|
0x0019 |
Y |
|
0x001A |
Y |
|
0x001C |
Y |
|
0x001D |
Y |
|
0x0020 |
Y |
|
0x0023 |
Y |
|
0x0025 |
Y |
|
0x0026 |
Y |
|
0x002B |
Y |
|
0x0100 |
Y |
|
0x0101 |
Y |
|
0x0102 |
Y |
|
0x0103 |
Y |
|
0x0110 |
Y |
|
0x0111 |
Y |
|
0x0112 |
Y |
|
0x0120 |
Y |
|
0x0121 |
Y |
|
0x0122 |
Y |
|
0x0123 |
Y |
|
0x0124 |
Y |
|
0x0140 |
Y |
|
0x0141 |
Y |
|
0x0142 |
Y |
|
0x0143 |
Y |
|
0x0144 |
Y |
|
0x0145 |
Y |
|
0x0146 |
Y |
|
0x0147 |
Y |
|
0x0300 |
Y |
|
0x0301 |
Y |
|
0x0306 |
Y |
|
0x0307 |
Y |
|
0x0308 |
Y |
|
0x0381 |
Y |
|
0x0389 |
Y |
|
0x038D |
Y |
|
0x0396 |
Y |
|
0x3160 |
Y |
|
0x3161 |
Y |
|
0x3162 |
Y |
|
0x3163 |
Y |
|
0x0A0E |
Y |
|
0x3252 |
Y |
|
0x3253 |
Y |
|
0x3256 |
Y |
|
0x0904 |
Y |
|
0x0909 |
Y |
|
0x0911 |
Y |
|
0x5001 |
Y |
|
0x8000 |
Y |
|
0x8001 |
Y |
|
0x8002 |
Y |
|
0x8003 |
Y |
|
0x8004 |
Y |
|
0x8005 |
Y |
|
0x8006 |
Y |
|
0x8040 |
Y |
|
0x8041 |
Y |
|
0x8042 |
Y |
|
0x8043 |
Y |
|
0x8044 |
Y |
|
0x8045 |
Y |
|
0x8046 |
Y |
|
0x8048 |
Y |
|
0x80C0 |
Y |
|
0x8500 |
Y |
|
0x8501 |
Y |
|
0x8502 |
Y |
|
0x8600 |
Y |
|
0x8700 |
Y |
|
0x8800 |
Y |
ACI_EVENT_ACK
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_ACK |
0x0000 |
cmd_id, status |
Description
Acks the received command for device.
Event Parameters
cmd_id (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX |
The command ID to ACK. |
status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Command complete: BTM can handle this command. |
0x01 |
Command disallow: BTM cannot handle this command. |
0x02 |
Unknown CMD. |
0x03 |
Parameters error. |
0x04 |
Busy. |
0x05 |
Process fail maybe due to stack resource. |
0x07 |
TTS frame send success and request for another TTS frame. |
0x08 |
Music frame send success and request for another music frame. |
0x09 |
SPP transfer success when sent to phone. |
0x10 |
SPP transfer failed when sent to phone. |
0x11 |
GATT transfer can continue sending to phone. |
0x12 |
GATT transfer cannot continue sending to phone. |
Others |
Reserved. |
ACI_EVENT_BT_REPLY_PAIRED_RECORD
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_BT_REPLY_PAIRED_RECORD |
0x0001 |
paired_device_number, paired_record |
Description
Reply to the Read_Paired_Device_Information command.
Event Parameters
paired_device_number (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Paired device number. |
paired_record (Size: (8*total_record) octets)
Value |
Parameter Description |
---|---|
byte0 |
Link priority: 1 is the highest (Newest device) and 4 (Or 8) is the lowest (Oldest device). |
byte1 |
bond_flag:
|
byte2~byte7 |
Linked device Bluetooth address. |
ACI_EVENT_LEGACY_DATA_TRANSFER
Command |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LEGACY_DATA_TRANSFER |
0x0002 |
link_id, payload_length, payload |
Description
Report SPP data to the MCU host.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Link_id, this index will be informed when the link is established (ACI_EVENT_PROFILE_CONN_STATUS). |
payload_length (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Payload length in this packet. |
payload (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
Payload in this packet. |
ACI_EVENT_PROFILE_CONN_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_PROFILE_CONN_STATUS |
0x0003 |
link_id, connect_status, address |
Description
Report the current Bluetooth profiles connect status.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Bluetooth profile link ID. |
connect_status (Size: 4 octets)
Value |
Parameter Description |
---|---|
0x00 |
Reserved. |
0x00000001 |
A2DP_SINK_PROFILE_MASK |
0x00000002 |
AVRCP_CONTROLLER_PROFILE_MASK |
0x00000004 |
HFP_HF_PROFILE_MASK |
0x00000080 |
HSP_AG_PROFILE_MASK |
0x00000200 |
MAP_MSE_PROFILE_MASK |
0x00000400 |
A2DP_SRC_PROFILE_MASK |
0x00000800 |
AVRCP_TARGET_PROFILE_MASK |
0x00001000 |
HFP_AG_PROFILE_MASK |
0x00002000 |
PBAP_PSE_PROFILE_MASK |
0x00004000 |
HSP_HF_PROFILE_MASK |
address (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
The remote device Bluetooth address. |
ACI_EVENT_PROFILE_CONNECT_FAIL_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_PROFILE_CONNECT_FAIL_STATUS |
0x0004 |
link_id, disconnect_status, address, cause |
Description
Report the Bluetooth profile’s disconnect status.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Bluetooth profile link ID. |
disconnect_status (Size: 4 octets)
Value |
Parameter Description |
---|---|
0x00 |
Reserved. |
0x00000001 |
A2DP_SINK_PROFILE_MASK |
0x00000002 |
AVRCP_CONTROLLER_PROFILE_MASK |
0x00000004 |
HFP_HF_PROFILE_MASK |
0x00000080 |
HSP_AG_PROFILE_MASK |
0x00000200 |
MAP_MSE_PROFILE_MASK |
0x00000400 |
A2DP_SRC_PROFILE_MASK |
0x00000800 |
AVRCP_TARGET_PROFILE_MASK |
0x00001000 |
HFP_AG_PROFILE_MASK |
0x00002000 |
PBAP_PSE_PROFILE_MASK |
0x00004000 |
HSP_HF_PROFILE_MASK |
address (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
The remote device Bluetooth address. |
cause (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX |
Reason for disconnect. |
ACI_EVENT_HFP_CALLER_ID
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_HFP_CALLER_ID |
0x0005 |
reserved, type, length, string |
Description
Report the caller’s phone number and the caller’s name.
Event Parameters
reserved (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xFF |
Reserved. |
type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Caller phone number. |
0x01 |
Caller name. |
Others |
Reserved. |
length (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Length of caller ID unit in byte. |
string (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
Caller ID. If the type is number, the encoder is ASCII, if the type is name, the encoder is UTF-8. |
ACI_EVENT_AUDIO_DEVICE_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_AUDIO_DEVICE_STATE |
0x0007 |
state |
Description
Report the device state.
Event Parameters
state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
APP_STATE_OFF |
0x01 |
APP_STATE_ON |
0x02 |
APP_DEVICE_STATE_OFF_ING |
Others |
Reserved. |
ACI_EVENT_BR_REMOTE_NAME
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_BR_REMOTE_NAME |
0x0009 |
status, bd_addr, name |
Description
Report the remote device name when Bluetooth connected.
Event Parameters
status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Success. |
Others |
Fail. |
bd_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Remote device address with low byte first. |
name (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
UTF-8 string with NULL terminate. |
ACI_EVENT_HFP_CALL_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_HFP_CALL_STATUS |
0x000A |
bd_addr, prev_status, curr_status |
Description
Report the call status of the connected device.
Event Parameters
bd_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
MAC address of the remote connected device whose call status has changed. |
prev_status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
CALL_IDLE |
0x01 |
VOICE_ACTIVATION_ONGOING |
0x02 |
INCOMING_CALL_ONGOING |
0x03 |
OUTGOING_CALL_ONGOING |
0x04 |
CALL_ACTIVE |
0x05 |
CALL_ACTIVE_WITH_CALL_WAITING |
0x06 |
CALL_ACTIVE_WITH_CALL_HOLD |
Others |
Reserved. |
curr_status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
CALL_IDLE |
0x01 |
VOICE_ACTIVATION_ONGOING |
0x02 |
INCOMING_CALL_ONGOING |
0x03 |
OUTGOING_CALL_ONGOING |
0x04 |
CALL_ACTIVE |
0x05 |
CALL_ACTIVE_WITH_CALL_WAITING |
0x06 |
CALL_ACTIVE_WITH_CALL_HOLD |
Others |
Reserved. |
ACI_EVENT_AUDIO_PLAYER_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_AUDIO_PLAYER_STATUS |
0x000B |
reserved, status, reserved |
Description
Report the current play status.
Event Parameters
reserved (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXX |
Reserved. |
status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Stop. |
0x01 |
Playing. |
0x02 |
Paused. |
reserved (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Reserved. |
ACI_EVENT_VOLUME_SYNC
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_VOLUME_SYNC |
0x0013 |
address, volume |
Description
Report volume setting to sync with the remote device during calls.
Event Parameters
address (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXX |
The remote device Bluetooth address. |
volume (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
HFP volume. |
ACI_EVENT_BR_LINK_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_BR_LINK_STATUS |
0x0014 |
link_state, bd_addr, link_id, conn_handle |
Description
Report ACL link status to MCU.
Event Parameters
link_state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
LINK_STATE_STANDBY |
0x01 |
LINK_STATE_CONNECTED |
0x02 |
LINK_STATE_LOST |
0x03 |
LINK_STATE_CONN_FAIL |
0x04 |
LINK_STATE_KEY_MISSING |
0x05 |
LINK_STATE_AUTHENTIC_FAIL |
bd_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Remote device address. |
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer link ID for BR/EDR link. |
conn_handle (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
It starts from 0x0001. For only one BR/EDR link, it will be 0x0001. |
ACI_EVENT_REPORT_CFG_TYPE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_REPORT_CFG_TYPE |
0x0018 |
get_type, name_len, name |
Description
Report configuration settings.
Event Parameters
get_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
LE name. |
0x01 |
Legacy name. |
name_len (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Name length. |
name (Size: name_len octets)
Value |
Parameter Description |
---|---|
0xXX |
Name payload. |
ACI_EVENT_REPORT_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_REPORT_STATUS |
0x0019 |
status_index, status_value0, status_value1, … |
Description
Report status information.
Event Parameters
status_index (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xA1 |
Volume. |
volume (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
0~maximum gain. |
maximum gain (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Maximum gain. |
ACI_EVENT_GET_BD_ADDR
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_GET_BD_ADDR |
0x001A |
bd_addr |
Description
Report the Bluetooth device address.
Event Parameters
bd_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Bluetooth address. |
ACI_EVENT_REPORT_DLPS_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_REPORT_DLPS_STATUS |
0x001C |
dlps_status |
Description
Report DLPS status.
Event Parameters
dlps_status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
DLPS disabled. |
0x01 |
DLPS enabled. |
ACI_EVENT_REPORT_KEY_ACTION
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_REPORT_KEY_ACTION |
0x001D |
key_mask, scenario, action |
Description
Report GPIO key action.
Event Parameters
key_mask (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Bit mask:
|
scenario (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
0x00: Short click. 0x01: Long press. 0x03: 2 clicks. 0x04: 3 clicks. 0x05: 4 clicks. 0x06: 5 clicks. |
action (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
MMI action. |
ACI_EVENT_AUDIO_VOL_CHANGE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_AUDIO_VOL_CHANGE |
0x0020 |
status, current_vol |
Description
Report volume change information to the remote device.
Event Parameters
status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
VolChange_None |
0x01 |
VolChange_Up |
0x02 |
VolChange_Down |
0x03 |
VolChange_Max |
0x04 |
VolChange_Min |
current_vol (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Current volume. |
ACI_EVENT_BT_READY
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_BT_READY |
0x0023 |
bd_addr |
Description
Report both Bluetooth and Bluetooth LE stacks are checked ready.
Event Parameters
bd_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Bluetooth address. |
ACI_EVENT_BR_INQUIRY_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_BR_INQUIRY_STATE |
0x0025 |
state |
Description
Report the inquiry state.
Event Parameters
state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Inquiry process has been completed. |
0x01 |
Inquiry process has been canceled. |
0x02 |
Inquiry process contains a valid inquiry result. |
0x03 |
Inquiry process failed. |
ACI_EVENT_SERVICES_SEARCH_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_SERVICES_SEARCH_STATE |
0x0026 |
state, bd_addr |
Description
Report the service search state.
Event Parameters
state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Service search process success. |
0x01 |
Service search process fail. |
0x02 |
Service search process stop. |
bd_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Bluetooth address. |
ACI_EVENT_BR_INQUIRY_RESULT
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_BR_INQUIRY_RESULT |
0x002B |
bd_addr, cod, name_len, name |
Description
Report inquiry results.
Event Parameters
bd_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXX |
MAC address of inquired device. |
cod (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXX |
Class of device. |
name_len (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Length of the inquired device. |
name (Size: name_len octets)
Value |
Parameter Description |
---|---|
0xXX |
Device name of the inquired device. |
ACI_EVENT_LE_CONNECTED
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_CONNECTED |
0x0100 |
link_id |
Description
Indicates LE link connected.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
ACI_EVENT_LE_DISCONNECTED
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_DISCONNECTED |
0x0101 |
link_id, result_code |
Description
Indicates LE link disconnection.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
result_code (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Disconnect cause. |
ACI_EVENT_LE_PAIR_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_PAIR_STATUS |
0x0102 |
link_id, status |
Description
Indicate LE link pair status.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP link ID for LE link. |
status (Size: 2 octets)
Value |
Parameter Description |
---|---|
0x00 |
Success. |
Others |
Fail. |
ACI_EVENT_LE_VENDOR_DATA_TRANSFER
Command |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_VENDOR_DATA_TRANSFER |
0x0103 |
link_id, pkt_type, total_length, payload_length, payload |
Description
Send data to SPP by LE link.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Link_id, the identifier for LE link. |
type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Single packet. |
0x02 |
Fragmented continue packet. |
0x03 |
Fragmented end packet. |
total_length (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Total payload length. |
payload_length (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Payload length in this packet. |
payload (Size: payload_length octets)
Value |
Parameter Description |
---|---|
N octet |
Payload in this packet. |
ACI_EVENT_ANCS_REGISTER_COMPLETE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_ANCS_REGISTER_COMPLETE |
0x0110 |
link_id, result |
Description
Inform the ANCS discovery completed.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
result (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Register success. |
ACI_EVENT_ANCS_NOTIFICATION
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_ANCS_NOTIFICATION |
0x0111 |
link_id, ancs_data_type, pkt_type, total len, pkt_len, pkt_data |
Description
Send the ANCS notification data.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
ancs_data_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
ANCS_FROM_DATA_SOURCE |
0x01 |
ANCS_FROM_NOTIFICATION_SOURCE |
pkt_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
PKT_TYPE_SINGLE |
0x01 |
PKT_TYPE_START |
0x02 |
PKT_TYPE_CONT |
0x03 |
PKT_TYPE_END |
total len (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Total len. |
pkt_len (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
pkt_len |
pkt_data (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX, … |
pkt_data |
ACI_EVENT_ANCS_ACTION_RESULT
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_ANCS_ACTION_RESULT |
0x0112 |
link_id, cause |
Description
Inform the action result.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
cause (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Success. |
0x4A0 |
Command ID was not recognized by the NP. |
0x4A1 |
Command was improperly formatted. |
0x4A2s |
One of the parameters (For example, the NotificationUID) does not refer to an existing object on the NP. |
0x4A3 |
The action was not performed. |
ACI_EVENT_AMS_ENTITY_UPD_NOTIFY
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_AMS_ENTITY_UPD_NOTIFY |
0x0121 |
link_id, pkt_type, total len, pkt_len, pkt_data |
Description
Notify the entity to update data.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
pkt_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
PKT_TYPE_SINGLE |
0x01 |
PKT_TYPE_START |
0x02 |
PKT_TYPE_CONT |
0x03 |
PKT_TYPE_END |
total len (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Total len. |
pkt_len (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
pkt_len |
pkt_data (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX, … |
pkt_data |
ACI_EVENT_AMS_ENTITY_UPD_NOTIFY_EN
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_AMS_ENTITY_UPD_NOTIFY_EN |
0x0122 |
link_id |
Description
Entity update notification was enabled.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
ACI_EVENT_AMS_REMOTE_CMD_NOTIFY
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_AMS_REMOTE_CMD_NOTIFY |
0x0123 |
link_id, pkt_type, total len, pkt_len, pkt_data |
Description
Notify the remote CMD data.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
pkt_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
PKT_TYPE_SINGLE |
0x01 |
PKT_TYPE_START |
0x02 |
PKT_TYPE_CONT |
0x03 |
PKT_TYPE_END |
total len (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Total len. |
pkt_len (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
pkt_len |
pkt_data (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX, … |
pkt_data |
ACI_EVENT_AMS_REMOTE_CMD_NOTIFY_EN
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_AMS_REMOTE_CMD_NOTIFY_EN |
0x0124 |
link_id |
Description
This event means the remote command notification is enabled.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
ACI_EVENT_LE_AUDIO_SCAN_INFO
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_AUDIO_SCAN_INFO |
0x0140 |
event_type, addr_type, addr, name_len, name |
Description
Report advertisements from devices supporting LE Audio.
Event Parameters
event_type (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Reported ADV type. |
addr_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Advertiser address type. |
addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Advertiser address. |
name_len (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Length of advertiser name. |
name (Size: 40 octets)
Value |
Parameter Description |
---|---|
0xXX, … |
Advertiser name. |
ACI_EVENT_LE_AUDIO_BAP_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_AUDIO_BAP_STATE |
0x0141 |
group_handle, state |
Description
Report BAP state.
Event Parameters
group_handle (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
Group handle. |
state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
BAP streaming state. |
ACI_EVENT_LE_AUDIO_BAP_DISCOVERY_DONE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_AUDIO_BAP_DISCOVERY_DONE |
0x0142 |
link_id |
Description
Indicates the BAP related info has been completely discovered.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Link ID. |
ACI_EVENT_LE_AUDIO_CSIS_SCAN_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_AUDIO_CSIS_SCAN_STATE |
0x0143 |
group_handle, state |
Description
Reports the group scan state of the group handle.
Event Parameters
group_handle (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
Group handle. |
state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Scan stopped. |
0x01 |
Scan started. |
ACI_EVENT_LE_AUDIO_ADD_GROUP
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_AUDIO_ADD_GROUP |
0x0144 |
group_handle_count |
Description
Report the count of group handles.
Event Parameters
group_handle_count (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
The count of group handles. |
ACI_EVENT_LE_AUDIO_ADD_SYNC_HANDLE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_AUDIO_ADD_SYNC_HANDLE |
0x0145 |
sync_handle_count |
Description
Report the count of sync handles.
Event Parameters
sync_handle_count (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
The count of sync handles. |
ACI_EVENT_LE_AUDIO_BAAS_SCAN_INFO
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_AUDIO_BAAS_SCAN_INFO |
0x0146 |
scan_baas_dev_count, addr_type, addr, name_len, name |
Description
Report advertisement information of BAAS scan.
Event Parameters
scan_baas_dev_count (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Device count of BAAS scan. |
addr_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Advertiser address type. |
addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Advertiser address. |
name_len (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Length of advertiser name. |
name (Size: 40 octet)
Value |
Parameter Description |
---|---|
0xXX, … |
Advertiser name. |
ACI_EVENT_LE_AUDIO_PA_SYNC_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_LE_AUDIO_PA_SYNC_STATE |
0x0147 |
sync_state |
Description
Report PA sync state.
Event Parameters
sync_state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x04 |
GAP_PA_SYNC_STATE_SYNCHRONIZED |
0x05 |
GAP_PA_SYNC_STATE_TERMINATING |
ACI_EVENT_SCO_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_SCO_STATE |
0x0300 |
connect_status, address |
Description
Report SCO connect state.
Event Parameters
connect_status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
SCO connect indication. |
0x01 |
SCO link established. |
0x02 |
SCO link disconnect. |
address (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
The remote device Bluetooth address. |
ACI_EVENT_CALL_WAITING
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_CALL_WAITING |
0x0301 |
num_len, number |
Description
Report the third call information (Can add other info if needed).
Event Parameters
num_len (Size: 1 octet)
Value |
Parameter Description |
---|---|
num_len |
Number length. |
number (Size: num_len * 1 octet)
Value |
Parameter Description |
---|---|
0x00… |
Caller phone number. |
ACI_EVENT_SUBSCRIBER_NUMBER
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_SUBSCRIBER_NUMBER |
0x0306 |
service, type, num_len, number |
Description
Report local phone information.
Event Parameters
service (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Service. |
type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Type. |
num_len (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Length of phone number. |
number (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
Caller number. |
ACI_EVENT_CURRENT_CALLS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_CURRENT_CALLS |
0x0307 |
call_idx, dir_incoming, status, mode, mpty, type, num_len, number |
Description
Report current call info.
Event Parameters
call_idx (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
call_idx |
dir_incoming (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Outgoing. |
0x01 |
Incoming. |
status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Active. |
0x01 |
Held. |
0x02 |
Dialing. |
0x03 |
Alerting. |
0x04 |
Incoming. |
0x05 |
Waiting. |
0x06 |
Call held by response and hold. |
mode (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Voice. |
0x01 |
Data. |
0x03 |
Fax. |
mpty (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Call is not a member of a multi-party call. |
0x01 |
Call is a member of a multi-party call. |
type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Type. |
num_len (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
num_len |
number (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
Number. |
ACI_EVENT_DTMF
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_DTMF |
0x0308 |
Vchar |
Description
Report the key value entered by the user.
Event Parameters
Vchar (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Vchar. |
ACI_EVENT_HFP_AG_CONN_CMPL
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_HFP_AG_CONN_CMPL |
0x0381 |
bd_addr |
Description
Report the key value entered by the user.
Event Parameters
bd_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXX |
MAC address of HFP AG connection. |
ACI_EVENT_HFP_AG_SUPPORTED_FEATURES
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_HFP_AG_SUPPORTED_FEATURES |
0x0389 |
link_id, feature_bitmap |
Description
This event is used to describe the HFP AG support features.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for BR/EDR link. |
feature_bitmap (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
HFP AG support features. |
ACI_EVENT_HFP_AG_CURR_CALLS_LIST_QUERY
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_HFP_AG_CURR_CALLS_LIST_QUERY |
0x038D |
link_id |
Description
Report the current calls list query.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for BR/EDR link. |
ACI_EVENT_HFP_AG_NETWORK_NAME_FORMAT_SET
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_HFP_AG_NETWORK_NAME_FORMAT_SET |
0x0396 |
link_id |
Description
Report the network name format set.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for BR/EDR link. |
ACI_EVENT_DFU_START_RSP
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_DFU_START_RSP |
0x3160 |
status |
Description
Accept or reject DFU request.
Event Parameters
status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
UART_DFU_REJECT |
0x01 |
UART_DFU_ACCEPT |
ACI_EVENT_DFU_DATA_REQ
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_DFU_DATA_REQ |
0x3161 |
offset, length |
Description
Request specific DFU data.
Event Parameters
offset (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
next_block_offset |
length (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX |
next_block_length |
ACI_EVENT_DFU_RESULT
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_DFU_RESULT |
0x3162 |
result |
Description
Report DFU result.
Event Parameters
result (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
UART_DFU_FAIL |
0x01 |
UART_DFU_SUCCESS |
ACI_EVENT_DFU_LOCAL_VERSION
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_DFU_LOCAL_VERSION |
0x3163 |
local_version |
Description
Report device’s local version.
Event Parameters
local_version (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
Version. |
ACI_APP_EVENT_TRI_DONGLE_EVENT_REPORT
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_APP_EVENT_TRI_DONGLE_EVENT_REPORT |
0x0A0E |
sub_report_event_id, sub_event_report_parameters |
Description
Report event related to Tri dongle.
Event Parameters
sub_report_event_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
LE scan report. |
0x01 |
BR scan report. |
0x02 |
LE BAS not support report. |
0x03 |
LE RSSI not support report. |
0x04 |
LE DIS info report. |
0x05 |
LE BAS info report. |
0x06 |
HF battery info report. |
0x07 |
Connected LE link info report. |
0x08 |
Connected BR link info report. |
0x09 |
LE connection info report. |
0x0A |
PASSKEY value report. |
0x0B |
LE RSSI info report. |
0x0C |
BR RSSI info report. |
0x0D |
LE scan status report. |
0x0E |
BR inquiry scan status report. |
0x0F |
USB reset status report. |
0x10 |
PASSKEY status report. |
0x11 |
ACL authen success report. |
0x12 |
LE bond list report. |
0x13 |
LE DIS not support report. |
0x14 |
LE DIS SYSTEM info report. |
0x15 |
LE DIS PNP info report. |
0x16 |
BR bond list report. |
0x17 |
BR RSSI not support report. |
sub_event_report_parameters (Size: 50 octets)
Sub_report_event_id |
Sub Event Report Parameter Description |
---|---|
0x00 LE scan report |
bd_addr (6 octets, Little-Endian), RSSI (1 octet), le_addr_type (1 octet), device_type_len (1 octet), device_type (2 octets, Little-Endian, 03C1 = Keyboard, 03C2 = Mouse), name_len (1 octet), name (correspond to name len) |
0x01 BR scan report |
bd_addr (6 octets, Little-Endian), RSSI (1 octet), name_len (1 octet), name (correspond to name len) |
0x02 LE BAS not support report |
bd_addr (6 octets for 1 Device) |
0x03 LE RSSI not support report |
bd_addr (6 octets for 1 Device) |
0x04 LE DIS info report |
UUID (2 octets, Little-Endian), bd_addr (6 octets for 1 Device), dis_info_len (2 octets, Little-Endian), dis_info (correspond to dis_info len) |
0x05 LE BAS info report |
battery_level (1 octet), bd_addr (6 octets for 1 Device) |
0x06 HF battery info report |
battery_level (1 octet), bd_addr (6 octets for 1 Device) |
0x07 Connected LE link info report |
Connected_LE_link_num (1 octet), bd_addr (6 octets for 1 Device, if has multiple devices connected, the next device bd_addr will append after) |
0x08 Connected BR link info report |
Connected_BR_link_num (1 octet), bd_addr (6 octets) |
0x09 LE connection info report |
LE connection status (1 octet, 0 = disconnect, 1 = connected), bd_addr (6 octets) |
0x0A LE PAIR PASSKEY info report |
PASSKEY INFO (3 octets, Little-Endian) |
0x0B LE RSSI info report |
RSSI (1 octet), bd_addr (6 octets for 1 Device) |
0x0C BR RSSI info report |
RSSI (1 octet), bd_addr (6 octets for 1 Device) |
0x0D LE scan status report |
status (1 octet, 0 = stop, 1 = start) |
0x0E BR inquiry scan status report |
status (1 octet, 0 = stop, 1 = start) |
0x0F USB reset status report |
status (1 octet, 0 = ready, 1 = reset) |
0x10 PASSKEY status report |
status (1 octet, 0 = disable, 1 = enable) |
0x11 ACL authen success report |
bd_addr (6 octets for 1 Device), link_id (1 octet), conn_handle (2 octets) |
0x12 LE bond list report |
LE device number (1 octet) |
0x13 LE DIS not support report |
UUID (2 octets, Little-Endian), bd_addr (6 octets for 1 Device) |
0x14 LE DIS SYSTEM info report |
UUID (2 octets, Little-Endian), bd_addr (6 octets for 1 Device), dis_system_len (2 octets, Little-Endian), mid (5 octets), oui (3 octets) |
0x15 LE DIS PNP info report |
UUID (2 octets, Little-Endian), bd_addr (6 octets for 1 Device), dis_pnp_len (2 octets, Little-Endian), vendor_id (2 octets), product_id (2 octets), product_version (2 octets), vendor_id_source (1 octet) |
0x16 BR bond list report |
BR device number (1 octet), bd_addr (6 octets for 1 Device, if has multiple devices connected, the next device bd_addr will append after) |
0x17 BR RSSI not support report |
bd_addr (6 octets for 1 Device) |
ACI_APP_EVENT_CCP_CALL_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_APP_EVENT_CCP_CALL_STATUS |
0x3252 |
conn_id, call_status |
Description
Report the device current call status.
Event Parameters
conn_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xxx |
Connect ID. |
call_status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
APP_CALL_IDLE |
0x01 |
APP_VOICE_ACTIVATION_ONGOING |
0x02 |
APP_CALL_INCOMING |
0x03 |
APP_CALL_OUTGOING |
0x04 |
APP_CALL_ACTIVE |
0x05 |
APP_CALL_ACTIVE_WITH_CALL_WAITING |
0x06 |
APP_CALL_ACTIVE_WITH_CALL_HELD |
0x07 |
APP_MULTILINK_CALL_ACTIVE_WITH_CALL_WAIT |
0x08 |
APP_MULTILINK_CALL_ACTIVE_WITH_CALL_HELD |
ACI_APP_EVENT_MCP_MEDIA_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_APP_EVENT_MCP_MEDIA_STATE |
0x3253 |
conn_id, media_state |
Description
Report the device current media state.
Event Parameters
conn_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xxx |
Connect ID. |
media_state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
MCS_MEDIA_STATE_INACTIVE |
0x01 |
MCS_MEDIA_STATE_PLAYING |
0x02 |
MCS_MEDIA_STATE_PAUSED |
0x03 |
MCS_MEDIA_STATE_SEEKING |
ACI_APP_EVENT_VCS_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_APP_EVENT_VCS_STATE |
0x3253 |
vol_setting, mute |
Description
Report the device current audio volume.
Event Parameters
vol_setting (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Current volume value of the audio. |
mute (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
SPK unmute state. |
0x01 |
SPK mute state. |
ACI_EVENT_BT_BOND_INFO_CLEAR
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_BT_BOND_INFO_CLEAR |
0x0904 |
status |
Description
Return the result of clearing the link keys of the target remote connection.
Event Parameters
status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Clear link keys successful. |
0x01 |
Fail to clear link keys, or if there are no link keys, the device will return fail if still using clear band info CMD. |
ACI_EVENT_FW_VERSION
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_FW_VERSION |
0x0909 |
fw_version |
Description
Report firmware version information.
Event Parameters
app (Size: 5 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXX |
APP version. |
patch (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
Patch version. |
app_ui (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
APP UI version. |
ACI_EVENT_REPORT_PACKAGE_ID
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_REPORT_PACKAGE_ID |
0x0911 |
chip_id, package_id |
Description
Report chip ID and package ID.
Event Parameters
chip_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x1B |
RTL87x3E. |
package_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x04 |
Reserved. |
ACI_EVENT_REQ_MEDIA_FRAME
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_REQ_MEDIA_FRAME |
0x5001 |
audio_queue_state, water_level |
Description
Report SCO connect state.
Event Parameters
audio_queue_state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
STATE_PRELOAD |
0x01 |
STATE_CONSUME |
0x02 |
STATE_CHARGE |
0x03 |
STATE_OFFLOAD |
0x04 |
STATE_EMPTY |
water_level (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Counts of buffered frames. |
ACI_EVENT_XM_SPP_DATA_TRANSFER
Command |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_SPP_DATA_TRANSFER |
0x8000 |
link_id, payload_length, payload |
Description
This command is used to report vendor SPP data to the MCU host.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for BR/EDR link. |
payload_length (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Payload length in this packet. |
payload (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
Payload in this packet. |
ACI_EVENT_XM_SPP_CONNECT_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_SPP_CONNECT_STATUS |
0x8001 |
connect_status, address |
Description
Report vendor SPP connect status.
Event Parameters
connect_status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Reserved. |
0x10 |
VENDOR_SPP_PROFILE_MASK |
address (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
The remote device Bluetooth address. |
ACI_EVENT_XM_SPP_DISCONNECT_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_SPP_DISCONNECT_STATUS |
0x8002 |
disconnect_status, address, cause |
Description
Report vendor SPP disconnect status.
Event Parameters
disconnect_status (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Reserved. |
0x10 |
VENDOR_SPP_PROFILE_MASK |
address (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
The remote device Bluetooth address. |
cause (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX |
Reason of disconnect. |
ACI_EVENT_XM_LE_ADV_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_LE_ADV_STATE |
0x8040 |
adv_state, adv_stop_cause |
Description
Report LE advertising state, adv_stop_cause
only valid when adv_state
is 0x00.
Event Parameters
adv_state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Advertising disabled. |
0x01 |
Advertising enabled. |
adv_stop_cause (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
LE ADV stop cause UNKNOWN. |
0x01 |
LE ADV stop cause APP, user terminate ADV. |
0x02 |
LE ADV stop cause CONN, connection establish. |
0x03 |
LE ADV stop cause TIMEOUT, ADV timeout. |
0x04 |
LE ADV stop cause ENABLE_FAILED, ADV enable failed. |
ACI_EVENT_XM_LE_ATT_MTU
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_LE_ATT_MTU |
0x8041 |
mtu_size |
Description
Report LE ATT MTU size, only valid when LE is connected.
Event Parameters
mtu_size (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXX |
LE ATT MTU size. |
ACI_EVENT_XM_LE_ADDR
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_LE_ADDR |
0x8042 |
le_addr |
Description
Report the LE address.
Event Parameters
le_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXX |
LE address. |
ACI_EVENT_XM_LE_CON_STATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_LE_CON_STATE |
0x8043 |
conn_state, link_id, conn_handle, role, remote_type, remote_addr, connInterval, connLatency, supTimeout |
Description
Report LE connect state after LE is connected.
Event Parameters
conn_state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
LE_LINK_STATE_DISCONNECTED |
0x01 |
LE_LINK_STATE_CONNECTING |
0x02 |
LE_LINK_STATE_CONNECTED |
0x03 |
LE_LINK_STATE_DISCONNECTING |
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xxx |
APP layer ID for LE link. |
conn_handle (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
It starts from 0x0013. For only one LE link, it will be 0x0013. |
role (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_LINK_ROLE_UNDEFINED |
0x01 |
GAP_LINK_ROLE_MASTER |
0x02 |
GAP_LINK_ROLE_SLAVE |
remote_type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
GAP_LINK_ROLE_UNDEFINED |
0x01 |
GAP_LINK_ROLE_MASTER |
0x02 |
GAP_LINK_ROLE_SLAVE |
remote_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Remote device address. |
connInterval (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
LE preferred connection interval to conn_interval * 1.25 ms, little endian. |
connLatency (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
LE preferred connection latency to conn_latency, little endian. |
supTimeout (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
LE preferred connection supervision timeout to conn_supervision_timeout * 10ms, little endian. |
ACI_EVENT_XM_LE_CON_PARAM
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_LE_CON_PARAM |
0x8044 |
link_id, connInterval_min, connInterval_max, connLatency, supTimeout |
Description
Report the LE Parameter state after LE update parameters.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xxx |
APP layer ID for LE link. |
connInterval_min (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
LE preferred connection interval to conn_interval * 1.25 ms, little endian. |
connInterval_max (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
LE preferred connection interval to conn_interval * 1.25 ms, little endian. |
connLatency (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
LE preferred connection latency to conn_latency, little endian. |
supTimeout (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
LE preferred connection supervision timeout to conn_supervision_timeout * 10ms, little endian. |
ACI_EVENT_XM_GATT_CON_NOTIFY
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_GATT_CON_NOTIFY |
0x8045 |
conn_handle, cid, xm_service, attr_index, value |
Description
Report GATT service notify state.
Event Parameters
conn_handle (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The connection handle from HCI (For a simple test, it is 0x01 for BR/EDR and 0x13 for LE). |
cid (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The channel ID for corresponding L2CAP channel. For BR/EDR, it is allocated dynamically. For LE, however, it is fixed to 0x0004. |
xm_service (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
T_DEVICE_SERVICE |
0x01 |
T_XM_UNLOCK_SERVICE |
0x02 |
T_XM_FACTORY_SERVICE |
0x03 |
T_XM_SERVICE |
0x04 |
T_XM_ALIPAY_SERVICE |
0x05 |
T_XM_WECHAT_SERVICE |
0x06 |
T_HID_SERVICE |
0x07 |
T_HRS_SERVICE |
0x08 |
T_GOODIX_SERVICE |
attr_index (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Each service has its attr and show this latter. |
value (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
Enable. |
0x02 |
Disable. |
ACI_EVENT_XM_GATT_DATA_TRANSFER
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_GATT_DATA_TRANSFER |
0x8005 |
conn_handle, cid, type, handle_index, total_length, payload_length, payload |
Description
Report GATT data to UART.
Event Parameters
conn_handle (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The connection handle from HCI (For a simple test, it is 0x01 for BR/EDR and 0x13 for LE). |
cid (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The channel ID for corresponding L2CAP channel. For BR/EDR, it is allocated dynamically. For LE, however, it is fixed to 0x0004. |
type (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Single packet. |
0x01 |
Fragmented start packet. |
0x02 |
Fragmented continue packet. |
0x03 |
Fragmented end packet. |
handle_index (Size: 1 octet)
Value |
Attribute |
Parameter Description |
---|---|---|
0x01 |
fd04 |
Service 02fd. |
0x11 |
4 |
Service unlock. |
0x12 |
7 |
Service unlock. |
0x21 |
2 |
Service factory. |
0x61 |
20 |
Service HID. |
0x71 |
7 |
Service HRS. |
0x81 |
2 |
Service goodix. |
total_length (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Total payload length. |
payload_length (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Payload length in this packet. |
payload (Size: N octets)
Value |
Parameter Description |
---|---|
N octets |
Payload in this packet. |
ACI_EVENT_XM_GATT_CREDIT_UPDATE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_GATT_CREDIT_UPDATE |
0x8006 |
conn_handle, cid, credit |
Description
Report GATT credit updated.
Event Parameters
conn_handle (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The connection handle from HCI (For a simple test, it is 0x01 for BR/EDR and 0x13 for LE). |
cid (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The channel ID for the corresponding L2CAP channel. For BR/EDR, it is allocated dynamically. For LE, however, it is fixed to 0x0004. |
credit (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
Number of credit for GATT TX. |
ACI_EVENT_XM_FACTORY_RESET_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_FACTORY_RESET_STATUS |
0x80c0 |
freset_done |
Description
Report device factory reset status.
Event Parameters
freset_done (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Factory reset not done. |
0x01 |
Factory reset done. |
ACI_EVENT_XM_MUSIC_REQ_FRAME
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_MUSIC_REQ_FRAME |
0x8500 |
None |
Description
Request MCU to send the next music frame.
Event Parameters
None.
ACI_EVENT_XM_TTS_REQ_FRAME
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_TTS_REQ_FRAME |
0x8501 |
tts_state |
Description
Request MCU to send the next TTS frame.
Event Parameters
tts_state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
TTS_STATE_STARTED |
0x04 |
TTS_STATE_RESUMED |
0x06 |
TTS_STATE_ABORTING |
0x07 |
TTS_STATE_STOPPED |
ACI_EVENT_XM_RECORDING_DATA
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_RECORDING_DATA |
0x8502 |
recording_data |
Description
Report recording data format.
Event Parameters
recording_data (Size: 1024 octets)
Value |
Parameter Description |
---|---|
1024 |
Recording data. |
ACI_EVENT_XM_AUDIO_TEST_PA_ID
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_AUDIO_TEST_PA_ID |
0x8600 |
pa_id |
Description
Report PA ID.
Event Parameters
pa_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x76 |
PA ID. |
ACI_EVENT_XM_BT_AVRCP_STATUS
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_BT_AVRCP_STATUS |
0x8700 |
avrcp_state, vol_number, address |
Description
Report the AVRCP command status.
Event Parameters
avrcp_state (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x01 |
AVRCP_STATE_PLAY |
0x02 |
AVRCP_STATE_PAUSE |
0x03 |
AVRCP_STATE_STOP |
0x04 |
AVRCP_STATE_FORWARD |
0x05 |
AVRCP_STATE_BACKWARD |
0x06 |
AVRCP_STATE_VOL_CHANGED |
vol_number (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Only AVRCP_STATE_VOL_CHANGED have the Parameters. |
address (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXX |
The remote device Bluetooth address. |
ACI_EVENT_XM_BR_ATT_CONNECTED
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_BR_ATT_CONNECTED |
0x8003 |
conn_handle, cid |
Description
Reports the BR/EDR ATT protocol is connected.
Event Parameters
conn_handle (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
It starts from 0x0001. For only one BR/EDR link, it will be 0x0001. |
cid (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The L2CAP channel ID, it is currently set to 0x0000. |
ACI_EVENT_XM_BR_ATT_DISCONNECTED
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_BR_ATT_DISCONNECTED |
0x8006 |
conn_handle, cid |
Description
Report that the BR/EDR ATT protocol is disconnected.
Event Parameters
conn_handle (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
It starts from 0x0001. For only one BR/EDR link, it will be 0x0001. |
cid (Size: 2 octets)
Value |
Parameter Description |
---|---|
0xXXXX |
The L2CAP channel ID, it is currently set to 0x0000. |
ACI_EVENT_XM_USER_CONFIRMATION_REQ
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_USER_CONFIRMATION_REQ |
0x8800 |
remote_addr, cfmcode, handle_idx |
Description
Request confirmation to connect.
Event Parameters
remote_addr (Size: 6 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXXXXXX |
Remote address. |
cfmcode (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
Confirm code, need to convert to decimal. |
handle_idx (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Connect handle_idx. |
ACI_EVENT_XM_LE_USER_CONFIRMATION_REQ
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_LE_USER_CONFIRMATION_REQ |
0x8046 |
conn_id, display_value |
Description
Request LE confirmation to connect.
Event Parameters
conn_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
Connect ID. |
display_value (Size: 4 octets)
Value |
Parameter Description |
---|---|
0xXXXXXXXX |
Confirm code, need to convert to decimal. |
ACI_EVENT_XM_LE_ADV_CREATED
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_XM_LE_ADV_CREATED |
0x8048 |
adv_handle |
Description
Report adv_handle for the ADV created by ACI_CMD_XM_LE_ADV_CREATE.
Event Parameters
adv_handle (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
adv_handle |
ACI_EVENT_AMS_REGISTER_COMPLETE
Event |
Opcode |
Event Parameters |
---|---|---|
ACI_EVENT_AMS_REGISTER_COMPLETE |
0x0120 |
link_id, result |
Description
Report AMS discovery completed.
Event Parameters
link_id (Size: 1 octet)
Value |
Parameter Description |
---|---|
0xXX |
APP layer ID for LE link. |
result (Size: 1 octet)
Value |
Parameter Description |
---|---|
0x00 |
Register success. |
ACI Host CLI Tool
The ACI Host CLI Tool is a test utility that runs on a PC. It is located under the path RTL87X3E-MCU-SDK-Common-v3.1x.x.xx_20xxxxxx\tool\AciHostCLI-v1.0.0.xx-Common_SDK
and is used to demonstrate ACI usage. The tool facilitates command/event communication tests with an ACI Device via a USB serial port.

ACI Host CLI Tool
The steps to run the ACI Host CLI Tool are as follows:
Open
config.yml
to modify the device’s serial port and baud rate settings.Run
AciHostCLI.exe
to start the application.Execute mmi freset to perform a factory reset.
Enter mmi pwron to power on the device.
Wait for
EVENT_DEVICE_STATE
to return 1.
Command Introduction
BR Connection
Use case: Connection and Linkback Function.
Command |
Description |
ACI Command |
---|---|---|
connect headset_sample |
Connect to a BUD with a specific address. |
|
connect idx |
Need inquiry first, select an index, connect to that BUD. |
|
connect phone_sample |
Connect to a phone with a specific address. |
|
disconnect headset_sample |
Disconnect BUD. |
|
disconnect phone_sample |
Disconnect phone. |
Man Machine Interface
Command |
Description |
ACI Command |
---|---|---|
mmi end_outgoing_call |
End an outgoing call. |
|
mmi answer |
Answer an incoming call. |
|
mmi reject |
Reject an incoming call. |
|
mmi end_active_call |
End an active call. |
|
mmi pwron |
Power on the device. |
|
mmi pwroff |
Power off the device. |
|
mmi freset |
Device factory reset. |
SPP Transfer
Command |
Description |
ACI Command |
---|---|---|
spp t0_sig |
Send single frame data to ACI Device and relay to phone via SPP profile. |
|
spp t2_start |
Send start frame data to ACI Device and relay to phone via SPP profile. |
|
spp t3_con |
Send continue frame data to ACI Device and relay to phone via SPP profile. |
|
spp t4_end |
Send end frame data to ACI Device and relay to phone via SPP profile. |
Assign RX Buffer Size
Command |
Description |
ACI Command |
---|---|---|
assign buffer |
Assign UART RX buffer size, if set to 128, SPP/LE data will split into several frames with max size 128. |
Set Configuration
Command |
Description |
ACI Command |
---|---|---|
set le_name |
Set the LE name (Represented in UTF-8), which will be effective after restart. |
|
set legacy_name |
Set Bluetooth legacy name, which will be effective after restart. |
Get Configuration
Command |
Description |
ACI Command |
---|---|---|
get le_name |
Get the LE name (Represented in UTF-8). |
|
get legacy_name |
Get Bluetooth legacy device name. |
Get Status
Command |
Description |
ACI Command |
---|---|---|
get volume |
Get playback or HFP volume depending on scenario. |
Phone Call
Use case: HFP Function.
Command |
Description |
ACI Command |
---|---|---|
call 10086 |
Make phone call to 10086. |
|
call 10010 |
Make phone call to 10010. |
Send Message During Phone Call
Use case: Send numbers during a call, adjust SPK volume, and adjust MIC volume.
Command |
Description |
ACI Command |
---|---|---|
dtmf num_2 |
Send number 2 to phone. |
|
VGS num_1 |
Send VGS 1 to phone and set SPK. |
|
VGS num_10 |
Send VGS 10 to phone and set SPK. |
|
VGM num_6 |
Send VGM 6 to phone and set MIC. |
|
VGM num_10 |
Send VGM 10 to phone and set MIC. |
Bluetooth Address Get/Set
Command |
Description |
ACI Command |
---|---|---|
get bd_addr |
Get Bluetooth address set by MCUConfig Tool. |
|
set Bluetooth address |
Update Bluetooth MAC to new address. |
Voice Prompt Volume
Command |
Description |
ACI Command |
---|---|---|
VP volume1 |
Set voice prompt volume level to 1. |
|
VP volume9 |
Set voice prompt volume level to 9. |
Deep Low Power State Control
Command |
Description |
ACI Command |
---|---|---|
dlps enable |
Allow device to enter DLPS mode automatically. |
|
dlps disable |
Disallow device to enter DLPS mode. |
Device Mode
Command |
Description |
ACI Command |
---|---|---|
mode idle |
Disable page scan and inquiry scan. |
|
mode inq_scan |
Enable inquiry scan only. |
|
mode page_scan |
Enable page scan only. |
|
mode all_enable |
Enable inquiry scan and page scan. |
SCO Manage
Command |
Description |
ACI Command |
---|---|---|
hfp reject |
Reject SCO connection indication. |
|
hfp agree |
Accept SCO connection indication. |
|
hfp disc |
Disconnect SCO connection. |
LE Data Transfer
Command |
Description |
ACI Command |
---|---|---|
le send1 |
Send LE data to phone via transmit service. |
Volume Control
Command |
Description |
ACI Command |
---|---|---|
volume level0 |
Set volume to level 0. |
|
volume level3 |
Set volume to level 3. |
|
volume level7 |
Set volume to level 7. |
|
volume level10 |
Set volume to level 10. |
Firmware Version
Command |
Description |
ACI Command |
---|---|---|
fw version |
Get firmware version. |
Clear Bond Info
Command |
Description |
ACI Command |
---|---|---|
clear ufo |
Clear a device bond info named ufo. |
HCI Mode
Command |
Description |
ACI Command |
---|---|---|
hci download |
Enter HCI download mode. |
Inquiry
Use case: Connect to BUD.
Command |
Description |
ACI Command |
---|---|---|
inquiry start |
Start inquiry Bluetooth devices. |
|
inquiry stop |
Stop inquiry Bluetooth devices. |
RF Test
Command |
Description |
ACI Command |
---|---|---|
hci enter |
Enter HCI mode for RF test. |
Device
Command |
Description |
ACI Command |
---|---|---|
device reboot |
Software reboot. |
XMMI
Command |
Description |
ACI Command |
---|---|---|
xmmi local |
Switch to local playback mode. |
|
xmmi source |
Switch to A2DP Source music mode. |
|
xmmi clear |
Delete all bond information in bond storage. |
LE Advertising
Use case: Bluetooth Low Energy Function.
Command |
Description |
ACI Command |
---|---|---|
le advstart |
Create customized LE advertising. |
|
le advstart |
Start LE advertising. |
|
le advstop |
Stop LE advertising. |
|
le adv_data |
Update LE advertising data. |
|
le scan_rsp_data |
Update LE scan response data. |
|
le adv500ms |
Change LE advertising interval to 500ms. |
|
le adv200ms |
Change LE advertising interval to 200ms. |
LE Connect
Use case: Bluetooth Low Energy Function.
Command |
Description |
ACI Command |
---|---|---|
le disconn |
Disconnect LE link. |
|
le conn_param |
Update LE connection parameters. |
|
le mtu |
Get LE MTU size. |
Music Control
Use case: Music Play Function.
Command |
Description |
ACI Command |
---|---|---|
music open |
Open and start music session. |
|
music pause |
Pause music session. |
|
music resume |
Resume music session. |
|
music abort |
Abort music session when an unexpected situation happens. |
|
music close |
Close music session. |
|
music single |
Send single MP3 frame to device. |
Recording
Command |
Description |
ACI Command |
---|---|---|
rc start_pcm |
Start recording with the format of PCM. |
|
rc start_opus |
Start recording with the format of Opus. |
|
rc start_msbc |
Start recording with the format of mSBC. |
|
rc start_sbc |
Start recording with the format of SBC. |
|
rc start_lc3 |
Start recording with the format of LC3. |
|
rc stop |
Stop recording. |
|
rc play |
Initialize record playing. |
|
rc s |
Stop record playing. |
Audio Test
Command |
Description |
ACI Command |
---|---|---|
pa id |
Get PA chip ID. |
|
algo bypass |
Set PA and DSP into bypass mode. |
|
algo normal |
Set PA and DSP into normal mode. |
Others Debug Only
Command |
Description |
ACI Command |
---|---|---|
dis log |
Disable verbose log. |
A2DP Transfer
Transfer to A2DP Source
Use case: A2DP Transparent Transmission (A2DP Output).
Command |
Description |
ACI Command |
---|---|---|
a2dpxmitroute a2dpsrc |
Set A2DP Source as a transparent transmission play path (From SPI). |
|
a2dpxmitctrl start |
Enable A2DP Source music (From SPI). |
|
a2dpxmitctrl stop |
Disable A2DP Source music (From SPI). |
Transfer to LE Audio (Broadcast Source)
Use case: A2DP Transparent Transmission (BIS Output).
Command |
Description |
ACI Command |
---|---|---|
bsrcinit 48k_1bis |
Initialize broadcast source. |
|
a2dpxmitroute bis |
Set broadcast source as transparent transmission play path (From SPI). |
|
a2dpxmitctrl start |
Enable broadcast source music (From SPI). |
|
a2dpxmitctrl stop |
Disable broadcast source music (From SPI). |
Source Play
Use case: Source Play Function.
Command |
Description |
ACI Command |
---|---|---|
set_route_in mic |
Set input route as MIC. |
|
set_route_in linein |
Set input route as Line-in. |
|
set_route_in usb |
Set input route as USB. |
|
set_route_in sd_card |
Set input route as SD card. |
|
set_route_out A2DP |
Set output route as A2DP. |
|
set_route_out hfp_ag |
Set output route as HFP AG. |
|
set_route_out bis |
Set output route as BIS. |
|
set_route_out cis |
Set output route as CIS. |
|
set_route_out local |
Set output route as Local. |
|
attach_feature nrec |
Attach NREC to source play. |
|
attach_feature localplay |
Attach Append LOCAL PLAY to source play. |
|
attach_feature nrec_localplay |
Attach NREC and Append LOCAL PLAY to source play. |
|
detach_feature nrec |
Detach NREC from source play. |
|
detach_feature localplay |
Detach Append LOCAL PLAY on source play. |
|
detach_feature nrec_localplay |
Detach NREC and Append LOCAL PLAY from source play. |
|
route_in start |
Start input route source. |
|
route_in stop |
Stop input route source. |
|
route_out start |
Start output route play. |
|
route_out stop |
Stop output route play. |
String Mode
Command |
Description |
ACI Command |
---|---|---|
set string_mode |
Enter string mode. |
HFP Transfer
Use case: HFP Transparent Transmission.
Command |
Description |
ACI Command |
---|---|---|
hfpag conn |
Connect SCO between device and BUD. |
|
hfpag disconn |
Disconnect SCO between device and BUD. |
|
hfpag call_incoming |
Notify the incoming call. |
|
hfpag call_answer |
Answer the incoming call. |
|
hfpag call_terminate |
Terminate the outgoing call. |
|
hfpag mic_mute |
Mute the MIC. |
|
hfpag mic_unmute |
Unmute the MIC. |
|
hfpag spk_vol_up |
Turn the SPK volume up. |
|
hfpag spk_vol_down |
Turn the SPK volume down. |
Find My Action
Command |
Description |
ACI Command |
---|---|---|
findmy enter_pairing |
Enter Find My pairing mode. |
|
findmy put_serial_number |
Put the state of serial number. |
GFPS Finder Action
Command |
Description |
ACI Command |
---|---|---|
gfps_finder_ring_stop |
Stop ring. |
LEA Advertising
Command |
Description |
ACI Command |
---|---|---|
lea_adv_start |
Start LE Audio advertising. |
|
lea_adv_stop |
Stop LE Audio advertising. |
LEA CCP (F_APP_CCP_SUPPORT, CLIENT)
Command |
Description |
ACI Command |
---|---|---|
lea_call_cp accept |
Answer the incoming call on the specified link. |
|
lea_call_cp terminate |
Terminate the call on the specified link. |
|
lea_call_cp local_hold |
Move the call on the specified link to local hold status. |
|
lea_call_cp local_retrieve |
Move the call on the specified link from local hold status to active status. |
|
lea_call_cp originate |
Originate call on the specified link. |
|
lea_call_cp join |
Join the call on the specified link. |
LEA MCP (F_APP_MCP_SUPPORT, CLIENT)
Command |
Description |
ACI Command |
---|---|---|
lea_media_cp play |
Play current track. |
|
lea_media_cp pause |
Pause current track. |
|
lea_media_cp fast_rewind |
Fast rewind. |
|
lea_media_cp fast_forward |
Fast forward. |
|
lea_media_cp stop |
Stop current track. |
|
lea_media_cp previous_track |
Move to previous track. |
|
lea_media_cp next_track |
Move to next track. |
LEA SYNC INIT
Command |
Description |
ACI Command |
---|---|---|
bis_sync_init random |
Initialize the role as a sink, which will sync any device around. |
|
bis_sync_init spec |
Initialize the role as a sink, which will sync a specific device according to the address. |
|
bis_sync_init delegator |
Initialize the role as a scan delegator. |
LEA SYNC
Command |
Description |
ACI Command |
---|---|---|
bis_sync start |
Start syncing broadcast according to the initialization policy. |
|
bis_sync stop |
Stop syncing the broadcast. |
CHARGING CASE COMMANDS
Command |
Description |
ACI Command |
---|---|---|
chargingcase end_outgoing_call |
End an outgoing call. |
|
chargingcase answer_call |
Answer an incoming call. |
|
chargingcase reject_call |
Reject an incoming call. |
|
chargingcase end_active_call |
End an active call. |
|
chargingcase mic_mute_unmute |
MIC mute toggle. |
|
chargingcase mic_mute |
MIC mute. |
|
chargingcase mic_unmute |
MIC unmute. |
|
chargingcase volume_up |
Volume up. |
|
chargingcase volume_down |
Volume down. |
|
chargingcase play_pause |
AV play/pause. |
|
chargingcase av_fwd |
AV forward. |
|
chargingcase av_bwd |
AV backward. |
|
chargingcase av_fastforward |
AV fast forward. |
|
chargingcase av_rewind |
AV rewind. |
|
chargingcase gaming_mode_switch |
Switch to gaming mode. |
|
chargingcase light_sensor_on_off |
Light sensor on/off. |
|
chargingcase vp_level3 |
Set voice prompt volume level to 3. |
|
chargingcase vp_level10 |
Set voice prompt volume level to 10. |
|
chargingcase audio_eq_index_set0 |
Set audio EQ index to 0. |
|
chargingcase audio_eq_index_set1 |
Set audio EQ index to 1. |
|
chargingcase volume_level0 |
Set volume to level 0. |
|
chargingcase volume_level3 |
Set volume to level 3. |
|
chargingcase volume_level7 |
Set volume to level 7. |
|
chargingcase volume_level10 |
Set volume to level 10. |
|
chargingcase volume_level15 |
Set volume to level 15. |
|
chargingcase set_key_mmi_map_volume_up |
Set MFB as volume up button. |
|
chargingcase set_key_mmi_map_volume_down |
Set MFB as volume down button. |
LEA BAP
Command |
Description |
ACI Command |
---|---|---|
bst_start group_0_sync_0 |
Start broadcast on group 0 and sync 0. |
|
bst_start group_0_sync_1 |
Start broadcast on group 0 and sync 1. |
|
bst_start group_1_sync_0 |
Start broadcast on group 1 and sync 0. |
|
bst_start group_1_sync_1 |
Start broadcast on group 1 and sync 1. |
|
bst_stop group_0_sync_0 |
Stop broadcast on group 0 and sync 0. |
|
bst_stop group_0_sync_1 |
Stop broadcast on group 0 and sync 1. |
|
bst_stop group_1_sync_0 |
Stop broadcast on group 1 and sync 0. |
|
bst_stop group_1_sync_1 |
Stop broadcast on group 1 and sync 1. |
|
bst_remove group_0_sync_0 |
Remove broadcast on group 0 and sync 0. |
|
bst_remove group_0_sync_1 |
Remove broadcast on group 0 and sync 1. |
|
bst_remove group_1_sync_0 |
Remove broadcast on group 1 and sync 0. |
|
bst_remove group_1_sync_1 |
Remove broadcast on group 1 and sync 1. |
|
baas scan |
Start extended scan for BAAS. |
|
pa_sync dev0 |
PA sync with device 0. |
|
pa_sync dev1 |
PA sync with device 1. |
|
pa_sync dev2 |
PA sync with device 2. |
LEA VCP VOLUME CONTROL
Command |
Description |
ACI Command |
---|---|---|
gvcs volume |
Set VCS volume. |
|
gvcs mute |
Set VCS mute. |
|
gvcs unmute |
Set VCS unmute. |
UART DFU
Command |
Description |
ACI Command |
---|---|---|
dfu start |
Start DFU process through UART. |
|
dfu abort |
Abort DFU process. |
|
dfu get_ver |
Get device’s version. |
|
dfu test_enable |
Enable test mode to downgrade. |
LEA VCS
Command |
Description |
ACI Command |
---|---|---|
lea_vcs vol_up |
Volume up. |
|
lea_vcs vol_down |
Volume down. |
|
lea_vcs spk_mute |
SPK mute. |
|
lea_vcs spk_unmute |
SPK unmute. |
LEA CCP (CCP_CALL_CONTROL_SERVER)
Command |
Description |
ACI Command |
---|---|---|
ccp_action incomingcall |
Incoming call action. |
|
ccp_action local_accept1 |
Local accept call index 1. |
|
ccp_action local_accept2 |
Local accept call index 2. |
|
ccp_action local_terminate1 |
Local terminate call index 1. |
|
ccp_action local_terminate2 |
Local terminate call index 2. |
LEA MCP (MCP_MEDIA_CONTROL_SERVER)
Command |
Description |
ACI Command |
---|---|---|
mcp_state playing |
The media player starts playing the current track. |
|
mcp_state paused |
The media player paused the current track. |
|
mcp_notify track_changed |
Send track changed notification. |
|
mcp_notify track_duration |
Send track duration notification. |
|
mcp_notify track_position |
Send track position notification. |
LEA MICP MIC CONTROL
Command |
Description |
ACI Command |
---|---|---|
gmic mute |
Set GMIC MIC mute. |
|
gmic unmute |
Set GMIC MIC unmute. |