TI BLE5-Stack API Documentation  1.00.01.04
Modules | Files | Functions
Micro Gap Layer

Modules

 Micro GAP Callbacks
 
 Micro GAP Constants
 
 Micro GAP Structures
 

Files

file  ugap.h
 Micro BLE GAP API.
 

Functions

bStatus_t ug_bcastInit (ugBcastCBs_t *pCBs)
 Initialize Micro Broadcaster. More...
 
bStatus_t ug_bcastSetDuty (uint16 dutyOnTime, uint16 dutyOffTime)
 Set Broadcaster Duty On/Off time. More...
 
bStatus_t ug_bcastStart (uint16 numAdvEvent)
 Start Broadcaster. Proceed the state from either Initialized or IDLE to Advertising. More...
 
bStatus_t ug_bcastStop (void)
 Stop Broadcaster. Proceed the state from either Advertising or Waiting to IDLE. More...
 

Detailed Description

Function Documentation

§ ug_bcastInit()

bStatus_t ug_bcastInit ( ugBcastCBs_t pCBs)

Initialize Micro Broadcaster.

Parameters
pCBs- a set of application callbacks for Broadcaster
Returns
SUCCESS
INVALIDPARAMETER
FAILURE

§ ug_bcastSetDuty()

bStatus_t ug_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

§ ug_bcastStart()

bStatus_t ug_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

§ ug_bcastStop()

bStatus_t ug_bcastStop ( void  )

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

Returns
SUCCESS
INVALIDPARAMETER
FAILURE
Copyright 2017, Texas Instruments Incorporated