XFusion API v1.3.0
载入中...
搜索中...
未找到
结构体 | 宏定义 | 类型定义 | 枚举 | 函数
gap
xf_ble

Generic Attribute Profile 更多...

gap 的协作图:

结构体

union  _xf_ble_gap_adv_struct_data_t
 BLE GAP 广播数据单元的数据 ( AD Data ) 更多...
 
struct  xf_ble_gap_adv_struct_t
 BLE GAP 广播数据单元 ( AD structure ） 更多...
 
struct  xf_ble_gap_adv_data_t
 BLE GAP 广播数据 ( 包含响应数据 ) 更多...
 
struct  xf_ble_gap_adv_param_t
 BLE GAP 广播参数 更多...
 
struct  xf_ble_gap_scan_param_t
 BLE GAP 扫描参数 更多...
 
struct  xf_ble_gap_conn_param_update_t
 BLE GAP 连接参数更新数据结构 更多...
 

宏定义

#define XF_BLE_APPEARANCE_UNKNOWN   0x0000
 
#define XF_BLE_APPEARANCE_GENERIC_PHONE   0x0040
 
#define XF_BLE_APPEARANCE_GENERIC_COMPUTER   0x0080
 
#define XF_BLE_APPEARANCE_GENERIC_WATCH   0x00C0
 
#define XF_BLE_APPEARANCE_SPORTS_WATCH   0x00C1
 
#define XF_BLE_APPEARANCE_GENERIC_CLOCK   0x0100
 
#define XF_BLE_APPEARANCE_GENERIC_DISPLAY   0x0140
 
#define XF_BLE_APPEARANCE_GENERIC_REMOTE   0x0180
 
#define XF_BLE_APPEARANCE_GENERIC_EYEGLASSES   0x01C0
 
#define XF_BLE_APPEARANCE_GENERIC_TAG   0x0200
 
#define XF_BLE_APPEARANCE_GENERIC_KEYRING   0x0240
 
#define XF_BLE_APPEARANCE_GENERIC_MEDIA_PLAYER   0x0280
 
#define XF_BLE_APPEARANCE_GENERIC_BARCODE_SCANNER   0x02C0
 
#define XF_BLE_APPEARANCE_GENERIC_THERMOMETER   0x0300
 
#define XF_BLE_APPEARANCE_THERMOMETER_EAR   0x0301
 
#define XF_BLE_APPEARANCE_GENERIC_HEART_RATE   0x0340
 
#define XF_BLE_APPEARANCE_HEART_RATE_BELT   0x0341
 
#define XF_BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE   0x0380
 
#define XF_BLE_APPEARANCE_BLOOD_PRESSURE_ARM   0x0381
 
#define XF_BLE_APPEARANCE_BLOOD_PRESSURE_WRIST   0x0382
 
#define XF_BLE_APPEARANCE_GENERIC_HID   0x03C0
 
#define XF_BLE_APPEARANCE_HID_KEYBOARD   0x03C1
 
#define XF_BLE_APPEARANCE_HID_MOUSE   0x03C2
 
#define XF_BLE_APPEARANCE_HID_JOYSTICK   0x03C3
 
#define XF_BLE_APPEARANCE_HID_GAMEPAD   0x03C4
 
#define XF_BLE_APPEARANCE_HID_DIGITIZER_TABLET   0x03C5
 
#define XF_BLE_APPEARANCE_HID_CARD_READER   0x03C6
 
#define XF_BLE_APPEARANCE_HID_DIGITAL_PEN   0x03C7
 
#define XF_BLE_APPEARANCE_HID_BARCODE_SCANNER   0x03C8
 
#define XF_BLE_APPEARANCE_GENERIC_GLUCOSE   0x0400
 
#define XF_BLE_APPEARANCE_GENERIC_WALKING   0x0440
 
#define XF_BLE_APPEARANCE_WALKING_IN_SHOE   0x0441
 
#define XF_BLE_APPEARANCE_WALKING_ON_SHOE   0x0442
 
#define XF_BLE_APPEARANCE_WALKING_ON_HIP   0x0443
 
#define XF_BLE_APPEARANCE_GENERIC_CYCLING   0x0480
 
#define XF_BLE_APPEARANCE_CYCLING_COMPUTER   0x0481
 
#define XF_BLE_APPEARANCE_CYCLING_SPEED   0x0482
 
#define XF_BLE_APPEARANCE_CYCLING_CADENCE   0x0483
 
#define XF_BLE_APPEARANCE_CYCLING_POWER   0x0484
 
#define XF_BLE_APPEARANCE_CYCLING_SPEED_CADENCE   0x0485
 
#define XF_BLE_APPEARANCE_GENERIC_PULSE_OXIMETER   0x0C40
 
#define XF_BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP   0x0C41
 
#define XF_BLE_APPEARANCE_PULSE_OXIMETER_WRIST   0x0C42
 
#define XF_BLE_APPEARANCE_GENERIC_WEIGHT   0x0C80
 
#define XF_BLE_APPEARANCE_GENERIC_PERSONAL_MOBILITY_DEVICE   0x0CC0
 
#define XF_BLE_APPEARANCE_POWERED_WHEELCHAIR   0x0CC1
 
#define XF_BLE_APPEARANCE_MOBILITY_SCOOTER   0x0CC2
 
#define XF_BLE_APPEARANCE_GENERIC_CONTINUOUS_GLUCOSE_MONITOR   0x0D00
 
#define XF_BLE_APPEARANCE_GENERIC_INSULIN_PUMP   0x0D40
 
#define XF_BLE_APPEARANCE_INSULIN_PUMP_DURABLE_PUMP   0x0D41
 
#define XF_BLE_APPEARANCE_INSULIN_PUMP_PATCH_PUMP   0x0D44
 
#define XF_BLE_APPEARANCE_INSULIN_PEN   0x0D48
 
#define XF_BLE_APPEARANCE_GENERIC_MEDICATION_DELIVERY   0x0D80
 
#define XF_BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS   0x1440
 
#define XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION   0x1441
 
#define XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_AND_NAV   0x1442
 
#define XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD   0x1443
 
#define XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD_AND_NAV   0x1444
 
#define XF_BLE_GAP_ADV_STRUCT_AD_TYPE_FIELD_SIZE   1
 BLE GAP 广播数据单元类型 (AD_TYPE) 字段的大小
 
#define XF_BLE_GAP_ADV_STRUCT_LEN_FIELD_SIZE   1
 BLE GAP 广播数据单元数据长度 (LEN) 字段的大小
 
#define XF_BLE_ADV_STRUCT_TYPE_ARRAY(type_name, adv_data_array_size)
 定义一个严格遵循蓝牙标准的广播数据单元结构，单元数据 ( AD Data ) 为数组的类型
 
#define XF_BLE_ADV_STRUCT_TYPE_VAL_U8(type_name)
 定义一个严格遵循蓝牙标准的广播数据单元结构，单元数据 ( AD Data ) 为 uint8_t 的类型
 
#define XF_BLE_ADV_STRUCT_TYPE_VAL_U16(type_name)
 定义一个严格遵循蓝牙标准的广播数据单元结构，单元数据 ( AD Data ) 为 uint16_t 的类型
 

类型定义

typedef uint16_t xf_ble_appearance_t
 BLE 外观值，完全遵循蓝牙标准进行定义
 
typedef union _xf_ble_gap_adv_struct_data_t xf_ble_gap_adv_struct_data_t
 BLE GAP 广播数据单元的数据 ( AD Data )
 

枚举

enum  xf_ble_gap_link_role_type_t { XF_BLE_GAP_LINK_ROLE_MASTER = 0 , XF_BLE_GAP_LINK_ROLE_SLAVE = 1 }
 BLE GAP 链接角色类型 更多...
 
enum  xf_ble_gap_adv_struct_type_t {
  XF_BLE_ADV_STRUCT_TYPE_FLAGS = 0x01 , XF_BLE_ADV_STRUCT_TYPE_LOCAL_NAME_SHORT = 0x08 , XF_BLE_ADV_STRUCT_TYPE_LOCAL_NAME_ALL = 0x09 , XF_BLE_ADV_STRUCT_TYPE_TX_POWER_LEVEL = 0x0A ,
  XF_BLE_ADV_STRUCT_TYPE_CLASS_OF_DEVICE = 0x0D , XF_BLE_ADV_STRUCT_TYPE_DEVICE_ID = 0x10 , XF_BLE_ADV_STRUCT_TYPE_APPEARANCE = 0x19
}
 BLE 广播数据单元 ( AD Structure ) 类型，完全遵循蓝牙标准进行定义 更多...
 
enum  xf_ble_gap_adv_type_t {
  XF_BLE_GAP_ADV_TYPE_CONN_SCAN_UNDIR = 0x00 , XF_BLE_GAP_ADV_TYPE_CONN_NONSCAN_DIR = 0x01 , XF_BLE_GAP_ADV_TYPE_NONCONN_SCAN_UNDIR = 0x02 , XF_BLE_GAP_ADV_TYPE_NONCONN_NONSCAN_UNDIR = 0x03 ,
  XF_BLE_GAP_ADV_TYPE_CONN_NONSCAN_DIR_LOW_DUTY = 0x04
}
 BLE GAP 广播类型，完全遵循蓝牙标准进行定义 更多...
 
enum  xf_ble_gap_adv_filter_policy_t { XF_BLE_GAP_ADV_FILTER_ALLOW_SCAN_ANY_CON_ANY = 0x00 , XF_BLE_GAP_ADV_FILTER_ALLOW_SCAN_WLST_CON_ANY = 0x01 , XF_BLE_GAP_ADV_FILTER_ALLOW_SCAN_ANY_CON_WLST = 0x02 , XF_BLE_GAP_ADV_FILTER_ALLOW_SCAN_WLST_CON_WLST = 0x03 }
 BLE GAP 广播过滤策略，完全遵循蓝牙标准进行定义 更多...
 
enum  xf_ble_gap_adv_channel_t { XF_BLE_GAP_ADV_CH_37 = 0x01 , XF_BLE_GAP_ADV_CH_38 = 0x02 , XF_BLE_GAP_ADV_CH_39 = 0x04 , XF_BLE_GAP_ADV_CH_ALL = 0x07 }
 BLE GAP 广播通道，完全遵循蓝牙标准进行定义 更多...
 
enum  xf_ble_gap_phy_type_t { XF_BLE_GAP_PHY_NO_PACKET = 0x00 , XF_BLE_GAP_PHY_1M = 0x01 , XF_BLE_GAP_PHY_2M = 0x02 , XF_BLE_GAP_PHY_CODED = 0x03 }
 BLE GAP PHY 类型 更多...
 
enum  xf_ble_gap_scan_filter_t { XF_BLE_GAP_SCAN_FILTER_ACCEPT_ALL = 0x00 , XF_BLE_GAP_SCAN_FILTER_ONLY_WHITE_LIST = 0x01 , XF_BLE_GAP_SCAN_FILTER_ACCEPT_ALL_AND_RPA = 0x02 , XF_BLE_GAP_SCAN_FILTER_ONLY_WHITE_LIST_AND_RPA = 0x03 }
 BLE GAP 扫描过滤策略，完全遵循蓝牙标准进行定义 更多...
 
enum  xf_ble_gap_scan_type_t { XF_BLE_GAP_SCAN_TYPE_PASSIVE = 0x0 , XF_BLE_GAP_SCAN_TYPE_ACTIVE = 0x1 }
 BLE GAP 扫描类型，完全遵循蓝牙标准进行定义 更多...
 
enum  xf_ble_gap_disconnect_reason_t { XF_BLE_GAP_DISCONNECT_UNKNOWN = 0x00 , XF_BLE_GAP_DISCONNECT_TIMEOUT = 0x8 , XF_BLE_GAP_DISCONNECT_ENDED_BY_REMOTE_USER = 0x13 , XF_BLE_GAP_DISCONNECT_ENDED_BY_LOCAL_HOST = 0x16 }
 蓝牙断连原因 更多...
 

函数

xf_err_t xf_ble_enable (void)
 BLE 功能开启
 
xf_err_t xf_ble_disable (void)
 BLE 功能关闭
 
xf_err_t xf_ble_gap_set_local_addr (uint8_t addr[XF_BLE_ADDR_LEN], xf_ble_addr_type_t type)
 BLE GAP 设置本端设备地址
 
xf_err_t xf_ble_gap_get_local_addr (xf_ble_addr_t *addr)
 BLE GAP 获取本端设备地址
 
xf_err_t xf_ble_gap_set_local_appearance (xf_ble_appearance_t appearance)
 BLE GAP 设置本端设备的外观
 
xf_ble_appearance_t xf_ble_gap_get_local_appearance (void)
 BLE GAP 获取本端设备的外观
 
xf_err_t xf_ble_gap_set_local_name (const uint8_t *name, const uint8_t len)
 BLE GAP 设置本端设备名称
 
xf_err_t xf_ble_gap_get_local_name (uint8_t *name, uint8_t *len)
 BLE GAP 获取本端设备名称
 
xf_err_t xf_ble_gap_set_adv_data (const xf_ble_gap_adv_data_t *data)
 BLE GAP 设置广播数据
 
xf_err_t xf_ble_gap_set_adv_param (const xf_ble_gap_adv_param_t *param)
 BLE GAP 设置广播参数
 
xf_err_t xf_ble_gap_start_adv (void)
 BLE GAP 广播开启
 
xf_err_t xf_ble_gap_stop_adv (void)
 BLE GAP 广播关闭
 
xf_err_t xf_ble_gap_set_scan_param (const xf_ble_gap_scan_param_t *param)
 BLE GAP 设置扫描参数
 
xf_err_t xf_ble_gap_start_scan (void)
 BLE GAP 扫描开启
 
xf_err_t xf_ble_gap_stop_scan (void)
 BLE GAP 扫描停止
 
xf_err_t xf_ble_gap_update_conn_params (xf_ble_gap_conn_param_update_t *params)
 BLE GAP 更新连接参数
 
xf_err_t xf_ble_gap_connect (const xf_ble_addr_t *addr)
 BLE GAP 发起连接
 
xf_err_t xf_ble_gap_disconnect (const xf_ble_addr_t *addr)
 BLE GAP 断开连接
 
xf_err_t xf_ble_gap_add_pair (const xf_ble_addr_t *addr)
 BLE GAP 添加配对
 
xf_err_t xf_ble_gap_del_pair (const xf_ble_addr_t *addr)
 BLE GAP 删除配对
 
xf_err_t xf_ble_gap_del_pair_all (void)
 BLE GAP 删除所有配对
 
xf_err_t xf_ble_gap_get_pair_list (uint16_t *max_num, xf_ble_addr_t *dev_list)
 BLE GAP 获取已配对的设备
 
xf_err_t xf_ble_gap_get_bond_list (int *max_num, xf_ble_addr_t *dev_list)
 BLE GAP 获取已绑定的设备
 
xf_err_t xf_ble_gap_set_security_param (xf_ble_sm_param_type_t param_type, void *value, uint8_t len)
 BLE GAP 设置安全参数
 

详细描述

Generic Attribute Profile

宏定义说明

◆ XF_BLE_APPEARANCE_UNKNOWN

#define XF_BLE_APPEARANCE_UNKNOWN   0x0000

在文件 xf_ble_gap_types.h 第 55 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_PHONE

#define XF_BLE_APPEARANCE_GENERIC_PHONE   0x0040

在文件 xf_ble_gap_types.h 第 56 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_COMPUTER

#define XF_BLE_APPEARANCE_GENERIC_COMPUTER   0x0080

在文件 xf_ble_gap_types.h 第 57 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_WATCH

#define XF_BLE_APPEARANCE_GENERIC_WATCH   0x00C0

在文件 xf_ble_gap_types.h 第 58 行定义.

◆ XF_BLE_APPEARANCE_SPORTS_WATCH

#define XF_BLE_APPEARANCE_SPORTS_WATCH   0x00C1

在文件 xf_ble_gap_types.h 第 59 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_CLOCK

#define XF_BLE_APPEARANCE_GENERIC_CLOCK   0x0100

在文件 xf_ble_gap_types.h 第 60 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_DISPLAY

#define XF_BLE_APPEARANCE_GENERIC_DISPLAY   0x0140

在文件 xf_ble_gap_types.h 第 61 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_REMOTE

#define XF_BLE_APPEARANCE_GENERIC_REMOTE   0x0180

在文件 xf_ble_gap_types.h 第 62 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_EYEGLASSES

#define XF_BLE_APPEARANCE_GENERIC_EYEGLASSES   0x01C0

在文件 xf_ble_gap_types.h 第 63 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_TAG

#define XF_BLE_APPEARANCE_GENERIC_TAG   0x0200

在文件 xf_ble_gap_types.h 第 64 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_KEYRING

#define XF_BLE_APPEARANCE_GENERIC_KEYRING   0x0240

在文件 xf_ble_gap_types.h 第 65 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_MEDIA_PLAYER

#define XF_BLE_APPEARANCE_GENERIC_MEDIA_PLAYER   0x0280

在文件 xf_ble_gap_types.h 第 66 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_BARCODE_SCANNER

#define XF_BLE_APPEARANCE_GENERIC_BARCODE_SCANNER   0x02C0

在文件 xf_ble_gap_types.h 第 67 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_THERMOMETER

#define XF_BLE_APPEARANCE_GENERIC_THERMOMETER   0x0300

在文件 xf_ble_gap_types.h 第 68 行定义.

◆ XF_BLE_APPEARANCE_THERMOMETER_EAR

#define XF_BLE_APPEARANCE_THERMOMETER_EAR   0x0301

在文件 xf_ble_gap_types.h 第 69 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_HEART_RATE

#define XF_BLE_APPEARANCE_GENERIC_HEART_RATE   0x0340

在文件 xf_ble_gap_types.h 第 70 行定义.

◆ XF_BLE_APPEARANCE_HEART_RATE_BELT

#define XF_BLE_APPEARANCE_HEART_RATE_BELT   0x0341

在文件 xf_ble_gap_types.h 第 71 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE

#define XF_BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE   0x0380

在文件 xf_ble_gap_types.h 第 72 行定义.

◆ XF_BLE_APPEARANCE_BLOOD_PRESSURE_ARM

#define XF_BLE_APPEARANCE_BLOOD_PRESSURE_ARM   0x0381

在文件 xf_ble_gap_types.h 第 73 行定义.

◆ XF_BLE_APPEARANCE_BLOOD_PRESSURE_WRIST

#define XF_BLE_APPEARANCE_BLOOD_PRESSURE_WRIST   0x0382

在文件 xf_ble_gap_types.h 第 74 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_HID

#define XF_BLE_APPEARANCE_GENERIC_HID   0x03C0

在文件 xf_ble_gap_types.h 第 75 行定义.

◆ XF_BLE_APPEARANCE_HID_KEYBOARD

#define XF_BLE_APPEARANCE_HID_KEYBOARD   0x03C1

在文件 xf_ble_gap_types.h 第 76 行定义.

◆ XF_BLE_APPEARANCE_HID_MOUSE

#define XF_BLE_APPEARANCE_HID_MOUSE   0x03C2

在文件 xf_ble_gap_types.h 第 77 行定义.

◆ XF_BLE_APPEARANCE_HID_JOYSTICK

#define XF_BLE_APPEARANCE_HID_JOYSTICK   0x03C3

在文件 xf_ble_gap_types.h 第 78 行定义.

◆ XF_BLE_APPEARANCE_HID_GAMEPAD

#define XF_BLE_APPEARANCE_HID_GAMEPAD   0x03C4

在文件 xf_ble_gap_types.h 第 79 行定义.

◆ XF_BLE_APPEARANCE_HID_DIGITIZER_TABLET

#define XF_BLE_APPEARANCE_HID_DIGITIZER_TABLET   0x03C5
示例
examples/wireless/ble/sample_gatt_server/main/xf_main.c.

在文件 xf_ble_gap_types.h 第 80 行定义.

◆ XF_BLE_APPEARANCE_HID_CARD_READER

#define XF_BLE_APPEARANCE_HID_CARD_READER   0x03C6

在文件 xf_ble_gap_types.h 第 81 行定义.

◆ XF_BLE_APPEARANCE_HID_DIGITAL_PEN

#define XF_BLE_APPEARANCE_HID_DIGITAL_PEN   0x03C7

在文件 xf_ble_gap_types.h 第 82 行定义.

◆ XF_BLE_APPEARANCE_HID_BARCODE_SCANNER

#define XF_BLE_APPEARANCE_HID_BARCODE_SCANNER   0x03C8

在文件 xf_ble_gap_types.h 第 83 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_GLUCOSE

#define XF_BLE_APPEARANCE_GENERIC_GLUCOSE   0x0400

在文件 xf_ble_gap_types.h 第 84 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_WALKING

#define XF_BLE_APPEARANCE_GENERIC_WALKING   0x0440

在文件 xf_ble_gap_types.h 第 85 行定义.

◆ XF_BLE_APPEARANCE_WALKING_IN_SHOE

#define XF_BLE_APPEARANCE_WALKING_IN_SHOE   0x0441

在文件 xf_ble_gap_types.h 第 86 行定义.

◆ XF_BLE_APPEARANCE_WALKING_ON_SHOE

#define XF_BLE_APPEARANCE_WALKING_ON_SHOE   0x0442

在文件 xf_ble_gap_types.h 第 87 行定义.

◆ XF_BLE_APPEARANCE_WALKING_ON_HIP

#define XF_BLE_APPEARANCE_WALKING_ON_HIP   0x0443

在文件 xf_ble_gap_types.h 第 88 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_CYCLING

#define XF_BLE_APPEARANCE_GENERIC_CYCLING   0x0480

在文件 xf_ble_gap_types.h 第 89 行定义.

◆ XF_BLE_APPEARANCE_CYCLING_COMPUTER

#define XF_BLE_APPEARANCE_CYCLING_COMPUTER   0x0481

在文件 xf_ble_gap_types.h 第 90 行定义.

◆ XF_BLE_APPEARANCE_CYCLING_SPEED

#define XF_BLE_APPEARANCE_CYCLING_SPEED   0x0482

在文件 xf_ble_gap_types.h 第 91 行定义.

◆ XF_BLE_APPEARANCE_CYCLING_CADENCE

#define XF_BLE_APPEARANCE_CYCLING_CADENCE   0x0483

在文件 xf_ble_gap_types.h 第 92 行定义.

◆ XF_BLE_APPEARANCE_CYCLING_POWER

#define XF_BLE_APPEARANCE_CYCLING_POWER   0x0484

在文件 xf_ble_gap_types.h 第 93 行定义.

◆ XF_BLE_APPEARANCE_CYCLING_SPEED_CADENCE

#define XF_BLE_APPEARANCE_CYCLING_SPEED_CADENCE   0x0485

在文件 xf_ble_gap_types.h 第 94 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_PULSE_OXIMETER

#define XF_BLE_APPEARANCE_GENERIC_PULSE_OXIMETER   0x0C40

在文件 xf_ble_gap_types.h 第 95 行定义.

◆ XF_BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP

#define XF_BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP   0x0C41

在文件 xf_ble_gap_types.h 第 96 行定义.

◆ XF_BLE_APPEARANCE_PULSE_OXIMETER_WRIST

#define XF_BLE_APPEARANCE_PULSE_OXIMETER_WRIST   0x0C42

在文件 xf_ble_gap_types.h 第 97 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_WEIGHT

#define XF_BLE_APPEARANCE_GENERIC_WEIGHT   0x0C80

在文件 xf_ble_gap_types.h 第 98 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_PERSONAL_MOBILITY_DEVICE

#define XF_BLE_APPEARANCE_GENERIC_PERSONAL_MOBILITY_DEVICE   0x0CC0

在文件 xf_ble_gap_types.h 第 99 行定义.

◆ XF_BLE_APPEARANCE_POWERED_WHEELCHAIR

#define XF_BLE_APPEARANCE_POWERED_WHEELCHAIR   0x0CC1

在文件 xf_ble_gap_types.h 第 100 行定义.

◆ XF_BLE_APPEARANCE_MOBILITY_SCOOTER

#define XF_BLE_APPEARANCE_MOBILITY_SCOOTER   0x0CC2

在文件 xf_ble_gap_types.h 第 101 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_CONTINUOUS_GLUCOSE_MONITOR

#define XF_BLE_APPEARANCE_GENERIC_CONTINUOUS_GLUCOSE_MONITOR   0x0D00

在文件 xf_ble_gap_types.h 第 102 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_INSULIN_PUMP

#define XF_BLE_APPEARANCE_GENERIC_INSULIN_PUMP   0x0D40

在文件 xf_ble_gap_types.h 第 103 行定义.

◆ XF_BLE_APPEARANCE_INSULIN_PUMP_DURABLE_PUMP

#define XF_BLE_APPEARANCE_INSULIN_PUMP_DURABLE_PUMP   0x0D41

在文件 xf_ble_gap_types.h 第 104 行定义.

◆ XF_BLE_APPEARANCE_INSULIN_PUMP_PATCH_PUMP

#define XF_BLE_APPEARANCE_INSULIN_PUMP_PATCH_PUMP   0x0D44

在文件 xf_ble_gap_types.h 第 105 行定义.

◆ XF_BLE_APPEARANCE_INSULIN_PEN

#define XF_BLE_APPEARANCE_INSULIN_PEN   0x0D48

在文件 xf_ble_gap_types.h 第 106 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_MEDICATION_DELIVERY

#define XF_BLE_APPEARANCE_GENERIC_MEDICATION_DELIVERY   0x0D80

在文件 xf_ble_gap_types.h 第 107 行定义.

◆ XF_BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS

#define XF_BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS   0x1440

在文件 xf_ble_gap_types.h 第 108 行定义.

◆ XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION

#define XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION   0x1441

在文件 xf_ble_gap_types.h 第 109 行定义.

◆ XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_AND_NAV

#define XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_AND_NAV   0x1442

在文件 xf_ble_gap_types.h 第 110 行定义.

◆ XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD

#define XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD   0x1443

在文件 xf_ble_gap_types.h 第 111 行定义.

◆ XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD_AND_NAV

#define XF_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD_AND_NAV   0x1444

在文件 xf_ble_gap_types.h 第 112 行定义.

◆ XF_BLE_GAP_ADV_STRUCT_AD_TYPE_FIELD_SIZE

#define XF_BLE_GAP_ADV_STRUCT_AD_TYPE_FIELD_SIZE   1

BLE GAP 广播数据单元类型 (AD_TYPE) 字段的大小

示例
examples/wireless/ble/sample_gatt_client/main/xf_main.c.

在文件 xf_ble_gap_types.h 第 142 行定义.

◆ XF_BLE_GAP_ADV_STRUCT_LEN_FIELD_SIZE

#define XF_BLE_GAP_ADV_STRUCT_LEN_FIELD_SIZE   1

BLE GAP 广播数据单元数据长度 (LEN) 字段的大小

示例
examples/wireless/ble/sample_gatt_client/main/xf_main.c.

在文件 xf_ble_gap_types.h 第 146 行定义.

◆ XF_BLE_ADV_STRUCT_TYPE_ARRAY

#define XF_BLE_ADV_STRUCT_TYPE_ARRAY (   type_name,
  adv_data_array_size 
)
值:
typedef struct { \
uint8_t struct_data_len; \
struct /* struct_data */ \
{ \
union \
{ \
xf_ble_gap_adv_struct_type_t ad_type; \
uint8_t _fixed_size; \
}; \
struct /* adv_data */ \
{ \
uint8_t ad_data[adv_data_array_size]; \
}; \
}; \
}type_name
xf_ble_gap_adv_struct_type_t
xf_ble_gap_adv_struct_type_t
BLE 广播数据单元 ( AD Structure ) 类型，完全遵循蓝牙标准进行定义
Definition xf_ble_gap_types.h:129

定义一个严格遵循蓝牙标准的广播数据单元结构，单元数据 ( AD Data ) 为数组的类型

参数
type_name指定定义的类型名
adv_data_array_size单元数据 ( AD Data ) 数组的大小
注解
一般仅用于平台对接时使用，便于 XF BLE 广播数据单元结构与符号标准的广播数据结构间的转换

在文件 xf_ble_gap_types.h 第 195 行定义.

◆ XF_BLE_ADV_STRUCT_TYPE_VAL_U8

#define XF_BLE_ADV_STRUCT_TYPE_VAL_U8 (   type_name)
值:
typedef struct { \
uint8_t struct_data_len; \
struct /* struct_data */ \
{ \
union \
{ \
xf_ble_gap_adv_struct_type_t ad_type; \
uint8_t _fixed_size; \
}; \
struct /* adv_data */ \
{ \
uint8_t val; \
}; \
}; \
}type_name

定义一个严格遵循蓝牙标准的广播数据单元结构，单元数据 ( AD Data ) 为 uint8_t 的类型

参数
type_name指定定义的类型名
注解
一般仅用于平台对接时使用，便于 XF BLE 广播数据单元结构与符号标准的广播数据结构间的转换

在文件 xf_ble_gap_types.h 第 218 行定义.

◆ XF_BLE_ADV_STRUCT_TYPE_VAL_U16

#define XF_BLE_ADV_STRUCT_TYPE_VAL_U16 (   type_name)
值:
typedef struct { \
uint8_t struct_data_len; \
struct /* struct_data */ \
{ \
union \
{ \
xf_ble_gap_adv_struct_type_t ad_type; \
uint8_t _fixed_size; \
}; \
struct /* adv_data */ \
{ \
uint16_t val; \
}; \
}; \
}type_name

定义一个严格遵循蓝牙标准的广播数据单元结构，单元数据 ( AD Data ) 为 uint16_t 的类型

参数
type_name指定定义的类型名
注解
一般仅用于平台对接时使用，便于 XF BLE 广播数据单元结构与符号标准的广播数据结构间的转换

在文件 xf_ble_gap_types.h 第 241 行定义.

类型定义说明

◆ xf_ble_appearance_t

typedef uint16_t xf_ble_appearance_t

BLE 外观值，完全遵循蓝牙标准进行定义

注解
这里仅列出部分常用的值，更多可选值参见蓝牙官方文档 《Assigned Numbers》 >| 2.6 Appearance Values
参见
https://www.bluetooth.com/specifications/assigned-numbers/
示例
examples/wireless/ble/sample_gatt_server/main/xf_main.c.

在文件 xf_ble_gap_types.h 第 53 行定义.

◆ xf_ble_gap_adv_struct_data_t

typedef union _xf_ble_gap_adv_struct_data_t xf_ble_gap_adv_struct_data_t

BLE GAP 广播数据单元的数据 ( AD Data )

注解
以下暂时仅列出部分类型的广播数据单元数据成员

以下为蓝牙标准定义的广播数据结构及广播数据单元数据 ( AD Data ) 所在的位置

| AdvData |
| AD Structure 1 | AD Structure 2 | ... |（无效数据 000...000b） |
| Length | Data | Length | Data | ...... |
| Length(type + data) | AD type | AD Data | Length | AD type | AD Data | ...... |
| ^ |

枚举类型说明

◆ xf_ble_gap_link_role_type_t

enum xf_ble_gap_link_role_type_t

BLE GAP 链接角色类型

枚举值
XF_BLE_GAP_LINK_ROLE_MASTER 

主机

XF_BLE_GAP_LINK_ROLE_SLAVE 

从机

在文件 xf_ble_gap_types.h 第 117 行定义.

◆ xf_ble_gap_adv_struct_type_t

enum xf_ble_gap_adv_struct_type_t

BLE 广播数据单元 ( AD Structure ) 类型，完全遵循蓝牙标准进行定义

注解
这里仅列出部分常用的类型，更多可选类型参见蓝牙官方文档 《Assigned Numbers》 > 2.3 Common Data Types
参见
https://www.bluetooth.com/specifications/assigned-numbers/
枚举值
XF_BLE_ADV_STRUCT_TYPE_FLAGS 
XF_BLE_ADV_STRUCT_TYPE_LOCAL_NAME_SHORT 
XF_BLE_ADV_STRUCT_TYPE_LOCAL_NAME_ALL 
XF_BLE_ADV_STRUCT_TYPE_TX_POWER_LEVEL 
XF_BLE_ADV_STRUCT_TYPE_CLASS_OF_DEVICE 
XF_BLE_ADV_STRUCT_TYPE_DEVICE_ID 
XF_BLE_ADV_STRUCT_TYPE_APPEARANCE 

在文件 xf_ble_gap_types.h 第 129 行定义.

◆ xf_ble_gap_adv_type_t

enum xf_ble_gap_adv_type_t

BLE GAP 广播类型，完全遵循蓝牙标准进行定义

参见
详参蓝牙核心文档 《Core_v5.4》>| Vol 4, Part E >| 7.8.5 LE Set Advertising Parameters command >| Command parameters >| Advertising_Type 在线文档: https://www.bluetooth.com/specifications/specs/core54-html/ 离线文档: https://www.bluetooth.com/specifications/specs/core-specification-amended-5-4/
枚举值
XF_BLE_GAP_ADV_TYPE_CONN_SCAN_UNDIR 

可连接， 可扫描， 非定向 广播 (ADV_IND) (默认)

XF_BLE_GAP_ADV_TYPE_CONN_NONSCAN_DIR 

可连接， 不可扫描， 定向 广播 (ADV_DIRECT_IND) (高频)

XF_BLE_GAP_ADV_TYPE_NONCONN_SCAN_UNDIR 

不可连接， 可扫描， 非定向 广播 (ADV_SCAN_IND)

XF_BLE_GAP_ADV_TYPE_NONCONN_NONSCAN_UNDIR 

不可连接， 不可扫描， 非定向 广播 (ADV_NONCONN_IND)

XF_BLE_GAP_ADV_TYPE_CONN_NONSCAN_DIR_LOW_DUTY 

可连接， 不可扫描， 定向 广播 (ADV_DIRECT_IND) (低频)

在文件 xf_ble_gap_types.h 第 282 行定义.

◆ xf_ble_gap_adv_filter_policy_t

enum xf_ble_gap_adv_filter_policy_t

BLE GAP 广播过滤策略，完全遵循蓝牙标准进行定义

参见
详参蓝牙核心文档 《Core_v5.4》>| Vol 4, Part E >| 7.8.5 LE Set Advertising Parameters command >| Command parameters >| Advertising_Filter_Policy 在线文档: https://www.bluetooth.com/specifications/specs/core54-html/ 离线文档: https://www.bluetooth.com/specifications/specs/core-specification-amended-5-4/
枚举值
XF_BLE_GAP_ADV_FILTER_ALLOW_SCAN_ANY_CON_ANY 

处理所有设备的扫描和连接请求

XF_BLE_GAP_ADV_FILTER_ALLOW_SCAN_WLST_CON_ANY 

处理所有 连接 请求，仅处理白名单的 扫描 请求

XF_BLE_GAP_ADV_FILTER_ALLOW_SCAN_ANY_CON_WLST 

处理所有 扫描 请求，仅处理白名单的 连接 请求

XF_BLE_GAP_ADV_FILTER_ALLOW_SCAN_WLST_CON_WLST 

仅处理白名单中扫描请求和连接请求

在文件 xf_ble_gap_types.h 第 298 行定义.

◆ xf_ble_gap_adv_channel_t

enum xf_ble_gap_adv_channel_t

BLE GAP 广播通道，完全遵循蓝牙标准进行定义

参见
详参蓝牙核心文档 《Core_v5.4》>| Vol 4, Part E >| 7.8.5 LE Set Advertising Parameters command >| Command parameters >| Advertising_Channel_Map 在线文档: https://www.bluetooth.com/specifications/specs/core54-html/ 离线文档: https://www.bluetooth.com/specifications/specs/core-specification-amended-5-4/
枚举值
XF_BLE_GAP_ADV_CH_37 

启用 37 通道

XF_BLE_GAP_ADV_CH_38 

启用 38 通道

XF_BLE_GAP_ADV_CH_39 

启用 39 通道

XF_BLE_GAP_ADV_CH_ALL 

启用所有通道

在文件 xf_ble_gap_types.h 第 313 行定义.

◆ xf_ble_gap_phy_type_t

enum xf_ble_gap_phy_type_t

BLE GAP PHY 类型

枚举值
XF_BLE_GAP_PHY_NO_PACKET 

无数据包

XF_BLE_GAP_PHY_1M 

1M PHY

XF_BLE_GAP_PHY_2M 

2M PHY

XF_BLE_GAP_PHY_CODED 

Coded PHY

在文件 xf_ble_gap_types.h 第 323 行定义.

◆ xf_ble_gap_scan_filter_t

enum xf_ble_gap_scan_filter_t

BLE GAP 扫描过滤策略，完全遵循蓝牙标准进行定义

参见
详参蓝牙核心文档 《Core_v5.4》
  1. >| Vol 6, Part B >| 4.3.3 Scanning filter policy
  2. >| Vol 4, Part E >| 7.8.10 LE Set Scan Parameters command >| Command parameters >| Scanning_Filter_Policy 在线文档: https://www.bluetooth.com/specifications/specs/core54-html/ 离线文档: https://www.bluetooth.com/specifications/specs/core-specification-amended-5-4/
枚举值
XF_BLE_GAP_SCAN_FILTER_ACCEPT_ALL 

接收所有广播不接收目标地址不是本设备地址的定向广播 (默认)

XF_BLE_GAP_SCAN_FILTER_ONLY_WHITE_LIST 

只接收白名单里设备的广播，不接收目标地址不是本设备地址的定向广播

XF_BLE_GAP_SCAN_FILTER_ACCEPT_ALL_AND_RPA 

接收所有的非定向广播、 地址是可解析私有地址的广播方发送的定向广播、 发给该设备的定向广播

XF_BLE_GAP_SCAN_FILTER_ONLY_WHITE_LIST_AND_RPA 

接收白名单中的所有非定向广播、 地址是可解析私有地址的广播方发送的定向广播、 发给该设备的定向广播

在文件 xf_ble_gap_types.h 第 357 行定义.

◆ xf_ble_gap_scan_type_t

enum xf_ble_gap_scan_type_t

BLE GAP 扫描类型，完全遵循蓝牙标准进行定义

参见
详参蓝牙核心文档 《Core_v5.4》>| Vol 4, Part E >| 7.8.10 LE Set Scan Parameters command >| Command parameters >| Scan_Type[ 在线文档: https://www.bluetooth.com/specifications/specs/core54-html/ 离线文档: https://www.bluetooth.com/specifications/specs/core-specification-amended-5-4/
枚举值
XF_BLE_GAP_SCAN_TYPE_PASSIVE 

被动扫描

XF_BLE_GAP_SCAN_TYPE_ACTIVE 

主动扫描

在文件 xf_ble_gap_types.h 第 376 行定义.

◆ xf_ble_gap_disconnect_reason_t

enum xf_ble_gap_disconnect_reason_t

蓝牙断连原因

注解
其他错误码值参见：具体平台说明或参考蓝牙标准
参见
详参蓝牙核心文档 《Core_v5.4》>| Vol 1, Part F >| 1.3 LIST OF ERROR CODES 在线文档: https://www.bluetooth.com/specifications/specs/core54-html/ 离线文档: https://www.bluetooth.com/specifications/specs/core-specification-amended-5-4/
枚举值
XF_BLE_GAP_DISCONNECT_UNKNOWN 

未知原因断连

XF_BLE_GAP_DISCONNECT_TIMEOUT 

连接超时断连

XF_BLE_GAP_DISCONNECT_ENDED_BY_REMOTE_USER 

远端用户断连

XF_BLE_GAP_DISCONNECT_ENDED_BY_LOCAL_HOST 

本端 HOST 断连

在文件 xf_ble_gap_types.h 第 421 行定义.

函数说明

◆ xf_ble_enable()

xf_err_t xf_ble_enable ( void  )

BLE 功能开启

注解
包含所有 BLE 开启前的处理
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_client/main/xf_main.c , 以及 examples/wireless/ble/sample_gatt_server/main/xf_main.c.

◆ xf_ble_disable()

xf_err_t xf_ble_disable ( void  )

BLE 功能关闭

注解
包含所有 BLE 关闭前的处理
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_set_local_addr()

xf_err_t xf_ble_gap_set_local_addr ( uint8_t  addr[XF_BLE_ADDR_LEN],
xf_ble_addr_type_t  type 
)

BLE GAP 设置本端设备地址

参数
addrBLE 地址值
typeBLE 地址类型，见 xf_ble_addr_type_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • XF_ERR_NOT_SUPPORTED 不支持
  • (OTHER) xf_err_t

◆ xf_ble_gap_get_local_addr()

xf_err_t xf_ble_gap_get_local_addr ( xf_ble_addr_t *  addr)

BLE GAP 获取本端设备地址

参数
[out]addrBLE 地址信息，见 xf_ble_addr_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_set_local_appearance()

xf_err_t xf_ble_gap_set_local_appearance ( xf_ble_appearance_t  appearance)

BLE GAP 设置本端设备的外观

参数
appearance外观值，见 xf_ble_appearance_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_server/main/xf_main.c.

◆ xf_ble_gap_get_local_appearance()

xf_ble_appearance_t xf_ble_gap_get_local_appearance ( void  )

BLE GAP 获取本端设备的外观

返回
xf_ble_appearance_t，见 xf_ble_appearance_t

◆ xf_ble_gap_set_local_name()

xf_err_t xf_ble_gap_set_local_name ( const uint8_t *  name,
const uint8_t  len 
)

BLE GAP 设置本端设备名称

参数
name设备名
len设备名长度
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_server/main/xf_main.c.

◆ xf_ble_gap_get_local_name()

xf_err_t xf_ble_gap_get_local_name ( uint8_t *  name,
uint8_t *  len 
)

BLE GAP 获取本端设备名称

参数
[out]name设备名
len设备名长度
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_set_adv_data()

xf_err_t xf_ble_gap_set_adv_data ( const xf_ble_gap_adv_data_t *  data)

BLE GAP 设置广播数据

参数
data广播数据，见 xf_ble_gap_adv_data_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_server/main/xf_main.c.

◆ xf_ble_gap_set_adv_param()

xf_err_t xf_ble_gap_set_adv_param ( const xf_ble_gap_adv_param_t *  param)

BLE GAP 设置广播参数

参数
param广播参数，见 xf_ble_gap_adv_param_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_server/main/xf_main.c.

◆ xf_ble_gap_start_adv()

xf_err_t xf_ble_gap_start_adv ( void  )

BLE GAP 广播开启

返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_server/main/xf_main.c.

◆ xf_ble_gap_stop_adv()

xf_err_t xf_ble_gap_stop_adv ( void  )

BLE GAP 广播关闭

返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_set_scan_param()

xf_err_t xf_ble_gap_set_scan_param ( const xf_ble_gap_scan_param_t *  param)

BLE GAP 设置扫描参数

参数
param扫描参数，见 xf_ble_gap_scan_param_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_client/main/xf_main.c.

◆ xf_ble_gap_start_scan()

xf_err_t xf_ble_gap_start_scan ( void  )

BLE GAP 扫描开启

返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_client/main/xf_main.c.

◆ xf_ble_gap_stop_scan()

xf_err_t xf_ble_gap_stop_scan ( void  )

BLE GAP 扫描停止

返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_client/main/xf_main.c.

◆ xf_ble_gap_update_conn_params()

xf_err_t xf_ble_gap_update_conn_params ( xf_ble_gap_conn_param_update_t *  params)

BLE GAP 更新连接参数

参数
params更新连接参数的信息，见 xf_ble_gap_conn_param_update_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_connect()

xf_err_t xf_ble_gap_connect ( const xf_ble_addr_t *  addr)

BLE GAP 发起连接

参数
addr要连接的地址，见 xf_ble_addr_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_client/main/xf_main.c.

◆ xf_ble_gap_disconnect()

xf_err_t xf_ble_gap_disconnect ( const xf_ble_addr_t *  addr)

BLE GAP 断开连接

参数
addr要断连的地址，见 xf_ble_addr_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_client/main/xf_main.c.

◆ xf_ble_gap_add_pair()

xf_err_t xf_ble_gap_add_pair ( const xf_ble_addr_t *  addr)

BLE GAP 添加配对

参数
addr要配对的设备的地址，见 xf_ble_addr_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_del_pair()

xf_err_t xf_ble_gap_del_pair ( const xf_ble_addr_t *  addr)

BLE GAP 删除配对

参数
addr要删除配对的设备的地址，见 xf_ble_addr_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_del_pair_all()

xf_err_t xf_ble_gap_del_pair_all ( void  )

BLE GAP 删除所有配对

返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_get_pair_list()

xf_err_t xf_ble_gap_get_pair_list ( uint16_t *  max_num,
xf_ble_addr_t *  dev_list 
)

BLE GAP 获取已配对的设备

参数
max_num要获取的最大数量
[out]dev_list获取到的设备列表，见 xf_ble_addr_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_get_bond_list()

xf_err_t xf_ble_gap_get_bond_list ( int *  max_num,
xf_ble_addr_t *  dev_list 
)

BLE GAP 获取已绑定的设备

参数
max_num要获取的最大数量
[out]dev_list获取到的设备列表，见 xf_ble_addr_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_ble_gap_set_security_param()

xf_err_t xf_ble_gap_set_security_param ( xf_ble_sm_param_type_t  param_type,
void *  value,
uint8_t  len 
)

BLE GAP 设置安全参数

警告
当前该接口有部分问题未确定，禁止调用
参数
param_type安全参数类型，见 xf_ble_sm_param_type_t
value安全参数的数据值
len安全参数的数据长度
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/ble/sample_gatt_server/main/xf_main.c.