Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Hands Free Profile (HFP)

Hands Free Profile (HFP) . More...

Data Structures

struct  bt_hfp_hf_cmd_complete
 HFP HF Command completion field. More...
 
struct  bt_hfp_hf_cb
 HFP profile application callback. More...
 

Macros

#define HFP_HF_CMD_OK   0
 
#define HFP_HF_CMD_ERROR   1
 
#define HFP_HF_CMD_CME_ERROR   2
 
#define HFP_HF_CMD_UNKNOWN_ERROR   4
 

Enumerations

enum  bt_hfp_hf_at_cmd { BT_HFP_HF_ATA , BT_HFP_HF_AT_CHUP }
 

Functions

int bt_hfp_hf_register (struct bt_hfp_hf_cb *cb)
 Register HFP HF profile.
 
int bt_hfp_hf_send_cmd (struct bt_conn *conn, enum bt_hfp_hf_at_cmd cmd)
 Handsfree client Send AT.
 

Detailed Description

Hands Free Profile (HFP) .

Macro Definition Documentation

◆ HFP_HF_CMD_CME_ERROR

#define HFP_HF_CMD_CME_ERROR   2

◆ HFP_HF_CMD_ERROR

#define HFP_HF_CMD_ERROR   1

◆ HFP_HF_CMD_OK

#define HFP_HF_CMD_OK   0

◆ HFP_HF_CMD_UNKNOWN_ERROR

#define HFP_HF_CMD_UNKNOWN_ERROR   4

Enumeration Type Documentation

◆ bt_hfp_hf_at_cmd

#include <zephyr/bluetooth/classic/hfp_hf.h>

Enumerator
BT_HFP_HF_ATA 
BT_HFP_HF_AT_CHUP 

Function Documentation

◆ bt_hfp_hf_register()

int bt_hfp_hf_register ( struct bt_hfp_hf_cb * cb)

#include <zephyr/bluetooth/classic/hfp_hf.h>

Register HFP HF profile.

Register Handsfree profile callbacks to monitor the state and get the required HFP details to display.

Parameters
cbcallback structure.
Returns
0 in case of success or negative value in case of error.

◆ bt_hfp_hf_send_cmd()

int bt_hfp_hf_send_cmd ( struct bt_conn * conn,
enum bt_hfp_hf_at_cmd cmd )

#include <zephyr/bluetooth/classic/hfp_hf.h>

Handsfree client Send AT.

Send specific AT commands to handsfree client profile.

Parameters
connConnection object.
cmdAT command to be sent.
Returns
0 in case of success or negative value in case of error.