open-wearables-react-native-sdk

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #machine-learning #deep-learning #linux #nodejs #awesome #awesome-list #pytorch #ios #mcp #open-source

open-wearables-react-native-sdk

(★ 14)

React Native SDK for Open Wearables

open-wearables-react-native-sdk 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Open Wearables React Native SDK

The official React Native SDK for the [Open Wearables](https://github.com/the-momentum/open-wearables) project.

The SDK is built with the [Expo Module API](https://docs.expo.dev/modules/module-api/) enabling install the app in Expo Project as well as in React Native CLI projects.
It is a wrapper for the native iOS and Android SDKs to allow React Native apps to collect and sync health data.

## Platform support

| Platform | Status                                                                        |
| -------- | ----------------------------------------------------------------------------- |
| iOS      | Implemented (via `OpenWearablesHealthSDK` CocoaPod, requires iOS 15.1+)       |
| Android  | Implemented (via Maven Local dependency `com.openwearables.health:sdk:0.11.1`) |

## Installation

Currently, the SDK is only available locally. You can install it using the following command from the project root folder:

```sh
npm install
```

When we publish the package to npm, we will use the following command (not available yet):

```sh
npm install open-wearables
```

Then, depending if you are using Expo or React Native CLI, follow the instructions below:

### Expo

Expo projects using the Expo Modules API automatically link native dependencies.

After installing the package, simply run your project.

```sh
npx expo run:ios
```

If your project does not yet contain native directories (ios/ and android/), Expo will automatically generate them.

You can also generate them manually using:

```sh
npx expo prebuild
```

### React Native CLI

For bare React Native projects, you must ensure that you have **[installed and configured the expo package](https://docs.expo.dev/bare/installing-expo-modules/)** before continuing.

After installing the package, install the iOS CocoaPods dependencies:

```sh
npx pod-install
```

or manually:

```sh
cd ios && pod install
```

### Android (temporary setup)

The Android implementation currently relies on a local Maven dependency:

```
implementation("com.openwearables.health:sdk:0.11.1")
```

To test the Android integration using `mavenLocal`, please refer to the setup instructions in the example app:

👉 **[example/README.md](./example/README.md)**

## Config Plugin (optional)

You can customize the permission messages displayed to users by configuring the plugin in your app.json or app.config.js.

```json
{
  "expo": {
    "plugins": [
      [
        "open-wearables",
        {
          "healthShareUsage": "Allow $(PRODUCT_NAME) to read your health data.",
          "healthUpdateUsage": "Allow $(PRODUCT_NAME) to write health data."
        }
      ]
    ]
  }
}
```

| **Option**        | **Description**                                              |
| ----------------- | ------------------------------------------------------------ |
| healthShareUsage  | Sets the NSHealthShareUsageDescription value in Info.plist.  |
| healthUpdateUsage | Sets the NSHealthUpdateUsageDescription value in Info.plist. |

## Example app

A minimal Expo application demonstrating how to integrate the SDK.

See the example project:  
👉 **[example/README.md](./example/README.md)**

## Usage

```ts
import OpenWearablesHealthSDK from "open-wearables";

// Configure the SDK with your backend host
OpenWearablesHealthSDK.configure("https://your-api-host.com");

// Sign in (token-based)
OpenWearablesHealthSDK.signIn(userId, accessToken, refreshToken, null);

// Or sign in (API key)
OpenWearablesHealthSDK.signIn(userId, null, null, apiKey);

// Request HealthKit authorization
await OpenWearablesHealthSDK.requestAuthorization([
  "steps",
  "heartRate",
  "sleep",
]);

// Start background sync
await OpenWearablesHealthSDK.startBackgroundSync();

// Sync immediately
await OpenWearablesHealthSDK.syncNow();
```

## API

### Configuration

#### `configure(host: string): void`

Sets the backend host URL for the SDK.

---

### Auth

#### `signIn(userId, accessToken, refreshToken, apiKey): void`

Signs in a user. `accessToken`, `refreshToken`, and `apiKey` are optional.

#### `signOut(): void`

Signs out the current user.

#### `updateTokens(accessToken: string, refreshToken: string): void`

Updates the stored auth tokens.

#### `restoreSession(): Promise<boolean>`

Attempts to restore a previously saved session. Returns `true` if successful.

#### `isSessionValid(): boolean`

Returns whether the current session is valid.

---

### HealthKit Authorization

#### `requestAuthorization(types: HealthDataType[]): Promise<boolean>`

Requests HealthKit read permissions for the given data types. Returns `true` if the authorization was granted.

See `[HealthDataType](#healthdatatype)` for the full list of supported types.

---

### Sync

#### `startBackgroundSync(): Promise<boolean>`

Starts background health data sync. Returns `true` if started successfully.

#### `stopBackgroundSync(): void`

Stops background sync.

#### `syncNow(): Promise<void>`

Triggers an immediate sync.

#### `resumeSync(): Promise<boolean>`

Resumes a previously paused sync.

#### `isSyncActive(): boolean`

Returns whether background sync is currently active.

#### `getSyncStatus(): Record<string, any>`

Returns the current sync status.

#### `resetAnchors(): void`

Resets the HealthKit query anchors, forcing a full re-sync on the next run.

#### `getStoredCredentials(): Record<string, any>`

Returns the credentials currently stored by the SDK.

---

### Events

Subscribe to native SDK events using the standard Expo module event emitter:

```ts
const subscription = OpenWearablesHealthSDK.addListener(
  "onLog",
  ({ message }) => {
    console.log("SDK log:", message);
  }
);

const authSub = OpenWearablesHealthSDK.addListener(
  "onAuthError",
  ({ statusCode, message }) => {
    console.error(`Auth error ${statusCode}:`, message);
  }
);

// Clean up
subscription.remove();
authSub.remove();
```

| Event         | Payload                                   | Description                            |
| ------------- | ----------------------------------------- | -------------------------------------- |
| `onLog`       | `{ message: string }`                     | Log messages emitted by the native SDK |
| `onAuthError` | `{ statusCode: number, message: string }` | Authentication errors                  |

---

### HealthDataType

The following health data type identifiers can be passed to `requestAuthorization`:

**Activity & Mobility**
`steps`, `distanceWalkingRunning`, `distanceCycling`, `flightsClimbed`, `walkingSpeed`, `walkingStepLength`, `walkingAsymmetryPercentage`, `walkingDoubleSupportPercentage`, `sixMinuteWalkTestDistance`, `activeEnergy`, `basalEnergy`

**Heart & Cardiovascular**
`heartRate`, `restingHeartRate`, `heartRateVariabilitySDNN`, `vo2Max`, `oxygenSaturation`, `respiratoryRate`

**Body Measurements**
`bodyMass`, `height`, `bmi`, `bodyFatPercentage`, `leanBodyMass`, `waistCircumference`, `bodyTemperature`

**Blood & Metabolic**
`bloodGlucose`, `insulinDelivery`, `bloodPressureSystolic`, `bloodPressureDiastolic`, `bloodPressure`

**Sleep & Mindfulness**
`sleep`, `mindfulSession`

**Reproductive Health**
`menstrualFlow`, `cervicalMucusQuality`, `ovulationTestResult`, `sexualActivity`

**Nutrition**
`dietaryEnergyConsumed`, `dietaryCarbohydrates`, `dietaryProtein`, `dietaryFatTotal`, `dietaryWater`

**Workout**
`workout`

**Aliases**
`restingEnergy`, `bloodOxygen`

open-wearables-react-native-sdk

open-wearables-react-native-sdk 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

open-wearables-react-native-sdk

open-wearables-react-native-sdk 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README