Library Interface

This section describes the API functions of the BM64 Bluetooth Driver library.

Refer to each section for a detailed description.

a) System Functions

	Name	Description
	DRV_BM64_Initialize	Initializes hardware and data for the instance of the BM64 Bluetooth module
	DRV_BM64_TaskReq	Make a power on/power off task request.
	DRV_BM64_Tasks	Maintains the driver's control and data interface state machine.
	DRV_BM64_GetPowerStatus	Gets the current status of the BM64 Bluetooth driver module (BM64-specific).
	DRV_BM64_Status	Gets the current system status of the BM64 Bluetooth driver module.

b) Client Setup Functions

	Name	Description
	DRV_BM64_Open	Open the specified BM64 driver instance and returns a handle to it
	DRV_BM64_Close	Close an opened-instance of the BM64 Bluetooth driver.
	DRV_BM64_BufferEventHandlerSet	This function allows a client to identify a event handling function for the driver to call back.
	DRV_BM64_EventHandlerSet	This function allows a client to identify an event handling function for the driver to call back.

c) Data Transfer Functions

	Name	Description
	DRV_BM64_BufferAddRead	Schedule a non-blocking driver read operation.

d) Settings Functions

	Name	Description
	DRV_BM64_volumeDown	Turn the volume down on the host device.
	DRV_BM64_volumeUp	Turn the volume up on the host device.
	DRV_BM64_VolumeSet	Set current volume.
	DRV_BM64_VolumeGet	returns 7-bit value 0-127
	DRV_BM64_SamplingRateSet	Set the current sampling rate.
	DRV_BM64_SamplingRateGet	Return the current sampling rate.

e) Bluetooth-specific Functions

	Name	Description
	DRV_BM64_DisconnectAllLinks	Disconnect all links.
	DRV_BM64_EnterBTPairingMode	Enter Bluetooth pairing mode.
	DRV_BM64_ForgetAllLinks	Forget all pairings.
	DRV_BM64_LinkLastDevice	Link last device.
	DRV_BM64_GetLinkStatus	Return link status.

f) AVRCP Functions

	Name	Description
	DRV_BM64_FastForward	Fast forward the media.
	DRV_BM64_Pause	Pause playback.
	DRV_BM64_Play	Start playback.
	DRV_BM64_PlayNextSong	Play the next song.
	DRV_BM64_PlayPause	Toggle play/pause mode.
	DRV_BM64_PlayPreviousSong	Play the previous song.
	DRV_BM64_Rewind	Rewind the media.
	DRV_BM64_Stop	Stop playback.
	DRV_BM64_CancelForwardOrRewind	Cancel previous fast forward or rewind request.
	DRV_BM64_GetPlayingStatus	Return the current playing status of the device.

g) Device Name and Address Functions

	Name	Description
	DRV_BM64_GetBDAddress	Return the Bluetooth address.
	DRV_BM64_GetBDName	Return Bluetooth device name.
	DRV_BM64_SetBDName	Set the Bluetooth device name.

h) BLE Functions

	Name	Description
	DRV_BM64_ClearBLEData	Clear the BLE receive buffer.
	DRV_BM64_BLE_EnableAdvertising	Enable or disable advertising.
	DRV_BM64_BLE_QueryStatus	Query BM64 LE status.
	DRV_BM64_ReadByteFromBLE	Read a byte over BLE.
	DRV_BM64_ReadDataFromBLE	Read data over BLE.
	DRV_BM64_SendByteOverBLE	Send a byte over BLE.
	DRV_BM64_SendDataOverBLE	Send data over BLE.

i) Data Types and Constants

	Name	Description
	DRV_BM64_BUFFER_EVENT_HANDLER	prototype for callback for DRV_BM64_BufferEventHandlerSet
	DRV_BM64_DRVR_STATUS	BM64 driver status
	DRV_BM64_EVENT	events that can be returned to a client via callback
	DRV_BM64_EVENT_HANDLER	prototype for callback for DRV_BM64_EventHandlerSet
	DRV_BM64_LINKSTATUS	BM64 link status
	DRV_BM64_PLAYINGSTATUS	This is type DRV_BM64_PLAYINGSTATUS.
	DRV_BM64_PROTOCOL	BM64 protocols
	DRV_BM64_REQUEST	BM64 power on/off request
	DRV_BM64_SAMPLE_FREQUENCY	BM64 sample frequency
	DRV_BM64_BUFFER_EVENT	This is macro DRV_BM64_BUFFER_EVENT.
	DRV_BM64_BUFFER_EVENT_COMPLETE	This is macro DRV_BM64_BUFFER_EVENT_COMPLETE.
	DRV_BM64_BUFFER_HANDLE	This is macro DRV_BM64_BUFFER_HANDLE.
	DRV_BM64_BUFFER_HANDLE_INVALID	This is macro DRV_BM64_BUFFER_HANDLE_INVALID.
	DRV_BM64_DATA32	BM64 defines based on I2S interface
	DRV_BM64_MAXBDNAMESIZE
	DRV_BM64_BLE_STATUS	This is type DRV_BM64_BLE_STATUS.
	DRV_BM64_H	This is macro DRV_BM64_H.

MPLAB Harmony Bluetooth Help