README.md 31.3 KB
Newer Older
Greg Wilson's avatar
Greg Wilson committed
1
# react-native-apple-healthkit
Greg Wilson's avatar
Greg Wilson committed
2 3
A React Native bridge module for interacting with [Apple HealthKit] data. 

Greg Wilson's avatar
Greg Wilson committed
4
![Alt text](https://devimages.apple.com.edgekey.net/assets/elements/icons/healthkit/healthkit-64x64.png "Apple HealthKit")
Greg Wilson's avatar
Greg Wilson committed
5

Greg Wilson's avatar
blah  
Greg Wilson committed
6

Greg Wilson's avatar
Greg Wilson committed
7
#### Notice
Greg Wilson's avatar
Greg Wilson committed
8 9
> *This package is undergoing rapid development and should be considered unstable for the time being.*
> *<strong>Use at your own risk</strong>*
Greg Wilson's avatar
Greg Wilson committed
10

Greg Wilson's avatar
Greg Wilson committed
11
## Table of Contents
Greg Wilson's avatar
Greg Wilson committed
12
  * [Getting Started](#getting-started)
Greg Wilson's avatar
Greg Wilson committed
13
    * [Installation](#installation)
Greg Wilson's avatar
Greg Wilson committed
14 15 16 17
    * [Usage](#usage)
  * [Documentation](#documentation)
    * [Permissions](#permissions)
    * [Methods](#methods)
Greg Wilson's avatar
Greg Wilson committed
18
      * [isAvailable](#isavailable)
Greg Wilson's avatar
Greg Wilson committed
19
      * [initHealthKit](#inithealthkit)
Greg Wilson's avatar
Greg Wilson committed
20 21
      * [getBiologicalSex](#getbiologicalsex)
      * [getDateOfBirth](#getdateofbirth)
Greg Wilson's avatar
Greg Wilson committed
22
      * [getStepCount](#getstepcount)
23 24
      * ~~[getStepCountForToday](#getstepcountfortoday)~~
      * ~~[getStepCountForDay](#getstepcountforday)~~
Greg Wilson's avatar
Greg Wilson committed
25 26
      * [getDailyStepCountSamples](#getdailystepcountsamples)
      * ~~[getMultiDayStepCounts](#getmultidaystepcounts)~~
Greg Wilson's avatar
Greg Wilson committed
27
      * [saveSteps](#savesteps)
Greg Wilson's avatar
Greg Wilson committed
28 29 30
      * [getDistanceWalkingRunning](#getdistancewalkingrunning)
      * [getDistanceCycling](#getdistancecycling)
      * [getFlightsClimbed](#getflightsclimbed)
Greg Wilson's avatar
Greg Wilson committed
31
      * [getLatestWeight](#getlatestweight)
Greg Wilson's avatar
Greg Wilson committed
32
      * [getWeightSamples](#getweightsamples)
Greg Wilson's avatar
Greg Wilson committed
33 34
      * [saveWeight](#saveweight)
      * [getLatestHeight](#getlatestheight)
Greg Wilson's avatar
Greg Wilson committed
35
      * [getHeightSamples](#getheightsamples)
Greg Wilson's avatar
Greg Wilson committed
36 37 38 39 40
      * [saveHeight](#saveheight)
      * [getLatestBmi](#getlatestbmi)
      * [saveBmi](#savebmi)
      * [getLatestBodyFatPercentage](#getlatestbodyfatpercentage)
      * [getLatestLeanBodyMass](#getlatestleanbodymass)
Daniele Volpi's avatar
Daniele Volpi committed
41 42 43 44 45
      * [getHeartRateSamples](#getheartratesamples)
      * [getBodyTemperatureSamples](#getbodytemperaturesamples)
      * [getBloodPressureSamples](#getbloodpressuresamples)
      * [getRespiratoryRateSamples](#getrespiratoryratesamples)
      * [getBloodGlucoseSamples](#getbloodglucosesamples)
Greg Wilson's avatar
Greg Wilson committed
46 47
  * [Examples](#examples)
  
Greg Wilson's avatar
Greg Wilson committed
48

Greg Wilson's avatar
Greg Wilson committed
49 50
## Getting started

Greg Wilson's avatar
Greg Wilson committed
51 52
###  Installation

Greg Wilson's avatar
Greg Wilson committed
53
Install the [react-native-apple-healthkit] package from npm:
Greg Wilson's avatar
Greg Wilson committed
54 55 56

`npm install react-native-apple-healthkit --save`

Greg Wilson's avatar
Greg Wilson committed
57
##### Xcode
Greg Wilson's avatar
Greg Wilson committed
58
  
Greg Wilson's avatar
Greg Wilson committed
59 60 61 62
1. In XCode, in the project navigator, right click `Libraries``Add Files to [your project's name]`
2. Go to `node_modules``react-native-apple-healthkit` and add `RCTAppleHealthKit.xcodeproj`
3. In XCode, in the project navigator, select your project. Add `libRCTAppleHealthKit.a` to your project's `Build Phases``Link Binary With Libraries`
4. Click `RCTAppleHealthKit.xcodeproj` in the project navigator and go the `Build Settings` tab. Make sure 'All' is toggled on (instead of 'Basic'). In the `Search Paths` section, look for `Header Search Paths` and make sure it contains both `$(SRCROOT)/../../react-native/React` and `$(SRCROOT)/../../../React` - mark both as `recursive`.
Greg Wilson's avatar
Greg Wilson committed
63 64
5. Enable HealthKit in your application's `Capabilities`
![Alt text](/examples/images/Capabilities_HealthKit.png "Xcode Capabilities Section")
Greg Wilson's avatar
Greg Wilson committed
65

Greg Wilson's avatar
Greg Wilson committed
66
6. Compile and run
Greg Wilson's avatar
Greg Wilson committed
67

Greg Wilson's avatar
Greg Wilson committed
68
### Usage
Greg Wilson's avatar
Greg Wilson committed
69

Greg Wilson's avatar
Greg Wilson committed
70 71 72
Just `require` the `react-native-apple-healthkit` module and you're ready to go!
```javascript
var AppleHealthKit = require('react-native-apple-healthkit');
Greg Wilson's avatar
Greg Wilson committed
73

Greg Wilson's avatar
Greg Wilson committed
74 75
...

Greg Wilson's avatar
Greg Wilson committed
76
let options = {
Greg Wilson's avatar
Greg Wilson committed
77
    permissions: {
Greg Wilson's avatar
Greg Wilson committed
78 79
        read: ["Height", "Weight", "StepCount", "DateOfBirth", "BodyMassIndex"],
        write: ["Weight", "StepCount", "BodyMassIndex"]
Greg Wilson's avatar
Greg Wilson committed
80 81 82
    }
};

Greg Wilson's avatar
Greg Wilson committed
83
AppleHealthKit.initHealthKit(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
84 85 86 87
    if(err) {
        console.log("error initializing healthkit: ", err);
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
88
    // healthkit initialized...
Greg Wilson's avatar
Greg Wilson committed
89 90 91 92 93
});


```

Greg Wilson's avatar
Greg Wilson committed
94 95 96 97 98 99 100 101
When the module has been successfully initialized you can read and write HealthKit data

```javascript
var AppleHealthKit = require('react-native-apple-healthkit');
var _ = require('lodash');

...

Greg Wilson's avatar
Greg Wilson committed
102
AppleHealthKit.getLatestWeight(null, (err: Object, weight: Object) => {
Greg Wilson's avatar
Greg Wilson committed
103 104 105 106
    if(err){
        console.log("error getting current weight: ", err);
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
107
    // use weight.value ...
Greg Wilson's avatar
Greg Wilson committed
108 109 110 111
});

...

Greg Wilson's avatar
Greg Wilson committed
112 113
let options = {value: 200};
AppleHealthKit.saveWeight(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
114 115 116 117 118 119 120 121 122
    if(err){
        console.log("error saving weight to healthkit: ", err);
        return;
    }
    // weight successfully saved
});


```
Greg Wilson's avatar
Greg Wilson committed
123 124


Greg Wilson's avatar
Greg Wilson committed
125 126 127

## Documentation

Greg Wilson's avatar
Greg Wilson committed
128 129
Permissions
-----------
Greg Wilson's avatar
Greg Wilson committed
130 131 132

The available HealthKit permissions to use with `initHealthKit` 

Greg Wilson's avatar
Greg Wilson committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
| Permission             | HealthKit Identifier Type                                                                                                                                      | Read | Write |
|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|------|-------|
| DateOfBirth            | [HKCharacteristicTypeIdentifierDateOfBirth](https://developer.apple.com/reference/healthkit/hkcharacteristictypeidentifierdateofbirth?language=objc)           | ✓    |       |
| BiologicalSex          | [HKCharacteristicTypeIdentifierBiologicalSex](https://developer.apple.com/reference/healthkit/hkcharacteristictypeidentifierbiologicalsex?language=objc)       | ✓    |       |
| Height                 | [HKQuantityTypeIdentifierHeight](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierheight?language=objc)                                 | ✓    | ✓     |
| Weight                 | [HKQuantityTypeIdentifierBodyMass](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierbodymass?language=objc)                             | ✓    | ✓     |
| BodyFatPercentage      | [HKQuantityTypeIdentifierBodyFatPercentage](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierbodyfatpercentage?language=objc)           | ✓    | ✓     |
| BodyMassIndex          | [HKQuantityTypeIdentifierBodyMassIndex](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierbodymassindex?language=objc)                   | ✓    | ✓     |
| LeanBodyMass           | [HKQuantityTypeIdentifierLeanBodyMass](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierleanbodymass?language=objc)                     | ✓    | ✓     |
| StepCount              | [HKQuantityTypeIdentifierStepCount](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierstepcount?language=objc)                           | ✓    | ✓     |
| DistanceWalkingRunning | [HKQuantityTypeIdentifierDistanceWalkingRunning](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierdistancewalkingrunning?language=objc) | ✓    | ✓     |
| DistanceCycling        | [HKQuantityTypeIdentifierDistanceCycling](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierdistancecycling?language=objc)               | ✓    | ✓     |
| BasalEnergyBurned      | [HKQuantityTypeIdentifierBasalEnergyBurned](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierbasalenergyburned?language=objc)           | ✓    | ✓     |
| ActiveEnergyBurned     | [HKQuantityTypeIdentifierActiveEnergyBurned](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifieractiveenergyburned?language=objc)         | ✓    | ✓     |
| FlightsClimbed         | [HKQuantityTypeIdentifierFlightsClimbed](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierflightsclimbed?language=objc)                 | ✓    | ✓     |
| NikeFuel               | [HKQuantityTypeIdentifierNikeFuel](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifiernikefuel?language=objc)                             | ✓    |       |
| AppleExerciseTime      | [HKQuantityTypeIdentifierAppleExerciseTime](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierappleexercisetime?language=objc)           | ✓    |       |
| DietaryEnergy          | [HKQuantityTypeIdentifierDietaryEnergyConsumed](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierdietaryenergyconsumed?language=objc)   | ✓    | ✓     |
Daniele Volpi's avatar
Daniele Volpi committed
151 152 153 154 155 156 157
| HeartRate              | [HKQuantityTypeIdentifierHeartRate](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierheartrate?language=objc)                           | ✓    |       |
| BodyTemperature        | [HKQuantityTypeIdentifierBodyTemperature](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierbodytemperature?language=objc)               | ✓    |       |
| BloodPressureSystolic  | [HKQuantityTypeIdentifierBloodPressureSystolic](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierbloodpressuresystolic?language=objc)   | ✓    |       |
| BloodPressureDiastolic | [HKQuantityTypeIdentifierBloodPressureDiastolic](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierbloodpressurediastolic?language=objc) | ✓    |       |
| RespiratoryRate        | [HKQuantityTypeIdentifierRespiratoryRate](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierrespiratoryrate?language=objc)               | ✓    |       |
| BloodGlucose           | [HKQuantityTypeIdentifierBloodGlucose](https://developer.apple.com/reference/healthkit/hkquantitytypeidentifierbloodglucose?language=objc)                     | ✓    |       |

Greg Wilson's avatar
Greg Wilson committed
158

Greg Wilson's avatar
Greg Wilson committed
159 160 161 162 163 164 165 166 167 168
These permissions are exported as constants of the `react-native-apple-healthkit` module.

```javascript
import AppleHealthKit from 'react-native-apple-healthkit';

...

// get the available permissions from AppleHealthKit.Constants object
const PERMS = AppleHealthKit.Constants.Permissions;

Greg Wilson's avatar
Greg Wilson committed
169
// setup healthkit read/write permissions using PERMS
Greg Wilson's avatar
Greg Wilson committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
const healthKitOptions = {
    permissions: {
        read:  [
            PERMS.StepCount,
            PERMS.Height,
        ],
        write: [
            PERMS.StepCount
        ],
    }
};

...
```

Greg Wilson's avatar
Greg Wilson committed
185

Greg Wilson's avatar
Greg Wilson committed
186 187
Options
-------
Greg Wilson's avatar
Greg Wilson committed
188 189


Greg Wilson's avatar
Greg Wilson committed
190 191
Methods
-------
Greg Wilson's avatar
Greg Wilson committed
192

Greg Wilson's avatar
Greg Wilson committed
193
#### **`isAvailable`** 
Greg Wilson's avatar
Greg Wilson committed
194
Check if HealthKit is available on the device.
Greg Wilson's avatar
Greg Wilson committed
195
```javascript
Greg Wilson's avatar
Greg Wilson committed
196
AppleHealthKit.isAvailable((err: Object, available: boolean) => {
Greg Wilson's avatar
Greg Wilson committed
197 198 199 200 201
    if(available){
        // ...
    }
});
```
Greg Wilson's avatar
Greg Wilson committed
202
___
Greg Wilson's avatar
Greg Wilson committed
203

Greg Wilson's avatar
Greg Wilson committed
204
#### **`initHealthKit`** 
Greg Wilson's avatar
Greg Wilson committed
205
Initialize HealthKit. This will show the HealthKit permissions prompt for any read/write permissions set in the required `options` object. 
Greg Wilson's avatar
Greg Wilson committed
206

Greg Wilson's avatar
Greg Wilson committed
207
Due to Apple's privacy model if an app user has previously denied a specific permission then they can not be prompted again for that same permission. The app user would have to go into the Apple Health app and grant the permission to your react-native app under *sources* tab. 
Greg Wilson's avatar
Greg Wilson committed
208

Greg Wilson's avatar
Greg Wilson committed
209
For any data that is read from HealthKit the status/error is the same for both. This privacy restriction results in having no knowledge of whether the permission was denied (make sure it's added to the permissions options object), or the data for the specific request was nil (ex. no steps recorded today).
Greg Wilson's avatar
Greg Wilson committed
210

Greg Wilson's avatar
Greg Wilson committed
211
For any data written to HealthKit an authorization error can be caught. If an authorization error occurs you can prompt the user to set the specific permission or add the permission to the options object if not present.
Greg Wilson's avatar
Greg Wilson committed
212

Greg Wilson's avatar
Greg Wilson committed
213
If new read/write permissions are added to the options object then the app user will see the HealthKit permissions prompt with the new permissions to allow.
Greg Wilson's avatar
Greg Wilson committed
214 215

`initHealthKit` requires an options object with HealthKit permission settings
Greg Wilson's avatar
Greg Wilson committed
216
```javascript
Greg Wilson's avatar
Greg Wilson committed
217
let options = {
Greg Wilson's avatar
Greg Wilson committed
218
    permissions: {
Greg Wilson's avatar
Greg Wilson committed
219 220
        read: ["Height", "Weight", "StepCount", "DateOfBirth", "BodyMassIndex"],
        write: ["Weight", "StepCount", "BodyMassIndex"]
Greg Wilson's avatar
Greg Wilson committed
221 222
    }
};
Greg Wilson's avatar
Greg Wilson committed
223
```
Greg Wilson's avatar
Greg Wilson committed
224

Greg Wilson's avatar
Greg Wilson committed
225
```javascript
Greg Wilson's avatar
Greg Wilson committed
226
AppleHealthKit.initHealthKit(options: Object, (err: string, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
227 228 229 230 231 232 233 234 235
    if(err) {
        console.log("error initializing healthkit: ", err);
        return;
    }
    // healthkit is initialized...
    // now safe to read and write healthkit data...
});
```

Greg Wilson's avatar
Greg Wilson committed
236 237
___

Greg Wilson's avatar
Greg Wilson committed
238
#### **`getBiologicalSex`**
Greg Wilson's avatar
Greg Wilson committed
239
Get the biological sex (gender). If the `BiologicalSex` read permission is missing or the user has denied it then the value will be `unknown`. The possible values are:
Greg Wilson's avatar
Greg Wilson committed
240

Greg Wilson's avatar
Greg Wilson committed
241 242 243 244 245 246 247 248
| Value   | HKBiologicalSex       |
|---------|-----------------------|
| unknown | HKBiologicalSexNotSet |
| male    | HKBiologicalSexMale   |
| female  | HKBiologicalSexFemale |
| other   | HKBiologicalSexOther  |

```javascript
249
AppleHealthKit.getBiologicalSex(null, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
250 251 252
    if(this._handleHealthKitError(err, 'getBiologicalSex')){
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
253
	// res.value will be one of the values from the above table (Value column)
254
    // use res.value ...
Greg Wilson's avatar
Greg Wilson committed
255 256 257 258 259
});
```

___

Greg Wilson's avatar
Greg Wilson committed
260
#### **`getDateOfBirth`**
261
Get the date of birth.
Greg Wilson's avatar
Greg Wilson committed
262

Greg Wilson's avatar
Greg Wilson committed
263
On success, the callback function will be provided with a `res` object containing dob `value: string` (ISO timestamp), and `age: number` (age in years):
Greg Wilson's avatar
Greg Wilson committed
264
```javascript
265 266 267 268 269 270 271 272
{ 
	value: '1986-09-01T00:00:00.000-0400', 
	age: 29 
}
```

```javascript
AppleHealthKit.getDateOfBirth(null, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
273 274 275
    if(this._handleHealthKitError(err, 'getDateOfBirth')){
        return;
    }
276 277
    // use res.value ... (ex: '1986-09-01T12:20:30-04:00')
	// use res.age ... (ex: 29)
Greg Wilson's avatar
Greg Wilson committed
278 279 280 281 282
});
```

___

Greg Wilson's avatar
Greg Wilson committed
283
#### **`getStepCount`**
Greg Wilson's avatar
Greg Wilson committed
284
Get the aggregated total steps for a specific day (starting and ending at midnight). 
Greg Wilson's avatar
Greg Wilson committed
285

Greg Wilson's avatar
Greg Wilson committed
286
An optional options object may be provided containing `date` field representing the selected day. If `date` is not set or an options object is not provided then the current day will be used. 
Greg Wilson's avatar
Greg Wilson committed
287 288 289 290 291 292 293
```javascript
let d = new Date(2016,5,27);
let options = {
    date: d.toISOString()
};
```

Greg Wilson's avatar
Greg Wilson committed
294
```javascript
Greg Wilson's avatar
Greg Wilson committed
295 296 297 298 299 300 301 302 303 304
AppleHealthKit.getStepCount(options: Object, (err: Object, steps: Object) => {
    if(this._handleHealthKitError(err, 'getStepCount')){
        return;
    }
    // steps.value is the step count for day 'd'
});
```

___

Greg Wilson's avatar
Greg Wilson committed
305
#### ~~**`getStepCountForToday`**~~
Greg Wilson's avatar
Greg Wilson committed
306
**removed** - replaced by `getStepCount`
Greg Wilson's avatar
Greg Wilson committed
307

Greg Wilson's avatar
Greg Wilson committed
308
get the aggregated total steps for the current day starting and ending at midnight
309 310 311 312 313 314 315 316 317 318 319
```javascript
AppleHealthKit.getStepCountForToday(null, (err: Object, steps: number) => {
    if(this._handleHealthKitError(err, 'getStepCountForToday')){
        return;
    }
    // use steps...
});
```

___

Greg Wilson's avatar
Greg Wilson committed
320
#### ~~**`getStepCountForDay`**~~
Greg Wilson's avatar
Greg Wilson committed
321
**removed** - replaced by `getStepCount`
Greg Wilson's avatar
Greg Wilson committed
322

Greg Wilson's avatar
Greg Wilson committed
323
get the the aggregated total steps for the day provided as `date` in options object. the `date` field expects an ISO date string as its value
324 325 326 327 328
```javascript
let d = new Date(2016,5,27);
let options = {
    date: d.toISOString()
};
Greg Wilson's avatar
Greg Wilson committed
329
AppleHealthKit.getStepCountForDay(options: Object, (err: Object, steps: number) => {
330 331 332 333 334 335 336 337 338
    if(this._handleHealthKitError(err, 'getStepCountForDay')){
        return;
    }
    // steps is the step count for day 'd'
});
```

___

Greg Wilson's avatar
Greg Wilson committed
339
#### **`getDailyStepCountSamples`**
Greg Wilson's avatar
Greg Wilson committed
340
Get the total steps per day over a specified date range. 
Greg Wilson's avatar
Greg Wilson committed
341

Greg Wilson's avatar
Greg Wilson committed
342
`getDailyStepCountSamples` accepts an options object containing required *`startDate: ISO8601Timestamp`* and optional *`endDate: ISO8601Timestamp`*. If `endDate` is not provided it will default to the current time
Greg Wilson's avatar
Greg Wilson committed
343 344 345 346 347 348
```javascript
let options = {
    startDate: (new Date(2016,5,1)).toISOString()  // required
    endDate:   (new Date()).toISOString()          // optional; default now
};
```
Greg Wilson's avatar
Greg Wilson committed
349
The function will be called with an array of elements. Each element is an object containing `value`, `startDate`, and `endDate` fields:
Greg Wilson's avatar
Greg Wilson committed
350 351 352 353 354 355 356 357 358 359
```javascript
[ 
  { value: 8, startDate: '2016-07-09T00:00:00.000-0400', endDate: '2016-07-10T00:00:00.000-0400' },
  { value: 1923, startDate: '2016-07-08T00:00:00.000-0400', endDate: '2016-07-09T00:00:00.000-0400' },
  { value: 1802, startDate: '2016-07-07T00:00:00.000-0400', endDate: '2016-07-08T00:00:00.000-0400' },
  ...
]
```


Greg Wilson's avatar
Greg Wilson committed
360
```javascript
Greg Wilson's avatar
Greg Wilson committed
361
 AppleHealthKit.getDailyStepCountSamples(options: Object, (err: Object, res: Array<Object>) => {
Greg Wilson's avatar
Greg Wilson committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
    if(this._handleHealthKitError(err, 'getDailyStepCountSamples')){
        return;
    }
    // 'res' is array of {value: number, startDate: string, endDate: string} objects
    // sorted ascending from startDate through endDate
    for(let i=0; i<res.length; ++i){
        let elem = res[i];
        let stepCount = elem.value;
        let day = elem.startDate;
		// ...
    }
});
```

___

#### ~~**`getMultiDayStepCounts`**~~
**removed** - replaced by `getDailyStepCountSamples`

Greg Wilson's avatar
Greg Wilson committed
381
Get the total steps per day over a specified date range. 
382

Greg Wilson's avatar
Greg Wilson committed
383
`getMultiDayStepCounts` accepts an options object containing required *`startDate: ISO8601Timestamp`* and optional *`endDate: ISO8601Timestamp`*. if `endDate` is not provided it will default to the current time
384 385 386 387 388 389
```javascript
let options = {
    startDate: (new Date(2016,5,1)).toISOString()  // required
    endDate:   (new Date()).toISOString()          // optional; default now
};
```
Greg Wilson's avatar
Greg Wilson committed
390
the function will be called with an array of elements `res` containing date and step count information
391
```javascript
Greg Wilson's avatar
Greg Wilson committed
392
 AppleHealthKit.getMultiDayStepCounts(options: Object, (err: Object, res: Array<Array<string|number>>) => {
393 394 395 396
    if(this._handleHealthKitError(err, 'getMultiDayStepCounts')){
        return;
    }
    // 'res' is array of [ISOTimestamp: string, stepCount: number] arrays
Greg Wilson's avatar
Greg Wilson committed
397
    // sorted ascending from startDate through endDate
398 399 400
    for(let i=0; i<res.length; ++i){
        let elem = res[i];
        // elem[0] is ISOTimestamp : string
Greg Wilson's avatar
Greg Wilson committed
401
        // elem[1] is step count   : number
402 403 404 405 406 407
    }
});
```

___

Greg Wilson's avatar
Greg Wilson committed
408
#### **`saveSteps`**
Greg Wilson's avatar
Greg Wilson committed
409
Save a step count sample.
Greg Wilson's avatar
Greg Wilson committed
410

Greg Wilson's avatar
Greg Wilson committed
411
A step count sample represents the number of steps during a specific period of time. A sample should be a precise as possible, with startDate and endDate representing the range of time the steps were taken in.
Greg Wilson's avatar
Greg Wilson committed
412 413 414

`saveSteps` accepts an options object containing required *`value: number`*, *`startDate: ISO8601Timestamp`*, and *`endDate: ISO8601Timestamp`*.
```javascript
Greg Wilson's avatar
Greg Wilson committed
415 416
// startDate and endDate are 30 minutes apart. 
// this means the step count value occured within those 30 minutes.
Greg Wilson's avatar
Greg Wilson committed
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
let options = {
	value: 100,
	startDate: (new Date(2016,6,2,6,0,0)).toISOString(),
	endDate: (new Date(2016,6,2,6,30,0)).toISOString()
};
```

```javascript
AppleHealthKit.saveSteps(options, (err, res) => {
	if(this._handleHKError(err, 'saveSteps')){
		return;
	}
	// step count sample successfully saved
});
```

___

Greg Wilson's avatar
Greg Wilson committed
435
#### **`getDistanceWalkingRunning`**
Greg Wilson's avatar
Greg Wilson committed
436
Get the total distance walking/running on a specific day. 
Greg Wilson's avatar
Greg Wilson committed
437

Greg Wilson's avatar
Greg Wilson committed
438
`getDistanceWalkingRunning` accepts an options object containing optional *`date: ISO8601Timestamp`* and *`unit: string`*. If `date` is not provided it will default to the current time. `unit` defaults to `meter`.
Greg Wilson's avatar
Greg Wilson committed
439 440 441 442 443 444 445 446
```javascript
let options = {
	unit: 'mile',									// optional; default 'meter'
    date: (new Date(2016,5,1)).toISOString(),  		// optional; default now
};
```

```javascript
Greg Wilson's avatar
Greg Wilson committed
447
AppleHealthKit.getDistanceWalkingRunning(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
448 449 450
    if(this._handleHKError(err, 'getDistanceWalkingRunning')){
    	return;
    }
Greg Wilson's avatar
Greg Wilson committed
451
	// use res.value ...
Greg Wilson's avatar
Greg Wilson committed
452 453 454 455 456 457
});
```

___

#### **`getDistanceCycling`**
Greg Wilson's avatar
Greg Wilson committed
458
Get the total distance cycling on a specific day. 
Greg Wilson's avatar
Greg Wilson committed
459

Greg Wilson's avatar
Greg Wilson committed
460
`getDistanceCycling` accepts an options object containing optional *`date: ISO8601Timestamp`* and *`unit: string`*. If `date` is not provided it will default to the current time. `unit` defaults to `meter`
Greg Wilson's avatar
Greg Wilson committed
461 462 463 464 465 466 467 468
```javascript
let options = {
	unit: 'meter',									// optional; default 'meter'
    date: (new Date(2016,5,1)).toISOString(),  		// optional; default now
};
```

```javascript
Greg Wilson's avatar
Greg Wilson committed
469
AppleHealthKit.getDistanceCycling(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
470 471 472
    if(this._handleHKError(err, 'getDistanceCycling')){
    	return;
    }
Greg Wilson's avatar
Greg Wilson committed
473
	// use res.value ...
Greg Wilson's avatar
Greg Wilson committed
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
});
```

___

#### **`getFlightsClimbed`**
get the total flights climbed (1 flight is ~10ft of elevation) on a specific day. 

`getFlightsClimbed` accepts an options object containing optional *`date: ISO8601Timestamp`*. if `date` is not provided it will default to the current time.
```javascript
let options = {
    date: (new Date(2016,5,1)).toISOString(),  		// optional; default now
};
```

```javascript
Greg Wilson's avatar
Greg Wilson committed
490
AppleHealthKit.getFlightsClimbed(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
491 492 493
    if(this._handleHKError(err, 'getFlightsClimbed')){
    	return;
    }
Greg Wilson's avatar
Greg Wilson committed
494
	// use res.value ...
Greg Wilson's avatar
Greg Wilson committed
495 496 497 498 499
});
```

___

500
#### **`getLatestWeight`**
Greg Wilson's avatar
Greg Wilson committed
501 502
Get the most recent weight sample.

Greg Wilson's avatar
Greg Wilson committed
503
On success, the callback function will be provided with a `weight` object containing the weight `value`, and the `startDate` and `endDate` of the weight sample. *Note: startDate and endDate will be the same as weight samples are saved at a specific point in time.*
Greg Wilson's avatar
Greg Wilson committed
504 505 506 507 508 509 510 511
```javascript
{
	value: 200,
	startDate: '2016-07-08T12:00:00.000-0400', 
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
512
```javascript
Greg Wilson's avatar
Greg Wilson committed
513
AppleHealthKit.getLatestWeight(null, (err: string, weight: Object) => {
Greg Wilson's avatar
Greg Wilson committed
514
    if(err){
515
        console.log("error getting latest weight: ", err);
Greg Wilson's avatar
Greg Wilson committed
516 517
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
518
    // use weight.value, weight.startDate, etc ...
Greg Wilson's avatar
Greg Wilson committed
519 520 521
});
```

Greg Wilson's avatar
Greg Wilson committed
522 523
___

Greg Wilson's avatar
Greg Wilson committed
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
#### **`getWeightSamples`**
query for weight samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
    unit: 'pound',										// optional; default 'pound'
    startDate: (new Date(2016,4,27)).toISOString(),		// required
	endDate: (new Date()).toISOString(),				// optional; default now
    ascending: false,									// optional; default false
    limit:10,											// optional; default no limit
};
```

```javascript
AppleHealthKit.getWeightSamples(options, (err: Object, samples: Array<Object>) => {
	if(this._handleHealthKitError(err, 'getWeightSamples')){
		return;
	}
	// use samples ...
});
```

___

Greg Wilson's avatar
Greg Wilson committed
547 548
#### **`saveWeight`**
save a numeric weight value to HealthKit
Greg Wilson's avatar
Greg Wilson committed
549

Greg Wilson's avatar
Greg Wilson committed
550
`saveWeight` accepts an options object containing a numeric weight value:
Greg Wilson's avatar
Greg Wilson committed
551
```javascript
Greg Wilson's avatar
Greg Wilson committed
552
let options = {value: 200}
Greg Wilson's avatar
Greg Wilson committed
553 554
```
```javascript
Greg Wilson's avatar
Greg Wilson committed
555
AppleHealthKit.saveWeight(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
556 557 558 559 560 561 562
    if(err){
        console.log("error saving weight to healthkit: ", err);
        return;
    }
    // weight successfully saved
});
```
Greg Wilson's avatar
Greg Wilson committed
563

564 565 566
___

#### **`getLatestHeight`**
Greg Wilson's avatar
Greg Wilson committed
567 568
Get the most recent height value.

Greg Wilson's avatar
Greg Wilson committed
569
On success, the callback function will be provided with a `height` object containing the height `value`, and the `startDate` and `endDate` of the height sample. *Note: startDate and endDate will be the same as height samples are saved at a specific point in time.*
570
```javascript
Greg Wilson's avatar
Greg Wilson committed
571 572 573 574 575 576 577 578 579 580
{
	value: 72,
	startDate: '2016-07-08T12:00:00.000-0400', 
	endDate: '2016-07-08T12:00:00.000-0400'
}
```


```javascript
AppleHealthKit.getLatestHeight(null, (err: string, height: Object) => {
581 582 583 584
    if(err){
        console.log("error getting latest height: ", err);
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
585
    // use height.value, height.startDate, etc ...
586 587
});
```
Greg Wilson's avatar
Greg Wilson committed
588 589 590

___

Greg Wilson's avatar
Greg Wilson committed
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
#### **`getHeightSamples`**
query for height samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
    unit: 'inch',										// optional; default 'inch'
    startDate: (new Date(2016,4,27)).toISOString(),		// required
	endDate: (new Date()).toISOString(),				// optional; default now
    ascending: false,									// optional; default false
    limit:10,											// optional; default no limit
};
```

the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields
```javascript
// samples is array of objects
[
Greg Wilson's avatar
Greg Wilson committed
607 608
	{value: 74.02, startDate:'2016-06-29T17:55:00.000-0400', endDate:'2016-06-29T17:55:00.000-0400'},
	{value: 74, startDate:'2016-03-12T13:22:00.000-0400', endDate:'2016-03-12T13:22:00.000-0400'},
Greg Wilson's avatar
Greg Wilson committed
609 610 611
	...
]
```
Greg Wilson's avatar
Greg Wilson committed
612
*example usage*
Greg Wilson's avatar
Greg Wilson committed
613 614 615 616 617 618 619 620 621 622 623
```javascript
AppleHealthKit.getHeightSamples(options, (err: Object, samples: Array<Object>) => {
	if(this._handleHealthKitError(err, 'getHeightSamples')){
		return;
	}
	// use samples ...
});
```

___

Greg Wilson's avatar
Greg Wilson committed
624 625 626 627 628 629 630 631
#### **`saveHeight`**
save a numeric height value to HealthKit

`saveHeight` accepts an options object containing a numeric height value:
```javascript
let options = {value: 200}
```
```javascript
Greg Wilson's avatar
Greg Wilson committed
632
AppleHealthKit.saveHeight(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
633 634 635 636 637 638 639
    if(this._handleHealthKitError(err, 'saveHeight')){
        return;
    }
    // height successfully saved
});
```

Greg Wilson's avatar
Greg Wilson committed
640 641 642
___

#### **`getLatestBmi`**
Greg Wilson's avatar
Greg Wilson committed
643 644
Get the most recent BMI sample. 

Greg Wilson's avatar
Greg Wilson committed
645
On success, the callback function will be provided with a `bmi` object containing the BMI `value`, and the `startDate` and `endDate` of the sample. *Note: startDate and endDate will be the same as bmi samples are saved at a specific point in time.*
Greg Wilson's avatar
Greg Wilson committed
646 647 648 649 650 651 652 653
```javascript
{
	value: 27.2,
	startDate: '2016-07-08T12:00:00.000-0400', 
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
654 655 656 657 658 659
```javascript
AppleHealthKit.getLatestBmi(null, (err: string, bmi: Object) => {
    if(err){
        console.log("error getting latest bmi data: ", err);
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
660 661 662
    let d = bmi.startDate
    let val = bmi.value;
    // ...
Greg Wilson's avatar
Greg Wilson committed
663 664 665
});
```

666 667
___

Greg Wilson's avatar
Greg Wilson committed
668 669 670 671 672 673 674 675
#### **`saveBmi`**
save a numeric BMI value to HealthKit

`saveBmi` accepts an options object containing a numeric BMI value:
```javascript
let options = {value: 27.2}
```
```javascript
Greg Wilson's avatar
Greg Wilson committed
676
AppleHealthKit.saveBmi(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
677 678 679 680 681 682 683 684 685
    if(this._handleHealthKitError(err, 'saveBmi')){
        return;
    }
    // BMI successfully saved
});
```

___

686
#### **`getLatestBodyFatPercentage`**
Greg Wilson's avatar
Greg Wilson committed
687 688
Get the most recent body fat percentage. The percentage value is a number between 0 and 100.

Greg Wilson's avatar
Greg Wilson committed
689
On success, the callback function will be provided with a `bodyFatPercentage` object containing the body fat percentage `value`, and the `startDate` and `endDate` of the sample. *Note: startDate and endDate will be the same as bodyFatPercentage samples are saved at a specific point in time.*
Greg Wilson's avatar
Greg Wilson committed
690 691 692 693 694 695 696 697
```javascript
{
	value: 20,
	startDate: '2016-07-08T12:00:00.000-0400', 
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

698
```javascript
Greg Wilson's avatar
Greg Wilson committed
699
AppleHealthKit.getLatestBodyFatPercentage(null, (err: Object, bodyFatPercentage: Object) => {
700 701 702
    if(this._handleHealthKitError(err, 'getLatestBodyFatPercentage')){
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
703
    // use bodyFatPercentage.value, bodyFatPercentage.startDate, etc ...
704 705 706
});
```

Greg Wilson's avatar
Greg Wilson committed
707 708 709
___

#### **`getLatestLeanBodyMass`**
Greg Wilson's avatar
Greg Wilson committed
710 711
Get the most recent lean body mass. The value is a number representing the weight in pounds (lbs)

Greg Wilson's avatar
Greg Wilson committed
712
On success, the callback function will be provided with a `leanBodyMass` object containing the leanBodyMass `value`, and the `startDate` and `endDate` of the sample. *Note: startDate and endDate will be the same as leanBodyMass samples are saved at a specific point in time.*
Greg Wilson's avatar
Greg Wilson committed
713 714 715 716 717 718 719 720
```javascript
{
	value: 176,
	startDate: '2016-07-08T12:00:00.000-0400', 
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
721
```javascript
Greg Wilson's avatar
Greg Wilson committed
722
 AppleHealthKit.getLatestLeanBodyMass(null, (err: Object, leanBodyMass: Object) => {
Greg Wilson's avatar
Greg Wilson committed
723 724 725
    if(this._handleHealthKitError(err, 'getLatestLeanBodyMass')){
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
726
    // use leanBodyMass.value, leanBodyMass.startDate, etc ...
Greg Wilson's avatar
Greg Wilson committed
727 728
});
```
Greg Wilson's avatar
Greg Wilson committed
729

Daniele Volpi's avatar
Daniele Volpi committed
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
___

#### **`getHeartRateSamples`**
query for heart rate samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
    unit: 'bpm',										// optional; default 'bpm'
    startDate: (new Date(2016,4,27)).toISOString(),		// required
	endDate: (new Date()).toISOString(),				// optional; default now
    ascending: false,									// optional; default false
    limit:10,											// optional; default no limit
};
```

the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields

*example usage*
```javascript
AppleHealthKit.getHeartRateSamples(options, (err: Object, samples: Array<Object>) => {
	if(this._handleHealthKitError(err, 'getHeartRateSamples')){
		return;
	}
	// use samples ...
});
```

___

#### **`getBodyTemperatureSamples`**
query for body temperature samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
    unit: 'celsius',									// optional; default 'celsius'
    startDate: (new Date(2016,4,27)).toISOString(),		// required
	endDate: (new Date()).toISOString(),				// optional; default now
    ascending: false,									// optional; default false
    limit:10,											// optional; default no limit
};
```
available units are: `'fahrenheit'`, `'celsius'`.

the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields.

*example usage*
```javascript
AppleHealthKit.getBodyTemperatureSamples(options, (err: Object, samples: Array<Object>) => {
	if(this._handleHealthKitError(err, 'getBodyTemperatureSamples')){
		return;
	}
	// use samples ...
});
```

___

#### **`getBloodPressureSamples`**
query for blood pressure samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
    unit: 'mmhg',								    	// optional; default 'mmhg'
    startDate: (new Date(2016,4,27)).toISOString(),		// required
	endDate: (new Date()).toISOString(),				// optional; default now
    ascending: false,									// optional; default false
    limit:10,											// optional; default no limit
};
```

the callback function will be called with a `samples` array containing objects with *bloodPressureSystolicValue*, *bloodPressureDiastolicValue*, *startDate*, and *endDate* fields
```javascript
// samples is array of objects
[
	{bloodPressureSystolicValue: 120, bloodPressureDiastolicValue: 81, startDate:'2016-06-29T17:55:00.000-0400', endDate:'2016-06-29T17:55:00.000-0400'},
	{bloodPressureSystolicValue: 119, bloodPressureDiastolicValue: 77, startDate:'2016-03-12T13:22:00.000-0400', endDate:'2016-03-12T13:22:00.000-0400'},
	...
]
```
*example usage*
```javascript
AppleHealthKit.getBloodPressureSamples(options, (err: Object, samples: Array<Object>) => {
	if(this._handleHealthKitError(err, 'getBloodPressureSamples')){
		return;
	}
	// use samples ...
});
```

___

#### **`getRespiratoryRateSamples`**
query for respiratory rate samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
    unit: 'bpm',								    	// optional; default 'bpm'
    startDate: (new Date(2016,4,27)).toISOString(),		// required
	endDate: (new Date()).toISOString(),				// optional; default now
    ascending: false,									// optional; default false
    limit:10,											// optional; default no limit
};
```

the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields

*example usage*
```javascript
AppleHealthKit.getRespiratoryRateSamples(options, (err: Object, samples: Array<Object>) => {
	if(this._handleHealthKitError(err, 'getRespiratoryRateSamples')){
		return;
	}
	// use samples ...
});
```

___

#### **`getBloodGlucoseSamples`**
query for blood glucose samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
    unit: 'mmolPerL',							    	// optional; default 'mmolPerL'
    startDate: (new Date(2016,4,27)).toISOString(),		// required
	endDate: (new Date()).toISOString(),				// optional; default now
    ascending: false,									// optional; default false
    limit:10,											// optional; default no limit
};
```
available units are: `'mmolPerL'`, `'mgPerdL'`.

the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields

*example usage*
```javascript
AppleHealthKit.getBloodGlucoseSamples(options, (err: Object, samples: Array<Object>) => {
	if(this._handleHealthKitError(err, 'getBloodGlucoseSamples')){
		return;
	}
	// use samples ...
});
```




Greg Wilson's avatar
Greg Wilson committed
872 873
## Examples

Greg Wilson's avatar
Greg Wilson committed
874 875
#### StepsDemo

Greg Wilson's avatar
Greg Wilson committed
876 877
[Steps Demo](https://github.com/GregWilson/react-native-apple-healthkit/tree/master/examples/StepsDemo)

878
![alt text](https://raw.githubusercontent.com/GregWilson/react-native-apple-healthkit/master/examples/images/steps_demo_screen.png "Steps Demo App Screenshot")
Greg Wilson's avatar
Greg Wilson committed
879 880 881

#### BodyMeasurements

Greg Wilson's avatar
Greg Wilson committed
882 883
[Body Measurements Demo](https://github.com/GregWilson/react-native-apple-healthkit/tree/master/examples/BodyMeasurements)

884
![alt text](https://raw.githubusercontent.com/GregWilson/react-native-apple-healthkit/master/examples/images/body_measurements_demo_screen.png "Body Measurements Demo App Screenshot")
Greg Wilson's avatar
Greg Wilson committed
885

886

Greg Wilson's avatar
Greg Wilson committed
887
[Apple HealthKit]: https://developer.apple.com/healthkit/
Greg Wilson's avatar
Greg Wilson committed
888
[react-native-apple-healthkit]: https://www.npmjs.com/package/react-native-apple-healthkit