HFP DEFINES

Overview

Instructions

API Reference

Enumerations

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_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_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_NONE = 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_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_service_availability_status_t

+CIND network service availability status

Values:

ESP_HF_SERVICE_AVAILABILITY_STATUS_UNAVAILABLE = 0

service not available

ESP_HF_SERVICE_AVAILABILITY_STATUS_AVAILABLE

service available

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:

unkown address type

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_at_response_code_t

response indication codes for AT commands

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_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_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_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