TI BLE-Stack for Bluetooth 4.2 API Documentation  3.01.00.07
Macros
GAP Parameter IDs

Macros

#define TGAP_CONN_ADV_INT_MAX   11
 Maximum advertising interval, when in Connectable mode (n * 0.625 mSec) More...
 
#define TGAP_CONN_ADV_INT_MIN   10
 Minimum advertising interval, when in Connectable mode (n * 0.625 mSec) More...
 
#define TGAP_CONN_EST_ADV_TIMEOUT   4
 Advertising timeout when performing connection establishment (ms) More...
 
#define TGAP_CONN_EST_INT_MAX   22
 Maximum connection interval for connection establishment (n * 1.25 mSec) More...
 
#define TGAP_CONN_EST_INT_MIN   21
 Minimum connection interval for connection establishment (n * 1.25 mSec) More...
 
#define TGAP_CONN_EST_LATENCY   26
 Slave latency for connection establishment (in number of connection events) More...
 
#define TGAP_CONN_EST_MAX_CE_LEN   28
 Local informational parameter about max len of connection needed, when using Connection Establishment proc (n * 0.625 mSec) More...
 
#define TGAP_CONN_EST_MIN_CE_LEN   27
 Local informational parameter about min len of connection needed, when using Connection Establishment proc (n * 0.625 mSec) More...
 
#define TGAP_CONN_EST_SCAN_INT   23
 Scan interval used during during connection establishment (n * 0.625 mSec) More...
 
#define TGAP_CONN_EST_SCAN_WIND   24
 Scan window used during during connection establishment (n * 0.625 mSec) More...
 
#define TGAP_CONN_EST_SUPERV_TIMEOUT   25
 Connection supervision timeout for connection establishment (n * 10 mSec) More...
 
#define TGAP_CONN_HIGH_SCAN_INT   14
 Scan interval used during connection establishment, high duty scan cycle scan parameters (n * 0.625 mSec) More...
 
#define TGAP_CONN_HIGH_SCAN_WIND   15
 Scan window used during connection establishment, high duty scan cycle scan parameters (n * 0.625 mSec) More...
 
#define TGAP_CONN_PARAM_TIMEOUT   5
 Timeout for link layer to wait to receive connection parameter update response before giving up (ms) More...
 
#define TGAP_CONN_PAUSE_CENTRAL   30
 Central idle timer (seconds) More...
 
#define TGAP_CONN_PAUSE_PERIPHERAL   31
 Minimum time upon connection establishment before the peripheral starts a connection update procedure (seconds) More...
 
#define TGAP_CONN_SCAN_INT   12
 Scan interval used during connection establishment (n * 0.625 mSec) More...
 
#define TGAP_CONN_SCAN_WIND   13
 Scan window used during connection establishment (n * 0.625 mSec) More...
 
#define TGAP_FILTER_ADV_REPORTS   35
 Filter duplicate advertising reports. More...
 
#define TGAP_GEN_DISC_ADV_INT_MAX   9
 Maximum advertising interval in general discovery mode (n × 0.625 ms) More...
 
#define TGAP_GEN_DISC_ADV_INT_MIN   8
 Minimum advertising interval in general discovery mode (n × 0.625 ms) More...
 
#define TGAP_GEN_DISC_ADV_MIN   0
 Minimum time to remain advertising, when in general discoverable mode (ms) More...
 
#define TGAP_GEN_DISC_SCAN   2
 Time to perform scanning for general discovery (ms) More...
 
#define TGAP_GEN_DISC_SCAN_INT   16
 Scan interval used when in General Discovery proc (n * 0.625 mSec) More...
 
#define TGAP_GEN_DISC_SCAN_WIND   17
 Scan window used when in General Discovery proc (n * 0.625 mSec) More...
 
#define TGAP_LIM_ADV_TIMEOUT   1
 Time to remain advertising in limited discovery mode (sec) More...
 
#define TGAP_LIM_DISC_ADV_INT_MAX   7
 Maximum advertising interval in limited discovery mode (n × 0.625 ms) More...
 
#define TGAP_LIM_DISC_ADV_INT_MIN   6
 Minimum advertising interval in limited discovery mode (n × 0.625 ms) More...
 
#define TGAP_LIM_DISC_SCAN   3
 Time to perform scanning for limited discovery (ms) More...
 
#define TGAP_LIM_DISC_SCAN_INT   18
 Scan interval used when in Limited Discovery proc (n * 0.625 mSec) More...
 
#define TGAP_LIM_DISC_SCAN_WIND   19
 Scan window used when in Limited Discovery proc (n * 0.625 mSec) More...
 
#define TGAP_PRIVATE_ADDR_INT   29
 Minimum Time Interval between private (resolvable) address changes (minutes) More...
 
#define TGAP_REJECT_CONN_PARAMS   37
 Whether or not to reject Connection Parameter Update Request received on Central device. More...
 
#define TGAP_SCAN_RSP_RSSI_MIN   36
 Minimum RSSI required for scan responses to be reported to the app (dBm) More...
 
#define TGAP_SM_MAX_KEY_LEN   34
 SM Maximum Key Length supported. More...
 
#define TGAP_SM_MIN_KEY_LEN   33
 SM Minimum Key Length supported. More...
 
#define TGAP_SM_TIMEOUT   32
 Time to wait for security manager response before returning bleTimeout (ms) More...
 

Detailed Description

Parameters set via GAP_SetParamValue

Macro Definition Documentation

§ TGAP_CONN_ADV_INT_MAX

#define TGAP_CONN_ADV_INT_MAX   11

Maximum advertising interval, when in Connectable mode (n * 0.625 mSec)

default: 2048

range: 32-16384

§ TGAP_CONN_ADV_INT_MIN

#define TGAP_CONN_ADV_INT_MIN   10

Minimum advertising interval, when in Connectable mode (n * 0.625 mSec)

default: 2048

range: 32-16384

§ TGAP_CONN_EST_ADV_TIMEOUT

#define TGAP_CONN_EST_ADV_TIMEOUT   4

Advertising timeout when performing connection establishment (ms)

default: 10240

range: 1-65535

§ TGAP_CONN_EST_INT_MAX

#define TGAP_CONN_EST_INT_MAX   22

Maximum connection interval for connection establishment (n * 1.25 mSec)

default: 80

range: 6-3200

§ TGAP_CONN_EST_INT_MIN

#define TGAP_CONN_EST_INT_MIN   21

Minimum connection interval for connection establishment (n * 1.25 mSec)

default: 80

range: 6-3200

§ TGAP_CONN_EST_LATENCY

#define TGAP_CONN_EST_LATENCY   26

Slave latency for connection establishment (in number of connection events)

default: 0

range: 0-499

§ TGAP_CONN_EST_MAX_CE_LEN

#define TGAP_CONN_EST_MAX_CE_LEN   28

Local informational parameter about max len of connection needed, when using Connection Establishment proc (n * 0.625 mSec)

default: 0

range: > TGAP_CONN_EST_MIN_CE_LEN

§ TGAP_CONN_EST_MIN_CE_LEN

#define TGAP_CONN_EST_MIN_CE_LEN   27

Local informational parameter about min len of connection needed, when using Connection Establishment proc (n * 0.625 mSec)

default: 0

range: < TGAP_CONN_EST_MAX_CE_LEN

§ TGAP_CONN_EST_SCAN_INT

#define TGAP_CONN_EST_SCAN_INT   23

Scan interval used during during connection establishment (n * 0.625 mSec)

default: 16

range: 4-16384

§ TGAP_CONN_EST_SCAN_WIND

#define TGAP_CONN_EST_SCAN_WIND   24

Scan window used during during connection establishment (n * 0.625 mSec)

default: 16

range: 4-16384

§ TGAP_CONN_EST_SUPERV_TIMEOUT

#define TGAP_CONN_EST_SUPERV_TIMEOUT   25

Connection supervision timeout for connection establishment (n * 10 mSec)

default: 2000

range: 10-3200

§ TGAP_CONN_HIGH_SCAN_INT

#define TGAP_CONN_HIGH_SCAN_INT   14

Scan interval used during connection establishment, high duty scan cycle scan parameters (n * 0.625 mSec)

default: 16

range: 4-16384

§ TGAP_CONN_HIGH_SCAN_WIND

#define TGAP_CONN_HIGH_SCAN_WIND   15

Scan window used during connection establishment, high duty scan cycle scan parameters (n * 0.625 mSec)

default: 16

range: 4-16384

§ TGAP_CONN_PARAM_TIMEOUT

#define TGAP_CONN_PARAM_TIMEOUT   5

Timeout for link layer to wait to receive connection parameter update response before giving up (ms)

default: 30000

range: 1-65535

§ TGAP_CONN_PAUSE_CENTRAL

#define TGAP_CONN_PAUSE_CENTRAL   30

Central idle timer (seconds)

default: 1

range: 1-65535

§ TGAP_CONN_PAUSE_PERIPHERAL

#define TGAP_CONN_PAUSE_PERIPHERAL   31

Minimum time upon connection establishment before the peripheral starts a connection update procedure (seconds)

default: 5

range: 1-65535

§ TGAP_CONN_SCAN_INT

#define TGAP_CONN_SCAN_INT   12

Scan interval used during connection establishment (n * 0.625 mSec)

default: 480

range: 4-16384

§ TGAP_CONN_SCAN_WIND

#define TGAP_CONN_SCAN_WIND   13

Scan window used during connection establishment (n * 0.625 mSec)

default: 240

range: 4-16384

§ TGAP_FILTER_ADV_REPORTS

#define TGAP_FILTER_ADV_REPORTS   35

Filter duplicate advertising reports.

default: TRUE

range: 0-1

§ TGAP_GEN_DISC_ADV_INT_MAX

#define TGAP_GEN_DISC_ADV_INT_MAX   9

Maximum advertising interval in general discovery mode (n × 0.625 ms)

default: 160

range: 32-16384

§ TGAP_GEN_DISC_ADV_INT_MIN

#define TGAP_GEN_DISC_ADV_INT_MIN   8

Minimum advertising interval in general discovery mode (n × 0.625 ms)

default: 160

range: 32-16384

§ TGAP_GEN_DISC_ADV_MIN

#define TGAP_GEN_DISC_ADV_MIN   0

Minimum time to remain advertising, when in general discoverable mode (ms)

Setting this parameter to 0 turns off the timeout, thus allowing infinite advertising

default: 0

range: 0-65535

§ TGAP_GEN_DISC_SCAN

#define TGAP_GEN_DISC_SCAN   2

Time to perform scanning for general discovery (ms)

default: 10240

range: 1-65535

§ TGAP_GEN_DISC_SCAN_INT

#define TGAP_GEN_DISC_SCAN_INT   16

Scan interval used when in General Discovery proc (n * 0.625 mSec)

default: 16

range: 4-16384

§ TGAP_GEN_DISC_SCAN_WIND

#define TGAP_GEN_DISC_SCAN_WIND   17

Scan window used when in General Discovery proc (n * 0.625 mSec)

default: 16

range: 4-16384

§ TGAP_LIM_ADV_TIMEOUT

#define TGAP_LIM_ADV_TIMEOUT   1

Time to remain advertising in limited discovery mode (sec)

default: 180

range: 1-65535

§ TGAP_LIM_DISC_ADV_INT_MAX

#define TGAP_LIM_DISC_ADV_INT_MAX   7

Maximum advertising interval in limited discovery mode (n × 0.625 ms)

default: 160

range: 32-16384

§ TGAP_LIM_DISC_ADV_INT_MIN

#define TGAP_LIM_DISC_ADV_INT_MIN   6

Minimum advertising interval in limited discovery mode (n × 0.625 ms)

default: 160

range: 32-16384

§ TGAP_LIM_DISC_SCAN

#define TGAP_LIM_DISC_SCAN   3

Time to perform scanning for limited discovery (ms)

default: 10240

range: 1-65535

§ TGAP_LIM_DISC_SCAN_INT

#define TGAP_LIM_DISC_SCAN_INT   18

Scan interval used when in Limited Discovery proc (n * 0.625 mSec)

default: 16

range: 4-16384

§ TGAP_LIM_DISC_SCAN_WIND

#define TGAP_LIM_DISC_SCAN_WIND   19

Scan window used when in Limited Discovery proc (n * 0.625 mSec)

default: 16

range: 4-16384

§ TGAP_PRIVATE_ADDR_INT

#define TGAP_PRIVATE_ADDR_INT   29

Minimum Time Interval between private (resolvable) address changes (minutes)

default: 15

range: 1-65535

§ TGAP_REJECT_CONN_PARAMS

#define TGAP_REJECT_CONN_PARAMS   37

Whether or not to reject Connection Parameter Update Request received on Central device.

default: FALSE

range: 0-1

§ TGAP_SCAN_RSP_RSSI_MIN

#define TGAP_SCAN_RSP_RSSI_MIN   36

Minimum RSSI required for scan responses to be reported to the app (dBm)

default: -127

range: -965535 - 0

§ TGAP_SM_MAX_KEY_LEN

#define TGAP_SM_MAX_KEY_LEN   34

SM Maximum Key Length supported.

default: 16

range: 1-65535

§ TGAP_SM_MIN_KEY_LEN

#define TGAP_SM_MIN_KEY_LEN   33

SM Minimum Key Length supported.

default: 7

range: 1-65535

§ TGAP_SM_TIMEOUT

#define TGAP_SM_TIMEOUT   32

Time to wait for security manager response before returning bleTimeout (ms)

default: 30000

range: 1-65535

Copyright 2017, Texas Instruments Incorporated