Audio Agent Notifications¶
Audio Agent uses ‘notifications’, or text prompts, to notify the host of events in the Bluetooth link (for example, completed commands or incoming connections), to provide information, or to require action. Notifications are generated only when Audio Agent is in command or remote configuration mode.
The syntax used is NOTIFICATION [link_ID](Parameter).
Event |
Description |
|---|---|
A2DP_STEAM_START [link_ID] |
Indicates that the A2DP media stream has been opened. One or more of these messages may be displayed when the remote or local side has requested the A2DP media channel state to change. Please note that an open media stream does not guarantee that there is an active music stream. |
A2DP_STEAM_SUSPEND [link_ID] |
Indicates that the A2DP media stream has been suspended. One or more of these messages may be displayed when the remote or local side has requested the A2DP media channel state to change. Please note that an a media stream suspend may come sometime after the active music stream has ended, or depending on phone implementation, may not come at all. |
ABS_VOL [link_ID](value) |
The current absolute volume set as an integer in the range 0 – 127 (representing 0 – 100% as per spec). |
AT [link_ID] (length) (data) |
Indicates that the remote device sent an AT command or AT reply. The reply is sent over UART as is without modification. The length indicates the length of the data. |
AVRCP_MEDIA [link_ID](property: value) |
ARTIST: string TITLE: string ALBUM: string NUMBER: integer TOTAL_NUMBER: integer PLAYING_TIME(MS): integer |
AVRCP_PLAY [link_ID] |
When an AVRCP play event is received from the remote device |
AVRCP_STOP [link_ID] |
When an AVRCP stop event is received from the remote device |
AVRCP_PAUSE [link_ID] |
When an AVRCP pause event is received from the remote device |
AVRCP_FORWARD [link_ID] |
When an AVRCP forward event is received from the remote device |
AVRCP_BACKWARD [link_ID] |
When an AVRCP backward event is received from the remote device |
BLE_CHAR [link_ID] type uuid handle |
Characteristic discovered: link_id: link of the peripheral device type: U16(16bits UUID) or U128(128bits UUID) uuid: Characteristic UUID (XXXX or XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) handle: Handle of the characteristic in hex |
BLE_INDICATION [link_ID] handle size data |
Indication received from a peripheral device. link_id: link of the peripheral device handle: Handle of the characteristic in hex size: Length of the characteristic value in bytes data: Characteristic value (hex) |
BLE_NOTIFICATION [link_ID] handle size data |
Notification received from a peripheral device. link_id: link of the peripheral device handle: Handle of the characteristic in hex size: Length of the characteristic value in bytes data: Characteristic value (hex) |
BLE_READ [link_ID] handle |
Read request from a central device. Must use BLE_READ_RES to respond. link_id: link of the central device handle: Handle of the characteristic in hex |
BLE_READ_RES [link_ID] handle size data |
Read response from a peripheral device. link_id: link of the peripheral device handle: Handle of the characteristic in hex size: Length of the characteristic value in bytes data: Characteristic value (hex) |
BLE_SERV [link_ID] type uuid handle |
Primary service discovered: link_id: link of the peripheral device type: U16(16bits UUID) or U128(128bits UUID) uuid: Service UUID (XXXX or XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) handle: Handle of the service in hex |
BLE_WRITE [link_ID] handle size data |
Write indication. link_id: link of the central device handle: Handle of the characteristic written in hex size: Length of the characteristic value in bytes data: Characteristic value (hex) |
CALL_ACTIVE AGHFP [link_ID] |
Notifies that there is an active call on the specified AGHFP link |
CALL_ACTIVE HFP [link_ID] |
Notifies an active call on the specified HFP link. |
CALL_DIAL AGHFP [link_ID] (number) |
Notifies that the HFP connected with the AGHFP on the link specified wants to establish an outgoing call to the number specified. |
CALL_END AGHFP [link_ID] |
Notifies that a call termination on the AGHFP link specified. |
CALL_IDLE HFP [link_ID] |
Notifies that there are no outgoing, incoming or active calls on the HFP link specified. |
CALL_INCOMING AGHFP [link_ID] |
Notifies that there is an incoming call procedure on the AGHFP link specified. |
CALL_INCOMING HFP [link_ID] |
Notifies that there is an incoming call procedure on the HFP link specified. |
CALL_MEMORY AGHFP [link_ID] (mem_string) |
Notifies that the HF connected to the AGHFP on the link specified wants to establish an outgoing call using memory dialling with the memory string specified. The memory string is AG specific. |
CALL_OUTGOING AGHFP [link_ID] |
Notifies that there is an outgoing call procedure on the AGHFP link specified. |
CALL_OUTGOING HFP [link_ID] |
Notifies that there is an outgoing call procedure on the HFP link specified. |
CALL_REDIAL AGHFP [link_ID] |
Notifies that the HF connected to the AGHFP link specified wants to establish a call to the last number dialled. |
CALLER_NUMBER [lind_ID] [number] |
Notifies the number of the incoming call. |
CAPSENSE (PAD) (DIRECTION) |
Notifies when a cap sense pad has changed. PAD can be 0-5 and DIRECTION is UP when pressing the pad or DOWN when releasing it. |
CHARGING IN PROGRESS |
The charger is currently charging the battery. |
CHARGING COMPLETE |
The battery is charged and the charger is in standby mode. |
CHARGER DISCONNECTED |
The charger has been disconnected. |
CLOSE_OK [link_ID] (profile) |
A connection has been closed for the link indicated. |
CLOSE_ERROR [link_ID] (profile) |
A connection could not be closed for the link indicated. |
CVC_CFG (TYPE)(KEY)[value] |
TYPE – WB or NB for wideband and narrowband CVC keys. KEY is the key id 0 – 3; Value – is the key value in ASCII representation of 16bit hexadecimal words. Value will not be present if the key is empty. |
DMTF AGHFP [link_ID] (code) |
The HF connected to the AGHFP on the link specified requests the AGHFP to send the following DTMF code to the network. |
ERROR 0xXXXX |
An error with a code is returned when a command has not been executed or the parameters are not correct. You can refer to the error codes in the appendix to find out more about the issue. |
HID_READ size value |
Read HID descriptor. size is the number of bytes. value is the descriptor in hex. |
HID_READ_ERROR |
Failed to read HID descriptor. |
INBAND_RING AGHFP[link_ID] |
Ring indicator received periodically when there is an incoming call. |
INQU_OK |
Indicates the end of the inquiry. |
INQUIRY(BDADDR)(NAME)(COD) (RSSI) |
Returned after an INQUIRY command is used if there are discoverable devices nearby. Returns Bluetooth address, name, class of device and RSSI |
LINK_LOSS [link_ID] (status) |
Link Loss notification for a specific link (HFP or A2DP). status=1 indicates a link loss. Audio Agent will try to reconnect. status=0 indicates that the link loss has been recovered. |
MAP_NEW_SMS [link_ID] |
Notifies that a new SMS has been received on the link. |
MAP_MSG_BEGIN [link_ID] |
Returned when a message data is going to be sent to the host. |
MAP_MSG_END [link_ID] |
Returned when a message data was completely sent to the host. |
NAME [addr] [remote_name] |
Returned the BT address and the name of a remote device in response to a NAME command. |
OPEN_ERROR [link_ID] (profile) |
A connection has failed or there was a link loss for the profile indicated. |
OPEN_OK [link_ID] (profile) (Bluetooth address) |
A connection has been successfully established for the profile indicated. |
PAIR_ERROR (Bluetooth address) |
When the module fails to pair with the remote device with the address specified. |
PAIR_OK (Bluetooth address) |
When the module successfully pairs with the remote device with the address specified. |
PAIR_PASSKEY (BDADDRESS) (TYPE) [PASSKEY] |
A SSP passkey request is being made. Depending on type these may require user action. TYPE: 0 – Passkey request. Enter passkey using the PASSKEY command 1 – Confirm passkey. Display passkey and have user confirm passkey using the PASSKEY command 2 – Display passkey. Display passkey for user. Note: the PASSKEY parameter will not be supplied for type 0. |
PAIR_PENDING |
When the module is starting to pair with a remote device. |
PB_PULL_START [link_ID] |
Returned when a phonebook data is going to be sent to the host. |
PB_PULL_END [link_ID] |
Returned when a phonebook data was completely sent to the host. |
PB_PULL_OK |
Returned when the phonebook download has been completed or aborted. |
PXP IMM (level) |
Proximity Profile, Immediate Alert Service alert level set to: 0 – No Alert; 1- Mild Alert, 2 – High Alert |
PXP LLA (level) |
Proximity Profile, Link Loss Service alert level set to: 0 – No Alert; 1- Mild Alert, 2 – High Alert |
READY |
Audio Agent is ready to take commands |
RECV [link_ID] (size) (report data) |
Data received from a BLE, HID or SPP link. |
ROLE (BT ADDRESS)<role> |
When the remove device changes the classic role, an indication event will be sent to the host with the remote device request a role change. |
ROLE_OK <role> |
Successful change of the classic role when the ROLE command was sent by the host. |
ROLE_NOT_ALLOWED <role> |
Failure to change the classic role. This is reached when the remote device refuses the role change requested by the host. |
SCAN (BT ADDRESS)(TYPE)(<BT SHORT NAME> ) (ADVERTISING FLAGS) (RSSI) |
Returned after calling SCAN and contains information about advertising devices. Type is 0 when the address is public and 1 when it is a randomly generated address. If the advertising data does not contain a short name, UNKNOWN will be displayed. The Advertising flags indicate device capabilities: 0x0A indicated this is a General Discoverable Dual Mode device (such as Audio Agent), 0x02 indicates this is a General Discoverable Single mode device (such as Audio Agent Smart) |
SCAN_OK |
Indicates the end of the scan. |
SCAN_RAW (BT ADDRESS) (RSSI) (size) (data) |
Returned after calling SCAN with the parameter raw_data ON. size is the length of the advertising data in decimal. data is the advertising data, in hexadecimal. |
SCO_OPEN (link_ID) |
A SCO connection has been opened and audio is routed. |
SCO_CLOSE (link_ID) |
A SCO connection has been closed and audio is no longer routed. |
SR: YES |
“YES” has been detected with Speech Recognition |
SR: NO |
“NO” has been detected with Speech Recognition |
SR: Unrecognised word |
An unrecognised word has been detected with Speech Recognition |