Skip to main content

Introduction

The Open Wearables Flutter SDK (open_wearables_health_sdk) enables secure background synchronization of health data from Apple HealthKit (iOS), Samsung Health, and Health Connect (Android) to the Open Wearables platform. On iOS, the Flutter SDK is a wrapper around the native iOS SDK (OpenWearablesHealthSDK). On Android, it wraps the native Android SDK (open-wearables-android-sdk). This means all the core sync logic — background execution, streaming uploads, secure storage, and retry mechanisms — is handled by the native implementations under the hood. The Flutter layer provides a convenient Dart API for cross-platform apps.

Flutter SDK Repository

View source code, report issues, and contribute to the Flutter SDK.

Native iOS SDK

See the native iOS SDK documentation for the underlying iOS implementation.

Native Android SDK

See the native Android SDK documentation for the underlying Android implementation.

Features

  • Cross-Platform - Single Dart API for iOS (HealthKit) and Android (Samsung Health, Health Connect)
  • Background Sync - Health data syncs even when your app is in the background
  • Incremental Updates - Only syncs new data using anchored queries
  • Secure Storage - Credentials stored in iOS Keychain / Android EncryptedSharedPreferences
  • Dual Authentication - Token-based auth with auto-refresh or API key authentication
  • Resumable Sessions - Sync sessions survive app restarts
  • Wide Data Support - Steps, heart rate, workouts, sleep, and 40+ data types
  • Provider Selection - Choose between Samsung Health and Health Connect on Android

Requirements

Installation

1

Add the dependency

Add open_wearables_health_sdk to your pubspec.yaml:
Then run:
2

iOS Configuration

Add the following to your ios/Runner/Info.plist:
Then enable HealthKit capability in Xcode:
  1. Open ios/Runner.xcworkspace in Xcode
  2. Select your target → Signing & Capabilities
  3. Click + Capability → Add HealthKit
  4. Check Background Delivery if you want updates while app is closed
3

Android Configuration

The SDK’s Android module handles most configuration automatically. Make sure your android/app/build.gradle has:
No additional permissions or manifest entries are needed — the SDK’s AndroidManifest.xml merges automatically.

Quick Start

Here’s the minimal code to get health sync working:

Android Provider Selection

On Android, you need to select a health data provider before requesting permissions:
AndroidHealthProvider.samsungHealth maps to Samsung Health, and AndroidHealthProvider.healthConnect maps to Google Health Connect. Use getAvailableProviders() to check which are installed on the device.

Log Level

Control SDK log output with setLogLevel. The default is OWLogLevel.debug (logs only in debug builds):

Listening to Events

The SDK exposes streams for logging and auth errors:

Documentation

Integration Guide

Complete guide to integrating the SDK including authentication flow, backend setup, and best practices.

Troubleshooting

Common issues and their solutions for iOS and Android.

Supported Health Data Types

The SDK supports 40+ health data types across multiple categories:
Not all data types are available on all providers. Samsung Health supports a subset of types compared to Health Connect and HealthKit. See the Android SDK docs for provider-specific availability.

Next Steps

Integration Guide

Complete step-by-step integration guide.

API Reference

Full API documentation on GitHub.