BT provides the interfaces to control the Bluetooth device. ,local device control and device discovery functionalities. More...

Data Structures
struct	BTAvsrcCallbacks_t

struct	BTAvsrcInterface_t

struct	BTGattUnformattedValue_t
	Buffer type for unformatted reads/writes. More...

struct	BTGattReadParams_t
	Parameters for GATT read operations. More...

struct	BTGattWriteParams_t
	Parameters for GATT write operations. More...

struct	BTGattNotifyParams_t
	Parameters for attribute change notifications. More...

struct	BTGattTestParams_t
	Parameters for test command interface. More...

struct	BTGattClientCallbacks_t

struct	BTGattClientInterface_t

struct	BTGattValue_t
	GATT value type used in response to remote read/Write requests. More...

union	BTGattResponse_t
	GATT response to read and write. More...

struct	BTGattServerCallbacks_t
	Callback structure for GATT server. More...

struct	BTGattServerInterface_t

struct	BTGattInstanceId_t
	GATT service instance ID. More...

struct	BTGattSrvcId_t
	GATT Service ID. More...

struct	BTGattTrackAdvInfo_t
	Structure that contains all advertisements info. Used to compress parameters in BTTrackAdvEventCallback_t. More...

struct	BTCharacteristic_t
	Structure describing a characteristic. More...

struct	BTCharacteristicDescr_t
	Structure describing a characteristic descriptor. More...

struct	BTIncludedService_t
	Structure describing an included service. More...

struct	BTAttribute_t
	Generic BLE attribute. More...

struct	BTService_t
	Structure describing a service. Note, handles are allocated separately so the attribute array can be allocated in ROM. pxHandlesBuffer has to dimensions: x and y [x][y] . x : Number of copies of the service y : needs to be equal to xNumberOfAttributes. More...

struct	BTGattDbElement_t

struct	BTPinCode_t
	Bluetooth PinKey Code, Valid only for BT legacy. More...

struct	BTProperty_t
	Bluetooth Adapter Property data structure. More...

struct	BTOutOfBandData_t
	Bluetooth Out Of Band data for bonding. More...

struct	BTActivityEnergyInfo
	Energy info. More...

struct	BTUidTraffic_t
	UUID traffic info. More...

struct	BTCallbacks_t
	Bluetooth DM callback structure. More...

struct	BTInterface_t
	Represents the standard SAL device management interface. More...

struct	BTGattFiltParamSetup_t
	Scan Filter Parameters. More...

struct	BTGattAdvName_t
	Advertising Name Format. More...

struct	BTGattAdvertismentParams_t
	Advertising Parameters. More...

struct	BTLocalLeFeatures_t
	Local supported LE features. More...

struct	BTBleProperty_t
	BLE Device Property. More...

struct	BTBleAdapterCallbacks_t
	Callback structure for BLE adapter. More...

struct	BTBleAdapter_t
	BLE adapter API. More...

struct	BTServiceRecord_t
	Bluetooth SDP service record. More...

struct	BTEirManfInfo_t
	manufacturer information EIR data More...

struct	BTGadgetEirManfInfo_t
	gadget manufacturer information EIR data More...

struct	BTClassicProperty_t
	Classic Device Property. More...

struct	BTClassicCallbacks_t

struct	BTClassicInterface_t

struct	BTBdaddr_t
	BT/BLE address. More...

struct	BTBdname_t
	Device Name. More...

struct	BTUuid_t
	UUID. More...

Macros
#define	btGATT_MAX_ATTR_LEN 600

#define	btMAJOR_VERSION 5
	Incompatible API changes without backward compatibility.

#define	btMINOR_VERSION 1
	Add new functionality with backward compatibility.

#define	btPATCH_VERSION 0
	Make changes in the API with backward compatibility.

#define	btSTR_HELPER(x, y, z) # x "." # y "." # z
	Help functions to convert version to string.

#define	btSTR(x, y, z) btSTR_HELPER( x, y, z )

#define	btSTRING_VERSION btSTR( btMAJOR_VERSION, btMINOR_VERSION, btPATCH_VERSION )
	Stringified version number.

#define	btBLE_ADD_BLOB_SERVICE_SUPPORTED_BIT 0x0001 /** Support GATT server database decleration as a blob. */

#define	btBLE_ADD_BLE_DYNAMIC_PRIVACY 0x0002 /** Stack can dynamicall enable or disable privacy. */

#define	btBLE_BLE_CENTRAL_WHITELISTING 0x0004 /** Provide a mechanism to manage whitelist for Gatt server. */

#define	BT_HAL_BLE_ADV_TX_PWR_ULTRA_LOW 0 /* Ultra Low Adv Tx Power */

#define	BT_HAL_BLE_ADV_TX_PWR_LOW 1 /* Low Adv Tx Power */

#define	BT_HAL_BLE_ADV_TX_PWR_MEDIUM 2 /* Medium Adv Tx Power */

#define	BT_HAL_BLE_ADV_TX_PWR_HIGH 3 /* High Adv Tx Power */

#define	BT_HAL_BLE_ADV_TX_PWR_ULTRA_HIGH 4 /* Ultra High Adv Tx Power */

#define	bt128BIT_UUID_LEN 16
	Size in byte of 128bits UUID.

#define	btADDRESS_LEN 6
	Size in byte of BT/BLE addresses.

#define	btKEY_MAX_LEN 16

Typedefs
typedef void(*	BTAvsrcConnectionStateCallback_t) (BTAvConnectionState_t xState, BTBdaddr_t *pxBdAddr)
	Callback invoked in to notify AV connection state change. More...

typedef void(*	BTAvsrcAudioStateCallback_t) (BTAvAudioState_t xState, BTBdaddr_t *pxBdAddr)
	Callback invoked in to notify AV Audio state change. More...

typedef void(*	BTAvsrcAclPriorityCallback_t) (BTAvsrcAclPriority_t xPriority, BTBdaddr_t *pxBdAddr)
	Callback invoked when ACL priority changes Priority can change when the stack enables/disables silent A2DP data while A2DP keepalive feature is enabled. More...

typedef void(*	BTRegisterClientCallback_t) (BTGattStatus_t xStatus, uint8_t ucClientIf, BTUuid_t *pxAppUuid)
	Callback invoked in response pxRegisterClient when the GATT client registration has been completed. More...

typedef void(*	BTSearchCompleteCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus)
	Callback invoked in response to pxSearchService when the GATT service search has been completed. More...

typedef void(*	BTRegisterForNotificationCallback_t) (uint16_t usConnId, bool bRegistered, BTGattStatus_t xStatus, uint16_t usHandle)
	Callback invoked in response to pxRegisterForNotification and pxUnregisterForNotification. More...

typedef void(*	BTNotifyCallback_t) (uint16_t usConnId, BTGattNotifyParams_t *pxData)
	Remote device notification callback, invoked when a remote device sends a notification or indication that a client has registered for. More...

typedef void(*	BTReadCharacteristicCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, BTGattReadParams_t *pxData)
	Reports result of a GATT read operation. Triggered by pxReadCharacteristic. More...

typedef void(*	BTWriteCharacteristicCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint16_t usHandle)
	GATT write characteristic operation callback. Triggered by pxWriteCharacteristic. More...

typedef void(*	BTExecuteWriteCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus)
	GATT execute prepared write callback. Triggered by pxExecuteWrite. More...

typedef void(*	BTReadDescriptorCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, BTGattReadParams_t *pxData)
	Callback invoked in response to pxReadDescriptor. More...

typedef void(*	BTWriteDescriptorCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint16_t usHandle)
	Callback invoked in response to pxWriteDescriptor. More...

typedef void(*	BTListenCallback_t) (BTGattStatus_t xStatus, uint32_t ulServerIf)
	Callback indicating the status of a listen() operation. More...

typedef void(*	BTConfigureMtuCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint32_t ulMtu)
	Callback invoked when the MTU for a given connection changes. Triggered by pxConfigureMtu. More...

typedef void(*	BTGetGattDbCallback_t) (uint16_t usConnId, BTGattDbElement_t *pxDb, uint32_t ulCount)
	GATT get database callback. Triggered by pxGetGattDb. More...

typedef void(*	BTServicesRemovedCallback_t) (uint16_t usConnId, uint16_t usStartHandle, uint16_t usEndHandle)
	GATT services between startHandle and endHandle were removed. More...

typedef void(*	BTServicesAddedCallback_t) (uint16_t usConnId, BTGattDbElement_t *pxAdded, uint32_t ulAddedCount)
	GATT services were added. More...

typedef void(*	BTRegisterServerCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, BTUuid_t *pxAppUuid)
	Callback invoked in response to pxRegisterServer. More...

typedef void(*	BTUnregisterServerCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf)
	Callback invoked in response to pxUnregisterServer. More...

typedef void(*	BTConnectionCallback_t) (uint16_t usConnId, uint8_t ucServerIf, bool bConnected, BTBdaddr_t *pxBda)
	Callback invoked on a connection event. More...

typedef void(*	BTServiceAddedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, BTGattSrvcId_t *pxSrvcId, uint16_t usServiceHandle)
	Callback invoked in response to pxAddService. More...

typedef void(*	BTIncludedServiceAddedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, uint16_t usServiceHandle, uint16_t usInclSrvcHandle)
	Callback invoked in response to pxAddIncludedService. More...

typedef void(*	BTCharacteristicAddedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, BTUuid_t *pxUuid, uint16_t usServiceHandle, uint16_t usCharHandle)
	Callback invoked in response to pxAddCharacteristic. More...

typedef void(*	BTSetValCallback_t) (BTStatus_t xStatus, uint16_t usAttrHandle)
	Callback invoked in response to pxSetVal. More...

typedef void(*	BTDescriptorAddedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, BTUuid_t *pxUuid, uint16_t usServiceHandle, uint16_t usDescrHandle)
	Callback invoked in response to pxAddDescriptor. More...

typedef void(*	BTServiceStartedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, uint16_t usServiceHandle)
	Callback invoked in response to pxStartService. More...

typedef void(*	BTServiceStoppedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, uint16_t usServiceHandle)
	Callback invoked in response to pxStopService. More...

typedef void(*	BTServiceDeletedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, uint16_t usServiceHandle)
	Callback invoked in response to pxDeleteService. More...

typedef void(*	BTRequestReadCallback_t) (uint16_t usConnId, uint32_t ulTransId, BTBdaddr_t *pxBda, uint16_t usAttrHandle, uint16_t usOffset)
	Callback invoked on read event. More...

typedef void(*	BTRequestWriteCallback_t) (uint16_t usConnId, uint32_t ulTransId, BTBdaddr_t pxBda, uint16_t usAttrHandle, uint16_t usOffset, size_t xLength, bool bNeedRsp, bool bIsPrep, uint8_t pucValue)
	Callback invoked on write event. More...

typedef void(*	BTRequestExecWriteCallback_t) (uint16_t usConnId, uint32_t ulTransId, BTBdaddr_t *pxBda, bool bExecWrite)
	Callback invoked on execute write event. More...

typedef void(*	BTResponseConfirmationCallback_t) (BTStatus_t xStatus, uint16_t usHandle)
	Callback triggered in response to sendResponse if the remote device sends a confirmation. More...

typedef void(*	BTIndicationSentCallback_t) (uint16_t usConnId, BTStatus_t xStatus)
	Callback on confirmation device from the remote device to an indication. Or confirm a Notification as been sent. More...

typedef void(*	BTMtuChangedCallback_t) (uint16_t usConnId, uint16_t usMtu)
	Callback invoked when the MTU for a given connection changes. More...

typedef void(*	BTWhiteListChangedCallback_t) (const BTBdaddr_t *pxBdAddr, bool bIsAdded)
	Callback for notifying modification in white list. More...

typedef uint16_t	BTCharProperties_t

typedef uint16_t	BTCharPermissions_t

typedef BTUuid_t	BTServiceUUID_t
	Structure describing a service UUID.

typedef void(*	BTConnectCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint8_t ucClientIf, BTBdaddr_t *pxBda)

typedef void(*	BTDisconnectCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint8_t ucClientIf, BTBdaddr_t *pxBda)

typedef void(*	BTReadRemoteRssiCallback_t) (uint8_t ucClientIf, BTBdaddr_t *pxBda, uint32_t ulRssi, BTStatus_t xStatus)

typedef void(*	BTCongestionCallback_t) (uint16_t usConnId, bool bCongested)

typedef uint8_t	BTSecurityLevel_t

typedef uint8_t	BTAuthReq_t

typedef void(*	BTDeviceStateChangedCallback_t) (BTState_t xState)
	Bluetooth state change Callback. Invoked on pxEnable/pxDisable. More...

typedef void(*	BTDevicePropertiesCallback_t) (BTStatus_t xStatus, uint32_t ulNumProperties, BTProperty_t *pxProperties)
	GET/SET local device Properties callback. More...

typedef void(*	BTRemoteDevicePropertiesCallback_t) (BTStatus_t xStatus, BTBdaddr_t pxBdAddr, uint32_t ulNumProperties, BTProperty_t pxProperties)
	GET/SET Remote Device Properties callback. Invoked on pxGetRemoteDeviceProperty, pxSetRemoteDeviceProperty, pxGetAllRemoteDeviceProperties. More...

typedef void(*	BTPinRequestCallback_t) (BTBdaddr_t pxRemoteBdAddr, BTBdname_t pxBdName, uint32_t ulCod, uint8_t ucMin16Digit)
	Callback Invoked on Pin Request. More...

typedef void(*	BTSspRequestCallback_t) (BTBdaddr_t pxRemoteBdAddr, BTBdname_t pxRemoteBdName, uint32_t ulCod, BTSspVariant_t xPairingVariant, uint32_t ulPassKey)
	Callback Invoked on SSP event. More...

typedef void(*	BTPairingStateChangedCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxRemoteBdAddr, BTBondState_t xState, BTSecurityLevel_t xSecurityLevel, BTAuthFailureReason_t xReason)
	Bluetooth pairing state changed event callback. Invoked in response to create_bond, cancel_bond or remove_bond reason field is valid only in case of xStatus == eBTStatusFail. Invoked on pairing event. More...

typedef void(*	BTEnergyInfoCallback_t) (BTActivityEnergyInfo pxEnergyInfo, BTUidTraffic_t pxUidData)
	Callback invoked on pxReadEnergyInfo. Invoked on pxReadEnergyInfo. More...

typedef void(*	BTDutModeRecvCallback_t) (uint16_t usOpcode, uint8_t *pucBuf, size_t xLen)
	Bluetooth Test Mode Callback. Invoked when remote device uses pxDutModeSend. More...

typedef void(*	BTLeTestModeCallback_t) (BTStatus_t xStatus, uint16_t usNumPackets)
	LE Test mode callbacks. Invoked on pxLeTestMode. More...

typedef void(*	BTReadRssiCallback_t) (BTBdaddr_t *pxBda, uint32_t ulRssi, BTStatus_t xStatus)
	Read RSSI Callback. Invoked on pxReadRssi. More...

typedef void(*	BTSlaveSecurityRequestCallBack_t) (BTBdaddr_t *pxBda, BTSecurityLevel_t xSecurityLevel, bool bBonding)
	Security request callback. Invoked on master from remote slave security request event. More...

typedef void(*	BTTxPowerCallback_t) (BTBdaddr_t *pxBda, BTTransport_t xTransport, uint8_t ucTxPowerValue, BTStatus_t xStatus)
	TX power Callback. Invoked on pxGetTxpower. More...

typedef void(*	BTBondedCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxRemoteBdAddr, bool bIsBonded)

typedef void(*	BTAclStateChangedCallback_t) (BTStatus_t xStatus, const BTBdaddr_t *pxRemoteBdAddr, BTAclState_t xState, BTTransport_t xTransport, BTAclDisconnectReason_t xReason)
	Callback invoked in response to ACL connection state change. More...

typedef void(*	BTRegisterBleAdapterCallback_t) (BTStatus_t xStatus, uint8_t ucAdapterIf, BTUuid_t *pxAppUuid)
	Callback invoked in response pxRegisterBleApp. More...

typedef void(*	BTBleDevicePropertiesCallback_t) (BTStatus_t xStatus, uint32_t ulNumProperties, BTBleProperty_t *pxProperties)
	Callback invoked in response to pxGetBleAdapterProperty and pxSetBleAdapterProperty. More...

typedef void(*	BTBleRemoteDevicePropertiesCallback_t) (BTStatus_t xStatus, BTBdaddr_t pxBdAddr, uint32_t ulNumProperties, BTBleProperty_t pxProperties)
	Callback invoked in response to pxGetBleRemoteDeviceProperty and pxSetBleRemoteDeviceProperty. More...

typedef void(*	BTScanResultCallback_t) (BTBdaddr_t pxBda, uint32_t ulRssi, uint8_t pucAdvData)
	Callback invoked in response to pxScan. More...

typedef void(*	BTAdvStatusCallback_t) (BTStatus_t xStatus, uint8_t ucAdapterIf, bool bStart)
	Callback invoked on pxStartAdv and stop advertisement. More...

typedef void(*	BTSetAdvDataCallback_t) (BTStatus_t xStatus)
	Callback invoked on pxSetAdvData. More...

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. More...

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. More...

typedef void(*	BTScanFilterParamCallback_t) (uint32_t ulAction, uint8_t ucAdapterIf, BTStatus_t xStatus, uint32_t ulAvblSpace)
	Callback invoked on pxScanFilterParamSetup. More...

typedef void(*	BTScanFilterStatusCallback_t) (bool bEnable, uint8_t ucAdapterIf, BTStatus_t xStatus)
	Callback invoked on pxScanFilterEnable. More...

typedef void(*	BTMultiAdvEnableCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
	Callback invoked on pxMultiAdvEnable. More...

typedef void(*	BTMultiAdvUpdateCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
	Callback invoked on pxMultiAdvUpdate. More...

typedef void(*	BTMultiAdvDataCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
	Callback invoked on pxMultiAdvSetInstData and pxMultiAdvSetInstRawData. More...

typedef void(*	BTMultiAdvDisableCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
	Callback invoked on pxMultiAdvDisable. More...

typedef void(*	BTBatchscanCfgStorageCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
	Callback invoked on pxBatchscanCfgStorage. More...

typedef void(*	BTBatchscanEnableDisableCallback_t) (uint32_t ulAction, uint8_t ucAdapterIf, BTStatus_t xStatus)
	Callback invoked on pxBatchscanDisBatchScan and TBD. More...

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. More...

typedef void(*	BTBatchscanThresholdCallback_t) (uint8_t ucAdapterIf)
	Callback invoked when batchscan storage threshold limit is crossed. More...

typedef void(*	BTTrackAdvEventCallback_t) (BTGattTrackAdvInfo_t *pxTrackAdvInfo)
	Track ADV VSE callback invoked when tracked device is found or lost. More...

typedef void(*	BTScanParameterSetupCompletedCallback_t) (uint8_t ucAdapterIf, BTStatus_t xStatus)
	Callback invoked when scan parameter setup has completed. More...

typedef void(*	BTPhyUpdatedCallback_t) (uint16_t usConnId, uint8_t ucTxPhy, uint8_t ucRxPhy, BTStatus_t xStatus)
	Callback invoked on pxSetPreferredPhy. More...

typedef void(*	BTReadClientPhyCallback_t) (uint16_t usConnId, uint8_t ucTxPhy, uint8_t ucRxPhy, BTStatus_t xStatus)
	Callback invoked on pxReadPhy. More...

typedef void(*	BTClassicDevicePropertiesCallback_t) (BTStatus_t xStatus, uint32_t ulNumProperties, BTClassicProperty_t *pxProperties)
	Callback invoked in response to pxGetClassicDeviceProperty and pxSetClassicDeviceProperty. More...

typedef void(*	BTClassicRemoteDevicePropertiesCallback_t) (BTStatus_t xStatus, BTBdaddr_t pxBdAddr, uint32_t ulNumProperties, BTClassicProperty_t pxProperties)
	Callback invoked in response to pxGetRemoteClassicDeviceProperty and pxSetRemoteClassicDeviceProperty. More...

typedef void(*	BTDeviceFoundCallback_t) (uint32_t ulNumProperties, BTClassicProperty_t *pxProperties)
	Callback invoked in response to device discovery If EIR data is not present, then BD_NAME and RSSI shall be NULL and -1 respectively. More...

typedef void(*	BTDiscoveryStateChangedCallback_t) (BTDiscoveryState_t xState)
	Callback invoked in response to pxStartDiscovery and pxStopDiscovery. More...

typedef void(*	BTaclStateChangedCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxRemoteBdAddr, BTaclState_t xState)
	Callback invoked in response to ACL connection state change. More...

Enumerations
enum	BTAvConnectionState_t { eBTAvsrcConnectionStateDisconnected = 0, eBTAvsrcConnectionStateConnecting = 1, eBTAvsrcConnectionStateConnected = 2, eBTAvsrcConnectionStateDisconnecting = 3 }
	Bluetooth AV connection states. More...

enum	BTAvAudioState_t { eBTAvsrcAudioStateRemoteSuspend = 0, eBTAvsrcAudioStateStopped = 1, eBTAvsrcAudioStateStarted = 2 }
	Bluetooth AV data path states. More...

enum	BTAvsrcAclPriority_t { eBTAvsrcAclPriorityLow = 0, eBTAvsrcAclPriorityHigh = 1 }
	Bluetooth AV ACL Priority. More...

enum	BTGattcError_t { eBTGattcCommandSuccess = 0, eBTGattcCommandStarted = 1, eBTGattcCommandBusy = 2, eBTGattcCommandStored = 3, eBTGattcNoResources = 4, eBTGattcModeUnsupported = 5, eBTGattcIllegalValue = 6, eBTGattcIncorrectState = 7, eBTGattcUnknownAddr = 8, eBTGattcDeviceTimeout = 9, eBTGattcInvalidControllerOutput = 10, eBTGattcSecurityError = 11, eBTGattcDelayedEncryptionCheck = 12, eBTGattcErrProcessing = 13 }
	BT GATT client error codes. More...

enum	BTRspErrorStatus_t { eBTRspErrorNone = 0, eBTRspErrorNo_mitm = 1, eBTRspErrorMitm = 2, eBTRspErrorSignedNoMitm = 3, eBTRspErrorSignedMitm = 4 }
	Error status sent inside response to a read or write from the client. More...

enum	BTGattStatus_t { eBTGattStatusSuccess = 0x00, eBTInvalidHandle = 0x01, eBTGattStatusReadNotPermitted = 0x02, eBTGattStatusWriteNotPermitted = 0x03, eBTGattStatusInvalidPDU = 0x04, eBTGattStatusInsufficientAuthentication = 0x05, eBTGattStatusRequestNotSupported = 0x06, eBTGattStatusInvalidOffset = 0x07, eBTGattStatusInsufficientAuthorization = 0x08, eBTGattStatusPrepareQueueFull = 0x09, eBTGattStatusAttributeNotFound = 0x0A, eBTGattStatusAttributeNotLong = 0x0B, eBTGattStatusInsufficientKeySize = 0x0C, eBTGattStatusInvalidAttributeLength = 0x0D, eBTGattStatusUnlikelyError = 0x0E, eBTGattStatusInsufficientEncryption = 0x0F, eBTGattStatusUnsupportedGroupType = 0x10, eBTGattStatusInsufficientResources = 0x11, eBTGattStatusInternalError = 0x81, eBTGattStatusError = 0x85, eBTGattStatusConnectionCongested = 0x8f, eBTGattStatusErrorConnEstFail = 0x93, eBTGattStatusErrorConnTimeout = 0x94, eBTGattStatusLocalHostTerminatedConnection = 0x99 }
	GATT Status Codes. More...

enum	{ eBTPropNone = 0x0000, eBTPropBroadcast = 0x0001, eBTPropRead = 0x0002, eBTPropWriteNoResponse = 0x0004, eBTPropWrite = 0x0008, eBTPropNotify = 0x0010, eBTPropIndicate = 0x0020, eBTPropSignedWrite = 0x0040, eBTPropExtendedProps = 0x0080 }
	GATT Characteristic property. More...

enum	{ eBTPermNone = 0x0000, eBTPermRead = 0x0001, eBTPermReadEncrypted = 0x0002, eBTPermReadEncryptedMitm = 0x0004, eBTPermWrite = 0x0010, eBTPermWriteEncrypted = 0x0020, eBTPermWriteEncryptedMitm = 0x0040, eBTPermWriteSigned = 0x0080, eBTPermWriteSignedMitm = 0x0100 }
	GATT permissions. More...

enum	BTAttrWriteRequests_t { eBTWriteTypeNoResponse = 0x0001, eBTWriteTypeDefault = 0x0002, eBTWriteTypePrepare = 0x0003, eBTWriteTypeSigned = 0x0004 }
	Write request type. More...

enum	BTGattServiceTypes_t { eBTServiceTypePrimary, eBTServiceTypeSecondary }
	GATT Service types. More...

enum	BTDbAttributeType_t { eBTDbPrimaryService, eBTDbSecondaryService, eBTDbIncludedService, eBTDbCharacteristicDecl, eBTDbCharacteristic, eBTDbDescriptor }
	Attribute types. More...

enum	{ eBTSecLevelNoSecurity = 0x01, eBTSecLevelUnauthenticatedPairing = 0x02, eBTSecLevelAuthenticatedPairing = 0x03, eBTSecLevelSecureConnect = 0x04 }
	Security Level. More...

enum	{ eBTAuthReqBonding = 0x01, eBTAuthReqMitm = 0x03, eBTAuthReqSecureConnect = 0x04, eBTAuthReqKeyPress = 0x05 }
	Authentication requirement. More...

enum	BTTransport_t { BTTransportAuto = 0, BTTransportBredr = 1, BTTransportLe = 2 }
	Preferred physical Transport for GATT connection . More...

enum	BTState_t { eBTstateOff, eBTstateOn }
	Bluetooth power State. More...

enum	BTAuthFailureReason_t { eBTauthSuccess = 0x00, eBTauthFailLmpRespTimeout = 0x01, eBTauthFailKeyMissing = 0x02, eBTauthFailEncrypMode = 0x03, eBTauthFailUnitKey = 0x04, eBTauthFailSmpCfrmValue = 0x05, eBTauthFailSmpEnc = 0x06, eBTauthFailSmpTimeout = 0x07, eBTauthFailPageTimeout = 0x08, eBTauthFailSmpPasskeyFail = 0x09, eBTauthFailSmpOobFail = 0x0A, eBTauthFailSmpFail = 0x0B, eBTauthFailConnTimeout = 0x0C, eBTauthFailSmp = 0x0D, eBTauthFailSmpPairNotSupport = 0x0E, eBTauthFailSmpUnknownIo = 0x0F, eBTauthFailSmpUnknown = 0x10, eBTauthFailHostRejectSecurity = 0x11, eBTauthFailInsuffSecurity = 0x12, eBTauthFailPeerUser = 0x13, eBTauthFailUnspecified = 0x14, eBTauthFailSmpAuthReqFail = 0x15, eBTauthFailSmpEncKeySize = 0x16, eBTauthFailSmpCmdNotSupport = 0x17, eBTauthFailSmpRepeatedAttempt = 0x18, eBTauthFailSmpInvalidParameters = 0x19, eBTauthFailSmpDhkeyCheckFail = 0x1A, eBTauthFailSmpNumericComparFail = 0x1B, eBTauthFailSmpBrPairInProg = 0x1C, eBTauthFailSmpXtransDeriveNotAllow = 0x1D, eBTauthFailStackErr = 0x100, eBTauthFailHciErr = 0x200 }
	Authentication failure reasons. More...

enum	BTPropertyType_t { eBTpropertyBdname = 0x1, eBTpropertyBdaddr, eBTpropertyTypeOfDevice, eBTpropertyAdapterBondedDevices, eBTpropertyRemoteFriendlyName, eBTpropertyRemoteRssi, eBTpropertyRemoteVersionInfo, eBTpropertyLocalMTUSize, eBTpropertyBondable, eBTpropertyIO, eBTpropertyConnectable, eBTpropertySecureConnectionOnly }
	Bluetooth local device and Remote Device property types. Properties common to both adapter and remote device. More...

enum	BTDeviceType_t { eBTdeviceDevtypeBredr = 0x1, eBTdeviceDevtypeBle, eBTdeviceDevtypeDual }
	Bluetooth Device Type. More...

enum	BTBondState_t { eBTbondStateNone, eBTbondStateBonding, eBTbondStateBonded }

enum	BTSspVariant_t { eBTsspVariantPasskeyConfirmation, eBTsspVariantPasskeyEntry, eBTsspVariantConsent, eBTsspVariantPasskeyNotification }
	Bluetooth SSP Bonding Variant. More...

enum	BTAclState_t { eBTaclConnected = 0, eBTaclDisconnected = 1 }
	Bluetooth ACL connection state. More...

enum	BTAclDisconnectReason_t { eBTaclSuccess = 0x00, eBTaclIllegalCommand = 0x01, eBTaclNoConnection = 0x02, eBTaclHwFailure = 0x03, eBTaclPageTimeout = 0x04, eBTaclAuthFailure = 0x05, eBTaclKeyMissing = 0x06, eBTaclMemFull = 0x07, eBTaclConnectionTimeout = 0x08, eBTaclMaxNumOfConnections = 0x09, eBTaclMaxNumOfScos = 0x0A, eBTaclConnectionExists = 0x0B, eBTaclCommandDisallowed = 0x0C, eBTaclHostRejectResource = 0x0D, eBTaclHostRejectSecurity = 0x0E, eBTaclHostRejectDevice = 0x0F, eBTaclHostTimeout = 0x10, eBTaclUnsupportedValue = 0x11, eBTaclIllegalParameterFmt = 0x12, eBTaclPeerUser = 0x13, eBTaclPeerLowResources = 0x14, eBTaclPeerPowerOff = 0x15, eBTaclHostUser = 0x16, eBTaclRepeatedAttempts = 0x17, eBTaclPairingNotAllowed = 0x18, eBTaclUnknownLmpPdu = 0x19, eBTaclUnsupportedRemFeature = 0x1A, eBTaclScoOffsetRejected = 0x1B, eBTaclScoIntervalRejected = 0x1C, eBTaclScoAirRejected = 0x1D, eBTaclInvalidLmpParam = 0x1E, eBTaclUnspecified = 0x1F, eBTaclUnsupportedLmpFeature = 0x20, eBTaclRoleChangeNotAllowed = 0x21, eBTaclLmpResponseTimeout = 0x22, eBTaclLmpErrTransCollision = 0x23, eBTaclLmpPduNotAllowed = 0x24, eBTaclEncryModeNotAcceptable = 0x25, eBTaclUnitKeyUsed = 0x26, eBTaclQosNotSupported = 0x27, eBTaclInstantPassed = 0x28, eBTaclPairingWithUnitKeyNotSupported = 0x29, eBTaclDiffTransactionCollision = 0x2A, eBTaclQosUnacceptableParam = 0x2C, eBTaclQosRejected = 0x2D, eBTaclChanClassifNotSupported = 0x2E, eBTaclInsuffcientSecurity = 0x2F, eBTaclParamOutOfRange = 0x30, eBTaclRoleSwitchPending = 0x32, eBTaclReservedSlotViolation = 0x34, eBTaclRoleSwitchFailed = 0x35, eBTaclInqRspDataTooLarge = 0x36, eBTaclSimplePairingNotSupported = 0x37, eBTaclHostBusyPairing = 0x38, eBTaclRejNoSuitableChannel = 0x39, eBTaclControllerBusy = 0x3A, eBTaclUnacceptConnInterval = 0x3B, eBTaclDirectedAdvertisingTimeout = 0x3C, eBTaclConnToutDueToMicFailure = 0x3D, eBTaclConnFailedEstablishment = 0x3E, eBTaclMacConnectionFailed = 0x3F }
	Bluetooth ACL Disconnect Reason From Bluetooth Core Spec 5.0 Vol 2, Part D Error Codes Unknown disconnect reason will be treated as eBTaclUnspecified. More...

enum	BTAddrType_t { BTAddrTypePublic, BTAddrTypeRandom, BTAddrTypeStaticRandom, BTAddrTypeResolvable }
	Advertising Address Type.

enum	BTAdvProperties_t { BTAdvInd, BTAdvDirectInd, BTAdvNonconnInd }
	Advertising Type.

enum	BTBlePropertyType_t { eBTPropertyLocalLeFeatures }
	BLE device property type. More...

enum	BTScanMode_t { eBTScanModeNone = 0, eBTScanModeConnectable = 1, eBTScanModeConnectableDiscoverable = 2 }
	Bluetooth Adapter Visibility Modes. More...

enum	BTScanParam_t { eBTPageScanInterval220ms = 0, eBTPageScanInterval1280ms = 1 }
	Bluetooth scan parameters. More...

enum	BTDiscoveryState_t { eBTDiscoveryStopped = 0, eBTDiscoveryStarted = 1 }
	Bluetooth Adapter Discovery state. More...

enum	BTaclState_t { eBTaclStateConnected = 0, eBTaclStateDisconnected = 1 }
	Bluetooth ACL connection state. More...

enum	BTScanType_t { eBTScanTypeStandard = 0, eBTScanTypeInterlaced = 1 }
	Bluetooth Scan types. More...

enum	BTClassicPropertyType_t { eBTPropertyBdname = 0x1, eBTPropertyBdaddr = 0x2, eBTPropertyTypeOfDevice = 0x3, eBTPropertyUUIDS = 0x4, eBTPropertyClassOfDevice = 0x5, eBTPropertyServiceRecord = 0x6, eBTPropertyAdapterDiscoveryTimeout = 0x7, eBTPropertyAdapterScanMode = 0x8, eBTPropertyEIRManfInfo = 0xFE, eBTPropertyAdapterScanParam = 0x100, eBTPropertyConnectability = 0x101, eBTPropertyScanType = 0x102, eBTPropertyGadgetEIRManfInfo = 0x103 }
	Classic Device Property Types. More...

enum	BTuuidType_t { eBTuuidType16 = 1, eBTuuidType32 = 2, eBTuuidType128 = 3 }
	UUID types. More...

enum	BTStatus_t { eBTStatusSuccess = 0, eBTStatusFail = 1, eBTStatusNotReady = 2, eBTStatusNoMem = 3, eBTStatusBusy = 4, eBTStatusDone = 5, eBTStatusUnsupported = 6, eBTStatusParamInvalid = 7, eBTStatusUnHandled = 8, eBTStatusAuthFailure = 9, eBTStatusRMTDevDown = 10, eBTStatusAuthRejected = 11, eBTStatusWakeLockError = 12, eBTStatusLinkLoss = 13 }
	Bluetooth Error Status . More...

enum	BTProfile_t { eProfileHeadset = 0, eBTProfileA2DP = 1, eBTProfileAVRCPTarget = 2, eBTProfileA2DPSink = 3, eBTProfileAVRCPController = 4, eBTProfileInputDevice = 5, eBTProfileHeadsetClient = 6, eBTProfileGATT = 7, eBTProfileSock = 8, eBTProfileMaxID = 9 }

enum	BTIOtypes_t { eBTIONone = 0, eBTIODisplayOnly = 1, eBTIODisplayYesNo = 2, eBTIOKeyboardOnly = 3, eBTIOKeyboardDisplay = 4 }
	Input Output device type. More...

Functions
const BTAvsrcInterface_t *	BT_GetAvsrcInterface ()

const BTInterface_t *	BTGetBluetoothInterface (void)

const BTClassicInterface_t *	BT_GetClassicAdapter ()

Detailed Description

BT provides the interfaces to control the Bluetooth device. ,local device control and device discovery functionalities.

This BT HAL provides the interfaces to control the Bluetooth power states ,local device control and device discovery functionalities

USAGE

BT Classic Adapter provides the interfaces to control Bluetooth classic (BR/EDR) functionalities of local device control and device discovery functionalities

USAGE

BT manager BLE adapter, provide GAP API functions that are specific to BLE.

USAGE

Before calling any GATT client function, the Generic Access Profile needs to be initialized (see bt_hal_manager.h and bt_hal_manager_adapter.h). After GAP has been initialized, pxGattClientInit must be called to register callbacks. After this, pxConnect can be called to connect to a GATT server.

Before calling any GATT server function, the Generic Access Profile needs to be initialized (see bt_hal_manager.h and bt_hal_manager_adapter*.h). bt_hal_manager.h give the starting point. After GAP has been initialized, the functions need to be called in that order:

pxRegisterServer: Need to be called first to get the server Interface
pxGattServerInit: Provided callbacks
pxAddService: Create memory space for a service
pxAddCharacteristic: Then all calls to pxAddDescriptor will add the descriptor to that characteristic
pxStartService: Complete service create. Another service can be create afterward.

The common generique access profile is the starting point of Bluetooth API. The flow is the following:

pxBtManagerInit
pxEnable (if wished)
pxGetClassicAdapter or/and pxGetLEAdapter to initialize them

Before calling pxRegisterBleApp, common GAP need to be enabled and started. Flow of the functions:

pxBleAdapterInit
pxRegisterBleApp
get the GATT interface to initialize GATT.

Macro Definition Documentation

◆ btGATT_MAX_ATTR_LEN

#define btGATT_MAX_ATTR_LEN 600

Buffer sizes for maximum attribute length and maximum read/write operation buffer size.

◆ btBLE_ADD_BLOB_SERVICE_SUPPORTED_BIT

#define btBLE_ADD_BLOB_SERVICE_SUPPORTED_BIT 0x0001 /** Support GATT server database decleration as a blob. */

Stack feature support bit mask

Typedef Documentation

◆ BTAvsrcConnectionStateCallback_t

typedef void(* BTAvsrcConnectionStateCallback_t) (BTAvConnectionState_t xState, BTBdaddr_t *pxBdAddr)

Callback invoked in to notify AV connection state change.

Audio callback structure

Parameters

[in]	xState	Connection state
[in]	pxBdAddr	Address of the Remote device

◆ BTAvsrcAudioStateCallback_t

typedef void(* BTAvsrcAudioStateCallback_t) (BTAvAudioState_t xState, BTBdaddr_t *pxBdAddr)

Callback invoked in to notify AV Audio state change.

Parameters

[in]	xState	Audio state
[in]	pxBdAddr	Address of the Remote device

◆ BTAvsrcAclPriorityCallback_t

typedef void(* BTAvsrcAclPriorityCallback_t) (BTAvsrcAclPriority_t xPriority, BTBdaddr_t *pxBdAddr)

Callback invoked when ACL priority changes Priority can change when the stack enables/disables silent A2DP data while A2DP keepalive feature is enabled.

Parameters

[in]	xPriority	Acl Priority
[in]	pxBdAddr	Address of the Remote device

◆ BTRegisterClientCallback_t

typedef void( * BTRegisterClientCallback_t) (BTGattStatus_t xStatus, uint8_t ucClientIf, BTUuid_t *pxAppUuid)

Callback invoked in response pxRegisterClient when the GATT client registration has been completed.

BT-GATT Client callback structure.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucClientIf	Client interface.
[in]	pxAppUuid	GATT client UUID.

◆ BTSearchCompleteCallback_t

typedef void( * BTSearchCompleteCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus)

Callback invoked in response to pxSearchService when the GATT service search has been completed.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.

◆ BTRegisterForNotificationCallback_t

typedef void( * BTRegisterForNotificationCallback_t) (uint16_t usConnId, bool bRegistered, BTGattStatus_t xStatus, uint16_t usHandle)

Callback invoked in response to pxRegisterForNotification and pxUnregisterForNotification.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	bRegistered	Set to True if attribute id registered for notifications, set to False otherwise.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	usHandle	Handle number of attribute [de]registered for notification.

◆ BTNotifyCallback_t

typedef void( * BTNotifyCallback_t) (uint16_t usConnId, BTGattNotifyParams_t *pxData)

Remote device notification callback, invoked when a remote device sends a notification or indication that a client has registered for.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	pxData	Parameters for attribute change notifications.

◆ BTReadCharacteristicCallback_t

typedef void( * BTReadCharacteristicCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, BTGattReadParams_t *pxData)

Reports result of a GATT read operation. Triggered by pxReadCharacteristic.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	pxData	Parameters for GATT read operation.

◆ BTWriteCharacteristicCallback_t

typedef void( * BTWriteCharacteristicCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint16_t usHandle)

GATT write characteristic operation callback. Triggered by pxWriteCharacteristic.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	usHandle	Handle of the attribute written to.

◆ BTExecuteWriteCallback_t

typedef void( * BTExecuteWriteCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus)

GATT execute prepared write callback. Triggered by pxExecuteWrite.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.

◆ BTReadDescriptorCallback_t

typedef void( * BTReadDescriptorCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, BTGattReadParams_t *pxData)

Callback invoked in response to pxReadDescriptor.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	pxData	Parameters for GATT read operation.

◆ BTWriteDescriptorCallback_t

typedef void( * BTWriteDescriptorCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint16_t usHandle)

Callback invoked in response to pxWriteDescriptor.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	usHandle	Handle of the attribute written to.

◆ BTListenCallback_t

typedef void( * BTListenCallback_t) (BTGattStatus_t xStatus, uint32_t ulServerIf)

Callback indicating the status of a listen() operation.

Callback has been deprecated, use BTAdvStatusCallback_t in BTBleAdapterCallbacks_t instead.

◆ BTConfigureMtuCallback_t

typedef void( * BTConfigureMtuCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint32_t ulMtu)

Callback invoked when the MTU for a given connection changes. Triggered by pxConfigureMtu.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	ulMtu	MTU size.

◆ BTGetGattDbCallback_t

typedef void( * BTGetGattDbCallback_t) (uint16_t usConnId, BTGattDbElement_t *pxDb, uint32_t ulCount)

GATT get database callback. Triggered by pxGetGattDb.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	pxDb	GATT database elements
[in]	ulCount	Number of elements in GATT database.

◆ BTServicesRemovedCallback_t

typedef void( * BTServicesRemovedCallback_t) (uint16_t usConnId, uint16_t usStartHandle, uint16_t usEndHandle)

GATT services between startHandle and endHandle were removed.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	usStartHandle	First service handle removed from server.
[in]	usEndHandle	Last service handle removed from server.

◆ BTServicesAddedCallback_t

typedef void( * BTServicesAddedCallback_t) (uint16_t usConnId, BTGattDbElement_t *pxAdded, uint32_t ulAddedCount)

GATT services were added.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	pxAdded	GATT database elements added.
[in]	ulAddedCount	Number of GATT database elements added.

◆ BTRegisterServerCallback_t

typedef void(* BTRegisterServerCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, BTUuid_t *pxAppUuid)

Callback invoked in response to pxRegisterServer.

BT-GATT Server callback structure.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucServerIf	Server interface.
[in]	pxAppUuid	GATT server UUID.

◆ BTUnregisterServerCallback_t

typedef void(* BTUnregisterServerCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf)

Callback invoked in response to pxUnregisterServer.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucServerIf	Server interface, return on the callback BTRegisterServerCallback_t after successful pxRegisterServer call.

Returns

◆ BTConnectionCallback_t

typedef void(* BTConnectionCallback_t) (uint16_t usConnId, uint8_t ucServerIf, bool bConnected, BTBdaddr_t *pxBda)

Callback invoked on a connection event.

Parameters

[in]	usConnId	Connection Identifier. Uniquely identify a connection.
[in]	ucServerIf	Server interface, return on the callback BTRegisterServerCallback_t after successful pxRegisterServer call.
[in]	bConnected	Flag set to true on a connect and to false on a disconnect.
[in]	pxBda	Address of the remote device.

◆ BTServiceAddedCallback_t

typedef void(* BTServiceAddedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, BTGattSrvcId_t *pxSrvcId, uint16_t usServiceHandle)

Callback invoked in response to pxAddService.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucServerIf	Server interface, return on the callback BTRegisterServerCallback_t after successful pxRegisterServer call.
[in]	pxSrvcId	Service ID, returned on BTServiceAddedCallback_t after calling pxAddService.
[in]	usServiceHandle	Handle of the service containing the attribute.

◆ BTIncludedServiceAddedCallback_t

typedef void(* BTIncludedServiceAddedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, uint16_t usServiceHandle, uint16_t usInclSrvcHandle)

Callback invoked in response to pxAddIncludedService.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucServerIf	Server interface, return on the callback BTRegisterServerCallback_t after successful pxRegisterServer call.
[in]	usServiceHandle	Handle of the service containing the attribute.
[in]	usInclSrvcHandle	Handle of the Attribute "included service".

◆ BTCharacteristicAddedCallback_t

typedef void(* BTCharacteristicAddedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, BTUuid_t *pxUuid, uint16_t usServiceHandle, uint16_t usCharHandle)

Callback invoked in response to pxAddCharacteristic.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucServerIf	Server interface, return on the callback BTRegisterServerCallback_t after successful pxRegisterServer call.
[in]	pxUuid	UUID of the characteristic.
[in]	usServiceHandle	Handle of the service containing the attribute.
[in]	usCharHandle	Handle of the characteristic being added.

◆ BTSetValCallback_t

typedef void(* BTSetValCallback_t) (BTStatus_t xStatus, uint16_t usAttrHandle)

Callback invoked in response to pxSetVal.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	usAttrHandle	Handle of the attribute.

◆ BTDescriptorAddedCallback_t

typedef void(* BTDescriptorAddedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, BTUuid_t *pxUuid, uint16_t usServiceHandle, uint16_t usDescrHandle)

Callback invoked in response to pxAddDescriptor.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucServerIf	Server interface, return on the callback BTRegisterServerCallback_t after successful pxRegisterServer call.
[in]	pxUuid	UUID of the descriptor.
[in]	usServiceHandle	Handle of the service containing the attribute.
[in]	usDescrHandle	Handle of the descriptor being added.

◆ BTServiceStartedCallback_t

typedef void(* BTServiceStartedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, uint16_t usServiceHandle)

Callback invoked in response to pxStartService.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucServerIf	Server interface, return on the callback BTRegisterServerCallback_t after successful pxRegisterServer call.
[in]	usServiceHandle	Handle of the service containing the attribute.

◆ BTServiceStoppedCallback_t

typedef void(* BTServiceStoppedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, uint16_t usServiceHandle)

Callback invoked in response to pxStopService.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucServerIf	Server interface, return on the callback BTRegisterServerCallback_t after successful pxRegisterServer call.
[in]	usServiceHandle	Handle of the service containing the attribute.

◆ BTServiceDeletedCallback_t

typedef void(* BTServiceDeletedCallback_t) (BTStatus_t xStatus, uint8_t ucServerIf, uint16_t usServiceHandle)

Callback invoked in response to pxDeleteService.

Parameters

[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	ucServerIf	Server interface, return on the callback BTRegisterServerCallback_t after successful pxRegisterServer call.
[in]	usServiceHandle	Handle of the service containing the attribute.

◆ BTRequestReadCallback_t

typedef void(* BTRequestReadCallback_t) (uint16_t usConnId, uint32_t ulTransId, BTBdaddr_t *pxBda, uint16_t usAttrHandle, uint16_t usOffset)

Callback invoked on read event.

Callback invoked when a remote device has requested to read a characteristic or descriptor. The application must respond by calling sendResponse.

Parameters

[in]	usConnId	Connection Identifier, created and return on connection event, when BTConnectionCallback_t is invoked.
[in]	ulTransId	Transaction ID.
[in]	pxBda	Remote device address.
[in]	usAttrHandle	Handle of the attribute.
[in]	usOffset	Index of read.

◆ BTRequestWriteCallback_t

typedef void(* BTRequestWriteCallback_t) (uint16_t usConnId, uint32_t ulTransId, BTBdaddr_t *pxBda, uint16_t usAttrHandle, uint16_t usOffset, size_t xLength, bool bNeedRsp, bool bIsPrep, uint8_t *pucValue)

Callback invoked on write event.

Callback invoked when a remote device has requested to write to a characteristic or descriptor.

Parameters

[in]	usConnId	Connection Identifier, created and return on connection event, when BTConnectionCallback_t is invoked.
[in]	ulTransId	Transaction ID.
[in]	pxBda	Remote device address.
[in]	usAttrHandle	Handle of the attribute.
[in]	usOffset	Index of write.
[in]	xLength	Length of pucValue to write.
[in]	bNeedRsp	True if a response is needed.
[in]	bIsPrep	True if it is a prepare write command.
[in]	pucValue	Data to write.

◆ BTRequestExecWriteCallback_t

typedef void(* BTRequestExecWriteCallback_t) (uint16_t usConnId, uint32_t ulTransId, BTBdaddr_t *pxBda, bool bExecWrite)

Callback invoked on execute write event.

Callback invoked when a remote device that has done prepare write is now executing the command.

Parameters

[in]	usConnId	Connection Identifier, created and return on connection event, when BTConnectionCallback_t is invoked.
[in]	ulTransId	Transaction ID.
[in]	pxBda	Remote device address.
[in]	bExecWrite	True is the write order needs to be executed.

◆ BTResponseConfirmationCallback_t

typedef void(* BTResponseConfirmationCallback_t) (BTStatus_t xStatus, uint16_t usHandle)

Callback triggered in response to sendResponse if the remote device sends a confirmation.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	usHandle	Handle of the attribute.

◆ BTIndicationSentCallback_t

typedef void(* BTIndicationSentCallback_t) (uint16_t usConnId, BTStatus_t xStatus)

Callback on confirmation device from the remote device to an indication. Or confirm a Notification as been sent.

Parameters

[in]	usConnId	Connection Identifier, created and return on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTStatusSuccess if operation succeeded.

◆ BTMtuChangedCallback_t

typedef void(* BTMtuChangedCallback_t) (uint16_t usConnId, uint16_t usMtu)

Callback invoked when the MTU for a given connection changes.

Parameters

[in]	usConnId	Connection Identifier, created and return on connection event, when BTConnectionCallback_t is invoked.
[in]	usMtu	MTU size.

◆ BTWhiteListChangedCallback_t

typedef void(* BTWhiteListChangedCallback_t) (const BTBdaddr_t *pxBdAddr, bool bIsAdded)

Callback for notifying modification in white list.

Parameters

[in]	pxBdAddr	Address of the Remote device.
[in]	bIsAdded	true if device added false if device not in white list

◆ BTConnectCallback_t

typedef void( * BTConnectCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint8_t ucClientIf, BTBdaddr_t *pxBda)

GATT open callback invoked in response to open

◆ BTDisconnectCallback_t

typedef void( * BTDisconnectCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint8_t ucClientIf, BTBdaddr_t *pxBda)

Callback invoked in response to close

◆ BTReadRemoteRssiCallback_t

typedef void( * BTReadRemoteRssiCallback_t) (uint8_t ucClientIf, BTBdaddr_t *pxBda, uint32_t ulRssi, BTStatus_t xStatus)

Callback triggered in response to readRemoteRssi

◆ BTCongestionCallback_t

typedef void( * BTCongestionCallback_t) (uint16_t usConnId, bool bCongested)

Callback notifying an application that a remote device connection is currently congested and cannot receive any more data. An application should avoid sending more data until a further callback is received indicating the congestion status has been cleared.

◆ BTDeviceStateChangedCallback_t

typedef void( * BTDeviceStateChangedCallback_t) (BTState_t xState)

Bluetooth state change Callback. Invoked on pxEnable/pxDisable.

Parameters

[in] xState Device event, triggered on state change. (switched on or off).

◆ BTDevicePropertiesCallback_t

typedef void( * BTDevicePropertiesCallback_t) (BTStatus_t xStatus, uint32_t ulNumProperties, BTProperty_t *pxProperties)

GET/SET local device Properties callback.

Parameters

[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	ulNumProperties	Number of properties returned.
[in]	pxProperties	Array of properties.

◆ BTRemoteDevicePropertiesCallback_t

typedef void( * BTRemoteDevicePropertiesCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxBdAddr, uint32_t ulNumProperties, BTProperty_t *pxProperties)

GET/SET Remote Device Properties callback. Invoked on pxGetRemoteDeviceProperty, pxSetRemoteDeviceProperty, pxGetAllRemoteDeviceProperties.

Parameters

[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	pxBdAddr	Address of the Remote device.
[in]	ulNumProperties	Number of properties returned.
[in]	pxProperties	Array of properties.

◆ BTPinRequestCallback_t

typedef void(* BTPinRequestCallback_t) (BTBdaddr_t *pxRemoteBdAddr, BTBdname_t *pxBdName, uint32_t ulCod, uint8_t ucMin16Digit)

Callback Invoked on Pin Request.

Parameters

[in]	pxRemoteBdAddr	remote Device address
[in]	pxBdName	remote Device name
[in]	ulCod	cod
[in]	ucMin16Digit	pinBluetooth Legacy PinKey Request callback

◆ BTSspRequestCallback_t

typedef void( * BTSspRequestCallback_t) (BTBdaddr_t *pxRemoteBdAddr, BTBdname_t *pxRemoteBdName, uint32_t ulCod, BTSspVariant_t xPairingVariant, uint32_t ulPassKey)

Callback Invoked on SSP event.

Bluetooth SSP Request callback - Just Works & Numeric Comparison pass_key - Shall be 0 for eBTSspPairingVariantConsent & eBTSspPairingPasskeyEntry.

Parameters

[in]	pxRemoteBdAddr	Remote device Address.
[in]	pxRemoteBdName	Remote device Name (NULL if not available.
[in]	ulCod	Class Of Device.
[in]	xPairingVariant	Paring variant.
[in]	ulPassKey	Pass Key.

◆ BTPairingStateChangedCallback_t

typedef void( * BTPairingStateChangedCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxRemoteBdAddr, BTBondState_t xState, BTSecurityLevel_t xSecurityLevel, BTAuthFailureReason_t xReason)

Bluetooth pairing state changed event callback. Invoked in response to create_bond, cancel_bond or remove_bond reason field is valid only in case of xStatus == eBTStatusFail. Invoked on pairing event.

Parameters

[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	pxRemoteBdAddr	Remote device Address.
[in]	xState	Bonded state value.
[in]	xReason	Authentication failure status.
[in]	xSecurityLevel	Security level (mode 1, level 1, 2 ,3 ,4).

◆ BTEnergyInfoCallback_t

typedef void( * BTEnergyInfoCallback_t) (BTActivityEnergyInfo *pxEnergyInfo, BTUidTraffic_t *pxUidData)

Callback invoked on pxReadEnergyInfo. Invoked on pxReadEnergyInfo.

Ctrl_state-Current controller state-Active-1,scan-2,or idle-3 state as defined by HCI spec. If the ctrl_state value is 0, it means the API call failed Time values-In milliseconds as returned by the controller Energy used-Value as returned by the controller Status-Provides the status of the read_energy_info API call uid_data provides an array of BTUidTraffic_t, where the array is terminated by an element withapp_uid set to -1.

Parameters

[in]	pxEnergyInfo	Energy information.
[in]	pxUidData	UID data traffic.

◆ BTDutModeRecvCallback_t

typedef void( * BTDutModeRecvCallback_t) (uint16_t usOpcode, uint8_t *pucBuf, size_t xLen)

Bluetooth Test Mode Callback. Invoked when remote device uses pxDutModeSend.

Parameters

[in]	usOpcode
[in]	pucBuf
[in]	xLen

◆ BTLeTestModeCallback_t

typedef void( * BTLeTestModeCallback_t) (BTStatus_t xStatus, uint16_t usNumPackets)

LE Test mode callbacks. Invoked on pxLeTestMode.

Parameters

[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	usNumPackets

◆ BTReadRssiCallback_t

typedef void( * BTReadRssiCallback_t) (BTBdaddr_t *pxBda, uint32_t ulRssi, BTStatus_t xStatus)

Read RSSI Callback. Invoked on pxReadRssi.

Parameters

[in]	pxBda	Remote device address.
[in]	ulRssi
[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.

◆ BTSlaveSecurityRequestCallBack_t

typedef void( * BTSlaveSecurityRequestCallBack_t) (BTBdaddr_t *pxBda, BTSecurityLevel_t xSecurityLevel, bool bBonding)

Security request callback. Invoked on master from remote slave security request event.

Parameters

[in]	pxBda	Remote device address.
[in]	xSecurityLevel	Request security
[in]	bBonding	True is bonding is requested

◆ BTTxPowerCallback_t

typedef void( * BTTxPowerCallback_t) (BTBdaddr_t *pxBda, BTTransport_t xTransport, uint8_t ucTxPowerValue, BTStatus_t xStatus)

TX power Callback. Invoked on pxGetTxpower.

Parameters

[in]	pxBda	Remote device address.
[in]	xTransport	Specify if BLE and BT classic is being used.
[in]	ucTxPowerValue	Tx Power value.
[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.

◆ BTBondedCallback_t

typedef void( * BTBondedCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxRemoteBdAddr, bool bIsBonded)

Deprecated:: See BTPairingStateChangedCallback_t

◆ BTAclStateChangedCallback_t

typedef void(* BTAclStateChangedCallback_t) (BTStatus_t xStatus, const BTBdaddr_t *pxRemoteBdAddr, BTAclState_t xState, BTTransport_t xTransport, BTAclDisconnectReason_t xReason)

Callback invoked in response to ACL connection state change.

Parameters

[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	pxRemoteBdAddr	Address of the remote device.
[in]	xState	ACL connection state.
[in]	xTransport	Transport type as in BTTransport_t. If transport type is unknown, use BTTransportAuto.
[in]	xReason	Contains ACL disconnect reason when xState is eBTaclStateDisconnected.

◆ 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]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp.
[in]	pxAppUuid	UUID 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]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	ulNumProperties	Number of BLE specific properties.
[in]	pxProperties	Properties 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]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	pxBdAddr	Address of the Remote device
[in]	ulNumProperties	Number of BLE specific properties.
[in]	pxProperties	Properties array.

◆ BTScanResultCallback_t

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

Callback invoked in response to pxScan.

Parameters

[in]	pxBda	Remote 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]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp.
[in]	bStarted	True for start advertisement, flase for stop

◆ BTSetAdvDataCallback_t

typedef void(* BTSetAdvDataCallback_t) (BTStatus_t xStatus)

Callback invoked on pxSetAdvData.

Parameters

[in] xStatus Returns 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]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	pxBdAddr	Address of the Remote device.
[in]	ulMinInterval	Minimum connection interval.
[in]	ulMaxInterval	Max connection interval.
[in]	ulLatency	Slave latency.
[in]	usConnInterval	Actual connection interval.
[in]	ulTimeout	Connection 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]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]	xStatus	Returns 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]	bEnable	True if filter is enabled.
[in]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.

◆ BTMultiAdvEnableCallback_t

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

Callback invoked on pxMultiAdvEnable.

Parameters

[in]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.

◆ BTMultiAdvUpdateCallback_t

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

Callback invoked on pxMultiAdvUpdate.

Parameters

[in]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.

◆ BTMultiAdvDataCallback_t

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

Callback invoked on pxMultiAdvSetInstData and pxMultiAdvSetInstRawData.

Parameters

[in]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.

◆ BTMultiAdvDisableCallback_t

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

Callback invoked on pxMultiAdvDisable.

Parameters

[in]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.

◆ BTBatchscanCfgStorageCallback_t

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

Callback invoked on pxBatchscanCfgStorage.

Parameters

[in]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]	xStatus	Returns 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]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp
[in]	xStatus	Returns 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]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp.
[in]	xStatus	Returns 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] ucAdapterIf Adapter 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

◆ BTScanParameterSetupCompletedCallback_t

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

Callback invoked when scan parameter setup has completed.

Parameters

[in]	ucAdapterIf	Adapter interface ID. Returned from BTRegisterBleAdapterCallback_t after calling pxRegisterBleApp.
[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.

◆ BTPhyUpdatedCallback_t

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

Callback invoked on pxSetPreferredPhy.

Parameters

[in]	usConnId	Connection ID return from BTConnectCallback_t.
[in]	ucTxPhy
[in]	ucRxPhy
[in]	xStatus	Returns 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]	usConnId	Connection ID return from BTConnectCallback_t.
[in]	ucTxPhy
[in]	ucRxPhy
[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.

◆ BTClassicDevicePropertiesCallback_t

typedef void(* BTClassicDevicePropertiesCallback_t) (BTStatus_t xStatus, uint32_t ulNumProperties, BTClassicProperty_t *pxProperties)

Callback invoked in response to pxGetClassicDeviceProperty and pxSetClassicDeviceProperty.

Parameters

[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	ulNumProperties	Number of classic specific properties.
[in]	pxProperties	Properties array.

◆ BTClassicRemoteDevicePropertiesCallback_t

typedef void( * BTClassicRemoteDevicePropertiesCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxBdAddr, uint32_t ulNumProperties, BTClassicProperty_t *pxProperties)

Callback invoked in response to pxGetRemoteClassicDeviceProperty and pxSetRemoteClassicDeviceProperty.

Parameters

[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	pxBdAddr	Address of the Remote device
[in]	ulNumProperties	Number of classic specific properties.
[in]	pxProperties	Properties array.

◆ BTDeviceFoundCallback_t

typedef void(* BTDeviceFoundCallback_t) (uint32_t ulNumProperties, BTClassicProperty_t *pxProperties)

Callback invoked in response to device discovery If EIR data is not present, then BD_NAME and RSSI shall be NULL and -1 respectively.

Parameters

[in]	ulNumProperties	Number of classic specific properties
[in]	pxProperties	Properties array

◆ BTDiscoveryStateChangedCallback_t

typedef void(* BTDiscoveryStateChangedCallback_t) (BTDiscoveryState_t xState)

Callback invoked in response to pxStartDiscovery and pxStopDiscovery.

Parameters

[in] xState Discovery state

◆ BTaclStateChangedCallback_t

typedef void(* BTaclStateChangedCallback_t) (BTStatus_t xStatus, BTBdaddr_t *pxRemoteBdAddr, BTaclState_t xState)

Callback invoked in response to ACL connection state change.

Parameters

[in]	xStatus	Returns eBTStatusSuccess if operation succeeded.
[in]	pxRemoteBdAddr	Address of the Remote device
[in]	xState	ACL connection state

Enumeration Type Documentation

◆ BTAvConnectionState_t

enum BTAvConnectionState_t

Bluetooth AV connection states.

Enumerator
eBTAvsrcConnectionStateDisconnected	Disconnected
eBTAvsrcConnectionStateConnecting	Connecting
eBTAvsrcConnectionStateConnected	Connected
eBTAvsrcConnectionStateDisconnecting	Disconnecting

◆ BTAvAudioState_t

enum BTAvAudioState_t

Bluetooth AV data path states.

Enumerator
eBTAvsrcAudioStateRemoteSuspend	Audio Suspended
eBTAvsrcAudioStateStopped	Audio Stopped
eBTAvsrcAudioStateStarted	Audio Started

◆ BTAvsrcAclPriority_t

enum BTAvsrcAclPriority_t

Bluetooth AV ACL Priority.

Enumerator
eBTAvsrcAclPriorityLow	ACL Low Priority
eBTAvsrcAclPriorityHigh	ACL High Priority

◆ BTGattcError_t

enum BTGattcError_t

BT GATT client error codes.

Enumerator
eBTGattcCommandSuccess	Command succeeded.
eBTGattcCommandStarted	Command started OK.
eBTGattcCommandBusy	Device busy with another command.
eBTGattcCommandStored	Request is stored in control block.
eBTGattcNoResources	No resources to issue command.
eBTGattcModeUnsupported	Request for 1 or more unsupported modes.
eBTGattcIllegalValue	Illegal command/parameter value.
eBTGattcIncorrectState	Device in wrong state for request.
eBTGattcUnknownAddr	Unknown remote BD address.
eBTGattcDeviceTimeout	Device timeout.
eBTGattcInvalidControllerOutput	An incorrect value was received from HCI.
eBTGattcSecurityError	Authorization or security failure or not authorized.
eBTGattcDelayedEncryptionCheck	Delayed encryption check.
eBTGattcErrProcessing	Generic error.

◆ BTRspErrorStatus_t

enum BTRspErrorStatus_t

Error status sent inside response to a read or write from the client.

Enumerator
eBTRspErrorNone	No error.
eBTRspErrorNo_mitm	Require simple encryption.
eBTRspErrorMitm	Require simple encryption + authentication.
eBTRspErrorSignedNoMitm	Require simple signed data.
eBTRspErrorSignedMitm	Require simple signed data + authentication.

◆ BTGattStatus_t

enum BTGattStatus_t

GATT Status Codes.

See also: BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part F, 3.4.1.1 Error Response

Enumerator
eBTGattStatusSuccess	Success
eBTInvalidHandle	Invalid handle
eBTGattStatusReadNotPermitted	Characteristic does not support read
eBTGattStatusWriteNotPermitted	Characteristic does not support write
eBTGattStatusInvalidPDU	Invalid PDU
eBTGattStatusInsufficientAuthentication	Link is not properly Authenticated
eBTGattStatusRequestNotSupported	Operation not supported
eBTGattStatusInvalidOffset	Invalid offset (long writes/reads)
eBTGattStatusInsufficientAuthorization	Link is not properly authorized
eBTGattStatusPrepareQueueFull	Too many prepare writes queued
eBTGattStatusAttributeNotFound	No attribute found within handle range
eBTGattStatusAttributeNotLong	Cannot be read with Read Blob Request
eBTGattStatusInsufficientKeySize	Link is not properly Encrypted
eBTGattStatusInvalidAttributeLength	Bad Attribute Length
eBTGattStatusUnlikelyError	Encountered an unlikeley error
eBTGattStatusInsufficientEncryption	Link is not properly Encrypted
eBTGattStatusUnsupportedGroupType	Unsupported grouping attribute
eBTGattStatusInsufficientResources	Insufficient Resources
eBTGattStatusInternalError	Internal GATT Error
eBTGattStatusError	Generic GATT Error
eBTGattStatusConnectionCongested	Congested connection
eBTGattStatusErrorConnEstFail	Failed to establish gatt connection
eBTGattStatusErrorConnTimeout	Connection Timed out
eBTGattStatusLocalHostTerminatedConnection	Disconnect from Local Host

◆ anonymous enum

anonymous enum

GATT Characteristic property.

See also: BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part G, 3.3.1.1 Characteristic Properties

◆ anonymous enum

anonymous enum

GATT permissions.

See also: BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part F, 3.2.5 Attribute Permissions

Enumerator
eBTPermRead	Readable, Encryption not required, No Authentication Required.
eBTPermReadEncrypted	Readable, Encryption required, No Authentication Required.
eBTPermReadEncryptedMitm	Readable, Encryption required, Authentication Required.
eBTPermWrite	Writable, Encryption not required, No Authentication Required.
eBTPermWriteEncrypted	Writable, Encryption required, No Authentication Required.
eBTPermWriteEncryptedMitm	Writable, Encryption required, Authentication Required.
eBTPermWriteSigned	Writable, Signed required, No Authentication Required.
eBTPermWriteSignedMitm	Writable, Signed required, Authentication Required.

◆ BTAttrWriteRequests_t

enum BTAttrWriteRequests_t

Write request type.

Enumerator
eBTWriteTypeNoResponse	Write request, do not need response.
eBTWriteTypeDefault	Write request, need a response.
eBTWriteTypePrepare	Prepared Write request
eBTWriteTypeSigned	Signed Write request, need a response.

◆ BTGattServiceTypes_t

enum BTGattServiceTypes_t

GATT Service types.

Enumerator
eBTServiceTypePrimary	Primary service.
eBTServiceTypeSecondary	Secondary service.

◆ BTDbAttributeType_t

enum BTDbAttributeType_t

Attribute types.

Enumerator
eBTDbPrimaryService	Primary service.
eBTDbSecondaryService	Secondary service.
eBTDbIncludedService	Included service.
eBTDbCharacteristicDecl	Characteristic declaration.
eBTDbCharacteristic	Characteristic.
eBTDbDescriptor	Characteristic descriptor.

◆ anonymous enum

anonymous enum

Security Level.

Enumerator
eBTSecLevelNoSecurity	Mode 1 level 1, No security (No authentication and no encryption).
eBTSecLevelUnauthenticatedPairing	Mode 1 level 2, Unauthenticated pairing with encryption.
eBTSecLevelAuthenticatedPairing	Mode 1 level 3, Authenticated pairing with encryption.
eBTSecLevelSecureConnect	Mode 1 level 4, Authenticated LE Secure Connections pairing with encryption using a 128-bit strength encryption key.

◆ anonymous enum

anonymous enum

Authentication requirement.

Enumerator
eBTAuthReqBonding	Set bonding request.
eBTAuthReqMitm	MITM protection.
eBTAuthReqSecureConnect	Authenticated encryption.

◆ BTTransport_t

enum BTTransport_t

Preferred physical Transport for GATT connection .

Enumerator
BTTransportAuto	BTTransportAuto
BTTransportBredr	BTTransportBredr
BTTransportLe	BTTransportLe

◆ BTState_t

enum BTState_t

Bluetooth power State.

Enumerator
eBTstateOff	Off mode
eBTstateOn	On mode

◆ BTAuthFailureReason_t

enum BTAuthFailureReason_t

Authentication failure reasons.

Enumerator
eBTauthSuccess	Authentication Success.
eBTauthFailLmpRespTimeout	LMP Response Timeout.
eBTauthFailKeyMissing	Authentication Key Missing.
eBTauthFailEncrypMode	Encryption Failure.
eBTauthFailUnitKey	Unit Key Failure.
eBTauthFailSmpCfrmValue	Smp Confirm Value failed. (Core Spec v5.2: 0x04 - Confirm Value Failed)
eBTauthFailSmpEnc	Smp Encryption Failure.
eBTauthFailSmpTimeout	Smp Connection Timeout.
eBTauthFailPageTimeout	Authentication Page Timeout.
eBTauthFailSmpPasskeyFail	Smp Pass Key Failure. (Core Spec v5.2: 0x01 - Passkey Entry Failed)
eBTauthFailSmpOobFail	Smp OOB Failure. (Core Spec v5.2: 0x02 - OOB Not Available)
eBTauthFailSmpFail	Smp Failure.
eBTauthFailConnTimeout	Authentication Connection Timeout.
eBTauthFailSmp	Smp Failure.
eBTauthFailSmpPairNotSupport	Smp Pairing Not Supported. (Core Spec v5.2: 0x05 - Pairing Not Supported)
eBTauthFailSmpUnknownIo	Smp IO Failure.
eBTauthFailSmpUnknown	Smp Unknown Failure.
eBTauthFailHostRejectSecurity	Host Reject Security.
eBTauthFailInsuffSecurity	Insufficient Security.
eBTauthFailPeerUser	Peer User Failure.
eBTauthFailUnspecified	Unspecified Failure. (Core Spec v5.2: 0x08 - Unspecified Reason)
eBTauthFailSmpAuthReqFail	Authentication Requirements Failure. (Core Spec v5.2: 0x03 - Authentication Requirements)
eBTauthFailSmpEncKeySize	Encryption Key Size Failure. (Core Spec v5.2: 0x06 - Encryption Key Size)
eBTauthFailSmpCmdNotSupport	Requested Command Not Supported. (Core Spec v5.2: 0x07 - Command Not Supported)
eBTauthFailSmpRepeatedAttempt	Repeated Attempts Failure. (Core Spec v5.2: 0x09 - Repeated Attempts)
eBTauthFailSmpInvalidParameters	Invalid Parameters.(Core Spec v5.2: 0x0A - Invalid Parameters)
eBTauthFailSmpDhkeyCheckFail	Dhkey Check Failed.(Core Spec v5.2: 0x0B - DHKey Check Failed)
eBTauthFailSmpNumericComparFail	Numeric Comparison Failed.(Core Spec v5.2: 0x0C - Numeric Comparison Failed)
eBTauthFailSmpBrPairInProg	Classic Pairing in Progress. (Core Spec v5.2: 0x0D - BR/EDR pairing in progress)
eBTauthFailSmpXtransDeriveNotAllow	Keys referenced betn BR/EDR and LE transport. (Core Spec v5.2: 0x0E - Cross-transport Key Derivation/Generation not allowed)
eBTauthFailStackErr	Add Vendor defined authentication failures to this base.
eBTauthFailHciErr	Add HCI Error codes (From Bluetooth Core Specification v5.2, Vol 1, Part F) to this base.

◆ BTPropertyType_t

enum BTPropertyType_t

Bluetooth local device and Remote Device property types. Properties common to both adapter and remote device.

Enumerator
eBTpropertyBdname	Description - Bluetooth Device Name Access mode - Adapter name can be GET/SET. Remote device can be GET Data type - BTBdname_teBTpropertyBdname
eBTpropertyBdaddr	Description - Bluetooth Device Address Access mode - Only GET. Data type - BTBdaddr_teBTpropertyBdaddr
eBTpropertyTypeOfDevice	Description - Device Type - BREDR, BLE or DUAL Mode Access mode - Only GET. Data type - BTDeviceType_teBTpropertyTypeOfDevice
eBTpropertyAdapterBondedDevices	Description - List of bonded devices Access mode - Only GET. Data type - Array of BTBdaddr_t of the bonded remote devices (Array size inferred from property length).eBTpropertyAdapterBondedDevices
eBTpropertyRemoteFriendlyName	Description - User defined friendly name of the remote device Access mode - GET and SET Data type - BTBdname_t.eBTpropertyRemoteFriendlyName
eBTpropertyRemoteRssi	Description - RSSI value of the inquired remote device Access mode - Only GET. Data type - int32_t.eBTpropertyRemoteRssi
eBTpropertyRemoteVersionInfo	Description - Remote version info Access mode - SET/GET. Data type - BTRemoteVersion_t.eBTpropertyRemoteVersionInfo
eBTpropertyLocalMTUSize	Description - MTU size Access mode - SET/GET. Data type - uint32_teBTpropertyLocalMTUSize
eBTpropertyBondable	Description - Bondable flag Access mode - SET/GET Data type - bool (true for bondable)eBTpropertyBondable
eBTpropertyIO	Description - I/O flag. : eBTpropertyIO has a dependency on the property eBTpropertySecureConnectionOnly. Only I/O yes/no is compatible with eBTpropertySecureConnectionOnly = 1 Access mode - SET/GET Data type - BTIOtypes_teBTpropertyIO
eBTpropertyConnectable	Description - Connectable mode flag Access mode - SET/GET Data type - booleBTpropertyConnectable Sets connectable mode.
eBTpropertySecureConnectionOnly	Description - Secure only mode flag. : Secure connections only has a dependency on the property eBTpropertyIO. Only I/O yes/no is compatible with eBTpropertySecureConnectionOnly = 1 Access mode - SET/GET Data type - booleBTpropertySecureOnly Sets secure connection only mode.

◆ BTDeviceType_t

enum BTDeviceType_t

Bluetooth Device Type.

Enumerator
eBTdeviceDevtypeBredr	Bluetooth classic device only.
eBTdeviceDevtypeBle	BLE device only.
eBTdeviceDevtypeDual	Device with BLE and BT classic.

◆ BTBondState_t

enum BTBondState_t

Bluetooth Bond state

◆ BTSspVariant_t

enum BTSspVariant_t

Bluetooth SSP Bonding Variant.

Enumerator
eBTsspVariantPasskeyConfirmation	eBTsspVariantPasskeyConfirmation
eBTsspVariantPasskeyEntry	eBTsspVariantPasskeyEntry
eBTsspVariantConsent	eBTsspVariantConsent
eBTsspVariantPasskeyNotification	eBTsspVariantPasskeyNotification

◆ BTAclState_t

enum BTAclState_t

Bluetooth ACL connection state.

Enumerator
eBTaclConnected	ACL connected
eBTaclDisconnected	ACL disconnected

◆ BTAclDisconnectReason_t

enum BTAclDisconnectReason_t

Bluetooth ACL Disconnect Reason From Bluetooth Core Spec 5.0 Vol 2, Part D Error Codes Unknown disconnect reason will be treated as eBTaclUnspecified.

Enumerator
eBTaclSuccess	Success
eBTaclIllegalCommand	Unknown HCI Command
eBTaclNoConnection	Unknown Connection Identifier
eBTaclHwFailure	Hardware Failure
eBTaclPageTimeout	Page Timeout
eBTaclAuthFailure	Authentication Failure
eBTaclKeyMissing	PIN or Key Missing
eBTaclMemFull	Memory Capacity Exceeded
eBTaclConnectionTimeout	Connection Timeout
eBTaclMaxNumOfConnections	Connection Limit Exceeded
eBTaclMaxNumOfScos	Synchronous Connection Limit To A Device Exceeded
eBTaclConnectionExists	Connection Already Exists
eBTaclCommandDisallowed	Command Disallowed
eBTaclHostRejectResource	Connection Rejected due to Limited Resources
eBTaclHostRejectSecurity	Connection Rejected Due To Security Reasons
eBTaclHostRejectDevice	Connection Rejected due to Unacceptable BD_ADDR
eBTaclHostTimeout	Connection Accept Timeout Exceeded
eBTaclUnsupportedValue	Unsupported Feature or Parameter Value
eBTaclIllegalParameterFmt	Invalid HCI Command Parameters
eBTaclPeerUser	Remote User Terminated Connection
eBTaclPeerLowResources	Remote Device Terminated Connection due to Low Resources
eBTaclPeerPowerOff	Remote Device Terminated Connection due to Power Off
eBTaclHostUser	Connection Terminated By Local Host
eBTaclRepeatedAttempts	Repeated Attempts
eBTaclPairingNotAllowed	Pairing Not Allowed
eBTaclUnknownLmpPdu	Unknown LMP PDU
eBTaclUnsupportedRemFeature	Unsupported Remote Feature / Unsupported LMP Feature
eBTaclScoOffsetRejected	SCO Offset Rejected
eBTaclScoIntervalRejected	SCO Interval Rejected
eBTaclScoAirRejected	SCO Air Mode Rejected
eBTaclInvalidLmpParam	Invalid LMP Parameters / Invalid LL Parameters
eBTaclUnspecified	Unspecified Error
eBTaclUnsupportedLmpFeature	Unsupported LMP Parameter Value / Unsupported LL Parameter Value
eBTaclRoleChangeNotAllowed	Role Change Not Allowed
eBTaclLmpResponseTimeout	LMP Response Timeout / LL Response Timeout
eBTaclLmpErrTransCollision	LMP Error Transaction Collision / LL Procedure Collision
eBTaclLmpPduNotAllowed	LMP PDU Not Allowed
eBTaclEncryModeNotAcceptable	Encryption Mode Not Acceptable
eBTaclUnitKeyUsed	Link Key cannot be Changed
eBTaclQosNotSupported	Requested QoS Not Supported
eBTaclInstantPassed	Instant Passed
eBTaclPairingWithUnitKeyNotSupported	Pairing With Unit Key Not Supported
eBTaclDiffTransactionCollision	Different Transaction Collision
eBTaclQosUnacceptableParam	QoS Unacceptable Parameter
eBTaclQosRejected	QoS Rejected
eBTaclChanClassifNotSupported	Channel Classification Not Supported
eBTaclInsuffcientSecurity	Insufficient Security
eBTaclParamOutOfRange	Parameter Out Of Mandatory Range
eBTaclRoleSwitchPending	Role Switch Pending
eBTaclReservedSlotViolation	Reserved Slot Violation
eBTaclRoleSwitchFailed	Role Switch Failed
eBTaclInqRspDataTooLarge	Extended Inquiry Response Too Large
eBTaclSimplePairingNotSupported	Secure Simple Pairing Not Supported By Host
eBTaclHostBusyPairing	Host Busy - Pairing
eBTaclRejNoSuitableChannel	Connection Rejected due to No Suitable Channel Found
eBTaclControllerBusy	Controller Busy
eBTaclUnacceptConnInterval	Unacceptable Connection Parameters
eBTaclDirectedAdvertisingTimeout	Advertising Timeout
eBTaclConnToutDueToMicFailure	Connection Terminated due to MIC Failure
eBTaclConnFailedEstablishment	Connection Failed to be Established
eBTaclMacConnectionFailed	MAC Connection Failed

◆ BTBlePropertyType_t

enum BTBlePropertyType_t

BLE device property type.

Enumerator
eBTPropertyLocalLeFeatures	Description - Local LE features Access mode - GET. Data type - bt_local_le_features_t.

◆ BTScanMode_t

enum BTScanMode_t

Bluetooth Adapter Visibility Modes.

Enumerator
eBTScanModeNone	Not visible
eBTScanModeConnectable	Connectable
eBTScanModeConnectableDiscoverable	Connectable and Discoverable

◆ BTScanParam_t

enum BTScanParam_t

Bluetooth scan parameters.

Enumerator
eBTPageScanInterval220ms	220 ms page scan interval
eBTPageScanInterval1280ms	1280 ms page scan interval

◆ BTDiscoveryState_t

enum BTDiscoveryState_t

Bluetooth Adapter Discovery state.

Enumerator
eBTDiscoveryStopped	Discovery Stopped
eBTDiscoveryStarted	Discovery Started

◆ BTaclState_t

enum BTaclState_t

Bluetooth ACL connection state.

Enumerator
eBTaclStateConnected	ACL connected
eBTaclStateDisconnected	ACL disconnected

◆ BTScanType_t

enum BTScanType_t

Bluetooth Scan types.

Enumerator
eBTScanTypeStandard	Standard Scan Type
eBTScanTypeInterlaced	Interlaced Scan Type

◆ BTClassicPropertyType_t

enum BTClassicPropertyType_t

Classic Device Property Types.

Enumerator
eBTPropertyBdname	Description - Bluetooth Device Name Access mode - Adapter name can be GET/SET. Remote device can be GET Data type - BTBdname_t
eBTPropertyBdaddr	Description - Bluetooth Device Address Access mode - Only GET. Data type - BTBdaddr_t
eBTPropertyTypeOfDevice	Description - Device Type - BREDR, BLE or DUAL Mode Access mode - Only GET. Data type - BTDeviceType_t.
eBTPropertyUUIDS	Description - Bluetooth Service 128-bit UUIDs Access mode - Only GET. Data type - Array of BTUuid_t (Array size inferred from property length).
eBTPropertyClassOfDevice	Description - Bluetooth Class of Device as found in Assigned Numbers Access mode - Only GET. Data type - uint32_t.
eBTPropertyServiceRecord	Description - Bluetooth Service Record Access mode - Only GET. Data type - BTServiceRecord_t
eBTPropertyAdapterDiscoveryTimeout	Description - Bluetooth Adapter Discovery timeout (in seconds) Access mode - GET and SET Data type - uint32_t
eBTPropertyAdapterScanMode	Description - Bluetooth Adapter scan mode Access mode - GET and SET Data type - BTScanMode_t.
eBTPropertyEIRManfInfo	Description - Manufacturer specific info on EIR Access mode - GET Data type - BTEirManfInfo_t.
eBTPropertyAdapterScanParam	Description - Bluetooth Adapter scan parameters Access mode - SET Data type - BTScanParam_t.
eBTPropertyConnectability	Description - Bluetooth Adapter's connectability Access mode - GET and SET Data type - 2 * uint32_t
eBTPropertyScanType	Description - Bluetooth Adapter's scan type (Standard or Interlaced) Access mode - GET and SET Data type - BTScanType_t
eBTPropertyGadgetEIRManfInfo	Description - Manufacturer gadget specific info on EIR Access mode - GET Data type - BTGadgetEirManfInfo_t.

◆ BTuuidType_t

enum BTuuidType_t

UUID types.

Enumerator
eBTuuidType16	16 bit UUID
eBTuuidType32	32 bit UUID
eBTuuidType128	128 bit UUID

◆ BTStatus_t

enum BTStatus_t

Bluetooth Error Status .

Enumerator
eBTStatusSuccess	Success.
eBTStatusFail	Generic fail.
eBTStatusNotReady	Service/Driver/Peripheral not ready.
eBTStatusNoMem	Failed to allocate memory.
eBTStatusBusy	Service/Driver/Peripheral busy.
eBTStatusDone	Request already completed.
eBTStatusUnsupported	Unsupported request/call.
eBTStatusParamInvalid	Invalid parameter.
eBTStatusUnHandled	Unhandled
eBTStatusAuthFailure	Authentication procedure failed.
eBTStatusRMTDevDown	Remote Device Down
eBTStatusAuthRejected	Authentication rejected.
eBTStatusWakeLockError	Wake lock error
eBTStatusLinkLoss	Link lost.

◆ BTProfile_t

enum BTProfile_t

Enumerator
eProfileHeadset	Headset and Handsfree profile.
eBTProfileA2DP	A2DP Source profile.
eBTProfileAVRCPTarget	AVRCP Target profile.
eBTProfileA2DPSink	A2DP Sink profile.
eBTProfileAVRCPController	AVRCP Controller profile.
eBTProfileInputDevice	Human Input Device (HID) Host profile.
eBTProfileHeadsetClient	Headset Client (HFP-HF role) profile.
eBTProfileGATT	GATT profile
eBTProfileSock	Socket profile
eBTProfileMaxID	Max profile index

◆ BTIOtypes_t

enum BTIOtypes_t

Input Output device type.

Enumerator
eBTIONone	No IO.
eBTIODisplayOnly	No input, only display.
eBTIODisplayYesNo	Display + yes/no input.
eBTIOKeyboardOnly	Only input, keyboard.
eBTIOKeyboardDisplay	Keyboard and Display.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

USAGE

USAGE

USAGE

Macro Definition Documentation

◆ btGATT_MAX_ATTR_LEN

◆ btBLE_ADD_BLOB_SERVICE_SUPPORTED_BIT

Typedef Documentation

◆ BTAvsrcConnectionStateCallback_t

◆ BTAvsrcAudioStateCallback_t

◆ BTAvsrcAclPriorityCallback_t

◆ BTRegisterClientCallback_t

◆ BTSearchCompleteCallback_t

◆ BTRegisterForNotificationCallback_t

◆ BTNotifyCallback_t

◆ BTReadCharacteristicCallback_t

◆ BTWriteCharacteristicCallback_t

◆ BTExecuteWriteCallback_t

◆ BTReadDescriptorCallback_t

◆ BTWriteDescriptorCallback_t

◆ BTListenCallback_t

◆ BTConfigureMtuCallback_t

◆ BTGetGattDbCallback_t

◆ BTServicesRemovedCallback_t

◆ BTServicesAddedCallback_t

◆ BTRegisterServerCallback_t

◆ BTUnregisterServerCallback_t

◆ BTConnectionCallback_t

◆ BTServiceAddedCallback_t

◆ BTIncludedServiceAddedCallback_t

◆ BTCharacteristicAddedCallback_t

◆ BTSetValCallback_t

◆ BTDescriptorAddedCallback_t

◆ BTServiceStartedCallback_t

◆ BTServiceStoppedCallback_t

◆ BTServiceDeletedCallback_t

◆ BTRequestReadCallback_t

◆ BTRequestWriteCallback_t

◆ BTRequestExecWriteCallback_t

◆ BTResponseConfirmationCallback_t

◆ BTIndicationSentCallback_t

◆ BTMtuChangedCallback_t

◆ BTWhiteListChangedCallback_t

◆ BTConnectCallback_t

◆ BTDisconnectCallback_t

◆ BTReadRemoteRssiCallback_t

◆ BTCongestionCallback_t

◆ BTDeviceStateChangedCallback_t

◆ BTDevicePropertiesCallback_t

◆ BTRemoteDevicePropertiesCallback_t

◆ BTPinRequestCallback_t

◆ BTSspRequestCallback_t

◆ BTPairingStateChangedCallback_t

◆ BTEnergyInfoCallback_t

◆ BTDutModeRecvCallback_t

◆ BTLeTestModeCallback_t

◆ BTReadRssiCallback_t

◆ BTSlaveSecurityRequestCallBack_t

◆ BTTxPowerCallback_t

◆ BTBondedCallback_t

◆ BTAclStateChangedCallback_t

◆ BTRegisterBleAdapterCallback_t

◆ BTBleDevicePropertiesCallback_t

◆ BTBleRemoteDevicePropertiesCallback_t

◆ BTScanResultCallback_t

◆ BTAdvStatusCallback_t

◆ BTSetAdvDataCallback_t

◆ BTConnParameterUpdateCallback_t

◆ BTScanFilterCfgCallback_t

◆ BTScanFilterParamCallback_t

◆ BTScanFilterStatusCallback_t

◆ BTMultiAdvEnableCallback_t

◆ BTMultiAdvUpdateCallback_t

◆ BTMultiAdvDataCallback_t

◆ BTMultiAdvDisableCallback_t