Coder Social home page Coder Social logo

react-native-wearables's Introduction

React Native Wearables

A React Native module with a common interface for interacting with wearables on iOS and Android.

Getting started

  • Browse to your react-native app. (see Demo for a ready made example)

  • Install react-native-wearables. npm install react-native-wearables

  • Install the peer dependencies. npm install rn-apple-healthkit react-native-google-fitness

  • Link the native modules. react-native link

  • Edit android/app/src/main/java/.../MainApplication.java. The line that looks like new GoogleFitPackage() should be changed to new GoogleFitPackage(BuildConfig.APPLICATION_ID). (this is a temporary fix to a known react-native limitation)

  • Add the following lines to ios//Info.plist – these are what iOS shows your users when requesting access to HealthKit data.

<key>NSHealthShareUsageDescription</key>
<string>Read and understand health data.</string>
<key>NSHealthUpdateUsageDescription</key>
<string>Share workout data with other apps.</string>
  • Enable HealthKit in your iOS app's Capabilities in Xcode.

Xcode Capabilities HealthKit

Demo app

Go to yldio/react-native-wearables-demo to check out a super simple demo app that runs on both iOS and Android.

Data

Data is a common interface to the health and fitness data system repositories on iOS and Android, respectively HealthKit and Google Fitness.

It lets you write code like this which works on both iOS and Android.

import { Data } from "react-native-wearables";

Data.authorize([Data.Types.heartRateBpm])
  .then(() =>
    Data.read(Data.Types.heartRateBpm, {
      startDate: new Date("2018-05-01"),
      endDate: new Date("2018-05-09")
    })
  )
  .then(samples => console.log(samples))
  .catch(error => console.error(error));

Motivation

This project builds on the great work of existing iOS- and Android-specific React Native modules to access wearables data on each platform. It abstracts the platform differences into a common interface that makes it easy to create great cross-platform experiences with wearables data.

API Documentation

Data.Types

An object of constants representing each of the data types supported by the module.

  • Data.Types.heartRateBpm, heart rate samples, unit is BPM (beats per minute)

Data.authorize(dataTypes)

Launches the OS-specific dialog to request permission from the user to read / write the data types requested.

Example
import { Data } from "react-native-wearables";

Data.authorize([Data.Types.heartRateBpm])
  .then(() => console.log("permission granted"))
  .catch(() => console.log("permission not granted"));
Arguments
  • dataTypes, an array of data types constants, found in Data.Types.
Returns

A promise which resolves when and if the user granted the requested permission to your app and rejects if the user cancelled or didn’t grant permission.

Data.read(dataType, options)

Retrieves data samples from HealthKit on iOS and Google Fitness on Android. Will fail if called before Data.authorize has been called with success.

Example
import { Data } from "react-native-wearables";

Data.read(Data.Types.heartRateBpm, {
  startDate: new Date("2018-05-01"),
  endDate: new Date("2018-05-09")
})
  .then(samples => console.log(samples))
  .catch(() => console.log("failed"));
Arguments
  • dataType, a data type, found in Data.Types
  • options, an object of options - startDate, a Date instance - endDate, a Date instance
Returns

An array of data points, where

  • value is a number
  • startDate is a Date ISO string
  • endDate is a Date ISO string
[
	{
		value: 80,
		startDate: "2018-06-06T13:59:47.375+0100",
		endDate: "2018-06-06T13:59:47.375+0100",
	},
	...
]

react-native-wearables's People

Contributors

dscape avatar nfcampos avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.