Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/OvalMoney/react-native-fitness

A React Native module to interact with Apple Healthkit and Google Fit.
https://github.com/OvalMoney/react-native-fitness

android apple-health fitness google-fit ios react-native

Last synced: 2 months ago
JSON representation

A React Native module to interact with Apple Healthkit and Google Fit.

Lists

README 

        

# react-native-fitness

`react-native-fitness` is a library that works on both `iOS` and `Android` with it you can interact with Apple Healthkit and Google Fit.

Currently the lib provides a set of [API](#API) that you can use to read steps count or distance count for a given period of time.



Note:

We're open to receive PRs that contains new features or improvements, so feel free to contribute to this repo.



## Getting started



`npm install @ovalmoney/react-native-fitness --save`



or



`yarn add @ovalmoney/react-native-fitness`



### Mostly automatic installation



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



### Manual installation



#### iOS



### Pods

1. Add the line below to your `Podfile`.

    ```pod

    pod 'react-native-fitness', :path => '../node_modules/@ovalmoney/react-native-fitness'`

    ```

2. Run `pod install` in your iOS project directory.

3. In XCode, select your project, go to `Build Phases` ➜ `Link Binary With Libraries` and add `libreact-native-fitness.a`.

4. Add following to your `Info.plist` in order to ask permissions.

    ```xml

    NSHealthShareUsageDescription

    Read and understand health data.

    ```



### Manually



1. In XCode's project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`

2. Go to `node_modules` ➜ `@ovalmoney` ➜ `react-native-fitness` and select `RNFitness.xcodeproj`

3. In XCode select your project, go to `Build Phases` ➜ `Link Binary With Libraries` and add `libRNFitness.a`.

4. Run your project (`Cmd+R`)



In order to make it run, it is necessary to turn on `Health Kit` in the `Capabilities`.



#### Android

1. Get an OAuth 2.0 Client ID as explained at https://developers.google.com/fit/android/get-api-key

2. Open up `MainApplication.java`

    - Add `import com.ovalmoney.fitness.RNFitnessPackage;` to the imports at the top of the file

    - Add `new RNFitnessPackage()` to the list returned by the `getPackages()` method

3. Append the following lines to `android/settings.gradle`:

  	```java

  	include ':@ovalmoney_react-native-fitness'

  	project(':@ovalmoney_react-native-fitness').projectDir = new File(rootProject.projectDir, 	'../node_modules/@ovalmoney/react-native-fitness/android')

  	```

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

  	```java

    compile project(':@ovalmoney_react-native-fitness')

  	```

5. (Optional) In order to better handle the right versions, add in your `android/build.gradle`:

  	```ext {

      // Other build versions

      fitnessPlayServices: "" // default: 17.0.0

      authPlayServices: "" // default: 17.0.0

    }

  	```



## Usage



```javascript

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



const permissions = [

  { kind: Fitness.PermissionKinds.Steps, access: Fitness.PermissionAccesses.Write },

];



Fitness.isAuthorized(permissions)

  .then((authorized) => {

    // Do something

  })

  .catch((error) => {

    // Do something

  });

```

### API



- **Fitness.isAuthorized([{ kind: int, access: int }])**

Check if permissions are granted or not. It works on Android and iOS >= 12.0, while it returns an error when iOS < 12.

It requires an `Array` of `Object` with a mandatory key `kind` and an optional key `access`.

Possible values for the keys can be found in `PermissionKinds` and `PermissionAccesses` under `Attributes` section.

On iOS at least one permissions with `Read` access must be provided, otherwise an `errorEmptyPermissions` will be thrown.



- **Fitness.requestPermissions([{ kind: int, access: int }])**

Ask permission and return if user granted or not(Android), while, due to Apple's privacy model, always true is returned in iOS.

It requires an `Array` of `Object` with a mandatory key `kind` and an optional key `access`.

Possible values for the keys can be found in `PermissionKinds` and `PermissionAccesses` under `Attributes` section.

On iOS at least one permissions with `Read` access must be provided, otherwise an `errorEmptyPermissions` will be thrown.



- **Fitness.logout()**

Available only on android. It performs a logout from google account.

It returns `true` for a successful logout, `false` if user cancel action.



- **Fitness.disconnect()**

Available only on android. It performs a disconnect action from Google Fit.

It returns `true` for a successful logout, `false` if user cancel action.



- **Fitness.getSteps({ startDate: string, endDate: string, interval: string })**

Fetch steps on a given period of time. It requires an `Object` with `startDate` and `endDate` attributes as string. If startDate is not provided an error will be thrown. Set `interval` to decide how detailed the returned data is, set it to `hour` or `minute` otherwise it defaults to `days`.



- **Fitness.getDistances({ startDate: string, endDate: string, interval: string })**

Fetch distance in meters on a given period of time. It requires an `Object` with `startDate` and `endDate` attributes as string. If startDate is not provided an error will be thrown. Set `interval` to decide how detailed the returned data is, set it to `hour` or `minute` otherwise it defaults to `days`.



- **Fitness.getCalories({ startDate: string, endDate: string, interval: string })**

Fetch calories burnt in kilocalories on a given period of time. It requires an `Object` with `startDate` and `endDate` attributes as string. If startDate is not provided an error will be thrown. Set `interval` to decide how detailed the returned data is, set it to `hour` or `minute` otherwise it defaults to `days`.



- **Fitness.getHeartRate({ startDate: string, endDate: string, interval: string })**

Fetch heart rate bpm on a given period of time. It requires an `Object` with `startDate` and `endDate` attributes as string. If startDate is not provided an error will be thrown. Set `interval` to decide how detailed the returned data is, set it to `hour` or `minute` otherwise it defaults to `days`.



- **Fitness.getSleepAnalysis({ startDate: string, endDate: string })**

Fetch sleep analysis data on a given period of time. It requires an `Object` with `startDate` and `endDate` attributes as string. If startDate is not provided an error will be thrown.



- **Fitness.subscribeToSteps()**

Available only on android. Subscribe only to steps from the Google Fit store. It returns a promise with `true` for a successful subscription and `false` otherwise.

Call this function to get steps and eliminate the need to have Google Fit installed on the device.



### Attributes



#### Platform

Return the used provider.



#### PermissionKinds

Return the information of what kind of Permission can be asked.

At the moment the list of possible kinds is:

 - ***Steps***: to required the access for `Steps`

 - ***Distances***: to required the access for `Distances`

 - ***Calories***: to required the access for `Calories`

 - ***HeartRate***: to required the access for `Heart rate`

 - ***Activity***: to required the access for `Activity` (only Android)

 - ***SleepAnalysis***: to required the access for `Sleep Analysis`



#### PermissionAccesses

Return the information of what kind of Access can be asked.

The list of possible kinds is:

 - ***Read***: to required the access to `Read`

 - ***Write***: to required the access to `Write`



#### Errors

Return the list of meaningful errors that can be possible thrown.



##### iOS

Possible values are:

 - ***hkNotAvailable***: thrown if HealthKit is not available

 - ***methodNotAvailable***: thrown if `isAuthorized` is called on iOS < 12.0

 - ***dateNotCorrect***: thrown if received date is not correct

 - ***errorEmptyPermissions***: thrown if no read permissions are provided

 - ***errorNoEvents***: thrown if an error occurs while try to retrieve data



##### Android

Possible values are:

 - ***methodNotAvailable***: thrown if `getSleepAnalysis` is called on Android less than N