GapScan Params

Enumerations
enum	GapScan_ParamId_t {   SCAN_PARAM_RPT_FIELDS, SCAN_PARAM_PRIM_PHYS, SCAN_PARAM_FLT_POLICY, SCAN_PARAM_FLT_PDU_TYPE,   SCAN_PARAM_FLT_MIN_RSSI, SCAN_PARAM_FLT_DISC_MODE, SCAN_PARAM_FLT_DUP, SCAN_PARAM_NUM_ADV_RPT = SCAN_NUM_RW_PARAM }

Detailed Description

Params used in the GapAdv module

Enumeration Type Documentation

GapScan_ParamId_t

enum GapScan_ParamId_t

GAP Scanner Parameters

These can be set with GapScan_setParam and read with GapScan_getParam. The default values below refer to the values that are set at initialization.

Enumerator
SCAN_PARAM_RPT_FIELDS	Advertising Report Fields (R/W) Bit mask of which fields in the GapScan_Evt_AdvRpt_t need to be stored in the AdvRptList Note Change of this parameter shall not be attempted while scanning is active size: uint16_t default: SCAN_PARAM_DFLT_RPT_FIELDS range: combination of individual values in GapScan_AdvRptField_t
SCAN_PARAM_PRIM_PHYS	Primary Scanning Channel PHYs (R/W) PHYs on which advertisements should be received on the primary advertising channel. Note Change of this parameter will not affect an ongoing scanning. If changed during scanning, it will take effect when the scanning is re-enabled after disabled. size: uint8_t default: SCAN_PARAM_DFLT_PHYS range: GapScan_PrimPhy_t
SCAN_PARAM_FLT_POLICY	Scanning Filter Policy (R/W) Policy of how to apply white list to filter out unwanted packets Note Change of this parameter will not affect an ongoing scanning. If changed during scanning, it will take effect when the scanning is re-enabled after disabled. size: uint8_t default: SCAN_PARAM_DFLT_FLT_POLICY range: GapScan_FilterPolicy_t
SCAN_PARAM_FLT_PDU_TYPE	Filter by PDU Type (R/W) This filter value specifies packets of which types in 6 different category sets are wanted. The 6 sets include Connectable/Non-Connectable, Scannable/Non-Scannable, Directed/Undirected, ScanRsp/Adv, Legacy/Extended, and Complete/Incomplete category sets. Each set has two mutually exclusive types. Only one type in a set can be* chosen. For example, SCAN_FLT_PDU_NONSCANNABLE_ONLY and SCAN_FLT_PDU_SCANNABLE_ONLY cannot be chosen together. Only either one can be used. If neither type is selected in a set, the filter will not care about the category. For example, if neither SCAN_FLT_PDU_NONCONNECTABLE_ONLY nor SCAN_FLT_PDU_CONNECTABLE_ONLY is set in the parameter value, the scanner will accept both connectable packets and non-connectable packets. Usage example: GapScan_setParam(SCAN_PARAM_FLT_PDU_TYPE, SCAN_FLT_PDU_CONNECTABLE_ONLY | SCAN_FLT_PDU_UNDIRECTED_ONLY | SCAN_FLT_PDU_EXTENDED_ONLY | SCAN_FLT_PDU_COMPLETE_ONLY); With the call above, the scanner will receive only connectable, undirected, extended(non-legacy), and complete packets. It will not be examined whether the packets are scannable or non-scannable and whether they are scan responses or advertisements. size: uint16_t default: SCAN_PARAM_DFLT_FLT_PDU range: combination of individual values in GapScan_FilterPduType_t
SCAN_PARAM_FLT_MIN_RSSI	Filter by Minimum RSSI (R/W) Only packets received with the specified RSSI or above will be accepted. Note -128 means to ignore RSSI (to not filter out any packet by RSSI) size: int8_t default: -128 (ignore) range: -128 - 127 (dBm)
SCAN_PARAM_FLT_DISC_MODE	Filter by Discoverable Mode (R/W) Note Change of this parameter shall not be attempted while scanning is active size: uint8_t default: SCAN_PARAM_DFLT_FLT_DISC range: GapScan_FilterDiscMode_t
SCAN_PARAM_FLT_DUP	Duplicate Filtering (R/W) Specify whether and when to filter out duplicated packets by DID and address Note Change of this parameter will not affect an ongoing scanning. If changed during scanning, it will take effect when the scanning is re-enabled after disabled. size: uint8_t default: SCAN_PARAM_DFLT_FLT_DUP range: GapScan_FilterDuplicate_t
SCAN_PARAM_NUM_ADV_RPT	Number of Reports Recorded (R) Number of advertising reports recorded since the current scanning started. Note This number will be the same as numReport that will come with GAP_EVT_ADV_REPORT when the scanning has ended. size: uint8_t range: 0 up to maxNumReport specified when GapScan_enable() is called