TI BLE5-Stack API Documentation  2.01.03.00
Modules | Enumerations
GapScan Constants

Modules

 GAPScan Default Parameter Value
 
 GAPScan Filter Minimum RSSI
 
 GAPScan RSSI Values
 

Enumerations

enum  GapScan_AdvRptField_t {
  SCAN_ADVRPT_FLD_EVENTTYPE = BV( 0), SCAN_ADVRPT_FLD_ADDRTYPE = BV( 1), SCAN_ADVRPT_FLD_ADDRESS = BV( 2), SCAN_ADVRPT_FLD_PRIMPHY = BV( 3),
  SCAN_ADVRPT_FLD_SECPHY = BV( 4), SCAN_ADVRPT_FLD_ADVSID = BV( 5), SCAN_ADVRPT_FLD_TXPOWER = BV( 6), SCAN_ADVRPT_FLD_RSSI = BV( 7),
  SCAN_ADVRPT_FLD_DIRADDRTYPE = BV( 8), SCAN_ADVRPT_FLD_DIRADDRESS = BV( 9), SCAN_ADVRPT_FLD_PRDADVINTERVAL = BV(10), SCAN_ADVRPT_FLD_DATALEN = BV(11)
}
 Fields of Adv Report. More...
 
enum  GapScan_AdvRptTypeNStatus_t {
  ADV_RPT_EVT_TYPE_CONNECTABLE = AE_EVT_TYPE_CONN_ADV, ADV_RPT_EVT_TYPE_SCANNABLE = AE_EVT_TYPE_SCAN_ADV, ADV_RPT_EVT_TYPE_DIRECTED = AE_EVT_TYPE_DIR_ADV, ADV_RPT_EVT_TYPE_SCAN_RSP = AE_EVT_TYPE_SCAN_RSP,
  ADV_RPT_EVT_TYPE_LEGACY = AE_EVT_TYPE_LEGACY, ADV_RPT_EVT_STATUS_COMPLETE = AE_EVT_TYPE_COMPLETE, ADV_RPT_EVT_STATUS_MORE_DATA = AE_EVT_TYPE_INCOMPLETE_MORE_TO_COME, ADV_RPT_EVT_STATUS_TRUNCATED = AE_EVT_TYPE_INCOMPLETE_NO_MORE_TO_COME,
  ADV_RPT_EVT_STATUS_RFU = AE_EVT_TYPE_RFU
}
 Advertising report event types. More...
 
enum  GapScan_EndReason_t { SCAN_END_REASON_USR_REQ = 0, SCAN_END_REASON_DUR_EXP }
 Reason for GapScan_Evt_End_t. More...
 
enum  GapScan_FilterPduType_t {
  SCAN_FLT_PDU_NONCONNECTABLE_ONLY = ADV_RPT_EVT_TYPE_CONNECTABLE, SCAN_FLT_PDU_CONNECTABLE_ONLY = ADV_RPT_EVT_TYPE_CONNECTABLE << 1, SCAN_FLT_PDU_NONSCANNABLE_ONLY = ADV_RPT_EVT_TYPE_SCANNABLE << 1, SCAN_FLT_PDU_SCANNABLE_ONLY = ADV_RPT_EVT_TYPE_SCANNABLE << 2,
  SCAN_FLT_PDU_UNDIRECTED_ONLY = ADV_RPT_EVT_TYPE_DIRECTED << 2, SCAN_FLT_PDU_DIRECTED_ONLY = ADV_RPT_EVT_TYPE_DIRECTED << 3, SCAN_FLT_PDU_ADV_ONLY = ADV_RPT_EVT_TYPE_SCAN_RSP << 3, SCAN_FLT_PDU_SCANRSP_ONLY = ADV_RPT_EVT_TYPE_SCAN_RSP << 4,
  SCAN_FLT_PDU_EXTENDED_ONLY = ADV_RPT_EVT_TYPE_LEGACY << 4, SCAN_FLT_PDU_LEGACY_ONLY = ADV_RPT_EVT_TYPE_LEGACY << 5, SCAN_FLT_PDU_TRUNCATED_ONLY = BV(10), SCAN_FLT_PDU_COMPLETE_ONLY = BV(11)
}
 PDU Types for PDU Type Filter. More...
 
enum  GapScan_PrimPhy_t { SCAN_PRIM_PHY_1M = LL_PHY_1_MBPS, SCAN_PRIM_PHY_CODED = LL_PHY_CODED }
 GAP Scanner Primary PHY. More...
 

Detailed Description

Other defines used in the GapScan module

Enumeration Type Documentation

§ GapScan_AdvRptField_t

Fields of Adv Report.

Enumerator
SCAN_ADVRPT_FLD_EVENTTYPE 

eventType field

SCAN_ADVRPT_FLD_ADDRTYPE 

addrType field

SCAN_ADVRPT_FLD_ADDRESS 

address field

SCAN_ADVRPT_FLD_PRIMPHY 

primPhy field

SCAN_ADVRPT_FLD_SECPHY 

secPhy field

SCAN_ADVRPT_FLD_ADVSID 

advSid field

SCAN_ADVRPT_FLD_TXPOWER 

txPower field

SCAN_ADVRPT_FLD_RSSI 

RSSI field.

SCAN_ADVRPT_FLD_DIRADDRTYPE 

dirAddrType field

SCAN_ADVRPT_FLD_DIRADDRESS 

dirAddress field

SCAN_ADVRPT_FLD_PRDADVINTERVAL 

prdAdvInterval field

SCAN_ADVRPT_FLD_DATALEN 

dataLen field

§ GapScan_AdvRptTypeNStatus_t

Advertising report event types.

Enumerator
ADV_RPT_EVT_TYPE_CONNECTABLE 

Connectable.

ADV_RPT_EVT_TYPE_SCANNABLE 

Scannable.

ADV_RPT_EVT_TYPE_DIRECTED 

Directed.

ADV_RPT_EVT_TYPE_SCAN_RSP 

Scan Response.

ADV_RPT_EVT_TYPE_LEGACY 

Legacy.

ADV_RPT_EVT_STATUS_COMPLETE 

Complete.

ADV_RPT_EVT_STATUS_MORE_DATA 

More Data To Come.

ADV_RPT_EVT_STATUS_TRUNCATED 

Truncated.

ADV_RPT_EVT_STATUS_RFU 

Reserved for Future Use.

§ GapScan_EndReason_t

Reason for GapScan_Evt_End_t.

Enumerator
SCAN_END_REASON_USR_REQ 

Scanning ended by user request.

SCAN_END_REASON_DUR_EXP 

Scanning ended by duration expiration.

§ GapScan_FilterPduType_t

PDU Types for PDU Type Filter.

Enumerator
SCAN_FLT_PDU_NONCONNECTABLE_ONLY 

Non-connectable only. Mutually exclusive with SCAN_FLT_PDU_CONNECTABLE_ONLY.

SCAN_FLT_PDU_CONNECTABLE_ONLY 

Connectable only. Mutually exclusive with SCAN_FLT_PDU_NONCONNECTABLE_ONLY.

SCAN_FLT_PDU_NONSCANNABLE_ONLY 

Non-scannable only. Mutually exclusive with SCAN_FLT_PDU_SCANNABLE_ONLY.

SCAN_FLT_PDU_SCANNABLE_ONLY 

Scannable only. Mutually exclusive with SCAN_FLT_PDU_NONSCANNABLE_ONLY.

SCAN_FLT_PDU_UNDIRECTED_ONLY 

Undirected only. Mutually exclusive with SCAN_FLT_PDU_DIRECTIED_ONLY.

SCAN_FLT_PDU_DIRECTED_ONLY 

Directed only. Mutually exclusive with SCAN_FLT_PDU_UNDIRECTED_ONLY.

SCAN_FLT_PDU_ADV_ONLY 

Advertisement only. Mutually exclusive with SCAN_FLT_PDU_SCANRSP_ONLY.

SCAN_FLT_PDU_SCANRSP_ONLY 

Scan Response only. Mutually exclusive with SCAN_FLT_PDU_ADV_ONLY.

SCAN_FLT_PDU_EXTENDED_ONLY 

Extended only. Mutually exclusive with SCAN_FLT_PDU_LEGACY_ONLY.

SCAN_FLT_PDU_LEGACY_ONLY 

Legacy only. Mutually exclusive with SCAN_FLT_PDU_EXTENDED_ONLY.

SCAN_FLT_PDU_TRUNCATED_ONLY 

Truncated only. Mutually exclusive with SCAN_FLT_PDU_COMPLETE_ONLY.

SCAN_FLT_PDU_COMPLETE_ONLY 

Complete only. Mutually exclusive with SCAN_FLT_PDU_TRUNCATED_ONLY.

§ GapScan_PrimPhy_t

GAP Scanner Primary PHY.

Enumerator
SCAN_PRIM_PHY_1M 

Scan on the 1M PHY.

SCAN_PRIM_PHY_CODED 

Scan on the Coded PHY.

© Copyright 1995-2020, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale