COMMON IO-BLE v1.0.0
Hardware abstraction layer for Bluetooth
 
Loading...
Searching...
No Matches
Typedefs
BLE Adapter Manager Callbacks

Callbacks for BLE Adapter Manager Interface. More...

Typedefs

typedef void(* BTRegisterBleAdapterCallback_t) (BTStatus_t xStatus, uint8_t ucAdapterIf, BTUuid_t *pxAppUuid)
 Callback invoked in response pxRegisterBleApp.
 
typedef void(* BTBleDevicePropertiesCallback_t) (BTStatus_t xStatus, uint32_t ulNumProperties, BTBleProperty_t *pxProperties)
 Callback invoked in response to pxGetBleAdapterProperty and pxSetBleAdapterProperty.
 
typedef void(* BTBleRemoteDevicePropertiesCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxBdAddr, uint32_t ulNumProperties, BTBleProperty_t *pxProperties)
 Callback invoked in response to pxGetBleRemoteDeviceProperty and pxSetBleRemoteDeviceProperty.
 
typedef void(* BTScanResultCallback_t) (BTBdaddr_t *pxBda, uint32_t ulRssi, uint8_t *pucAdvData)
 Callback invoked in response to pxScan.
 
typedef void(* BTAdvStatusCallback_t) (BTStatus_t xStatus, uint8_t ucAdapterIf, bool bStart)
 Callback invoked on pxStartAdv and stop advertisement.
 
typedef void(* BTSetAdvDataCallback_t) (BTStatus_t xStatus)
 Callback invoked on pxSetAdvData.
 
typedef void(* BTConnParameterUpdateCallback_t) (BTStatus_t xStatus, const BTBdaddr_t *pxBdAddr, uint32_t ulMinInterval, uint32_t ulMaxInterval, uint32_t ulLatency, uint32_t usConnInterval, uint32_t ulTimeout)
 Callback invoked on when a peer device makes a request. The callback is triggered by pxConnParameterUpdateRequest.
 
typedef void(* BTScanFilterCfgCallback_t) (uint32_t ulAction, uint8_t ucAdapterIf, BTStatus_t xStatus, uint32_t ulFiltType, uint32_t ulAvblSpace)
 Callback invoked when a scan filter configuration command has completed.
 
typedef void(* BTScanFilterParamCallback_t) (uint32_t ulAction, uint8_t ucAdapterIf, BTStatus_t xStatus, uint32_t ulAvblSpace)
 Callback invoked on pxScanFilterParamSetup.
 
typedef void(* BTScanFilterStatusCallback_t) (bool bEnable, uint8_t ucAdapterIf, BTStatus_t xStatus)
 Callback invoked on pxScanFilterEnable.
 
typedef void(* BTMultiAdvEnableCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
 Callback invoked on pxMultiAdvEnable.
 
typedef void(* BTMultiAdvUpdateCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
 Callback invoked on pxMultiAdvUpdate.
 
typedef void(* BTMultiAdvDataCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
 Callback invoked on pxMultiAdvSetInstData and pxMultiAdvSetInstRawData.
 
typedef void(* BTMultiAdvDisableCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
 Callback invoked on pxMultiAdvDisable.
 
typedef void(* BTBatchscanCfgStorageCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
 Callback invoked on pxBatchscanCfgStorage.
 
typedef void(* BTBatchscanEnableDisableCallback_t) (uint32_t ulAction, uint8_t ucAdapterIf, BTStatus_t xStatus)
 Callback invoked on pxBatchscanDisBatchScan and TBD.
 
typedef void(* BTBatchscanReportsCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus, uint32_t ulReportFormat, uint32_t ulNumRecords, size_t XDataLen, uint8_t *pucRepData)
 Callback invoked on pxBatchscanReadReports.
 
typedef void(* BTBatchscanThresholdCallback_t) (uint8_t ucAdapterIf)
 Callback invoked when batchscan storage threshold limit is crossed.
 
typedef void(* BTTrackAdvEventCallback_t) (BTGattTrackAdvInfo_t *pxTrackAdvInfo)
 Track ADV VSE callback invoked when tracked device is found or lost.
 
typedef void(* BTPhyUpdatedCallback_t) (uint16_t usConnId, uint8_t ucTxPhy, uint8_t ucRxPhy, BTStatus_t xStatus)
 Callback invoked on pxSetPreferredPhy.
 
typedef void(* BTReadClientPhyCallback_t) (uint16_t usConnId, uint8_t ucTxPhy, uint8_t ucRxPhy, BTStatus_t xStatus)
 Callback invoked on pxReadPhy.
 

Detailed Description

Callbacks for BLE Adapter Manager Interface.

Typedef Documentation

◆ BTRegisterBleAdapterCallback_t

typedef void(* BTRegisterBleAdapterCallback_t) (BTStatus_t xStatus, uint8_t ucAdapterIf, BTUuid_t *pxAppUuid)

Callback invoked in response pxRegisterBleApp.

BLE Adapter callback structure.

Parameters
[in]xStatusReturns eBTStatusSuccess if operation succeeded.
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp.
[in]pxAppUuidUUID of the adapter.

◆ BTBleDevicePropertiesCallback_t

typedef void(* BTBleDevicePropertiesCallback_t) (BTStatus_t xStatus, uint32_t ulNumProperties, BTBleProperty_t *pxProperties)

Callback invoked in response to pxGetBleAdapterProperty and pxSetBleAdapterProperty.

Parameters
[in]xStatusReturns eBTStatusSuccess if operation succeeded.
[in]ulNumPropertiesNumber of BLE specific properties.
[in]pxPropertiesProperties array.

◆ BTBleRemoteDevicePropertiesCallback_t

typedef void(* BTBleRemoteDevicePropertiesCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxBdAddr, uint32_t ulNumProperties, BTBleProperty_t *pxProperties)

Callback invoked in response to pxGetBleRemoteDeviceProperty and pxSetBleRemoteDeviceProperty.

Parameters
[in]xStatusReturns eBTStatusSuccess if operation succeeded.
[in]pxBdAddrAddress of the Remote device
[in]ulNumPropertiesNumber of BLE specific properties.
[in]pxPropertiesProperties array.

◆ BTScanResultCallback_t

typedef void(* BTScanResultCallback_t) (BTBdaddr_t *pxBda, uint32_t ulRssi, uint8_t *pucAdvData)

Callback invoked in response to pxScan.

Parameters
[in]pxBdaRemote device address.
[in]ulRssi
[in]pucAdvData

◆ BTAdvStatusCallback_t

typedef void(* BTAdvStatusCallback_t) (BTStatus_t xStatus, uint8_t ucAdapterIf, bool bStart)

Callback invoked on pxStartAdv and stop advertisement.

GATT open callback invoked in response to open

Parameters
[in]xStatusReturns eBTStatusSuccess if operation succeeded.
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp.
[in]bStartTrue for start advertisement, flase for stop

◆ BTSetAdvDataCallback_t

typedef void(* BTSetAdvDataCallback_t) (BTStatus_t xStatus)

Callback invoked on pxSetAdvData.

Parameters
[in]xStatusReturns eBTStatusSuccess if operation succeeded.

◆ BTConnParameterUpdateCallback_t

typedef void(* BTConnParameterUpdateCallback_t) (BTStatus_t xStatus, const BTBdaddr_t *pxBdAddr, uint32_t ulMinInterval, uint32_t ulMaxInterval, uint32_t ulLatency, uint32_t usConnInterval, uint32_t ulTimeout)

Callback invoked on when a peer device makes a request. The callback is triggered by pxConnParameterUpdateRequest.

Parameters
[in]xStatusReturns eBTStatusSuccess if operation succeeded.
[in]pxBdAddrAddress of the Remote device.
[in]ulMinIntervalMinimum connection interval.
[in]ulMaxIntervalMax connection interval.
[in]ulLatencySlave latency.
[in]usConnIntervalActual connection interval.
[in]ulTimeoutConnection timeout.

◆ BTScanFilterCfgCallback_t

typedef void(* BTScanFilterCfgCallback_t) (uint32_t ulAction, uint8_t ucAdapterIf, BTStatus_t xStatus, uint32_t ulFiltType, uint32_t ulAvblSpace)

Callback invoked when a scan filter configuration command has completed.

Parameters
[in]ulAction
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]xStatusReturns eBTStatusSuccess if operation succeeded.
[in]ulFiltType
[in]ulAvblSpace

◆ BTScanFilterParamCallback_t

typedef void(* BTScanFilterParamCallback_t) (uint32_t ulAction, uint8_t ucAdapterIf, BTStatus_t xStatus, uint32_t ulAvblSpace)

Callback invoked on pxScanFilterParamSetup.

Parameters
[in]ulAction
[in]ucAdapterIf
[in]xStatus
[in]ulAvblSpace

◆ BTScanFilterStatusCallback_t

typedef void(* BTScanFilterStatusCallback_t) (bool bEnable, uint8_t ucAdapterIf, BTStatus_t xStatus)

Callback invoked on pxScanFilterEnable.

Parameters
[in]bEnableTrue if filter is enabled.
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]xStatusReturns eBTStatusSuccess if operation succeeded.

◆ BTMultiAdvEnableCallback_t

typedef void(* BTMultiAdvEnableCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)

Callback invoked on pxMultiAdvEnable.

Parameters
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]xStatusReturns eBTStatusSuccess if operation succeeded.

◆ BTMultiAdvUpdateCallback_t

typedef void(* BTMultiAdvUpdateCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)

Callback invoked on pxMultiAdvUpdate.

Parameters
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]xStatusReturns eBTStatusSuccess if operation succeeded.

◆ BTMultiAdvDataCallback_t

typedef void(* BTMultiAdvDataCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)

Callback invoked on pxMultiAdvSetInstData and pxMultiAdvSetInstRawData.

Parameters
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]xStatusReturns eBTStatusSuccess if operation succeeded.

◆ BTMultiAdvDisableCallback_t

typedef void(* BTMultiAdvDisableCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)

Callback invoked on pxMultiAdvDisable.

Parameters
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]xStatusReturns eBTStatusSuccess if operation succeeded.

◆ BTBatchscanCfgStorageCallback_t

typedef void(* BTBatchscanCfgStorageCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)

Callback invoked on pxBatchscanCfgStorage.

Parameters
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]xStatusReturns eBTStatusSuccess if operation succeeded.

◆ BTBatchscanEnableDisableCallback_t

typedef void(* BTBatchscanEnableDisableCallback_t) (uint32_t ulAction, uint8_t ucAdapterIf, BTStatus_t xStatus)

Callback invoked on pxBatchscanDisBatchScan and TBD.

Parameters
[in]ulAction
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]xStatusReturns eBTStatusSuccess if operation succeeded.

◆ BTBatchscanReportsCallback_t

typedef void(* BTBatchscanReportsCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus, uint32_t ulReportFormat, uint32_t ulNumRecords, size_t XDataLen, uint8_t *pucRepData)

Callback invoked on pxBatchscanReadReports.

Parameters
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp.
[in]xStatusReturns eBTStatusSuccess if operation succeeded.
[in]ulReportFormat
[in]ulNumRecords
[in]XDataLen
[in]pucRepData

◆ BTBatchscanThresholdCallback_t

typedef void(* BTBatchscanThresholdCallback_t) (uint8_t ucAdapterIf)

Callback invoked when batchscan storage threshold limit is crossed.

Parameters
[in]ucAdapterIfAdapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp.

◆ BTTrackAdvEventCallback_t

typedef void(* BTTrackAdvEventCallback_t) (BTGattTrackAdvInfo_t *pxTrackAdvInfo)

Track ADV VSE callback invoked when tracked device is found or lost.

Parameters
[in]pxTrackAdvInfo

◆ BTPhyUpdatedCallback_t

typedef void(* BTPhyUpdatedCallback_t) (uint16_t usConnId, uint8_t ucTxPhy, uint8_t ucRxPhy, BTStatus_t xStatus)

Callback invoked on pxSetPreferredPhy.

Parameters
[in]usConnIdConnection ID return from BTConnectCallback_t.
[in]ucTxPhy
[in]ucRxPhy
[in]xStatusReturns eBTStatusSuccess if operation succeeded.

◆ BTReadClientPhyCallback_t

typedef void(* BTReadClientPhyCallback_t) (uint16_t usConnId, uint8_t ucTxPhy, uint8_t ucRxPhy, BTStatus_t xStatus)

Callback invoked on pxReadPhy.

Parameters
[in]usConnIdConnection ID return from BTConnectCallback_t.
[in]ucTxPhy
[in]ucRxPhy
[in]xStatusReturns eBTStatusSuccess if operation succeeded.