S122 SoftDevice v8.1.1
Data Fields
ble_gap_scan_params_t Struct Reference

GAP scanning parameters. More...

#include <ble_gap.h>

Data Fields

uint8_t extended: 1
 
uint8_t report_incomplete_evts: 1
 
uint8_t active: 1
 
uint8_t filter_policy: 2
 
uint8_t scan_phys
 
uint32_t interval_us
 
uint32_t window_us
 
uint16_t timeout
 
ble_gap_ch_mask_t channel_mask
 

Detailed Description

GAP scanning parameters.

Field Documentation

uint8_t ble_gap_scan_params_t::active

If 1, perform active scanning by sending scan requests. This parameter is ignored when used with sd_ble_gap_connect.

ble_gap_ch_mask_t ble_gap_scan_params_t::channel_mask
               Channel mask for primary and secondary advertising channels.

At least one of the primary channels, that is channel index 37-39, must be set to 0. Masking away secondary channels is not supported.

uint8_t ble_gap_scan_params_t::extended

This feature is not supported by this SoftDevice.

uint8_t ble_gap_scan_params_t::filter_policy

Scanning filter policy.

See Also
GAP Scanner filter policies.
Note
Only BLE_GAP_SCAN_FP_ACCEPT_ALL and BLE_GAP_SCAN_FP_WHITELIST are valid when used with sd_ble_gap_connect
uint32_t ble_gap_scan_params_t::interval_us

Scan interval in us.

See Also
GAP Scan interval max and min.
uint8_t ble_gap_scan_params_t::report_incomplete_evts

This feature is not supported by this SoftDevice.

uint8_t ble_gap_scan_params_t::scan_phys
                  Bitfield of PHYs to scan on. If set to @ref BLE_GAP_PHY_AUTO,

scan_phys will default to BLE_GAP_PHY_1MBPS. Only BLE_GAP_PHY_1MBPS is supported for this SoftDevice.

uint16_t ble_gap_scan_params_t::timeout

Scan timeout in 10 ms units.

See Also
GAP Scan timeout max and min.
uint32_t ble_gap_scan_params_t::window_us
                  Scan window in us.@sa BLE_GAP_SCAN_WINDOW.

If scan_phys contains multiple phys, then interval shall be larger than or equal to the sum of scan window sizes. This parameter represents the time set aside for each scan window. That is, the actual listening time is slightly less. See the SoftDevice Specification for details.


Documentation feedback | Developer Zone | Subscribe | Updated