HFP DEFINES¶

API Reference¶

Header File¶

bt/host/bluedroid/api/include/api/esp_hf_defs.h

Macros¶

ESP_BT_HF_NUMBER_LEN¶

ESP_BT_HF_OPERATOR_NAME_LEN¶

BTC_HSAG_SERVICE_NAME¶

BTC_HFAG_SERVICE_NAME¶

BTC_HF_SERVICES¶

BTC_HF_SERVICE_NAMES¶

BTC_HF_SECURITY¶

BTC_HF_CALL_END_TIMEOUT¶

BTC_HF_INVALID_IDX¶

Type Definitions¶

typedef void (*esp_hf_connection_state_callback)(esp_hf_connection_state_t state, esp_bd_addr_t *bd_addr)¶: Callback for connection state change. state will have one of the values from BtHfConnectionState

typedef void (*esp_hf_audio_state_callback)(esp_hf_audio_state_t state, esp_bd_addr_t *bd_addr)¶: Callback for audio connection state change. state will have one of the values from BtHfAudioState

typedef void (*esp_hf_vr_cmd_callback)(esp_hf_vr_state_t state, esp_bd_addr_t *bd_addr)¶: Callback for VR connection state change. state will have one of the values from BtHfVRState

typedef void (*esp_hf_answer_call_cmd_callback)(esp_bd_addr_t *bd_addr)¶: Callback for answer incoming call (ATA)

typedef void (*esp_hf_hangup_call_cmd_callback)(esp_bd_addr_t *bd_addr)¶: Callback for disconnect call (AT+CHUP)

typedef void (*esp_hf_volume_cmd_callback)(esp_hf_volume_control_target_t type, int volume, esp_bd_addr_t *bd_addr)¶: Callback for disconnect call (AT+CHUP) type will denote Speaker/Mic gain (BtHfVolumeControl).

typedef void (*esp_hf_dial_call_cmd_callback)(char *number, esp_bd_addr_t *bd_addr)¶: Callback for dialing an outgoing call If number is NULL, redial

typedef void (*esp_hf_dtmf_cmd_callback)(char tone, esp_bd_addr_t *bd_addr)¶: Callback for sending DTMF tones tone contains the dtmf character to be sent

typedef void (*esp_hf_nrec_cmd_callback)(esp_hf_nrec_t nrec, esp_bd_addr_t *bd_addr)¶: Callback for enabling/disabling noise reduction/echo cancellation value will be 1 to enable, 0 to disable

typedef void (*esp_hf_wbs_callback)(esp_hf_wbs_config_t wbs, esp_bd_addr_t *bd_addr)¶: Callback for AT+BCS and event from BAC WBS enable, WBS disable

typedef void (*esp_hf_chld_cmd_callback)(esp_hf_chld_type_t chld, esp_bd_addr_t *bd_addr)¶: Callback for call hold handling (AT+CHLD) value will contain the call hold command (0, 1, 2, 3)

typedef void (*esp_hf_cnum_cmd_callback)(esp_bd_addr_t *bd_addr)¶: Callback for CNUM (subscriber number)

typedef void (*esp_hf_cind_cmd_callback)(esp_bd_addr_t *bd_addr)¶: Callback for indicators (CIND)

typedef void (*esp_hf_cops_cmd_callback)(esp_bd_addr_t *bd_addr)¶: Callback for operator selection (COPS)

typedef void (*esp_hf_clcc_cmd_callback)(esp_bd_addr_t *bd_addr)¶: Callback for call list (AT+CLCC)

typedef void (*esp_hf_unknown_at_cmd_callback)(char *at_string, esp_bd_addr_t *bd_addr)¶: Callback for unknown AT command recd from AG at_string will contain the unparsed AT string

typedef void (*esp_hf_key_pressed_cmd_callback)(esp_bd_addr_t *bd_addr)¶: Callback for keypressed (HSP) event.

Enumerations¶

enum esp_hf_in_band_ring_state_t¶

in-band ring tone state

Values:

ESP_HF_IN_BAND_RINGTONE_NOT_PROVIDED = 0¶

ESP_HF_IN_BAND_RINGTONE_PROVIDED¶

enum esp_hf_vr_state_t¶

voice recognition state

Values:

ESP_HF_VR_STATE_DISABLED = 0¶: voice recognition disabled

ESP_HF_VR_STATE_ENABLED¶: voice recognition enabled

enum esp_hf_volume_control_target_t¶

Bluetooth HFP audio volume control target.

Values:

ESP_HF_VOLUME_CONTROL_TARGET_SPK = 0¶: speaker

ESP_HF_VOLUME_CONTROL_TARGET_MIC¶: microphone

enum esp_hf_audio_state_t¶

Bluetooth HFP audio connection status.

Values:

ESP_HF_AUDIO_STATE_DISCONNECTED = 0¶: audio connection released

ESP_HF_AUDIO_STATE_CONNECTING¶: audio connection has been initiated

ESP_HF_AUDIO_STATE_CONNECTED¶: audio connection is established

ESP_HF_AUDIO_STATE_CONNECTED_MSBC¶: mSBC audio connection is established

enum esp_hf_volume_type_t¶

Values:

ESP_HF_VOLUME_TYPE_SPK = 0¶

ESP_HF_VOLUME_TYPE_MIC¶

enum esp_hf_network_state_t¶

+CIND network service availability status

Values:

ESP_HF_NETWORK_STATE_NOT_AVAILABLE = 0¶

ESP_HF_NETWORK_STATE_AVAILABLE¶

enum esp_hf_service_type_t¶

+CIEV Service type

Values:

ESP_HF_SERVICE_TYPE_HOME = 0¶

ESP_HF_SERVICE_TYPE_ROAMING¶

enum esp_hf_call_status_t¶

+CIND call status indicator values

Values:

ESP_HF_CALL_STATUS_NO_CALLS = 0¶: no call in progress

ESP_HF_CALL_STATUS_CALL_IN_PROGRESS = 1¶: call is present(active or held)

enum esp_hf_call_setup_status_t¶

+CIND call setup status indicator values

Values:

ESP_HF_CALL_SETUP_STATUS_IDLE = 0¶: no call setup in progress

ESP_HF_CALL_SETUP_STATUS_INCOMING = 1¶: incoming call setup in progress

ESP_HF_CALL_SETUP_STATUS_OUTGOING_DIALING = 2¶: outgoing call setup in dialing state

ESP_HF_CALL_SETUP_STATUS_OUTGOING_ALERTING = 3¶: outgoing call setup in alerting state

enum esp_hf_roaming_status_t¶

+CIND roaming status indicator values

Values:

ESP_HF_ROAMING_STATUS_INACTIVE = 0¶: roaming is not active

ESP_HF_ROAMING_STATUS_ACTIVE¶: a roaming is active

enum esp_hf_call_held_status_t¶

+CIND call held indicator values

Values:

ESP_HF_CALL_HELD_STATUS_NONE = 0¶: no calls held

ESP_HF_CALL_HELD_STATUS_HELD_AND_ACTIVE = 1¶: both active and held call

ESP_HF_CALL_HELD_STATUS_HELD = 2¶: call on hold, no active call

enum esp_hf_current_call_status_t¶

+CLCC status of the call

Values:

ESP_HF_CURRENT_CALL_STATUS_ACTIVE = 0¶: active

ESP_HF_CURRENT_CALL_STATUS_HELD = 1¶: held

ESP_HF_CURRENT_CALL_STATUS_DIALING = 2¶: dialing (outgoing calls only)

ESP_HF_CURRENT_CALL_STATUS_ALERTING = 3¶: alerting (outgoing calls only)

ESP_HF_CURRENT_CALL_STATUS_INCOMING = 4¶: incoming (incoming calls only)

ESP_HF_CURRENT_CALL_STATUS_WAITING = 5¶: waiting (incoming calls only)

ESP_HF_CURRENT_CALL_STATUS_HELD_BY_RESP_HOLD = 6¶: call held by response and hold

enum esp_hf_current_call_direction_t¶

+CLCC direction of the call

Values:

ESP_HF_CURRENT_CALL_DIRECTION_OUTGOING = 0¶: outgoing

ESP_HF_CURRENT_CALL_DIRECTION_INCOMING = 1¶: incoming

enum esp_hf_current_call_mpty_type_t¶

+CLCC multi-party call flag

Values:

ESP_HF_CURRENT_CALL_MPTY_TYPE_SINGLE = 0¶: not a member of a multi-party call

ESP_HF_CURRENT_CALL_MPTY_TYPE_MULTI = 1¶: member of a multi-party call

enum esp_hf_current_call_mode_t¶

+CLCC call mode

Values:

ESP_HF_CURRENT_CALL_MODE_VOICE = 0¶

ESP_HF_CURRENT_CALL_MODE_DATA = 1¶

ESP_HF_CURRENT_CALL_MODE_FAX = 2¶

enum esp_hf_call_addr_type_t¶

+CLCC address type

Values:

ESP_HF_CALL_ADDR_TYPE_UNKNOWN = 0x81¶: unkown address type

ESP_HF_CALL_ADDR_TYPE_INTERNATIONAL = 0x91¶: international address

enum esp_hf_subscriber_service_type_t¶

+CNUM service type of the phone number

Values:

ESP_HF_SUBSCRIBER_SERVICE_TYPE_UNKNOWN = 0¶: unknown

ESP_HF_SUBSCRIBER_SERVICE_TYPE_VOICE¶: voice service

ESP_HF_SUBSCRIBER_SERVICE_TYPE_FAX¶: fax service

enum esp_hf_btrh_status_t¶

+BTRH response and hold result code

Values:

ESP_HF_BTRH_STATUS_HELD = 0¶: incoming call is put on held in AG

ESP_HF_BTRH_STATUS_ACCEPTED¶: held incoming call is accepted in AG

ESP_HF_BTRH_STATUS_REJECTED¶: held incoming call is rejected in AG

enum esp_hf_btrh_cmd_t¶

AT+BTRH response and hold action code.

Values:

ESP_HF_BTRH_CMD_HOLD = 0¶: put the incoming call on hold

ESP_HF_BTRH_CMD_ACCEPT = 1¶: accept a held incoming call

ESP_HF_BTRH_CMD_REJECT = 2¶: reject a held incoming call

enum esp_hf_nrec_t¶

Values:

ESP_HF_NREC_STOP = 0¶

ESP_HF_NREC_START¶

enum esp_hf_call_waiting_status_t¶

+CCWA resposne status

Values:

ESP_HF_CALL_WAITING_INACTIVE¶

ESP_HF_CALL_WAITING_ACTIVE¶

enum esp_hf_wbs_config_t¶

Values:

ESP_HF_WBS_NONE¶

ESP_HF_WBS_NO¶

ESP_HF_WBS_YES¶

enum esp_hf_connection_state_t¶

Bluetooth HFP RFCOMM connection and service level connection status.

Values:

ESP_HF_CONNECTION_STATE_DISCONNECTED = 0¶: RFCOMM data link channel released

ESP_HF_CONNECTION_STATE_CONNECTING¶: connecting remote device on the RFCOMM data link

ESP_HF_CONNECTION_STATE_CONNECTED¶: RFCOMM connection established

ESP_HF_CONNECTION_STATE_SLC_CONNECTED¶: service level connection established

ESP_HF_CONNECTION_STATE_DISCONNECTING¶: disconnecting with remote device on the RFCOMM data link

enum esp_hf_chld_type_t¶

AT+CHLD command values.

Values:

ESP_HF_CHLD_TYPE_REL = 0¶: <0>, Terminate all held or set UDUB(“busy”) to a waiting call

ESP_HF_CHLD_TYPE_REL_ACC¶: <1>, Terminate all active calls and accepts a waiting/held call

ESP_HF_CHLD_TYPE_HOLD_ACC¶: <2>, Hold all active calls and accepts a waiting/held call

ESP_HF_CHLD_TYPE_MERGE¶: <3>, Add all held calls to a conference

ESP_HF_CHLD_TYPE_MERGE_DETACH¶: <4>, connect the two calls and disconnects the subscriber from both calls

ESP_HF_CHLD_TYPE_REL_X¶: <1x>, releases specified calls only

ESP_HF_CHLD_TYPE_PRIV_X¶: <2x>, request private consultation mode with specified call

enum esp_hf_at_response_code_t¶

Values:

ESP_HF_AT_RESPONSE_CODE_OK = 0¶: acknowledges execution of a command line

ESP_HF_AT_RESPONSE_CODE_ERR¶: command not accepted

ESP_HF_AT_RESPONSE_CODE_NO_CARRIER¶: connection terminated

ESP_HF_AT_RESPONSE_CODE_BUSY¶: busy signal detected

ESP_HF_AT_RESPONSE_CODE_NO_ANSWER¶: connection completion timeout

ESP_HF_AT_RESPONSE_CODE_DELAYED¶: delayed

ESP_HF_AT_RESPONSE_CODE_BLACKLISTED¶: blacklisted

ESP_HF_AT_RESPONSE_CODE_CME¶: CME error

enum esp_hf_at_response_t¶

Values:

ESP_HF_AT_RESPONSE_ERROR = 0¶

ESP_HF_AT_RESPONSE_OK¶

enum esp_hf_cme_err_t¶

Extended Audio Gateway Error Result Code Response.

Values:

ESP_HF_CME_AG_FAILURE = 0¶: ag failure

ESP_HF_CME_NO_CONNECTION_TO_PHONE = 1¶: no connection to phone

ESP_HF_CME_OPERATION_NOT_ALLOWED = 3¶: operation not allowed

ESP_HF_CME_OPERATION_NOT_SUPPORTED = 4¶: operation not supported

ESP_HF_CME_PH_SIM_PIN_REQUIRED = 5¶: PH-SIM PIN Required

ESP_HF_CME_SIM_NOT_INSERTED = 10¶: SIM not inserted

ESP_HF_CME_SIM_PIN_REQUIRED = 11¶: SIM PIN required

ESP_HF_CME_SIM_PUK_REQUIRED = 12¶: SIM PUK required

ESP_HF_CME_SIM_FAILURE = 13¶: SIM failure

ESP_HF_CME_SIM_BUSY = 14¶: SIM busy

ESP_HF_CME_INCORRECT_PASSWORD = 16¶: incorrect password

ESP_HF_CME_SIM_PIN2_REQUIRED = 17¶: SIM PIN2 required

ESP_HF_CME_SIM_PUK2_REQUIRED = 18¶: SIM PUK2 required

ESP_HF_CME_MEMEORY_FULL = 20¶: memory full

ESP_HF_CME_INVALID_INDEX = 21¶: invalid index

ESP_HF_CME_MEMEORY_FAILURE = 23¶: memory failure

ESP_HF_CME_TEXT_STRING_TOO_LONG = 24¶: test string too long

ESP_HF_CME_INVALID_CHARACTERS_IN_TEXT_STRING = 25¶: invalid characters in text string

ESP_HF_CME_DIAL_STRING_TOO_LONG = 26¶: dial string too long

ESP_HF_CME_INVALID_CHARACTERS_IN_DIAL_STRING = 27¶: invalid characters in dial string

ESP_HF_CME_NO_NETWORK_SERVICE = 30¶: no network service

ESP_HF_CME_NETWORK_TIMEOUT = 31¶: network timeout

ESP_HF_CME_NETWORK_NOT_ALLOWED = 32¶: network not allowed emergency calls only

Provide feedback about this document