TI BLE5-Stack API Documentation  1.00.01.04
Data Structures | Macros | Typedefs | Functions
ugap.h File Reference

Detailed Description

Micro BLE GAP API.

This file contains the interface to the Micro GAP Layer.

Go to the source code of this file.

Data Structures

struct  ugBcastCBs_t
 Set of Broadcaster callbacks - must be setup by the application. More...
 

Macros

#define UG_BCAST_STATE_ADVERTISING   3
 Advertising.
 
#define UG_BCAST_STATE_IDLE   2
 Advertising or Waiting stopped.
 
#define UG_BCAST_STATE_INITIALIZED   1
 Initialized. Waiting for start request.
 
#define UG_BCAST_STATE_INVALID   0
 Invalid state. Not even initialized.
 
#define UG_BCAST_STATE_SUSPENDED   5
 Advertising or Waiting is suspended.
 
#define UG_BCAST_STATE_WAITING   4
 Advertising paused during duty off period.
 
#define UG_DUTY_TIME_UNIT   100L
 Duty Control Time Unit. More...
 
#define UGB_EVT_ADV_POSTPROCESS   3
 Adv has just been done. Do post processing if necessary.
 
#define UGB_EVT_ADV_PREPARE   2
 About to issue the next adv. Prepare adv payload.
 
#define UGB_EVT_STATE_CHANGE   1
 Broadcaster's state has changed.
 

Typedefs

typedef void(* ugbAdvDoneCb_t) (bStatus_t status)
 Callback of when an Advertising Event has just been done. More...
 
typedef void(* ugbAdvPrepareCb_t) (void)
 Callback of when the next Adverting Event is about to start. More...
 
typedef uint8 ugBcastState_t
 Broadcaster state.
 
typedef void(* ugbStateChangeCb_t) (ugBcastState_t state)
 Callback of when the Broadcaster's state changes. More...
 

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...
 
Copyright 2017, Texas Instruments Incorporated