FreeRTOS: BLE
BLE
Return to main page ↑
BTClassicInterface_t Struct Reference

#include <bt_hal_manager_adapter_classic.h>

Data Fields

BTStatus_t(* pxInit )(BTClassicCallbacks_t *pxCallbacks)
 
BTStatus_t(* pxCleanup )()
 
BTStatus_t(* pxGetClassicDeviceProperty )(BTClassicPropertyType_t xType)
 
BTStatus_t(* pxSetClassicDeviceProperty )(const BTClassicProperty_t *pxProperty)
 
BTStatus_t(* pxGetAllRemoteClassicDeviceProperties )(BTBdaddr_t *pxRemote_addr)
 
BTStatus_t(* pxGetRemoteClassicDeviceProperty )(BTBdaddr_t *pxRemote_addr, BTClassicPropertyType_t xType)
 
BTStatus_t(* pxSetRemoteClassicDeviceProperty )(BTBdaddr_t *pxRemote_addr, const BTClassicProperty_t *pxProperty)
 
BTStatus_t(* pxGetRemoteServiceRecord )(BTBdaddr_t *pxRemote_addr, BTUuid_t *pxUuid)
 
BTStatus_t(* pxGetRemoteService )(BTBdaddr_t *pxRemote_addr)
 
BTStatus_t(* pxStartDiscovery )()
 
BTStatus_t(* pxStopDiscovery )()
 
const void *(* ppvGetProfileInterface )(BTProfile_t xProfile)
 

Detailed Description

Represents the standard SAL BT Classic device management interface.

Field Documentation

◆ pxInit

BTStatus_t( * BTClassicInterface_t::pxInit) (BTClassicCallbacks_t *pxCallbacks)

Initializes SAL classic BT adapter.

Parameters
callbacks,BTCallbacks_tcallbacks.
Returns
eBTStatusSuccess if init is successful. Or any other error code

◆ pxCleanup

BTStatus_t( * BTClassicInterface_t::pxCleanup) ()

Cleans to SAL classic Bluetooth adapter

Parameters
None
Returns
eBTStatusSuccess if cleanup is successful

◆ pxGetClassicDeviceProperty

BTStatus_t( * BTClassicInterface_t::pxGetClassicDeviceProperty) (BTClassicPropertyType_t xType)

Get Bluetooth Classic Adapter property of 'type'

Parameters
propertytype
Returns
eBTStatusSuccess if the operation is successful, else error code. When property is read, it will be returned as part of BTClassic_device_properties_callback()
eBTStatusSuccess if the operation is successful, else error code.

◆ pxSetClassicDeviceProperty

BTStatus_t( * BTClassicInterface_t::pxSetClassicDeviceProperty) (const BTClassicProperty_t *pxProperty)

Sets Bluetooth classic Adapter property of 'type'.Based on the type, val shall be one of BTScanmode_t, BTScanType_t etc

Parameters
propertycontaining BTClassicProperty_t structure
Returns
eBTStatusSuccess if the operation is successful, else error code.

◆ pxGetAllRemoteClassicDeviceProperties

BTStatus_t( * BTClassicInterface_t::pxGetAllRemoteClassicDeviceProperties) (BTBdaddr_t *pxRemote_addr)

Retrieves all properties of a remote device

Parameters
BTbdaddr_t :BT Address of remote device
Returns
eBTStatusSuccess if the operation is successful, else error code. When properties are read, they will be returned as part of BTClassicRemoteDevicePropertiesCallback()

◆ pxGetRemoteClassicDeviceProperty

BTStatus_t( * BTClassicInterface_t::pxGetRemoteClassicDeviceProperty) (BTBdaddr_t *pxRemote_addr, BTClassicPropertyType_t xType)

Get Bluetooth property of 'type' associated with a remote device

Parameters
BTbdaddr_t :BT Address of remote device

◆ pxSetRemoteClassicDeviceProperty

BTStatus_t( * BTClassicInterface_t::pxSetRemoteClassicDeviceProperty) (BTBdaddr_t *pxRemote_addr, const BTClassicProperty_t *pxProperty)

Sets Bluetooth property of 'type'.Based on the type, to a remote device

Parameters
BTbdaddr_t :BT Address of remote device

◆ pxGetRemoteServiceRecord

BTStatus_t( * BTClassicInterface_t::pxGetRemoteServiceRecord) (BTBdaddr_t *pxRemote_addr, BTUuid_t *pxUuid)

Get Remote Device's service record for the given UUID

Parameters
BTbdaddr_t :BT Address of remote device

◆ pxGetRemoteService

BTStatus_t( * BTClassicInterface_t::pxGetRemoteService) (BTBdaddr_t *pxRemote_addr)

Starts service search on a given Bluetooth device

Parameters
BTbdaddr_t :BT Address of remote device
Returns
eBTStatusSuccess if the operation is successful, else error code.

◆ pxStartDiscovery

BTStatus_t( * BTClassicInterface_t::pxStartDiscovery) ()

Starts device discovery for nearby devices

Parameters
None
Returns
eBTStatusSuccess if the operation is successful, else error code.

◆ pxStopDiscovery

BTStatus_t( * BTClassicInterface_t::pxStopDiscovery) ()

Stops an ongoing device discovery

Parameters
None
Returns
eBTStatusSuccess if the operation is successful, else error code.

◆ ppvGetProfileInterface

const void*( * BTClassicInterface_t::ppvGetProfileInterface) (BTProfile_t xProfile)

Retrieves the HAL profile interface.

Parameters
BTProfile_tprofile needed
Returns
void* pointer that points to the profile interface itself. This needs to be type-casted to the right profile interface by the caller

The documentation for this struct was generated from the following file: