rn-fitness-tracker

React Native library for step tracking based on Google Fit (Android) and CoreMotion (iOS) native API's.

Recommended React Native versions

Installation

yarn:

$ yarn add @kilohealth/rn-fitness-tracker

npm:

$ npm i @kilohealth/rn-fitness-tracker

Installing dependencies into a bare React Native project

In your project directory, run:

yarn:

yarn add react-native-device-info react-native-permissions

npm:

npm i react-native-device-info react-native-permissions

iOS

React-Native > 0.61

1. Add following lines to info.plist file <dict> tag:

<!-- Fitness tracker -->
<key>NSMotionUsageDescription</key>
<string>Reason string goes here</string>

<!-- Health tracker -->
<key>NSHealthUpdateUsageDescription</key>
<string>Reason string goes here</string>
<key>NSHealthShareUsageDescription</key>
<string>Reason string goes here</string>

or

Navigate to info.plist file in XCode ➜ Add new property list key - NSMotionUsageDescription. This will add new line in the containing Privacy - Motion Usage Description. Same to be done with HealthKit.

2. Make sure that you have at least one permission handler set up. Else you will get error **No permission handler detected**

Android

React-Native > 0.61

1. Enable Google Fitness Api:

2. React Native autolinking should handle the rest.

3. Add ACTIVITY_RECOGNITION permission to AndroidManifest.xml

<uses-permission android:name="android.permission.ACTIVITY_RECOGNITION"/>

React-Native < 0.60

include ':@kilohealth-rn-fitness-tracker'
project(':@kilohealth-rn-fitness-tracker').projectDir = new File(rootProject.projectDir, 	'../node_modules/@kilohealth/rn-fitness-tracker/android')

implementation project(path: ':@kilohealth-rn-fitness-tracker')

implementation 'com.google.android.gms:play-services-fitness:16.0.1'
implementation 'com.google.android.gms:play-services-auth:16.0.1'

Fitness tracker usage

import { FitnessTrackerAPI } from '@kilohealth/rn-fitness-tracker';

// This step is required in order to use any of the methods bellow
// Returns an object:
// authorized: boolean;
// shouldOpenAppSettings: boolean;
// trackingNotSupported?: boolean;
const authorizationStatus = await FitnessTrackerAPI.setupTracking();

// Get steps total today
const steps = await FitnessTrackerAPI.getStepsToday();

// Get steps total this week
const steps = await FitnessTrackerAPI.getStepsWeekTotal();

// Get running & walking distance today
const distance = await FitnessTrackerAPI.getDistanceToday();

// Get floors climbed today
const floorsClimbed = await FitnessTrackerAPI.getFloorsToday();

To access native API:

import { RNFitnessTracker } from '@kilohealth/rn-fitness-tracker';

Health tracker usage

import {
  HealthTrackerAPI,
  HealthDataTypes,
  UnitTypes,
  WorkoutTypes,
} from '@kilohealth/rn-fitness-tracker';

// Setup Health tracking
const authorizationStatus = await HealthTrackerAPI.setupTracking(
  [HealthDataTypes.Carbohydrates, HealthDataTypes.Calcium], // write types
  [HealthDataTypes.Carbohydrates, HealthDataTypes.Fiber], // read types
);

// Get health data type total from HealthKit
const healthTotalFiber = await HealthTrackerAPI.getStatisticTotalForToday({
  key: HealthDataTypes.Fiber,
  unit: UnitTypes.grams,
});

// Get absolute data type total from HealthKit
const absoluteTotalFiber = await HealthTrackerAPI.getAbsoluteTotalForToday({
  key: HealthDataTypes.Fiber,
  unit: UnitTypes.grams,
});

// Write single category health data to HealthKit
const writeStatus = await HealthTrackerAPI.writeData({
  key: HealthDataTypes.Carbohydrates,
  quantity: 28,
  unit: UnitTypes.grams,
  metadata: {
    Meal: 'Lightly smoked salmon',
  },
});

// Write health data array to HealthKit
const writeStatus = await HealthTrackerAPI.writeDataArray([
  {
    key: HealthDataTypes.Carbohydrates,
    quantity: 55,
    unit: UnitTypes.grams,
    metadata: {
      Meal: 'Lightly smoked salmon',
    },
  },
  {
    key: HealthDataTypes.Calcium,
    quantity: 35,
    unit: UnitTypes.grams,
    metadata: {
      Meal: 'Milk pint',
      'Random parameter': 'Very delicious milk',
    },
  },
]);

// Record a workout to HealthKit
const currentDate = +new Date();

const writeStatus = await HealthTrackerAPI.recordWorkout({
  key: WorkoutTypes.Bowling,
  startDate: currentDate,
  endDate: currentDate + 3600,
  energyBurned: 221, // kcal
  metadata: {
    'Workout name': 'Las Vegas II',
  },
});

To access native API:

import { RNHealthTracker } from '@kilohealth/rn-fitness-tracker';

API Methods documentation

Full API Methods documentation