GapAdv Params

Enumerations
enum	GapAdv_ParamId_t {   GAP_ADV_PARAM_PROPS, GAP_ADV_PARAM_PRIMARY_INTERVAL_MIN, GAP_ADV_PARAM_PRIMARY_INTERVAL_MAX, GAP_ADV_PARAM_PRIMARY_CHANNEL_MAP,   GAP_ADV_PARAM_PEER_ADDRESS_TYPE, GAP_ADV_PARAM_PEER_ADDRESS, GAP_ADV_PARAM_FILTER_POLICY, GAP_ADV_PARAM_TX_POWER,   GAP_ADV_PARAM_PRIMARY_PHY, GAP_ADV_PARAM_SECONDARY_PHY, GAP_ADV_PARAM_SID }

Detailed Description

Params used in the GapAdv module

Enumeration Type Documentation

GapAdv_ParamId_t

enum GapAdv_ParamId_t

GAP Advertising Parameters

These can be set with GapAdv_setParam and read with GapAdv_getParam. They do not have default values since it is required to pass a set of parameters into GapAdv_create

Each advertising handle can have a different set of parameters.

All parameters are readable and writable

Enumerator
GAP_ADV_PARAM_PROPS	Advertising Event Properties size: uint16_t range: GapAdv_eventProps_t
GAP_ADV_PARAM_PRIMARY_INTERVAL_MIN	Minimum advertising interval (n * 0.625 ms) This is for undirected and low duty cycle directed advertising size: uint32_t range: 20 ms to 10,485.759375 s
GAP_ADV_PARAM_PRIMARY_INTERVAL_MAX	Maximum advertising interval (n * 0.625 ms This is for undirected and low duty cycle directed advertising Note This will be ignored as the GAP_ADV_PARAM_PRIMARY_INTERVAL_MIN is always used size: uint32_t range: 20 ms to 10,485.759375 s
GAP_ADV_PARAM_PRIMARY_CHANNEL_MAP	Primary Channel Map A bit field that indicates the advertising channels that shall be used when transmitting advertising packets size: uint8_t range: GapAdv_advChannels_t
GAP_ADV_PARAM_PEER_ADDRESS_TYPE	Peer Address Type for Directed Advertising size: uint8_t range: GAP_Peer_Addr_Types_t
GAP_ADV_PARAM_PEER_ADDRESS	Peer Address for Directed Advertising size: uint8_t[6] range: 0x000000000000 - 0xFFFFFFFFFFFE
GAP_ADV_PARAM_FILTER_POLICY	Advertising Filter Policy size: uint8_t range: GapAdv_filterPolicy_t
GAP_ADV_PARAM_TX_POWER	Advertising Tx Power This is the maximum power level at which the advertising packets are to be transmitted on the advertising channels. The Controller will choose a power level lower than or equal to this. Note When setting this parameter, the host will overwrite the value with the new chosen value if it is set successfully. Warning In order to set this parameter, GAP_ADV_PARAM_PROPS must be set to include GAP_ADV_PROP_TX_POWER size: int8_t units: dBm range: -127 to +20 or GAP_ADV_TX_POWER_NO_PREFERENCE
GAP_ADV_PARAM_PRIMARY_PHY	Primary PHY The PHY on which the advertising packets are transmitted on the primary advertising channel. size: uint8_t range: GapAdv_primaryPHY_t
GAP_ADV_PARAM_SECONDARY_PHY	Secondary PHY The PHY on which the advertising packets are be transmitted on the secondary advertising channel. size: uint8_t range: GapAdv_secondaryPHY_t
GAP_ADV_PARAM_SID	Advertising SID (set identity) This is the value to be transmitted in the Advertising SID subfield of the ADI field of the Extended Header of those advertising channel PDUs that have an ADI field. If the advertising set only uses PDUs that do not contain an ADI field, this parameter is ignored. size: uint8_t range: 0-15