Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
st_ble_gap_scan_on_t Struct Reference

Parameters configured when scanning starts. More...

Data Fields

uint8_t proc_type
 Procedure type. More...
 
uint8_t filter_dups
 Filter duplicates. More...
 
uint16_t duration
 Scan duration. More...
 
uint16_t period
 Scan period. More...
 

Detailed Description

Parameters configured when scanning starts.

Field Documentation

◆ proc_type

uint8_t st_ble_gap_scan_on_t::proc_type

Procedure type.

macro description
BLE_GAP_SC_PROC_OBS(0x00) Observation Procedure.
Notify all advertising PDUs.
BLE_GAP_SC_PROC_LIM(0x01) Limited Discovery Procedure.
Notify advertising PDUs from only devices in the limited discoverable mode.
BLE_GAP_SC_PROC_GEN(0x02) General Discovery Procedure.
Notify advertising PDUs from devices in the limited discoverable mode and the general discoverable mode.

◆ filter_dups

uint8_t st_ble_gap_scan_on_t::filter_dups

Filter duplicates.

macro description
BLE_GAP_SCAN_FILT_DUPLIC_DISABLE(0x00) Duplicate filter disabled.
BLE_GAP_SCAN_FILT_DUPLIC_ENABLE(0x01) Duplicate filter enabled.
BLE_GAP_SCAN_FILT_DUPLIC_ENABLE_FOR_PERIOD(0x02) Duplicate filtering enabled, reset for each scan period.
Note
If the "Balance" library is used, BLE_GAP_SCAN_FILT_DUPLIC_ENABLE_FOR_PERIOD is not allowed.

◆ duration

uint16_t st_ble_gap_scan_on_t::duration

Scan duration.

Time(ms) = duration * 10.
Valid range is 0x0000 - 0xFFFF.
If this field is set to 0x0000, scanning is continued until R_BLE_GAP_StopScan() is called.
When the period field is zero and the time specified the duration field expires, BLE_GAP_EVENT_SCAN_TO event notifies the application layer that scanning stops.

Note
If the "Balance" library is used, this field is ignored.

◆ period

uint16_t st_ble_gap_scan_on_t::period

Scan period.

Time(s) = N * 1.28.
Valid range is 0x0000 - 0xFFFF.
If the duration field is set to 0x0000, this field is ignored.

Note
If the "Balance" library is used, this field is ignored.