Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@kilohealth/rn-fitness-tracker

1.2.0 • Public • Published

rn-fitness-tracker

npm version

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

Recommended React Native versions

React Native version(s) Fitness Tracker version
<= v0.59 v0.1.1
<= v0.62 v0.1.2 (Migrated to Autolinking)
>= v0.63 v0.1.4+ (Dropped iOS 8 support)

Installation

$ yarn add @kilohealth/rn-fitness-tracker

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.

React-Native < 0.60 - Manual linking for projects with older react-native version

  1. Add following line to Podfile: pod 'RNFitnessTracker', :podspec => '../node_modules/@kilohealth/rn-fitness-tracker/ios/RNFitnessTracker.podspec'.
  2. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  3. Go to node_modules@kilohealth/rn-fitness-tracker and add RNFitnessTracker.xcodeproj
  4. In XCode, in the project navigator, select your project. Add libRNFitnessTracker.a to your project's Build PhasesLink Binary With Libraries
  5. If you want to use Health Tracking, make sure to add HealthKit under XCode ➜ Signing & Capabilities+ CapabilityHealthKit

Android

React-Native > 0.61

  1. Enable Google Fitness Api:
Setting up Android Fit API permissions

  1. Make sure your Google account has access to app firebase project.

  2. Create an OAuth screen for your project.

  3. Select User Type: External and fill out the form. Add ../auth/fitness.activity.read to Scopes for Google APIs.

  4. Fill out next popup forms with a brief explanation why you're using the activity tracker (no need to write much).

  5. Go to Google console

  6. Select your app's project, Continue, and Go to Credentials.

  7. Where will you be calling the API from? Select Android.

  8. What data will you be accessing? Select User data and click next.

  9. The Signing-certificate fingerprint generation command must be pointed to your app release / staging keystore file.

  10. Save and submit everything. If you haven't got your google services config inside your app - download your google-services.json file from firebase console and place it inside android/app directory within your project.

  1. React Native autolinking should handle the rest.

  2. Add ACTIVITY_RECOGNITION permission to AndroidManifest.xml

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

React-Native < 0.60

Manual linking for projects with older react-native version

  1. Open up android/app/src/main/java/[...]/MainActivity.java Add import com.fitnesstracker.RNFitnessTrackerPackage; to the imports at the top of the file. Add new RNFitnessTrackerPackage() to the list returned by the getPackages() method.

  2. Append the following lines to android/settings.gradle:

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

3.Insert the following lines inside the dependencies block in android/app/build.gradle:

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

Install

npm i @kilohealth/rn-fitness-tracker

DownloadsWeekly Downloads

281

Version

1.2.0

License

MIT

Unpacked Size

206 kB

Total Files

46

Last publish

Collaborators

  • avatar
  • avatar