Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.synheart.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
General

​
What is Synheart?

Synheart is a privacy-preserving platform for building human-state-aware applications. It includes:
  • Synheart Core — unified SDK with on-device HSI (Human State Interface) computation via the Synheart runtime engine.
  • Synheart Wear — biometric data streaming from Apple Watch, WHOOP, Garmin, BLE HRMs, and more.
  • Synheart Behavior — content-free interaction event capture (taps, scrolls, typing patterns).
  • Synheart Session — explicit time-bounded HR + behavioral sessions on phone or watch.

​
What platforms are supported?

  • Flutter (Dart)
  • Android (Kotlin)
  • iOS (Swift)
  • CLI: synheart-cli for runtime install, mock streams, and local platform.

​
Is Synheart HIPAA / GDPR compliant?

Synheart SDKs are designed with privacy in mind: all inference is on-device, derived signals only leave the device with explicit consent, and users can revoke permissions and delete data. Compliance for your application depends on how you implement it — consult legal counsel for your specific use case.

​
Is Synheart a medical device?

No. Synheart is for wellness, productivity, and research purposes only. It is not a medical device and must not be used for medical diagnosis or treatment.

​
Synheart Wear

​
Which wearables are supported?

See the device matrix. Highlights: Apple Watch (HealthKit), Health Connect (Android), WHOOP, Garmin (cloud + native RTS — RTS requires a Garmin Health SDK license; see GARMIN_SETUP.md), BLE HRMs (Polar, Wahoo, Garmin straps).

​
Do I need OAuth credentials for all wearables?

No. Cloud-based vendors (WHOOP, Garmin, Fitbit) require OAuth credentials. Local sources (Apple Watch via HealthKit, Health Connect, BLE HRMs) use system permissions only.

​
Can I use multiple wearables at once?

Yes. The SDK supports multiple device adapters simultaneously and normalizes everything into the same WearMetrics shape — see the wear data shape for the canonical fields.

​
Integration

​
Can I use a single module standalone?

Yes. Wear, Behavior, and Session can each be used standalone via their package — no CLI, no platform account, no runtime needed. See Quickstart Track B.

​
How do I combine signals into HSI output?

Use Synheart Core. Core loads the Synheart runtime, accepts signals from Wear / Behavior / Phone modules, and emits HSI 1.3 JSON frames on-device. See the Quickstart Track A.

​
How do I handle permissions?

  • iOS: HealthKit usage descriptions in Info.plist and requestAuthorization().
  • Android: Health Connect permissions via system settings.
  • Cloud APIs: OAuth flow per vendor (WHOOP, Garmin, Fitbit).

​
Development

​
Can I test without a physical wearable?

Yes — synheart mock start streams mock Whoop/Garmin payloads over WebSocket/SSE/UDP. See Synheart CLI reference.

​
Where can I find code examples?

​
Privacy & Security

​
Does Synheart send data to servers?

Only when you explicitly enable cloud upload via Synheart Core’s Cloud Connector, and only after consent has been granted. Raw biosignal content never leaves the device.

​
How is data stored?

  • Local storage: AES-256 encrypted (when enabled).
  • Memory: Processed and discarded by default.
  • Cloud: HSI snapshots only, gated by user consent and capability tokens.

​
Can users delete their data?

Yes. Users can revoke consent (stops collection), clear app data (removes local storage), or uninstall the app.

​
Performance

​
Will Synheart drain my battery?

Designed for low overhead in continuous background operation. Earlier docs published specific CPU / memory / battery numbers — those were internal design targets, not measured runtime numbers. Profile your own integration with Synheart.runtimeDiagnostics() and platform profilers, and tune by adjusting streaming frequency and HSI window sizes.

​
Support

​
Where can I get help?

  1. Check the relevant guide in this documentation.
  2. File issues on the per-repo GitHub trackers.
  3. Email support@synheart.ai.