Added in API level 14
Deprecated in API level 29

BluetoothHealth

class BluetoothHealth : BluetoothProfile
kotlin.Any
   ↳ android.bluetooth.BluetoothHealth

Public API for Bluetooth Health Profile.

BluetoothHealth is a proxy object for controlling the Bluetooth Service via IPC.

How to connect to a health device which is acting in the source role.

  • Use BluetoothAdapter.getProfileProxy to get the BluetoothHealth proxy object.
  • Create an BluetoothHealth callback and call registerSinkAppConfiguration to register an application configuration
  • Pair with the remote device. This currently needs to be done manually from Bluetooth Settings
  • Connect to a health device using connectChannelToSource. Some devices will connect the channel automatically. The BluetoothHealth callback will inform the application of channel state change.
  • Use the file descriptor provided with a connected channel to read and write data to the health channel.
  • The received data needs to be interpreted using a health manager which implements the IEEE 11073-xxxxx specifications.
  • When done, close the health channel by calling disconnectChannel and unregister the application configuration calling unregisterAppConfiguration

    • Summary

    Constants
    static Int

    Health App Configuration registration failure
    static Int

    Health App Configuration registration success
    static Int

    Health App Configuration un-registration failure
    static Int

    Health App Configuration un-registration success
    static Int

    Health Profile - Channel Type used - Reliable
    static Int

    Health Profile - Channel Type used - Streaming
    static Int

    Health Profile Sink Role the device talking to the health device.
    static Int

    Health Profile Source Role - the health device.
    static Int

    Health Channel Connection State - Connected
    static Int

    Health Channel Connection State - Connecting
    static Int

    Health Channel Connection State - Disconnected
    static Int

    Health Channel Connection State - Disconnecting
    Inherited constants
    Public methods
    Boolean

    Connect to a health device which has the SOURCE_ROLE.
    Boolean

    Disconnect a connected health channel.
    MutableList<BluetoothDevice!>!

    Get connected devices for the health profile.
    Int

    Get the current connection state of the profile.
    MutableList<BluetoothDevice!>!

    Get a list of devices that match any of the given connection states.
    ParcelFileDescriptor!

    Get the file descriptor of the main channel associated with the remote device and application configuration.
    Boolean

    Register an application configuration that acts as a Health SINK.
    Boolean

    Unregister an application configuration that has been registered using registerSinkAppConfiguration
    For apps targeting Build.VERSION_CODES.R or lower, this requires the Manifest.permission.BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.

    Constants

    APP_CONFIG_REGISTRATION_FAILURE

    Added in API level 14
    static val APP_CONFIG_REGISTRATION_FAILURE: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health App Configuration registration failure

    Value: 1

    APP_CONFIG_REGISTRATION_SUCCESS

    Added in API level 14
    static val APP_CONFIG_REGISTRATION_SUCCESS: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health App Configuration registration success

    Value: 0

    APP_CONFIG_UNREGISTRATION_FAILURE

    Added in API level 14
    static val APP_CONFIG_UNREGISTRATION_FAILURE: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health App Configuration un-registration failure

    Value: 3

    APP_CONFIG_UNREGISTRATION_SUCCESS

    Added in API level 14
    static val APP_CONFIG_UNREGISTRATION_SUCCESS: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health App Configuration un-registration success

    Value: 2

    CHANNEL_TYPE_RELIABLE

    Added in API level 14
    static val CHANNEL_TYPE_RELIABLE: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health Profile - Channel Type used - Reliable

    Value: 10

    CHANNEL_TYPE_STREAMING

    Added in API level 14
    static val CHANNEL_TYPE_STREAMING: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health Profile - Channel Type used - Streaming

    Value: 11

    SINK_ROLE

    Added in API level 14
    static val SINK_ROLE: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health Profile Sink Role the device talking to the health device.

    Value: 2

    SOURCE_ROLE

    Added in API level 14
    static val SOURCE_ROLE: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health Profile Source Role - the health device.

    Value: 1

    STATE_CHANNEL_CONNECTED

    Added in API level 14
    static val STATE_CHANNEL_CONNECTED: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health Channel Connection State - Connected

    Value: 2

    STATE_CHANNEL_CONNECTING

    Added in API level 14
    static val STATE_CHANNEL_CONNECTING: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health Channel Connection State - Connecting

    Value: 1

    STATE_CHANNEL_DISCONNECTED

    Added in API level 14
    static val STATE_CHANNEL_DISCONNECTED: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health Channel Connection State - Disconnected

    Value: 0

    STATE_CHANNEL_DISCONNECTING

    Added in API level 14
    static val STATE_CHANNEL_DISCONNECTING: Int

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Health Channel Connection State - Disconnecting

    Value: 3

    Public methods

    connectChannelToSource

    Added in API level 14
    fun connectChannelToSource(
        device: BluetoothDevice!, 
        config: BluetoothHealthAppConfiguration!
    ): Boolean

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Connect to a health device which has the SOURCE_ROLE. This is an asynchronous call. If this function returns true, the callback associated with the application configuration will be called.
    For apps targeting Build.VERSION_CODES.R or lower, this requires the Manifest.permission.BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.
    For apps targeting Build.VERSION_CODES.S or or higher, this requires the Manifest.permission.BLUETOOTH_CONNECT permission which can be gained with android.app.Activity#requestPermissions(String[], int).
    Requires android.Manifest.permission#BLUETOOTH_CONNECT

    Parameters
    device BluetoothDevice!: The remote Bluetooth device.
    config BluetoothHealthAppConfiguration!: The application configuration which has been registered using registerSinkAppConfiguration(java.lang.String,int,android.bluetooth.BluetoothHealthCallback)
    Return
    Boolean If true, the callback associated with the application config will be called.

    disconnectChannel

    Added in API level 14
    fun disconnectChannel(
        device: BluetoothDevice!, 
        config: BluetoothHealthAppConfiguration!, 
        channelId: Int
    ): Boolean

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Disconnect a connected health channel. This is an asynchronous call. If this function returns true, the callback associated with the application configuration will be called.
    For apps targeting Build.VERSION_CODES.R or lower, this requires the Manifest.permission.BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.
    For apps targeting Build.VERSION_CODES.S or or higher, this requires the Manifest.permission.BLUETOOTH_CONNECT permission which can be gained with android.app.Activity#requestPermissions(String[], int).
    Requires android.Manifest.permission#BLUETOOTH_CONNECT

    Parameters
    device BluetoothDevice!: The remote Bluetooth device.
    config BluetoothHealthAppConfiguration!: The application configuration which has been registered using registerSinkAppConfiguration(java.lang.String,int,android.bluetooth.BluetoothHealthCallback)
    channelId Int: The channel id associated with the channel
    Return
    Boolean If true, the callback associated with the application config will be called.

    getConnectedDevices

    Added in API level 14
    fun getConnectedDevices(): MutableList<BluetoothDevice!>!

    Deprecated: Deprecated in Java.

    Get connected devices for the health profile.

    Return the set of devices which are in state STATE_CONNECTED

    This is not specific to any application configuration but represents the connection state of the local Bluetooth adapter for this profile. This can be used by applications like status bar which would just like to know the state of the local adapter.
    For apps targeting Build.VERSION_CODES.R or lower, this requires the Manifest.permission.BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.
    For apps targeting Build.VERSION_CODES.S or or higher, this requires the Manifest.permission.BLUETOOTH_CONNECT permission which can be gained with android.app.Activity#requestPermissions(String[], int).
    Requires android.Manifest.permission#BLUETOOTH_CONNECT

    Return
    MutableList<BluetoothDevice!>! List of devices. The list will be empty on error.

    getConnectionState

    Added in API level 14
    fun getConnectionState(device: BluetoothDevice!): Int

    Deprecated: Deprecated in Java.

    Get the current connection state of the profile.

    This is not specific to any application configuration but represents the connection state of the local Bluetooth adapter with the remote device. This can be used by applications like status bar which would just like to know the state of the local adapter.
    For apps targeting Build.VERSION_CODES.R or lower, this requires the Manifest.permission.BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.
    For apps targeting Build.VERSION_CODES.S or or higher, this requires the Manifest.permission.BLUETOOTH_CONNECT permission which can be gained with android.app.Activity#requestPermissions(String[], int).
    Requires android.Manifest.permission#BLUETOOTH_CONNECT

    Parameters
    device BluetoothDevice!: Remote bluetooth device.
    Return
    Int State of the profile connection. One of STATE_CONNECTED, STATE_CONNECTING, STATE_DISCONNECTED, STATE_DISCONNECTING

    getDevicesMatchingConnectionStates

    Added in API level 14
    fun getDevicesMatchingConnectionStates(states: IntArray!): MutableList<BluetoothDevice!>!

    Deprecated: Deprecated in Java.

    Get a list of devices that match any of the given connection states.

    If none of the devices match any of the given states, an empty list will be returned.

    This is not specific to any application configuration but represents the connection state of the local Bluetooth adapter for this profile. This can be used by applications like status bar which would just like to know the state of the local adapter.
    For apps targeting Build.VERSION_CODES.R or lower, this requires the Manifest.permission.BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.
    For apps targeting Build.VERSION_CODES.S or or higher, this requires the Manifest.permission.BLUETOOTH_CONNECT permission which can be gained with android.app.Activity#requestPermissions(String[], int).
    Requires android.Manifest.permission#BLUETOOTH_CONNECT

    Parameters
    states IntArray!: Array of states. States can be one of STATE_CONNECTED, STATE_CONNECTING, STATE_DISCONNECTED, STATE_DISCONNECTING,
    Return
    MutableList<BluetoothDevice!>! List of devices. The list will be empty on error.

    getMainChannelFd

    Added in API level 14
    fun getMainChannelFd(
        device: BluetoothDevice!, 
        config: BluetoothHealthAppConfiguration!
    ): ParcelFileDescriptor!

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Get the file descriptor of the main channel associated with the remote device and application configuration.

    It's the responsibility of the caller to close the ParcelFileDescriptor when done.
    For apps targeting Build.VERSION_CODES.R or lower, this requires the Manifest.permission.BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.
    For apps targeting Build.VERSION_CODES.S or or higher, this requires the Manifest.permission.BLUETOOTH_CONNECT permission which can be gained with android.app.Activity#requestPermissions(String[], int).
    Requires android.Manifest.permission#BLUETOOTH_CONNECT

    Parameters
    device BluetoothDevice!: The remote Bluetooth health device
    config BluetoothHealthAppConfiguration!: The application configuration
    Return
    ParcelFileDescriptor! null on failure, ParcelFileDescriptor on success.

    registerSinkAppConfiguration

    Added in API level 14
    fun registerSinkAppConfiguration(
        name: String!, 
        dataType: Int, 
        callback: BluetoothHealthCallback!
    ): Boolean

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Register an application configuration that acts as a Health SINK. This is the configuration that will be used to communicate with health devices which will act as the SOURCE_ROLE. This is an asynchronous call and so the callback is used to notify success or failure if the function returns true.
    For apps targeting Build.VERSION_CODES.R or lower, this requires the Manifest.permission.BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.
    For apps targeting Build.VERSION_CODES.S or or higher, this requires the Manifest.permission.BLUETOOTH_CONNECT permission which can be gained with android.app.Activity#requestPermissions(String[], int).
    Requires android.Manifest.permission#BLUETOOTH_CONNECT

    Parameters
    name String!: The friendly name associated with the application or configuration.
    dataType Int: The dataType of the Source role of Health Profile to which the sink wants to connect to.
    callback BluetoothHealthCallback!: A callback to indicate success or failure of the registration and all operations done on this application configuration.
    Return
    Boolean If true, callback will be called.

    unregisterAppConfiguration

    Added in API level 14
    fun unregisterAppConfiguration(config: BluetoothHealthAppConfiguration!): Boolean

    Deprecated: Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as BluetoothGatt, android.bluetooth.BluetoothAdapter#listenUsingL2capChannel(), or android.bluetooth.BluetoothDevice#createL2capChannel(int)

    Unregister an application configuration that has been registered using registerSinkAppConfiguration
    For apps targeting Build.VERSION_CODES.R or lower, this requires the Manifest.permission.BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.
    For apps targeting Build.VERSION_CODES.S or or higher, this requires the Manifest.permission.BLUETOOTH_CONNECT permission which can be gained with android.app.Activity#requestPermissions(String[], int).
    Requires android.Manifest.permission#BLUETOOTH_CONNECT

    Parameters
    config BluetoothHealthAppConfiguration!: The health app configuration
    Return
    Boolean Success or failure.