Release Note

Release Date

February 26, 2025

Release Version

v1.0.0 beta2

Target Device

The Samsung Health Data SDK support Android smartphones including non-Samsung Android smartphones.

SDK Content

Content

Description

/docs

API Reference
Programming Guide

/libs

SDK’s library. Import it in your app project.
- samsung-health-data-api.aar

/sample-code

App project including sample codes. It’s project name is:
- HealthDiary

/tool

DataViewer.
It displays saved health data in the Samsung Health app.

Features

Samsung Health Data SDK enable an application to access Samsung Health’s selected data.

Health Data Store

An app can read or aggregate the following data with the SDK’s APIs. The user’s health data is kept secured in the health data store. Available data operators can be different for each data type.

  • Activity summary
  • Active calories burned goal
  • Active time goal
  • Blood glucose
  • Blood oxygen
  • Blood pressure
  • Body composition
  • Energy score
  • Exercise
  • Exercise location
  • Floor climbed
  • Heart rate
  • Nutrition
  • Nutrition goal
  • Skin temperature
  • Sleep
  • Sleep goal
  • Steps
  • Step goal
  • Water intake
  • Water intake goal
  • User profile

Data Permission

The use’s data can be accessed after getting the user’s consent clearly.

Device Manager

Saved health data in Samsung Health can be from various connected devices like a Galaxy Watch, Galaxy Ring and a weight scale. DeviceManager provides source device information of saved health data in the Samsung Health’s data store.

Limitations

  • Samsung Health Data SDK requires Samsung Health v6.29 or later version installation.
  • Samsung Health runs on devices with Android 10 (API level 29) or above. It is available on all Samsung smartphones and also non-Samsung Android smartphones.
  • The SDK doesn’t support an emulator.
  • Measured data by Samsung Health Data SDK is for fitness and wellness only, not for the diagnosis or treatment of any medical condition.

Changes

[New]

Data type
  • The following data type has been added. Reading data and retrieving changed data are available.
    • EnergyScoreType
Inserting, updating, and deleting data
  • Inserting, updating, and deleting data has been supported for the following data types.
    • Body composition
    • Blood glucose
    • Blood pressure
    • Heart rate
    • Nutrition
    • Water intake
  • The following APIs have been added in com.samsung.android.sdk.health.data.HealthDataStore for inserting data.
    • insert(type: Writeable<T>, builder: suspend InsertDataRequest.BasicBuilder<T>.() -> insertDataRequest.BasicBuilder<T>)
    • insertData(request:InsertDataRequest<T>)
    • insertDataAsync(request:InsertDataRequest<T>)
  • The following APIs have been added in com.samsung.android.sdk.health.data.HealthDataStore for updating data.
    • update(type: Writeable<T>,builder: suspend UpdateDataRequest.BasicBuilder<T>.() -> UpdateDataRequest.BasicBuilder<T>)
    • updateData(request:UpdateDataRequest<T>)
    • updateDataAsync(request:UpdateDataRequest<T>)
  • The following APIs have been added in com.samsung.android.sdk.health.data.HealthDataStore for deleting data.
    • delete(type: Writeable<T>,builder: suspend DeleteDataRequest.BasicBuilder.() -> DeleteDataRequest.BasicBuilder)
    • deleteData(request:DeleteDataRequest)
    • deleteDataAsync(request:DeleteDataRequest)
  • The com.samsung.android.sdk.health.data.data.HealthDataPoint.Builder class has beed added to insert or update health data.
  • The following classs have been added in com.samsung.android.sdk.health.data.request.
    • InsertDataRequest
    • UpdateDataRequest
    • DeleteDataRequest
Access code
  • Developer mode's access code
    • To insert, update, or delete data when testing apps, the access code is required on the developer mode page. The access code can be obtained by requesting partnership.
Device manager
  • The following APIs have been added in com.samsung.android.sdk.health.data.DeviceManager to register health devices and getting device information.
    • registerDevice(request:DeviceRegistrationRequest)
    • registerDeviceAsync(request:DeviceRegistrationRequest)
    • getDeviceBySeed()
    • getDeviceBySeedAsync()
    • getOwnDevices()
    • getOwnDevicesAsync()
  • The com.samsung.android.sdk.health.data.request.DeviceRegistrationRequest has been added to register a health device.
  • The following classes and APIs have been added related to the accessory device.
    • com.samsung.android.sdk.health.data.device
      • AccessoryType
      • Device.AccessoryBuilder
      • Device.Companion.accessoryBuilder()
      • Device.isOf(type:AccessoryType)
Others
  • The following APIs have been added in com.samsung.android.sdk.health.data.request.IdFilter.Builder.
    • addClientDataId(clientDataId:String)
    • fromClientDataId(clientDataId:String)
  • The following error code has been added in com.samsung.android.sdk.health.data.error.
    • ERR_NO_OWNERSHIP_TO_WRITE
  • The following property has been added in the BloodGlucoseType.
    • MEDICATION_TAKEN

[Changed]

  • The BloodGlucoseType.MEAL_STATUS property has been changed to be required.
  • The first SDK release.

[New]

  • Reading the following Samsung Health's data is available.
    • Activity summary
    • Active calories burned goal
    • Active time goal
    • Blood glucose
    • Blood oxygen
    • Blood pressure
    • Body composition
    • Exercise
    • Exercise location
    • Floor climbed
    • Heart rate
    • Nutrition
    • Nutrition goal
    • Skin temperature
    • Sleep
    • Sleep goal
    • Steps
    • Step goal
    • Water intake
    • Water intake goal
    • User profile
  • Data permission
    • Requesting data permissions is required to read health data.
  • Device manager
    • The device type like a Galaxy Watch, Galaxy Ring and a weight scale can be known with the device manager.
  • Developer mode
    • For development and debugging purposes, developers can activate the developer mode to interact with the Samsung Health Data SDK within their Android apps.
    • To distribute the app using the Samsung Health Data SDK, request partnership. You can find more information in the SDK process.