health

Health

This library combines both GoogleFit and AppleHealthKit. It support most of the values provided.

Supports iOS and Android X

Data Types

Data Type	Available on iOS	Available on Android	Comments
BODY_FAT	yes	yes
HEIGHT	yes	yes
WEIGHT	yes	yes
BODY_MASS_INDEX	yes	yes
WAIST_CIRCUMFERENCE	yes
STEPS	yes	yes
BASAL_ENERGY_BURNED	yes
ACTIVE_ENERGY_BURNED	yes	yes
HEART_RATE	yes	yes
BODY_TEMPERATURE	yes	yes
BLOOD_PRESSURE_SYSTOLIC	yes	yes
BLOOD_PRESSURE_DIASTOLIC	yes	yes
RESTING_HEART_RATE	yes
WALKING_HEART_RATE	yes
BLOOD_OXYGEN	yes	yes
BLOOD_GLUCOSE	yes	yes
ELECTRODERMAL_ACTIVITY	yes		Requires Apple Watch
HIGH_HEART_RATE_EVENT	yes		Requires Apple Watch
LOW_HEART_RATE_EVENT	yes		Requires Apple Watch
IRREGULAR_HEART_RATE_EVENT	yes		Requires Apple Watch

Setup

Apple HealthKit (iOS)

Step 1: Append the Info.plist with the following 2 entries

<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>

Step 2: Enable "HealthKit" inside the "Capabilities" tab.

Google Fit (Android)

Follow the guide at https://developers.google.com/fit/android/get-api-key

Below is an example of following the guide:

Change directory to your key-store directory (MacOS): cd ~/.android/

Get your keystore SHA1 fingerprint: keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android

Example output:

Alias name: androiddebugkey
Creation date: Jan 01, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4aa9b300
Valid from: Mon Jan 01 08:04:04 UTC 2013 until: Mon Jan 01 18:04:04 PST 2033
Certificate fingerprints:
     MD5:  AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6A:AC:F9
     SHA1: BB:0D:AC:74:D3:21:E1:43:07:71:9B:62:90:AF:A1:66:6E:44:5D:75
     Signature algorithm name: SHA1withRSA
     Version: 3

Follow the instructions at https://console.developers.google.com/flows/enableapi?apiid=fitness for setting up an OAuth2 Client ID for a Google project, and adding the SHA1 fingerprint to that OAuth2 credential.

The client id will look something like YOUR_CLIENT_ID.apps.googleusercontent.com

Android X

Replace the content of the android/gradle.properties file with the following lines:

org.gradle.jvmargs=-Xmx1536M
android.enableJetifier=true
android.useAndroidX=true

Usage

Below is a snippet from the example app showing the plugin in use.

Health data

A HealthData object contains the following fields:

num value;
String unit;
int dateFrom;
int dateTo;
String dataType;
String platform;

A HealthData healthData object can be serialized to JSON with the healthData.toJson() method.

Check authorization

The following example shows prompting the user for authorization to the API, which is necessary in order to fetch any data.

Calls to fetch data from the API should be done within the inner if-clause.

Future.delayed(Duration(seconds: 2), () async {
    bool _isAuthorized = await Health.requestAuthorization();
    if (_isAuthorized) {
    /// Do something with the API here
    }
});

Specify data type

Data types indicate the type of data to fetch from the API and are available from the enum class HealthDataType.

Below is an example of a few data types:

List<HealthDataType> types = [
        HealthDataType.WEIGHT,
        HealthDataType.HEIGHT,
        HealthDataType.STEPS,
    ];

For an overview of all data types see the table in Data Types section above.

Check if data type available

Not all data types are available on both platforms. In order to check whether or not a data type is available for the current platform,

bool weightAvailable = Health.isDataTypeAvailable(HealthDataType.WEIGHT);

Fetch data for a given type

Given the list of data types (types) as well as a startData and an endDate, we can now fetch all the data, for each data type with a call to the Health.getHealthDataFromType function.

Set up dates:

DateTime startDate = DateTime.utc(2001, 01, 01);
DateTime endDate = DateTime.now();

Make the fetch call:

List<HealthDataPoint> healthDataList = List<HealthDataPoint>();

for (HealthDataType type in types) {
    /// Calls to 'Health.getHealthDataFromType' must be wrapped in a try catch block.
    try {
        List<HealthDataPoint> healthData = await Health.getHealthDataFromType(startDate, endDate, type);
        healthDataList.addAll(healthData);
    } catch (exception) {
        print(exception.toString());
    }
}

This call must be inside a try catch block, since when some data type is not available, an exception will be thrown. Also, make sure the access to the API has been authorized (see Check authorization).

Full example

void _getHealthDataPoints() async {

    List<HealthDataType> types = [
        HealthDataType.WEIGHT,
        HealthDataType.HEIGHT,
        HealthDataType.STEPS,
    ];

    DateTime startDate = DateTime.utc(2001, 01, 01);
    DateTime endDate = DateTime.now();

    List<HealthDataPoint> healthDataList = List<HealthDataPoint>();

    Future.delayed(Duration(seconds: 2), () async {
        bool isAuthorized = await Health.requestAuthorization();
        if (isAuthorized) {
            for (HealthDataType type in types) {
                /// Calls to 'Health.getHealthDataFromType' must be wrapped in a try catch block.
                try {
                    List<HealthDataPoint> healthData = await Health.getHealthDataFromType(startDate, endDate, type);
                    healthDataList.addAll(healthData);
                } catch (exception) {
                    print(exception.toString());
                }
            }
        }
        /// Do something with the health data list
        for (var healthData in healthDataList) {
            print(healthData);
        }
    });
}