Take spot health measurements with MeasureClient

With the MeasureClient API, your app registers callbacks to receive data for a short amount of time. This is meant for situations in which your app is in use and requires rapid data updates. If possible, create this with a foreground UI so that the user is aware.

Add dependencies

To add a dependency on Health Services, you must add the Google Maven repository to your project. For more information, see Google's Maven repository.

Then, in your module-level build.gradle file, add the following dependency:

dependencies {
    implementation "androidx.health:health-services-client:1.1.0-alpha04"
}

dependencies {
    implementation("androidx.health:health-services-client:1.1.0-alpha04")
}

Check capabilities

Before registering for data updates, check that the device can provide the type of data your app needs. By checking capabilities first, you can enable or disable certain features or modify your app's UI to compensate for capabilities that are not available.

The following example shows how to check whether a device can provide the HEART_RATE_BPM data type:

val healthClient = HealthServices.getClient(this /*context*/)
val measureClient = healthClient.measureClient
lifecycleScope.launch {
    val capabilities = measureClient.getCapabilitiesAsync().await()
    supportsHeartRate = DataType.HEART_RATE_BPM in capabilities.supportedDataTypesMeasure
}

Register for data

Each callback you register is for a single data type. Note that some data types might have varying states of availability. For example, heart rate data might not be available when the device is not properly attached to the wrist.

It's important to minimize the amount of time that your callback is registered, as callbacks cause an increase in sensor sampling rates, which in turn increases power consumption.

The following example shows how to register and unregister a callback to receive HEART_RATE_BPM data:

val heartRateCallback = object : MeasureCallback {
    override fun onAvailabilityChanged(dataType: DeltaDataType<*, *>, availability: Availability) {
        if (availability is DataTypeAvailability) {
            // Handle availability change.
        }
    }

    override fun onDataReceived(data: DataPointContainer) {
        // Inspect data points.
    }
}
val healthClient = HealthServices.getClient(this /*context*/)
val measureClient = healthClient.measureClient

// Register the callback.
measureClient.registerMeasureCallback(DataType.Companion.HEART_RATE_BPM, heartRateCallback)

// Unregister the callback.
awaitClose {
    runBlocking {
        measureClient.unregisterMeasureCallbackAsync(DataType.Companion.HEART_RATE_BPM, heartRateCallback)
    }
}