TI BLE-Stack for Bluetooth API Documentation
3.03.01.00
|
This module implements the GAP Bond Manager For a detailed usage section describing how to send these commands and receive events, see the GAPBondMgr Section of the User's Guide. More...
Modules | |
GAP Bond Manager Callbacks | |
GAP Bond Manager Constants | |
GAP Bond Manager Structures | |
Files | |
file | gapbondmgr.h |
GAPBondMgr layer interface. | |
Functions | |
uint8_t | GAPBondMgr_CheckNVLen (uint8_t id, uint8_t len) |
This function will check the length of a Bond Manager NV Item. More... | |
bStatus_t | GAPBondMgr_GetParameter (uint16_t param, void *pValue) |
Get a GAP Bond Manager parameter. More... | |
bStatus_t | GAPBondMgr_LinkEst (uint8_t addrType, uint8_t *pDevAddr, uint16_t connHandle, uint8_t role) |
Notify the Bond Manager that a connection has been made. More... | |
void | GAPBondMgr_LinkTerm (uint16_t connHandle) |
Notify the Bond Manager that a connection has been terminated. More... | |
bStatus_t | GAPBondMgr_PasscodeRsp (uint16_t connectionHandle, uint8_t status, uint32_t passcode) |
Respond to a passcode request. More... | |
uint8_t | GAPBondMgr_ProcessGAPMsg (gapEventHdr_t *pMsg) |
This is a bypass mechanism to allow the bond manager to process GAP messages. More... | |
bStatus_t | GAPBondMgr_ReadCentAddrResChar (uint16_t connectionHandle) |
Read Central Address Resolution Characteristic. More... | |
void | GAPBondMgr_Register (gapBondCBs_t *pCB) |
Register callback functions with the bond manager. More... | |
uint8_t | GAPBondMgr_ResolveAddr (uint8_t addrType, uint8_t *pDevAddr, uint8_t *pResolvedAddr) |
Resolve an address from bonding information. More... | |
bStatus_t | GAPBondMgr_ServiceChangeInd (uint16_t connectionHandle, uint8_t setParam) |
Set/clear the service change indication in a bond record. More... | |
bStatus_t | GAPBondMgr_SetParameter (uint16_t param, uint8_t len, void *pValue) |
Set a GAP Bond Manager parameter. More... | |
void | GAPBondMgr_SlaveReqSecurity (uint16_t connHandle, uint8_t authReq) |
Notify the Bond Manager that a Slave Security Request is received. More... | |
uint8_t | GAPBondMgr_SupportsEnhancedPriv (uint8_t *pPeerIdAddr) |
Determine if peer device supports enhanced privacy by checking the Enhanced Privacy state flag of the bond record that corresponds to the peer's identity address. More... | |
bStatus_t | GAPBondMgr_syncResolvingList (void) |
This function will add all device address and IRK pairs from bond records to the Controller. Used with PRIVACY_1_2_CFG. More... | |
bStatus_t | GAPBondMgr_UpdateCharCfg (uint16_t connectionHandle, uint16_t attrHandle, uint16_t value) |
Update the Characteristic Configuration in a bond record. More... | |
This module implements the GAP Bond Manager For a detailed usage section describing how to send these commands and receive events, see the GAPBondMgr Section of the User's Guide.
uint8_t GAPBondMgr_CheckNVLen | ( | uint8_t | id, |
uint8_t | len | ||
) |
bStatus_t GAPBondMgr_GetParameter | ( | uint16_t | param, |
void * | pValue | ||
) |
Get a GAP Bond Manager parameter.
param | - Profile parameter ID: GAP Bond Manager Parameters |
pValue | - pointer to location to get the value. This is dependent on the parameter ID and WILL be cast to the appropriate data type (example: data type of uint16_t will be cast to uint16_t pointer). |
bStatus_t GAPBondMgr_LinkEst | ( | uint8_t | addrType, |
uint8_t * | pDevAddr, | ||
uint16_t | connHandle, | ||
uint8_t | role | ||
) |
Notify the Bond Manager that a connection has been made.
addrType | - Device Address Type |
pDevAddr | - device's address |
connHandle | - connection handle |
role | - GAP Profile Roles |
void GAPBondMgr_LinkTerm | ( | uint16_t | connHandle | ) |
Notify the Bond Manager that a connection has been terminated.
connHandle | - connection handle |
bStatus_t GAPBondMgr_PasscodeRsp | ( | uint16_t | connectionHandle, |
uint8_t | status, | ||
uint32_t | passcode | ||
) |
Respond to a passcode request.
connectionHandle | - connection handle of the connected device or 0xFFFF if all devices in database. |
status | - SUCCESS if passcode is available, otherwise see Pairing failure status values. |
passcode | - integer value containing the passcode. |
uint8_t GAPBondMgr_ProcessGAPMsg | ( | gapEventHdr_t * | pMsg | ) |
This is a bypass mechanism to allow the bond manager to process GAP messages.
pMsg | - GAP event message |
bStatus_t GAPBondMgr_ReadCentAddrResChar | ( | uint16_t | connectionHandle | ) |
Read Central Address Resolution Characteristic.
Send Read By Type Request to get value attribute of Central Address Resolution characteristic. Value determines if peer supports Enhanced Privacy. Bond record will automatically be updated based on peer response
connectionHandle | - connection handle of the connected device |
void GAPBondMgr_Register | ( | gapBondCBs_t * | pCB | ) |
Register callback functions with the bond manager.
pCB | - pointer to callback function structure. |
uint8_t GAPBondMgr_ResolveAddr | ( | uint8_t | addrType, |
uint8_t * | pDevAddr, | ||
uint8_t * | pResolvedAddr | ||
) |
Resolve an address from bonding information.
addrType | - Device Address Type |
pDevAddr | - peer's address |
pResolvedAddr | - pointer to buffer to put the resolved address |
bStatus_t GAPBondMgr_ServiceChangeInd | ( | uint16_t | connectionHandle, |
uint8_t | setParam | ||
) |
Set/clear the service change indication in a bond record.
connectionHandle | - connection handle of the connected device or 0xFFFF if all devices in database. |
setParam | - TRUE to set the service change indication, FALSE to clear it. |
bStatus_t GAPBondMgr_SetParameter | ( | uint16_t | param, |
uint8_t | len, | ||
void * | pValue | ||
) |
Set a GAP Bond Manager parameter.
param | - GAP Bond Manager Parameters |
len | - length of data to write |
pValue | - pointer to data to write. This is dependent on the parameter ID and WILL be cast to the appropriate data type (example: data type of uint16_t will be cast to uint16_t pointer). |
void GAPBondMgr_SlaveReqSecurity | ( | uint16_t | connHandle, |
uint8_t | authReq | ||
) |
Notify the Bond Manager that a Slave Security Request is received.
connHandle | - connection handle |
authReq | - slave device's authentication requirements |
uint8_t GAPBondMgr_SupportsEnhancedPriv | ( | uint8_t * | pPeerIdAddr | ) |
Determine if peer device supports enhanced privacy by checking the Enhanced Privacy state flag of the bond record that corresponds to the peer's identity address.
pPeerIdAddr | - peer identity address |
bStatus_t GAPBondMgr_syncResolvingList | ( | void | ) |
bStatus_t GAPBondMgr_UpdateCharCfg | ( | uint16_t | connectionHandle, |
uint16_t | attrHandle, | ||
uint16_t | value | ||
) |
Update the Characteristic Configuration in a bond record.
connectionHandle | - connection handle of the connected device or 0xFFFF if all devices in database. |
attrHandle | - attribute handle. |
value | - characteristic configuration value. |