Macros
#define	GAP_ADV_INVALID_HANDLE 0xFF
	Invalid Advertising Handle for GAP Advertising API's.

#define	GAP_ADV_TX_POWER_NO_PREFERENCE 127
	Allow the controller to choose the Tx power.

#define	GAPADV_PARAMS_AE_LONG_RANGE_CONN
	Default parameters for long range, connectable, advertising extension. More...

#define	GAPADV_PARAMS_LEGACY_SCANN_CONN
	Default parameters for legacy, scannable, connectable advertising. More...

Enumerations
enum	GapAdv_advChannels_t { GAP_ADV_CHAN_37 = BV(0), GAP_ADV_CHAN_38 = BV(1), GAP_ADV_CHAN_39 = BV(2), GAP_ADV_CHAN_ALL }
	GAP Advertiser Defines for Advertiser Channels. More...

enum	GapAdv_dataTypes_t { GAP_ADV_DATA_TYPE_ADV, GAP_ADV_DATA_TYPE_SCAN_RSP }
	Gap Advertising Data Types. More...

enum	GapAdv_enableOptions_t { GAP_ADV_ENABLE_OPTIONS_USE_MAX, GAP_ADV_ENABLE_OPTIONS_USE_DURATION, GAP_ADV_ENABLE_OPTIONS_USE_MAX_EVENTS }
	Enable options for GapAdv_enable. More...

enum	GapAdv_eventMaskFlags_t { GAP_ADV_EVT_MASK_SCAN_REQ_NOTI = AE_NOTIFY_ENABLE_SCAN_REQUEST, GAP_ADV_EVT_MASK_SET_TERMINATED = BV(1), GAP_ADV_EVT_MASK_START_AFTER_ENABLE = AE_NOTIFY_ENABLE_ADV_SET_START, GAP_ADV_EVT_MASK_START = AE_NOTIFY_ENABLE_ADV_START, GAP_ADV_EVT_MASK_END = AE_NOTIFY_ENABLE_ADV_END, GAP_ADV_EVT_MASK_END_AFTER_DISABLE = AE_NOTIFY_ENABLE_ADV_SET_END, GAP_ADV_EVT_MASK_ALL }

enum	GapAdv_eventProps_t { GAP_ADV_PROP_CONNECTABLE = BV(0), GAP_ADV_PROP_SCANNABLE = BV(1), GAP_ADV_PROP_DIRECTED = BV(2), GAP_ADV_PROP_HDC = BV(3), GAP_ADV_PROP_LEGACY = BV(4), GAP_ADV_PROP_ANONYMOUS = BV(5), GAP_ADV_PROP_TX_POWER = BV(6) }
	GAP Advertising Event Param Properties. More...

enum	GapAdv_filterPolicy_t { GAP_ADV_WL_POLICY_ANY_REQ, GAP_ADV_WL_POLICY_WL_SCAN_REQ, GAP_ADV_WL_POLICY_WL_CONNECT_IND, GAP_ADV_WL_POLICY_WL_ALL_REQ }
	GAP Advertiser White List Policy. More...

enum	GapAdv_freeBufferOptions_t { GAP_ADV_FREE_OPTION_DONT_FREE, GAP_ADV_FREE_OPTION_ADV_DATA, GAP_ADV_FREE_OPTION_SCAN_RESP_DATA, GAP_ADV_FREE_OPTION_ALL_DATA }
	Possible free options for Gap Advertiser API's. More...

enum	GapAdv_primaryPHY_t { GAP_ADV_PRIM_PHY_1_MBPS = 0x01, GAP_ADV_PRIM_PHY_CODED_S8 = 0x03, GAP_ADV_PRIM_PHY_CODED_S2 = 0x83 }
	Gap Advertiser Options for advertising on the primary PHY. More...

enum	GapAdv_secondaryPHY_t { GAP_ADV_SEC_PHY_1_MBPS = 0x01, GAP_ADV_SEC_PHY_2_MBPS = 0x02, GAP_ADV_SEC_PHY_CODED_S8 = 0x03, GAP_ADV_SEC_PHY_CODED_S2 = 0x83 }
	Gap Advertiser Options for advertising on the secondary PHY. More...

Detailed Description

Other defines used in the GapAdv module

Macro Definition Documentation

§ GAPADV_PARAMS_AE_LONG_RANGE_CONN

#define GAPADV_PARAMS_AE_LONG_RANGE_CONN

Value:

{                                 \
  .eventProps = GAP_ADV_PROP_CONNECTABLE,                                  \
  .primIntMin = 160,                                                       \
  .primIntMax = 160,                                                       \
  .primChanMap = GAP_ADV_CHAN_ALL,                                         \
  .peerAddrType = PEER_ADDRTYPE_PUBLIC_OR_PUBLIC_ID,                       \
  .peerAddr = { 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa },                      \
  .filterPolicy = GAP_ADV_WL_POLICY_ANY_REQ,                               \
  .txPower = GAP_ADV_TX_POWER_NO_PREFERENCE,                               \
  .primPhy = GAP_ADV_PRIM_PHY_CODED_S2,                                    \
  .secPhy = GAP_ADV_SEC_PHY_CODED_S2,                                      \
  .sid = 0                                                                 \
}

Default parameters for long range, connectable, advertising extension.

§ GAPADV_PARAMS_LEGACY_SCANN_CONN

#define GAPADV_PARAMS_LEGACY_SCANN_CONN

Value:

{                                  \
  .eventProps = GAP_ADV_PROP_CONNECTABLE | GAP_ADV_PROP_SCANNABLE |        \
                GAP_ADV_PROP_LEGACY,                                       \
  .primIntMin = 160,                                                       \
  .primIntMax = 160,                                                       \
  .primChanMap = GAP_ADV_CHAN_ALL,                                         \
  .peerAddrType = PEER_ADDRTYPE_PUBLIC_OR_PUBLIC_ID,                       \
  .peerAddr = { 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa },                      \
  .filterPolicy = GAP_ADV_WL_POLICY_ANY_REQ,                               \
  .txPower = GAP_ADV_TX_POWER_NO_PREFERENCE,                               \
  .primPhy = GAP_ADV_PRIM_PHY_1_MBPS,                                      \
  .secPhy = GAP_ADV_SEC_PHY_1_MBPS,                                        \
  .sid = 0                                                                 \
}

Default parameters for legacy, scannable, connectable advertising.

Enumeration Type Documentation

§ GapAdv_advChannels_t

enum GapAdv_advChannels_t

GAP Advertiser Defines for Advertiser Channels.

Enumerator
GAP_ADV_CHAN_37	Channel 37.
GAP_ADV_CHAN_38	Channel 38.
GAP_ADV_CHAN_39	Channel 39.
GAP_ADV_CHAN_ALL	All Channels.

§ GapAdv_dataTypes_t

enum GapAdv_dataTypes_t

Gap Advertising Data Types.

Enumerator
GAP_ADV_DATA_TYPE_ADV	Advertising data.
GAP_ADV_DATA_TYPE_SCAN_RSP	Scan response data.

§ GapAdv_enableOptions_t

enum GapAdv_enableOptions_t

Enable options for GapAdv_enable.

Enumerator
GAP_ADV_ENABLE_OPTIONS_USE_MAX	Use the maximum possible value. This is the spec-defined maximum for directed advertising and infinite advertising for all other types
GAP_ADV_ENABLE_OPTIONS_USE_DURATION	Use the user-specified duration
GAP_ADV_ENABLE_OPTIONS_USE_MAX_EVENTS	Use the user-specified maximum number of events

§ GapAdv_eventMaskFlags_t

enum GapAdv_eventMaskFlags_t

GAP Advertiser bitfields to enable / disable callback events

These are used in GapAdv_setEventMask The events that that these flags control are defined in GapAdv Event IDs

Enumerator
GAP_ADV_EVT_MASK_SCAN_REQ_NOTI	Enables / disables the GAP_EVT_SCAN_REQ_RECEIVED event
GAP_ADV_EVT_MASK_SET_TERMINATED	Enables / disables the GAP_EVT_ADV_SET_TERMINATED event
GAP_ADV_EVT_MASK_START_AFTER_ENABLE	Enables / disables the GAP_EVT_ADV_START_AFTER_ENABLE event
GAP_ADV_EVT_MASK_START	Enables / disables the GAP_EVT_ADV_START event
GAP_ADV_EVT_MASK_END	Enables / disables the GAP_EVT_ADV_END event
GAP_ADV_EVT_MASK_END_AFTER_DISABLE	Enables / disables the GAP_EVT_ADV_END_AFTER_DISABLE event
GAP_ADV_EVT_MASK_ALL	Mask to enables / disable all advertising events

§ GapAdv_eventProps_t

enum GapAdv_eventProps_t

GAP Advertising Event Param Properties.

Enumerator
GAP_ADV_PROP_CONNECTABLE	Connectable advertising.
GAP_ADV_PROP_SCANNABLE	Scannable advertising.
GAP_ADV_PROP_DIRECTED	Directed advertising.
GAP_ADV_PROP_HDC	High Duty Cycle Directed Advertising.
GAP_ADV_PROP_LEGACY	Use legacy advertising PDU's.
GAP_ADV_PROP_ANONYMOUS	Omit advertiser's address from PDU's.
GAP_ADV_PROP_TX_POWER	Include TxPower in the extended header of the advertising PDU

§ GapAdv_filterPolicy_t

enum GapAdv_filterPolicy_t

GAP Advertiser White List Policy.

Enumerator
GAP_ADV_WL_POLICY_ANY_REQ	Process scan and connection requests from all devices (i.e., the White List is not in use)
GAP_ADV_WL_POLICY_WL_SCAN_REQ	Process connection requests from all devices and only scan requests from devices that are in the White List
GAP_ADV_WL_POLICY_WL_CONNECT_IND	Process scan requests from all devices and only connection requests from devices that are in the White List.
GAP_ADV_WL_POLICY_WL_ALL_REQ	Process scan and connection requests only from devices in the White List.

§ GapAdv_freeBufferOptions_t

enum GapAdv_freeBufferOptions_t

Possible free options for Gap Advertiser API's.

Enumerator
GAP_ADV_FREE_OPTION_DONT_FREE	Don't free anything, NOTE: do NOT use this flag - It has a known issue while using it.
GAP_ADV_FREE_OPTION_ADV_DATA	Free the advertising data.
GAP_ADV_FREE_OPTION_SCAN_RESP_DATA	Free the scan response data.
GAP_ADV_FREE_OPTION_ALL_DATA	Free both the advertising and scan response data

§ GapAdv_primaryPHY_t

enum GapAdv_primaryPHY_t

Gap Advertiser Options for advertising on the primary PHY.

Enumerator
GAP_ADV_PRIM_PHY_1_MBPS	1 mbps
GAP_ADV_PRIM_PHY_CODED_S8	coded-s8
GAP_ADV_PRIM_PHY_CODED_S2	coded-s2

§ GapAdv_secondaryPHY_t

enum GapAdv_secondaryPHY_t

Gap Advertiser Options for advertising on the secondary PHY.

Enumerator
GAP_ADV_SEC_PHY_1_MBPS	1 mbps
GAP_ADV_SEC_PHY_2_MBPS	2 mbps
GAP_ADV_SEC_PHY_CODED_S8	coded-s8
GAP_ADV_SEC_PHY_CODED_S2	coded-s2

Macros

Enumerations