LESCAN Interface Functions

[English]

LESCAN_IF API Brief

Application

Brief

lescan_if_scan_enable()

enable ble scan

lescan_if_scan_disable()

disable ble scan

lescan_if_start_PA_sync()

start sync to PA

lescan_if_terminate_PA_sync()

terminate PA sync link

LESCAN_IF API Reference

Header File

Functions

btif_ret_t lescan_if_scan_enable(lescan_if_para_t *p_scan_param)

enable ble scan.

enable ble scan using the configured parameters

返回值:
  • 0 – success [BK_RET_OK]

  • other – fail

返回:

result

btif_ret_t lescan_if_scan_disable(void)

disable ble scan.

disable ble scan

返回值:
  • 0 – success [BK_RET_OK]

  • other – fail

返回:

result

btif_ret_t lescan_if_start_PA_sync(lescan_if_PA_sync_para_t *p_PA_sync_param)

lescan_if_start_PA_sync brief description

start sync to PA

返回值:
  • 0 – success [BK_RET_OK]

  • other – fail

返回:

result

btif_ret_t lescan_if_terminate_PA_sync(uint16_t PA_handle)

lescan_if_terminate_PA_sync brief description

terminate PA sync link

返回值:
  • 0 – success [BK_RET_OK]

  • other – fail

返回:

result

Structures

struct root_buff_if_t
struct lescan_if_cb_ind_t

LE scan indicate callback data struct definition.

Public Members

lescan_if_ind_t ind_type

index of indicated

btif_ret_t status

status value

uint8_t *p_data

pointer indicated data

struct lescan_if_adv_rpt_head_t

LE scan report header data struct definition.

struct lescan_if_adv_rpt_t

LE scan report data struct definition.

struct lescan_if_para_t

LE scan interface parameter struct definition.

Public Members

lescan_if_type_t scan_type

Passive scan or Active scan

uint16_t scan_intv

Scan interval (N* 0.625 ms)

uint16_t scan_win

Scan window (N* 0.625 ms)

lescan_if_callback_fp scan_cb

Scan timeout (N* 10 ms), Set zero to disable timeout

struct lescan_if_PA_sync_cb_ind_t

LE SYNC indicate callback data struct definition.

struct lescan_if_pa_rpt_head_t

LE scan PA report header data struct definition.

struct lescan_if_pa_rpt_t

LE scan PA report data struct definition.

struct lescan_if_PA_sync_para_t

LE scan PA sync interface parameter struct definition.

Public Members

uint8_t adv_sid

advertising sid

btif_le_bd_addr_t address

advertiser address

struct lescan_if_biginfo_rpt_t

LE scan biginfo struct definition.

Macros

LESCAN_IF_IND_START
LESCAN_IF_IND_ENABLE
LESCAN_IF_IND_DISABLE
LESCAN_IF_IND_ADV_RPT
LESCAN_IF_PASSIVE_SCAN
LESCAN_IF_ACTIVE_SCAN
LESCAN_IF_SYNC_IND_CREATE
LESCAN_IF_SYNC_IND_DISC
LESCAN_IF_SYNC_IND_CANL
LESCAN_IF_SYNC_IND_EN_RPT
LESCAN_IF_SYNC_IND_DIS_RPT
LESCAN_IF_SYNC_IND_PA_PRT
LESCAN_IF_SYNC_IND_BIGINFO_RPT

Type Definitions

typedef uint8_t lescan_if_ind_t
typedef uint8_t lescan_if_type_t
typedef void (*lescan_if_callback_fp)(lescan_if_cb_ind_t *p_scan_para)
typedef uint8_t lescan_if_sync_ind_t
typedef void (*lescan_if_PA_sync_callback_fp)(lescan_if_PA_sync_cb_ind_t *ind)