Gap Initiator

This module implements the Host Initiator. More...

Modules
	GapInit Constants
	GapInit Params
	GapInit Structures

Files
file	gap_initiator.h
	GAP Initiator layer interface.

Functions
status_t	GapInit_cancelConnect (void)
status_t	GapInit_connect (GAP_Peer_Addr_Types_t peerAddrType, uint8_t *pPeerAddress, uint8_t phys, uint16_t timeout)
status_t	GapInit_connectWl (uint8_t phys, uint16_t timeout)
status_t	GapInit_getPhyParam (uint8_t phy, GapInit_PhyParamId_t paramId, uint16_t *pValue)
status_t	GapInit_setPhyParam (uint8_t phys, GapInit_PhyParamId_t paramId, uint16_t value)

Detailed Description

This module implements the Host Initiator.

Function Documentation

GapInit_cancelConnect()

status_t GapInit_cancelConnect

(

void

)

Cancel the ongoing connection process.

Returns

SUCCESS

bleNotReady

bleIncorrectMode

GapInit_connect()

status_t GapInit_connect	(	GAP_Peer_Addr_Types_t	peerAddrType,
		uint8_t *	pPeerAddress,
		uint8_t	phys,
		uint16_t	timeout
	)

Initiate connection with the specified peer device

Parameters

peerAddrType	peer device's address type.
pPeerAddress	peer device's address
phys	PHY to try making connection on: shall be one from GapInit_InitPhy_t.
timeout	If there is no chance to initiate a connection within timeout ms, this connect request will be canceled automatically. if timeout is 0, the initiator will keep trying to get a chance to make a connection until GapInit_cancelConnect is called.

Returns

SUCCESS

bleNotReady

bleInvalidRange

bleMemAllocError

bleAlreadyInRequestedMode

GapInit_connectWl()

status_t GapInit_connectWl	(	uint8_t	phys,
		uint16_t	timeout
	)

Parameters

phys	PHY to try making connection on: shall be one from GapInit_InitPhy_t.
timeout	If there is no chance to initiate a connection within timeout ms, this connect request will be canceled automatically. if timeout is 0, the initiator will keep trying to get a chance to make a connection until GapInit_cancelConnect is called.

Returns

SUCCESS

bleNotReady

bleInvalidRange

bleMemAllocError

bleAlreadyInRequestedMode

GapInit_getPhyParam()

status_t GapInit_getPhyParam	(	uint8_t	phy,
		GapInit_PhyParamId_t	paramId,
		uint16_t *	pValue
	)

Get parameters of the specified PHY.

Note

Phy shall indicate only one PHY.

Parameters

phy	connection channel PHY: shall be one from GapInit_InitPhy_t.
paramId	parameter ID
pValue	pointer to where the parameter value is to be stored

Returns

SUCCESS

INVALIDPARAMETER

bleInvalidRange

GapInit_setPhyParam()

status_t GapInit_setPhyParam	(	uint8_t	phys,
		GapInit_PhyParamId_t	paramId,
		uint16_t	value
	)

Set parameters dependent on PHY.

Note

that if phys contains more than one PHY, the same parameter of those PHYs will be set with the same value.

Parameters

phys	connection channel PHY(s): Individual PHY values of GapInit_InitPhy_t can be OR'ed.
paramId	parameter ID
value	parameter value

Returns

SUCCESS

bleInvalidRange