README.md 26.4 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)
Greg Wilson's avatar
Greg Wilson committed
41 42
  * [Examples](#examples)
  
Greg Wilson's avatar
Greg Wilson committed
43

Greg Wilson's avatar
Greg Wilson committed
44 45
## Getting started

Greg Wilson's avatar
Greg Wilson committed
46 47
###  Installation

Greg Wilson's avatar
Greg Wilson committed
48
Install the [react-native-apple-healthkit] package from npm:
Greg Wilson's avatar
Greg Wilson committed
49 50 51

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

Greg Wilson's avatar
Greg Wilson committed
52
##### Xcode
Greg Wilson's avatar
Greg Wilson committed
53
  
Greg Wilson's avatar
Greg Wilson committed
54 55 56 57
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
58 59
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
60

Greg Wilson's avatar
Greg Wilson committed
61
6. Compile and run
Greg Wilson's avatar
Greg Wilson committed
62

Greg Wilson's avatar
Greg Wilson committed
63
### Usage
Greg Wilson's avatar
Greg Wilson committed
64

Greg Wilson's avatar
Greg Wilson committed
65 66 67
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
68

Greg Wilson's avatar
Greg Wilson committed
69 70
...

Greg Wilson's avatar
Greg Wilson committed
71
let options = {
Greg Wilson's avatar
Greg Wilson committed
72
    permissions: {
Greg Wilson's avatar
Greg Wilson committed
73 74
        read: ["Height", "Weight", "StepCount", "DateOfBirth", "BodyMassIndex"],
        write: ["Weight", "StepCount", "BodyMassIndex"]
Greg Wilson's avatar
Greg Wilson committed
75 76 77
    }
};

Greg Wilson's avatar
Greg Wilson committed
78
AppleHealthKit.initHealthKit(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
79 80 81 82
    if(err) {
        console.log("error initializing healthkit: ", err);
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
83
    // healthkit initialized...
Greg Wilson's avatar
Greg Wilson committed
84 85 86 87 88
});


```

Greg Wilson's avatar
Greg Wilson committed
89 90 91 92 93 94 95 96
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
97
AppleHealthKit.getLatestWeight(null, (err: Object, weight: Object) => {
Greg Wilson's avatar
Greg Wilson committed
98 99 100 101
    if(err){
        console.log("error getting current weight: ", err);
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
102
    // use weight.value ...
Greg Wilson's avatar
Greg Wilson committed
103 104 105 106
});

...

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


```
Greg Wilson's avatar
Greg Wilson committed
118 119


Greg Wilson's avatar
Greg Wilson committed
120 121 122

## Documentation

Greg Wilson's avatar
Greg Wilson committed
123 124
Permissions
-----------
Greg Wilson's avatar
Greg Wilson committed
125 126 127

The available HealthKit permissions to use with `initHealthKit` 

Greg Wilson's avatar
Greg Wilson committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
| 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
146 147 148 149 150 151 152
| 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
153

Greg Wilson's avatar
Greg Wilson committed
154 155 156 157 158 159 160 161 162 163
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
164
// setup healthkit read/write permissions using PERMS
Greg Wilson's avatar
Greg Wilson committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
const healthKitOptions = {
    permissions: {
        read:  [
            PERMS.StepCount,
            PERMS.Height,
        ],
        write: [
            PERMS.StepCount
        ],
    }
};

...
```

Greg Wilson's avatar
Greg Wilson committed
180

Greg Wilson's avatar
Greg Wilson committed
181 182
Options
-------
Greg Wilson's avatar
Greg Wilson committed
183 184


Greg Wilson's avatar
Greg Wilson committed
185 186
Methods
-------
Greg Wilson's avatar
Greg Wilson committed
187

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

Greg Wilson's avatar
Greg Wilson committed
199
#### **`initHealthKit`** 
Greg Wilson's avatar
Greg Wilson committed
200
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
201

Greg Wilson's avatar
Greg Wilson committed
202
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
203

Greg Wilson's avatar
Greg Wilson committed
204
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
205

Greg Wilson's avatar
Greg Wilson committed
206
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
207

Greg Wilson's avatar
Greg Wilson committed
208
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
209 210

`initHealthKit` requires an options object with HealthKit permission settings
Greg Wilson's avatar
Greg Wilson committed
211
```javascript
Greg Wilson's avatar
Greg Wilson committed
212
let options = {
Greg Wilson's avatar
Greg Wilson committed
213
    permissions: {
Greg Wilson's avatar
Greg Wilson committed
214 215
        read: ["Height", "Weight", "StepCount", "DateOfBirth", "BodyMassIndex"],
        write: ["Weight", "StepCount", "BodyMassIndex"]
Greg Wilson's avatar
Greg Wilson committed
216 217
    }
};
Greg Wilson's avatar
Greg Wilson committed
218
```
Greg Wilson's avatar
Greg Wilson committed
219

Greg Wilson's avatar
Greg Wilson committed
220
```javascript
Greg Wilson's avatar
Greg Wilson committed
221
AppleHealthKit.initHealthKit(options: Object, (err: string, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
222 223 224 225 226 227 228 229 230
    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
231 232
___

Greg Wilson's avatar
Greg Wilson committed
233
#### **`getBiologicalSex`**
Greg Wilson's avatar
Greg Wilson committed
234
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
235

Greg Wilson's avatar
Greg Wilson committed
236 237 238 239 240 241 242 243
| Value   | HKBiologicalSex       |
|---------|-----------------------|
| unknown | HKBiologicalSexNotSet |
| male    | HKBiologicalSexMale   |
| female  | HKBiologicalSexFemale |
| other   | HKBiologicalSexOther  |

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

___

Greg Wilson's avatar
Greg Wilson committed
255
#### **`getDateOfBirth`**
256
Get the date of birth.
Greg Wilson's avatar
Greg Wilson committed
257

Greg Wilson's avatar
Greg Wilson committed
258
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
259
```javascript
260 261 262 263 264 265 266 267
{ 
	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
268 269 270
    if(this._handleHealthKitError(err, 'getDateOfBirth')){
        return;
    }
271 272
    // use res.value ... (ex: '1986-09-01T12:20:30-04:00')
	// use res.age ... (ex: 29)
Greg Wilson's avatar
Greg Wilson committed
273 274 275 276 277
});
```

___

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

Greg Wilson's avatar
Greg Wilson committed
281
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
282 283 284 285 286 287 288
```javascript
let d = new Date(2016,5,27);
let options = {
    date: d.toISOString()
};
```

Greg Wilson's avatar
Greg Wilson committed
289
```javascript
Greg Wilson's avatar
Greg Wilson committed
290 291 292 293 294 295 296 297 298 299
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
300
#### ~~**`getStepCountForToday`**~~
Greg Wilson's avatar
Greg Wilson committed
301
**removed** - replaced by `getStepCount`
Greg Wilson's avatar
Greg Wilson committed
302

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

___

Greg Wilson's avatar
Greg Wilson committed
315
#### ~~**`getStepCountForDay`**~~
Greg Wilson's avatar
Greg Wilson committed
316
**removed** - replaced by `getStepCount`
Greg Wilson's avatar
Greg Wilson committed
317

Greg Wilson's avatar
Greg Wilson committed
318
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
319 320 321 322 323
```javascript
let d = new Date(2016,5,27);
let options = {
    date: d.toISOString()
};
Greg Wilson's avatar
Greg Wilson committed
324
AppleHealthKit.getStepCountForDay(options: Object, (err: Object, steps: number) => {
325 326 327 328 329 330 331 332 333
    if(this._handleHealthKitError(err, 'getStepCountForDay')){
        return;
    }
    // steps is the step count for day 'd'
});
```

___

Greg Wilson's avatar
Greg Wilson committed
334
#### **`getDailyStepCountSamples`**
Greg Wilson's avatar
Greg Wilson committed
335
Get the total steps per day over a specified date range. 
Greg Wilson's avatar
Greg Wilson committed
336

Greg Wilson's avatar
Greg Wilson committed
337
`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
338 339 340 341 342 343
```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
344
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
345 346 347 348 349 350 351 352 353 354
```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
355
```javascript
Greg Wilson's avatar
Greg Wilson committed
356
 AppleHealthKit.getDailyStepCountSamples(options: Object, (err: Object, res: Array<Object>) => {
Greg Wilson's avatar
Greg Wilson committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
    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
376
Get the total steps per day over a specified date range. 
377

Greg Wilson's avatar
Greg Wilson committed
378
`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
379 380 381 382 383 384
```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
385
the function will be called with an array of elements `res` containing date and step count information
386
```javascript
Greg Wilson's avatar
Greg Wilson committed
387
 AppleHealthKit.getMultiDayStepCounts(options: Object, (err: Object, res: Array<Array<string|number>>) => {
388 389 390 391
    if(this._handleHealthKitError(err, 'getMultiDayStepCounts')){
        return;
    }
    // 'res' is array of [ISOTimestamp: string, stepCount: number] arrays
Greg Wilson's avatar
Greg Wilson committed
392
    // sorted ascending from startDate through endDate
393 394 395
    for(let i=0; i<res.length; ++i){
        let elem = res[i];
        // elem[0] is ISOTimestamp : string
Greg Wilson's avatar
Greg Wilson committed
396
        // elem[1] is step count   : number
397 398 399 400 401 402
    }
});
```

___

Greg Wilson's avatar
Greg Wilson committed
403
#### **`saveSteps`**
Greg Wilson's avatar
Greg Wilson committed
404
Save a step count sample.
Greg Wilson's avatar
Greg Wilson committed
405

Greg Wilson's avatar
Greg Wilson committed
406
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
407 408 409

`saveSteps` accepts an options object containing required *`value: number`*, *`startDate: ISO8601Timestamp`*, and *`endDate: ISO8601Timestamp`*.
```javascript
Greg Wilson's avatar
Greg Wilson committed
410 411
// 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
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
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
430
#### **`getDistanceWalkingRunning`**
Greg Wilson's avatar
Greg Wilson committed
431
Get the total distance walking/running on a specific day. 
Greg Wilson's avatar
Greg Wilson committed
432

Greg Wilson's avatar
Greg Wilson committed
433
`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
434 435 436 437 438 439 440 441
```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
442
AppleHealthKit.getDistanceWalkingRunning(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
443 444 445
    if(this._handleHKError(err, 'getDistanceWalkingRunning')){
    	return;
    }
Greg Wilson's avatar
Greg Wilson committed
446
	// use res.value ...
Greg Wilson's avatar
Greg Wilson committed
447 448 449 450 451 452
});
```

___

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

Greg Wilson's avatar
Greg Wilson committed
455
`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
456 457 458 459 460 461 462 463
```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
464
AppleHealthKit.getDistanceCycling(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
465 466 467
    if(this._handleHKError(err, 'getDistanceCycling')){
    	return;
    }
Greg Wilson's avatar
Greg Wilson committed
468
	// use res.value ...
Greg Wilson's avatar
Greg Wilson committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
});
```

___

#### **`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
485
AppleHealthKit.getFlightsClimbed(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
486 487 488
    if(this._handleHKError(err, 'getFlightsClimbed')){
    	return;
    }
Greg Wilson's avatar
Greg Wilson committed
489
	// use res.value ...
Greg Wilson's avatar
Greg Wilson committed
490 491 492 493 494
});
```

___

495
#### **`getLatestWeight`**
Greg Wilson's avatar
Greg Wilson committed
496 497
Get the most recent weight sample.

Greg Wilson's avatar
Greg Wilson committed
498
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
499 500 501 502 503 504 505 506
```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
507
```javascript
Greg Wilson's avatar
Greg Wilson committed
508
AppleHealthKit.getLatestWeight(null, (err: string, weight: Object) => {
Greg Wilson's avatar
Greg Wilson committed
509
    if(err){
510
        console.log("error getting latest weight: ", err);
Greg Wilson's avatar
Greg Wilson committed
511 512
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
513
    // use weight.value, weight.startDate, etc ...
Greg Wilson's avatar
Greg Wilson committed
514 515 516
});
```

Greg Wilson's avatar
Greg Wilson committed
517 518
___

Greg Wilson's avatar
Greg Wilson committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
#### **`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
542 543
#### **`saveWeight`**
save a numeric weight value to HealthKit
Greg Wilson's avatar
Greg Wilson committed
544

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

559 560 561
___

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

Greg Wilson's avatar
Greg Wilson committed
564
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.*
565
```javascript
Greg Wilson's avatar
Greg Wilson committed
566 567 568 569 570 571 572 573 574 575
{
	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) => {
576 577 578 579
    if(err){
        console.log("error getting latest height: ", err);
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
580
    // use height.value, height.startDate, etc ...
581 582
});
```
Greg Wilson's avatar
Greg Wilson committed
583 584 585

___

Greg Wilson's avatar
Greg Wilson committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
#### **`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
602 603
	{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
604 605 606
	...
]
```
Greg Wilson's avatar
Greg Wilson committed
607
*example usage*
Greg Wilson's avatar
Greg Wilson committed
608 609 610 611 612 613 614 615 616 617 618
```javascript
AppleHealthKit.getHeightSamples(options, (err: Object, samples: Array<Object>) => {
	if(this._handleHealthKitError(err, 'getHeightSamples')){
		return;
	}
	// use samples ...
});
```

___

Greg Wilson's avatar
Greg Wilson committed
619 620 621 622 623 624 625 626
#### **`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
627
AppleHealthKit.saveHeight(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
628 629 630 631 632 633 634
    if(this._handleHealthKitError(err, 'saveHeight')){
        return;
    }
    // height successfully saved
});
```

Greg Wilson's avatar
Greg Wilson committed
635 636 637
___

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

Greg Wilson's avatar
Greg Wilson committed
640
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
641 642 643 644 645 646 647 648
```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
649 650 651 652 653 654
```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
655 656 657
    let d = bmi.startDate
    let val = bmi.value;
    // ...
Greg Wilson's avatar
Greg Wilson committed
658 659 660
});
```

661 662
___

Greg Wilson's avatar
Greg Wilson committed
663 664 665 666 667 668 669 670
#### **`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
671
AppleHealthKit.saveBmi(options: Object, (err: Object, res: Object) => {
Greg Wilson's avatar
Greg Wilson committed
672 673 674 675 676 677 678 679 680
    if(this._handleHealthKitError(err, 'saveBmi')){
        return;
    }
    // BMI successfully saved
});
```

___

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

Greg Wilson's avatar
Greg Wilson committed
684
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
685 686 687 688 689 690 691 692
```javascript
{
	value: 20,
	startDate: '2016-07-08T12:00:00.000-0400', 
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

693
```javascript
Greg Wilson's avatar
Greg Wilson committed
694
AppleHealthKit.getLatestBodyFatPercentage(null, (err: Object, bodyFatPercentage: Object) => {
695 696 697
    if(this._handleHealthKitError(err, 'getLatestBodyFatPercentage')){
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
698
    // use bodyFatPercentage.value, bodyFatPercentage.startDate, etc ...
699 700 701
});
```

Greg Wilson's avatar
Greg Wilson committed
702 703 704
___

#### **`getLatestLeanBodyMass`**
Greg Wilson's avatar
Greg Wilson committed
705 706
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
707
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
708 709 710 711 712 713 714 715
```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
716
```javascript
Greg Wilson's avatar
Greg Wilson committed
717
 AppleHealthKit.getLatestLeanBodyMass(null, (err: Object, leanBodyMass: Object) => {
Greg Wilson's avatar
Greg Wilson committed
718 719 720
    if(this._handleHealthKitError(err, 'getLatestLeanBodyMass')){
        return;
    }
Greg Wilson's avatar
Greg Wilson committed
721
    // use leanBodyMass.value, leanBodyMass.startDate, etc ...
Greg Wilson's avatar
Greg Wilson committed
722 723
});
```
Greg Wilson's avatar
Greg Wilson committed
724

Greg Wilson's avatar
Greg Wilson committed
725 726
## Examples

Greg Wilson's avatar
Greg Wilson committed
727 728
#### StepsDemo

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

731
![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
732 733 734

#### BodyMeasurements

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

737
![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
738

739

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