Micro Gap Layer

Modules
	Micro GAP Broadcaster Callbacks
	Micro GAP Broadcaster Structures
	Micro GAP Constants
	Micro GAP Monitor Callbacks
	Micro GAP Monitor Structures

Files
file	ugap.h
	Micro BLE GAP API.

Functions
bStatus_t	ugap_bcastInit (ugapBcastCBs_t *pCBs)
	Initialize Micro Broadcaster. More...
bStatus_t	ugap_bcastSetDuty (uint16 dutyOnTime, uint16 dutyOffTime)
	Set Broadcaster Duty On/Off time. More...
bStatus_t	ugap_bcastStart (uint16 numAdvEvent)
	Start Broadcaster. Proceed the state from either Initialized or IDLE to Advertising. More...
bStatus_t	ugap_bcastStop (void)
	Stop Broadcaster. Proceed the state from either Advertising or Waiting to IDLE. More...
bStatus_t	ugap_monitorInit (ugapMonitorCBs_t *pCBs)
	Initialize Micro Monitor. More...
bStatus_t	ugap_monitorRequest (uint8_t channel, uint32_t accessAddr, uint32_t startTime, uint16_t duration)
	uGAP monitor request More...
bStatus_t	ugap_monitorStart (void)
	Start Monitor scanning. Proceed the state from either Initialized or Idle to Monitoring. More...
bStatus_t	ugap_monitorStop (void)
	Stop Monitor scanning. Proceed the state from Monitoring to Idle. More...

Detailed Description

Function Documentation

ugap_bcastInit()

bStatus_t ugap_bcastInit

(

ugapBcastCBs_t *

pCBs

)

Initialize Micro Broadcaster.

Parameters

pCBs	- a set of application callbacks for Broadcaster

Returns

SUCCESS

INVALIDPARAMETER

FAILURE

ugap_bcastSetDuty()

bStatus_t ugap_bcastSetDuty	(	uint16	dutyOnTime,
		uint16	dutyOffTime
	)

Set Broadcaster Duty On/Off time.

Parameters

dutyOnTime	- Time period during which the Broadcaster is in Advertising state. 100 ms unit. This cannot be 0 unless dutyOffTime is also 0.
dutyOffTime	- Time period during which the Broadcaster is in Waiting state. 100 ms unit. If this is 0, Duty Control is disabled regardless of dutyOnTime.

Returns

SUCCESS

INVALIDPARAMETER

ugap_bcastStart()

bStatus_t ugap_bcastStart

(

uint16

numAdvEvent

)

Start Broadcaster. Proceed the state from either Initialized or IDLE to Advertising.

Parameters

numAdvEvent

- # of Advertising events to be performed before the Broadcaster state goes to IDLE. If this is 0, the Broadcaster will keep staying in Advertising or Advertising and Waiting alternately unless an error happens or the application requests to stop.

Returns

SUCCESS

FAILURE

INVALIDPARAMETER

ugap_bcastStop()

bStatus_t ugap_bcastStop

(

void

)

Stop Broadcaster. Proceed the state from either Advertising or Waiting to IDLE.

Returns

SUCCESS

INVALIDPARAMETER

FAILURE

ugap_monitorInit()

bStatus_t ugap_monitorInit

(

ugapMonitorCBs_t *

pCBs

)

Initialize Micro Monitor.

Parameters

pCBs	- a set of application callbacks for Monitor

Returns

SUCCESS

FAILURE

INVALIDPARAMETER

ugap_monitorRequest()

bStatus_t ugap_monitorRequest	(	uint8_t	channel,
		uint32_t	accessAddr,
		uint32_t	startTime,
		uint16_t	duration
	)

uGAP monitor request

Parameters

channel	- Channels to monitor.
accessAddr	- Access address. 0xFFFFFFFF is used as a wildcard access address. An error status will be returned if the channel is one of 37, 38, or 39 but the accessAddr is not 0x8E89BED6.
startTime	- Absolute start time in RAT ticks.
duration	- Scan window per scanChanIndexchanIndex. A monitor complete time-out statuscallback will be sent to the application. A zero indicates a continuous scan. Unit in 0.625 ms; range from 2.5 ms to 40.959375 s.

Returns

SUCCESS

INVALIDPARAMETER

ugap_monitorStart()

bStatus_t ugap_monitorStart

(

void

)

Start Monitor scanning. Proceed the state from either Initialized or Idle to Monitoring.

Returns

SUCCESS

FAILURE

ugap_monitorStop()

bStatus_t ugap_monitorStop

(

void

)

Stop Monitor scanning. Proceed the state from Monitoring to Idle.

Returns

SUCCESS

FAILURE