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 |
| uint16_t | interval |
| uint16_t | window |
| 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 |
If 1, the scanner will accept extended advertising packets. If set to 0, the scanner will not receive advertising packets on secondary advertising channels, and will not be able to receive long advertising PDUs.
| 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
| uint16_t ble_gap_scan_params_t::interval |
Scan interval in 625 us units.
- See Also
- GAP Scan interval max and min .
| uint8_t ble_gap_scan_params_t::report_incomplete_evts |
If 1, events of type ble_gap_evt_adv_report_t may have ble_gap_adv_report_type_t::status set to BLE_GAP_ADV_DATA_STATUS_INCOMPLETE_MORE_DATA . This parameter is ignored when used with sd_ble_gap_connect
- Note
- This may be used to abort receiving more packets from an extended advertising event, and is only available for extended scanning, see sd_ble_gap_scan_start .
- 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 .
- If ble_gap_scan_params_t::extended is set to 0, the only supported PHY is BLE_GAP_PHY_1MBPS .
- When used with sd_ble_gap_scan_start , the bitfield indicates the PHYs the scanner will use for scanning on primary advertising channels. The scanner will accept BLE_GAP_PHYS_SUPPORTED as secondary advertising channel PHYs.
- When used with sd_ble_gap_connect , the bitfield indicates the PHYs the initiator will use for scanning on primary advertising channels. The initiator will accept connections initiated on either of the BLE_GAP_PHYS_SUPPORTED PHYs. If scan_phys contains BLE_GAP_PHY_1MBPS and/or BLE_GAP_PHY_2MBPS , the primary scan PHY is BLE_GAP_PHY_1MBPS .
| uint16_t ble_gap_scan_params_t::timeout |
Scan timeout in 10 ms units.
- See Also
- GAP Scan timeout max and min .
| uint16_t ble_gap_scan_params_t::window |
Scan window in 625 us units.
- See Also
- GAP Scan window max and min .