105
SWRU271H – October 2010 – Revised April 2019
Copyright © 2010–2019, Texas Instruments Incorporated
GAP API
Appendix A
SWRU271H – October 2010 – Revised April 2019
GAP API
A.1
Commands
This section details the GAP commands from gap.h which the application uses. Other GAP commands
are abstracted through the GAPRole or the GAPBondMgr.
uint16 GAP_GetParamValue (gapParamIDs_t paramID)
Get a GAP parameter.
Parameters
paramID – parameter ID (
Returns
GAP Parameter Value if successful
0xFFFF if paramID invalid
bStatus_t GAP_SetParamValue (gapParamIDs_t paramID, uint16 paramValue)
Set a GAP parameter.
Parameters
paramID – parameter ID (Section A.2)
paramValue – new param value
Returns
SUCCESS
INVALIDPARAMETER: paramID is invalid
A.2
Configurable Parameters
ParamID
Description
TGAP_GEN_DISC_ADV_MIN
Minimum time (ms) to remain advertising in Discovery mode.
Setting this to 0 turns off this time-out, thus advertising
infinitely. Default is 0.
TGAP_LIM_ADV_TIMEOUT
Maximum time (sec) to remain advertising in Limited Discovery
mode. Default is 180 seconds.
TGAP_GEN_DISC_SCAN
Minimum time (ms) to perform scanning for General Discovery
TGAP_LIM_DISC_SCAN
Minimum time (ms) to perform scanning for Limited Discovery
TGAP_CONN_EST_ADV_TIMEOUT
Advertising time-out (ms) when performing Connection
Establishment
TGAP_CONN_PARAM_TIMEOUT
Time-out (ms) for link layer to wait to receive connection
parameter update response
TGAP_LIM_DISC_ADV_INT_MIN
Minimum advertising interval in limited discovery mode
(n × 0.625 ms)
TGAP_LIM_DISC_ADV_INT_MAX
Maximum advertising interval in limited discovery mode
(n × 0.625 ms)
TGAP_GEN_DISC_ADV_INT_MIN
Minimum advertising interval in general discovery mode
(n × 0.625 ms)
TGAP_GEN_DISC_ADV_INT_MAX
Maximum advertising interval in general discovery mode
(n × 0.625 ms)
TGAP_CONN_ADV_INT_MIN
Minimum advertising interval when in connectable mode
(n × 0.625 ms)