react-native-fitness

Install the package using npm or yarn:

npm install @ovalmoney/react-native-fitness --save
# or
yarn add @ovalmoney/react-native-fitness

For automatic linking in React Native, run:

react-native link @ovalmoney/react-native-fitness

Use the following methods to retrieve health metrics for a specific time period. All methods require a startDate and endDate as strings within an options object.

• Fitness.getSteps({ startDate, endDate, interval }): Returns step count.
• Fitness.getDistances({ startDate, endDate, interval }): Returns distance in meters.
• Fitness.getCalories({ startDate, endDate, interval }): Returns calories burnt in kilocalories.
• Fitness.getHeartRate({ startDate, endDate, interval }): Returns heart rate in bpm.
• Fitness.getSleepAnalysis({ startDate, endDate }): Returns sleep analysis data.

Interval Option: For methods supporting interval, you can set it to 'hour', 'minute', or leave it blank to default to 'days'.

Before reading health data, you must check or request permissions. Permissions are defined as an array of objects with kind and access keys.

Note for iOS: At least one permission with Read access must be provided, otherwise errorEmptyPermissions will be thrown. On iOS, requestPermissions always returns true due to Apple's privacy model.

Note for Android: isAuthorized and requestPermissions work on Android and iOS >= 12.0. On iOS < 12.0, isAuthorized returns an error.

import Fitness from '@ovalmoney/react-native-fitness';

const permissions = [
  { kind: Fitness.PermissionKinds.Steps, access: Fitness.PermissionAccesses.Write },
];

Fitness.isAuthorized(permissions)
  .then((authorized) => {
    // Handle authorization status
  })
  .catch((error) => {
    // Handle error
  });

The following methods are exclusive to Android and interact with the Google Fit account:

• Fitness.logout(): Performs a logout from the Google account. Returns true if successful, false if the user cancels.
• Fitness.disconnect(): Performs a disconnect action from Google Fit. Returns true if successful, false if the user cancels.
• Fitness.subscribeToSteps(): Subscribes to steps from the Google Fit store. Returns a promise that resolves to true on success. Using this allows you to get steps without requiring the Google Fit app to be installed on the device.

The library throws specific error strings when operations fail.

iOS Errors:

• hkNotAvailable: HealthKit is not available.
• methodNotAvailable: isAuthorized called on iOS < 12.0.
• dateNotCorrect: Received date is invalid.
• errorEmptyPermissions: No read permissions were provided.
• errorNoEvents: Error occurred while retrieving data.

Android Errors:

• methodNotAvailable: getSleepAnalysis called on Android version less than N.

Use these constants to define the scope of your permission requests.

PermissionKinds:

• Steps
• Distances
• Calories
• HeartRate
• Activity (Android only)
• SleepAnalysis

PermissionAccesses:

• Read
• Write

You can retrieve various fitness metrics over a specific time range and interval. These methods accept an object with the following properties:

• startDate: A valid date string or object.
• endDate: A valid date string or object.
• interval (optional): The granularity of the data. Defaults to "days".

Available methods:

• getSteps({ startDate, endDate, interval })
• getDistances({ startDate, endDate, interval })
• getCalories({ startDate, endDate, interval })
• getHeartRate({ startDate, endDate, interval })

import Fitness from 'react-native-fitness';

const data = await Fitness.getSteps({
  startDate: '2023-01-01',
  endDate: '2023-01-07',
  interval: 'days'
});

Use getSleepAnalysis to retrieve sleep-related data for a specific period.

Arguments:

• startDate: A valid date string or object.
• endDate: A valid date string or object.

import Fitness from 'react-native-fitness';

const sleepData = await Fitness.getSleepAnalysis({
  startDate: '2023-01-01T00:00:00Z',
  endDate: '2023-01-02T00:00:00Z'
});

The library provides methods to manage the Google Fit connection on Android. On iOS, these methods are no-ops (return null).

• logout(): Logs out from the current Google Account.
• disconnect(): Disconnects Google Fit.

import Fitness from 'react-native-fitness';

// Android only
await Fitness.logout();
await Fitness.disconnect();