carp_health_package 2.11.0

CARP health sampling package. Samples health data from Apple Health or Google Fit.

CARP Health Sampling Package

This library contains a sampling package for sampling health data from Apple Health and Google Health Connect to work with the carp_mobile_sensing framework. It uses the health plugin for this. This packages supports sampling of the following Measure type:

• dk.cachet.carp.health

See the wiki for further documentation, particularly on available measure types. See the CARP Mobile Sensing App for an example of how to build a mobile sensing app in Flutter.

For Flutter plugins for other CARP products, see CARP Mobile Sensing in Flutter.

If you're interested in writing you own sampling packages for CARP, see the description on how to extend CARP on the wiki.

Installing

To use this package, add the following to you pubspc.yaml file. Note that this package only works together with carp_mobile_sensing.

dependencies:
  carp_core: ^latest
  carp_mobile_sensing: ^latest
  carp_health_package: ^latest
  ...

Then, follow the setup guides in the health plugin.

Android Integration

This sampling package only supports Google Health Connect. To configure your app to use Health Connect, follow the documentation on the health package and on the Android Developer page.

Note that Health Connect requires API level 34 and quite some edits to the Manifest.xml file, including declaring permissions to all the health data types you want to access. Read more on Health Connect data types and permissions. If you are targeting SDK levels < 34 make sure to install the Health Connect app. Read more on the "Get started with Health Connect " page.

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="dk.cachet.carp_mobile_sensing_app"
    xmlns:tools="http://schemas.android.com/tools">

    <!-- Check whether Health Connect is installed or not -->
    <queries>
        <package android:name="com.google.android.apps.healthdata" />
        <intent>
            <action android:name="androidx.health.ACTION_SHOW_PERMISSIONS_RATIONALE" />
        </intent>
    </queries>    

    ...

     <!-- Permissions for Health Connect -->
    <uses-permission android:name="android.permission.health.READ_STEPS"/>
    <uses-permission android:name="android.permission.health.READ_WEIGHT"/>

    ...

   <application
        <activity
            android:name=".MainActivity"
            android:exported="true"
            android:launchMode="singleTop"

            ...

            <!-- Intention to show Permissions screen for Health Connect API -->
            <intent-filter>
                <action android:name="androidx.health.ACTION_SHOW_PERMISSIONS_RATIONALE" />
            </intent-filter>
        </activity>

iOS Integration

See the setup guide for iOS in the health package.

Add this permission in the Info.plist file located in ios/Runner:

<key>NSHealthShareUsageDescription</key>
<string>We will sync your data with the Apple Health app to give you better insights</string>
<key>NSHealthUpdateUsageDescription</key>
<string>We will sync your data with the Apple Health app to give you better insights</string>

Then open your Flutter project in XCode by right clicking on the ios folder and selecting "Open in XCode". Enable "HealthKit" by adding a capability inside the "Signing & Capabilities" tab of the Runner target's settings.

Using it

To use this package, import it into your app together with the carp_mobile_sensing package:

import 'package:carp_core/carp_core.dart';
import 'package:carp_mobile_sensing/carp_mobile_sensing.dart';
import 'package:carp_health_package/health_package.dart';
import 'package:health/health.dart';

Before creating a study and running it, register this package in the SamplingPackageRegistry.

SamplingPackageRegistry().register(HealthSamplingPackage());

When defining a study protocol with a health device, it would look like this:

  // Create a study protocol
  StudyProtocol protocol = StudyProtocol(
    ownerId: '[e-mail]',
    name: 'Health Sensing Example',
  );

  // Define which devices are used for data collection.

  // First add this smartphone.
  final phone = Smartphone();
  protocol.addPrimaryDevice(phone);

  // Create and add a health service (device)
  final healthService = HealthService();
  protocol.addConnectedDevice(healthService, phone);

Data sampling can now be configured by a measure in the protocol. This measure is created using the factory method getHealthMeasure that takes a list of of HealthDataType types.

  // Automatically collect a set of health data every hour.
  protocol.addTaskControl(
      PeriodicTrigger(period: Duration(minutes: 60)),
      BackgroundTask(measures: [
        HealthSamplingPackage.getHealthMeasure([
          HealthDataType.STEPS,
          HealthDataType.BASAL_ENERGY_BURNED,
          HealthDataType.WEIGHT,
          HealthDataType.SLEEP_SESSION,
        ])
      ]),
      healthService);

The health measures are one-time measures, which implies that health data is collected when the measure is triggered. In the example above, this happens periodically - once pr. hour. Configuration of what data to collect is done via the HealthSamplingConfiguration which is used to override the default configuration (default is to collect nothing). The getHealthMeasure() factory method is a convenient way to create a Measure with the correct HealthSamplingConfiguration.

The HealthSamplingConfiguration can be configured to collect a set of HealthDataType data, like:

• BODY_FAT_PERCENTAGE,
• HEIGHT,
• WEIGHT,
• BODY_MASS_INDEX,
• WAIST_CIRCUMFERENCE,
• STEPS,
• ...

See the HealthDataType documentation for a complete list.

A HealthSamplingConfiguration is a HistoricSamplingConfiguration. This means that when triggered, the task and measure will try to collect data back to the last time data was collected. Hence, this measure is suited for configuration using some trigger that collects data on a regular basis, like the PeriodicTrigger used above. However, it can also be configured using as an AppTask that asks the user to collect the data.

  // Create an app task for the user to collect his own health data once pr. day
  protocol.addTaskControl(
      PeriodicTrigger(period: Duration(hours: 24)),
      AppTask(
          type: 'health',
          title: "Press here to collect your physical health data",
          description:
              "This will collect your weight, exercise time, steps, and sleep "
              "time from the Health database on the phone.",
          measures: [
            HealthSamplingPackage.getHealthMeasure([
              HealthDataType.WEIGHT,
              HealthDataType.STEPS,
              HealthDataType.BASAL_ENERGY_BURNED,
              HealthDataType.SLEEP_SESSION,
            ])
          ]),
      healthService);

NOTE - Health data can only be collected when the app is in the foreground and the phone is unlocked. This applies both for Android and iOS.

See the example.dart file for a full example of how to set up a CAMS study protocol for this sampling package.

Collected Data

The data collected is contained in a HealthData object, which wraps the data collected from a HealthDataPoint. For example, workout collected from Apple Health serialized to JSON may looks like this:

{
 "sensorStartTime": 1700415799841973,
 "data": {
  "__type": "dk.cachet.carp.health.workout",
  "uuid": "4321",
  "value": {
   "workoutActivityType": "AEROBICS",
   "totalEnergyBurned": 8,
   "totalEnergyBurnedUnit": "KILOCALORIE",
   "totalDistance": 1000,
   "totalDistanceUnit": "METER"
  },
  "unit": "NO_UNIT",
  "date_from": "2023-11-19T09:43:19.841907Z",
  "date_to": "2023-11-19T17:43:19.841907Z",
  "data_type": "WORKOUT",
  "platform": "APPLE_HEALTH",
  "device_id": "1234",
  "source_id": "4321",
  "source_name": "4321"
 }
}

Similarly, step counts collected from Google Health Connect would look like this.

{
  "sensorStartTime": 1704582000000000,
  "sensorEndTime": 1704668399999000,
  "data": {
   "__type": "dk.cachet.carp.health.steps",
   "uuid": "85328732-41d3-53b2-a81e-007f33bee353",
   "value": {
    "numericValue": "1982"
   },
   "unit": "COUNT",
   "date_from": "2024-01-06T23:00:00.000Z",
   "date_to": "2024-01-07T22:59:59.999Z",
   "data_type": "STEPS",
   "platform": "GOOGLE_HEALTH_CONNECT",
   "device_id": "SP1A.210812.016",
   "source_id": "",
   "source_name": "com.sec.android.app.shealth"
  }
}

The type of the collected health data is dk.cachet.carp.health.workout or dk.cachet.carp.health.steps. In general, the collected health data has the type of dk.cachet.carp.health.<health_type>, where health_type is the lower-case version of the HealthDataType.