platform_bluetoothconnectivity_api_service_bluetoothconnectivity/com.tomtom.ivi.platform.bluetoothconnectivity.api.service.bluetoothconnectivity/BluetoothConnectivityService

BluetoothConnectivityService

interface BluetoothConnectivityService

Interface which can be extended by a service implementation, which is responsible for providing clients with information about nearby Bluetooth devices, and functionality to change the connection state of those devices.

The configuration mode indicates when a UI is currently visible which allows a user to make changes to the connectivity state of Bluetooth devices. The mode is intended to be enabled by multiple clients. A client can call enableConfigurationMode to enable the configuration mode and disableConfigurationMode to disable it. The isConfigurationModeEnabled flag can be observed by a client in order to show a UI related to Bluetooth configuration when it is set to true and to stop showing the UI when the flag is set to false.

Types

BluetoothPairingRequestListener

interface BluetoothPairingRequestListener

Clients can implement this listener to know when a pairing request has been received.

Companion

object Companion

Properties

connectableProfiles

abstract val connectableProfiles: Set<BluetoothDeviceProfile>

Set of all Bluetooth profiles which are supported by the platform and are connectable. When a profile is connectable, the connection policy can be altered by using method setProfileConnectionPolicy.

deviceInformation

abstract val deviceInformation: MirrorableMap<BluetoothDeviceAddress, BluetoothDeviceInformation>

Map of all the Bluetooth devices where the key is a unique identifier referring to a BluetoothDeviceAddress entry and where the value provides the current BluetoothDeviceInformation of the device.

isConfigurationModeEnabled

abstract val isConfigurationModeEnabled: Boolean

Indicates if the configuration mode is currently enabled. Can be used by a client to show in a UI that configuration mode is enabled.

isDiscoveryActive

abstract val isDiscoveryActive: Boolean

Indicates when the discovery process is active.

recentlyConnectedDevices

abstract val recentlyConnectedDevices: List<BluetoothDeviceAddress>

List of BluetoothDeviceAddresses of the most recently connected Bluetooth devices ordered by how recently they were connected to, with the most recent first and least recent last. The list includes the current connected devices.

Functions

acceptPairing

abstract suspend fun acceptPairing(deviceAddress: BluetoothDeviceAddress, pairingDetails: BluetoothPairingDetails): Boolean

Provides the currently running pairing process with the required pairingDetails, so it can be finalised successfully.

cleanupNeverPairedDevices

abstract suspend fun cleanupNeverPairedDevices()

Cleanup deviceInformation by removing all entries which have BluetoothConnectivityStatus.bondState equal to BluetoothConnectivityStatus.BluetoothBondState.UNPAIRED.

connect

abstract suspend fun connect(deviceAddress: BluetoothDeviceAddress)

Connects to a specific Bluetooth device which is registered to BluetoothDeviceAddress. BluetoothConnectivityStatus.connectionState will be updated for the device entry in deviceInformation.

disableConfigurationMode

abstract suspend fun disableConfigurationMode()

Disables configuration mode by setting the isConfigurationModeEnabled to false.

disconnect

abstract suspend fun disconnect(deviceAddress: BluetoothDeviceAddress)

Disconnects from a specific Bluetooth device which is registered to BluetoothDeviceAddress. BluetoothConnectivityStatus.connectionState will be updated for the device entry in deviceInformation.

enableConfigurationMode

abstract suspend fun enableConfigurationMode()

Enables configuration mode by setting the isConfigurationModeEnabled to true.

executeDiscoveryProcessOnce

abstract suspend fun executeDiscoveryProcessOnce()

Start discovering devices. When devices are nearby and discoverable they will be added to deviceInformation.

forgetPairedDevice

abstract suspend fun forgetPairedDevice(deviceAddress: BluetoothDeviceAddress)

Removes bond (pairing) with a specific Bluetooth device which is registered to BluetoothDeviceAddress. It deletes the link key associated with that device and, by doing so, the connections to that device are terminated immediately.

getProfileConnectionPolicies

abstract suspend fun getProfileConnectionPolicies( profile: BluetoothDeviceProfile, deviceConnectionState: BluetoothConnectivityStatus.BluetoothConnectionState? = null, deviceBondState: BluetoothConnectivityStatus.BluetoothBondState? = null): Map<BluetoothDeviceAddress, BluetoothProfileConnectionPolicy>

Retrieves the platform side connection policies of a specific Bluetooth profile for all devices in a specific connection state and/or specific bond state.

getProfileConnectionPolicy

abstract suspend fun getProfileConnectionPolicy(deviceAddress: BluetoothDeviceAddress, profile: BluetoothDeviceProfile): BluetoothProfileConnectionPolicy

Retrieves the platform side connection policy of a specific Bluetooth profile for a specific Bluetooth device.

setProfileConnectionPolicy

abstract suspend fun setProfileConnectionPolicy( deviceAddress: BluetoothDeviceAddress, profile: BluetoothDeviceProfile, isAllowed: Boolean): Boolean

Sets the platform side connection policy for a specific Bluetooth device, which is registered to BluetoothDeviceAddress. The connection policy of the remote device is not impacted and will not change.

startPairing

abstract suspend fun startPairing(deviceAddress: BluetoothDeviceAddress): Boolean

Initiates pairing with a specific Bluetooth device which is registered to BluetoothDeviceAddress. Once the bond state has changed BluetoothConnectivityStatus.bondState will be update for the device entry in deviceInformation.

stopPairing

abstract suspend fun stopPairing()

Stops the currently running pairing process and BluetoothConnectivityStatus.bondState will be set to BluetoothConnectivityStatus.BluetoothBondState.UNPAIRED for the device entry in deviceInformation.