overview package class tree deprecated index com.samsung.android.sdk.healthdata class healthconnectionerrorresult java.lang.object com.samsung.android.sdk.healthdata.healthconnectionerrorresult public final class healthconnectionerrorresult extends object this class handles errors raised by connection failure to the health data store. considerations for connection failure a partner app works with samsung health. the partner app can meet the following error cases when it connects to samsung health. connection error description platform_not_installed samsung health is not installed. old_version_platform installed samsung health's version is old. platform_disabled samsung health is disabled. user_agreement_needed the user didn't agree to samsung health's terms & conditions and privacy policies. user_password_needed samsung health is locked by the user password. handling connection exceptions samsung health sdk for android helps you to handle all available error cases with healthconnectionerror when your application connects to the health data store. healthconnectionerror is retrieved in healthdatastore.connectionlistener's event handler and all samsung health's partner applications need to check the health data store's connection error mandatorily. the following example shows how to handle the connection error. public class mainactivity extends activity { private healthdatastore mstore; private healthconnectionerrorresult mconnerror; private static mainactivity minstance = null; @override public void oncreate(bundle savedinstancestate) { // ... mstore = new healthdatastore(this, mconnectionlistener); mstore.connectservice(); } @override public void ondestroy() { mstore.disconnectservice(); // ... } private final healthdatastore.connectionlistener mconnectionlistener = new healthdatastore.connectionlistener() { @override public void onconnected() { // connected } @override public void onconnectionfailed(healthconnectionerrorresult error) { // connection fails showconnectionfailuredialog(error); } @override public void ondisconnected() { // connection is disconnected } }; private void showconnectionfailuredialog(healthconnectionerrorresult error) { alertdialog.builder alert = new alertdialog.builder(this); mconnerror = error; if (mconnerror.hasresolution()) { switch(error.geterrorcode()) { case healthconnectionerrorresult.platform_not_installed: message = "please install samsung health"; break; case healthconnectionerrorresult.old_version_platform: message = "please upgrade samsung health"; break; case healthconnectionerrorresult.platform_disabled: message = "please enable samsung health"; break; case healthconnectionerrorresult.user_agreement_needed: message = "please agree to samsung health policy"; break; default: message = "please make samsung health available"; break; } } else { // in case that the device doesn't support samsung health, // hasresolution() returns false also. alert.setmessage(r.string.msg_conn_not_available); } alert.setpositivebutton(r.string.ok, (dialog, id) -> { if (error.hasresolution()) { error.resolve(mainactivity.this); } }); if (error.hasresolution()) { alert.setnegativebutton("cancel", null); } alert.show(); } } since: 1.0.0 see also: healthdatastore.connectionlistener field summary fields modifier and type field and description static int connection_failure the connection is not established in the health data framework. static int old_version_platform the version of the health data framework is outdated to cooperate with sdk. static int old_version_sdk the sdk's data library version is outdated to cooperate with the samsung health's health data framework. static int platform_disabled the health data framework is disabled. static int platform_not_installed samsung health is not installed. static int platform_signature_failure it fails to check the signature of the health data framework. static int timeout the connection time exceeded the limit. static int unknown unknown error. static int user_agreement_needed the user did not agree to terms and conditions, and privacy policy of samsung health yet. static int user_password_needed the user cancels the password input explicitly on the password pop-up window. method summary all methods instance methods concrete methods modifier and type method and description int geterrorcode() gets the error code of connection failure. boolean hasresolution() checks whether the given error has a resolution. void resolve(activity activity) resolves an error with an activity which is able to get the user's feedback for possible error cases. field detail unknown public static final int unknown unknown error. its constant value is 0. since: 1.0.0 see also: constant field values connection_failure public static final int connection_failure the connection is not established in the health data framework. its constant value is 1. since: 1.0.0 see also: constant field values platform_not_installed public static final int platform_not_installed samsung health is not installed. to resolve it: if your app runs on android 11, check your app manifest whether the "<queries>" element is added. see the app manifest guide. call resolve(android.app.activity). it leads the user to install samsung health on an app seller site. its constant value is 2. since: 1.0.0 see also: resolve(android.app.activity), constant field values old_version_sdk public static final int old_version_sdk the sdk's data library version is outdated to cooperate with the samsung health's health data framework. to resolve it: apply the latest data library to your app. if your app uses the latest data library, create an activity to update to install your latest app. its constant value is 3. since: 1.0.0 see also: constant field values old_version_platform public static final int old_version_platform the version of the health data framework is outdated to cooperate with sdk. to resolve it, call resolve(android.app.activity). it leads the user to install the latest samsung health on an app seller site. its constant value is 4. since: 1.0.0 see also: resolve(android.app.activity), constant field values timeout public static final int timeout the connection time exceeded the limit. its constant value is 5. since: 1.0.0 see also: constant field values platform_disabled public static final int platform_disabled the health data framework is disabled. to resolve it, call resolve(android.app.activity). it leads the user to activate samsung health through the phone's settings. its constant value is 6. since: 1.0.0 see also: resolve(android.app.activity), constant field values user_password_needed public static final int user_password_needed the user cancels the password input explicitly on the password pop-up window. some devices can request a password to protect the user's data. the password for the health data access can be registered in samsung health by the user. then the user can enter the password through the password pop-up window. if the predetermined time passed without the valid password input, timeout occurs. its constant value is 7. since: 1.0.0 see also: constant field values platform_signature_failure public static final int platform_signature_failure it fails to check the signature of the health data framework. its constant value is 8. since: 1.0.0 see also: constant field values user_agreement_needed public static final int user_agreement_needed the user did not agree to terms and conditions, and privacy policy of samsung health yet. the health data framework is not activated before agreement. to resolve it, call reslove. it leads the user to the samsung health's service agreement page. its constant value is 9. since: 1.0.0 see also: resolve(android.app.activity), constant field values method detail geterrorcode public int geterrorcode() gets the error code of connection failure. usually it is called in healthdatastore.connectionlistener.onconnectionfailed(healthconnectionerrorresult). it's required to resolve the error depending on its returned error code. returns: the error code since: 1.0.0 hasresolution public boolean hasresolution() checks whether the given error has a resolution. whether the device supports samsung health the sdk supports marshmallow and above android devices including non-samsung devices. and it works with samsung health. there is no connection issue on most devices but it is not available occasionally depending on the device's specification. this api lets you know whether the device supports samsung health. the returned false involves that the device is not available for samsung health. precondition: check the network connection. permission: android.permission.internet returns: true if the platform provides a resolution for the error. call resolve(activity). false in the following cases: if the device doesn't support samsung health if there is no resolution for the error since: 1.0.0 resolve public void resolve(activity activity) resolves an error with an activity which is able to get the user's feedback for possible error cases. it handles the following errors and operations. show a proper message for each error case in your application before call this method. error operation platform_not_installed linked to the application installation page old_version_platform linked to the application installation page platform_disabled linked to settings of the device to turn on samsung health user_agreement_needed linked to the starting screen of samsung health to get the user's agreement precondition: check the network connection. permission: android.permission.internet parameters: activity - an activity which resolves the error with the user's feedback. usually it's the main activity of your application. throws: illegalargumentexception - if the specified input is null or invalid since: 1.0.0

development environment check prerequisites first and follow all steps below to create a samsung health’s partner app. prerequisites check following prerequisites before downloading samsung health sdk for android. android version android 8.0 oreo (api level 26) or above available devices android smartphones including non-samsung devices samsung health version a partner app runs with samsung health 4.0 or higher downloading samsung health sdk for android the sdk can be downloaded on the samsung developer site. folder in sdk description docs api reference describes the sdk's health data apis. programming guide contains development information to create a samsung health's partner app with health data access. libs samsung-health-data-va.b.c.aar health data library of samsung health sdk for android. samples simplehealth sample application that demonstrates how to read step count data. stepdiary sample application that demonstrates how to read step count and daily step count trend data. foodnote sample application to check daily calorie intake. tools dataviewer.apk a test tool for the connection between your app and samsung health that works via the samsung health's developer mode. it reads samsung health's saved data.

test apps test apps download | sep 26, 2019 (399.14 kb) samsung health device sdk’s test apps help a basic test. you can check paring and measured data transmission with these tools. the verification tool provides full checks for samsung health device’s specs. it can be used after these test apps. they are composed of the following services. blood pressure test blood glucose test heart rate test weight test enhanced heart rate test exercise test step test sleep test multiple health service test if the health device follows one more specs, use the multiple health service test app also. prerequisites test apps downloads test apps and install wanted test apps on an android phone. test apps run on android 6.0 marshmallow (api level 23) or above. turn on the phone’s bluetooth. ble health device prepare your ble health device that follows samsung health device specs. power on the health device how to use test apps 1. run one of test apps and allow the location permission. 2. tap scan button. 3. check optional functions with the top-right setting menu and select your health device in a scanned ble device list. 4. select ok or enter pin code to pair your health device with the test app. confirm the pairing on your health device also. 5. your health device and the test app are connected. if it fails, unpair the health device and try from step 2. 6. measure health data with the health device and check the data is shown on the test app well. 7. you can see health device’s more info through the test app’s top-right menu.

faq common | what are the benefits of samsung health sdk for android? samsung health app is a most popular health app and has more than 50 million of monthly active users. it works not only on samsung smartphones but also non-samsung phones if the device supports android marshmallow or above. it consists a big ecosystem including various health apps and connected accessory devices. samsung health sdk for android enables your app to manage the user’s health data with the unified interface by connecting to samsung health app. you can have more enhanced chances with a partnership of samsung health. common | i know the sdk needs samsung health installation. can samsung health be installed to all phones? if not, how can i know the samsung health’s availability on the device? even though samsung health is installed in android smartphones with marshmallow or above including samsung and non-samsung smartphones, some phones cannot support samsung health. its check code needs to be added to prevent a relevant situation. the sdk’s health data provides a solution to check it through healthconnectionerrorresult.hasresolution(). if the app meets the following cases, it means that the device is not available for samsung health. healthdatastore.connectservice() gives a failure event. healthconnectionerrorresult.hasresolution() returns false. see an example for failure exception handling. health data | i would like to know data’s common properties. all data type interfaces extend the healthconstants.common interface basically. some data types extend healthconstants.discretemeasurement and others extend healthconstants.sessionmeasurement depending on whether the end measured time exists. for example, healthconstants.sleep extends: healthconstants.common healthconstants.sessionmeasurement you can set healthconstants.sleep's following properties including its own ones. healthconstants.common.device_uuid healthconstants.sessionmeasurement.start_time healthconstants.sessionmeasurement.end_time see the "properties" description of each data type interface in api reference for more information. sleep data can be set as the example shown below. public class healthdataexample { // the state of connection private healthdatastore mstore; private void insertsleepdata(long start, long end, long offset) { healthdevice mydevice = new healthdevicemanager(mstore).getlocaldevice(); healthdata data = new healthdata(); data.setsourcedevice(mydevice.getuuid()); // fills all mandatory properties out data.putlong(healthconstants.sleep.start_time, start); data.putfloat(healthconstants.sleep.end_time, end); data.putlong(healthconstants.sleep.time_offset, offset); healthdataresolver resolver = new healthdataresolver(mstore, null); healthdataresolver.insertrequest insrequest = new healthdataresolver.insertrequest.builder() .setdatatype(healthconstants.sleep.health_data_type) .build(); // do something } } health data | there are two data types for steps. which data type is better? handling all use cases for the phone and linked multi-accessory devices is not easy with it because the phone and accessory device like galaxy watch can provide step count data at the same time or not depending on how many devices are carried by the user. samsung health sdk provides the following data types for steps: healthconstants.stepdailytrend healthconstants.stepcount healthconstants.stepdailytrend is used to generally to read the user’s daily steps. especially, its source_type_all provides the day’s total steps simply without excluding duplicated steps when the user carries one more devices at the same time. healthconstants.stepcount is useful for: getting each source device’s step count getting real-time step count of the phone that samsung health is installed. health data | the inserted health data’s measured time looks different. how can i solve it? if new data is inserted to the health data store, created_time, updated_time of healthconstants.common are assigned by the system automatically. so you don’t need to set them separately. data’s start_time or end_time indicates its utc measurement time in milliseconds. be careful not to set start_time or end_time as the device’s current local time. time_offset is indicated by the time zone and daylight saving time in milliseconds and it helps in showing the health data’s measured time properly in the device. the following example shows getting the current device’s time_offset. import java.util.timezone; public class heathdataexample { long gettimeoffset(long intaketime) { return timezone.getdefault().getoffset(intaketime); } }

release note introduction release date: september 26, 2019 release contents health device specs ble compatible guidelines for following health devices:blood glucose meterblood pressure monitorheart rate monitorweight scalesamsung health specifications for following health devices:exercise monitorenhanced heart rate monitorpedometersleep monitorsamsung health specification for multiple health service devices:handling multiple data typessetting user info test app test tools to check basic operation for:blood pressure testblood glucose testheart rate testweight testenhanced heart rate testexercise teststep testsleep testmultiple health service test verification tool it checks overall implementation of your health device for whole samsung health’s device specs. change history sep 26, 2019 [update] tools testapps_weight.apk and verificationtool.apk are updated. a pop-up displays for a device’s location access if it is not enabled. april 11, 2019 [new feature] weight scale user data service is defined for a multiple user scenario. see its spec 2.0. [update] tools testapps_weight.apk and verificationtool.apk are updated as a weight scale spec update. nov 23, 2017 the following tools to test your health device are added. test apps verification tool oct 17, 2017 samsung health device sdk v1.0.0 a new sdk release

overview package class tree deprecated index com.samsung.android.sdk.healthdata interface healthdataresolver.insertrequest enclosing class: healthdataresolver public static interface healthdataresolver.insertrequest this interface is able to make a request to insert health data for the specific health data type. request for inserting data healthdataresolver.insert() helps that your application saves a new measured data to samsung health. the following information is mandatory to build an insertrequest instance. mandatory information description data type set the data type with: insertrequest.builder.setdatatype() source device the device id that provides health data. set it with: healthdata.setsourcedevice() data's mandatory properties set mandatory properties of the health data type by referring to: data type definition you can make a request instance with insertrequest.builder.build(). inserting data example you can save health data to samsung health with healthdataresolver.insert() after setting detailed property values of the created healthdata instance. the health data framework registers the current device where your application is installed. if the source device is the current device, its id can be checked as shown below. // the state of connection private final healthdatastore mstore; public static final string app_tag = "myapp"; private void insertglucose(long start, long offset, float value) { // set the source device as the current device healthdevice mydevice = new healthdevicemanager(mstore).getlocaldevice(); healthdata data = new healthdata(); data.setsourcedevice(mydevice.getuuid()); and the data instance's properties including mandatory ones needs to be set. // set properties including mandatory ones data.putlong(healthconstants.bloodglucose.start_time, start); data.putlong(healthconstants.bloodglucose.time_offset, offset); data.putint(healthconstants.bloodglucose.measurement_type, healthconstants.bloodglucose.measurement_type_whole_blood); the measured data value needs to be set after checking defined data unit. each property in api reference lets you know it. in this case, see healthconstants.bloodglucose.glucose data.putfloat(healthconstants.bloodglucose.glucose, value); an insertrequest instance is created by insertrequest.builder.build() with setting the data type. it's ready to add data to samsung health if the data is added to the insertrequest. healthdataresolver.insertrequest insrequest = new healthdataresolver.insertrequest.builder() .setdatatype(healthconstants.bloodglucose.health_data_type) .build(); // add health data insrequest.addhealthdata(data); healthdataresolver resolver = new healthdataresolver(mstore, null); try { resolver.insert(insrequest).setresultlistener(mistresult); } catch (exception e) { log.d(app_tag, "resolver.insert() fails."); } } healthdataresolver.insert(com.samsung.android.sdk.healthdata.healthdataresolver.insertrequest) sends a request to samsung health. a data validation exception is received in healthresultholder.baseresult. it gives a request's result state and a number of inserted data. private final healthresultholder.resultlistener<healthresultholder.baseresult> mistresult = new healthresultholder.resultlistener<healthresultholder.baseresult>(){ @override public void onresult(healthresultholder.baseresult result) { if(result.getstatus() != status_successful) { // check the error } else { // check the count of inserted data log.d(app_tag, "count of inserted data: " + result.getcount()); } } }; since: 1.0.0 nested class summary nested classes modifier and type interface and description static class healthdataresolver.insertrequest.builder this class is a builder to configure healthdataresolver.insertrequest. method summary all methods instance methods abstract methods modifier and type method and description void addhealthdata(healthdata object) adds health data to insert. void addhealthdata(list<healthdata> objectlist) adds a health data list to insert. method detail addhealthdata void addhealthdata(healthdata object) adds health data to insert. parameters: object - the health data instance. the source device of object should be valid. throws: illegalargumentexception - if source device is not set or data is null since: 1.0.0 addhealthdata void addhealthdata(list<healthdata> objectlist) adds a health data list to insert. parameters: objectlist - the list of health data objects. the source device for each health data has to be defined in advance. throws: illegalargumentexception - if source device is not set or data list is null since: 1.0.0

overview package class tree deprecated index com.samsung.android.sdk.healthdata class healthdataobserver java.lang.object com.samsung.android.sdk.healthdata.healthdataobserver public abstract class healthdataobserver extends object this class defines a health data observer for health data change. adding an observer you can add an observer for the specific health data type and get notification in onchange(string) if the designated health data is changed. in case that you add an observer for the data type that updates too frequently in short time like step count, it can send too many events to your application and it can bring degradation of your application's performance. check that your application needs to update data with real-time from samsung health again before adding an observer. a health data observer can be defined as below. public class healthdataobserverexample { // the state of connection private healthdatastore mstore; public static final string app_tag = "myapp"; private final healthdataobserver mobserver = new healthdataobserver(null) { // checks notification for changed health data @override public void onchange(string datatypename) { log.d(app_tag, "health data is changed."); readchangeddata(datatypename); } }; when you add an observer for the specific health data type, specify the data type name as below. only data type is allowed to be observed. public void start() { // adds an observer for change of the weight healthdataobserver.addobserver(mstore, healthconstants.weight.health_data_type, mobserver); } the change notification is received in onchange(string) and you can check updated health data as below. private void readchangeddata(string datatypename) { healthdataresolver resolver = new healthdataresolver(mstore, null); healthdataresolver.readrequest rdrequest = new healthdataresolver.readrequest.builder() .setdatatype(datatypename) .build(); try { // make an asynchronous request to read health data resolver.read(rdrequest).setresultlistener(mrdlistener); } catch (exception e) { log.d(app_tag, "healthdataresolver.read() fails."); } } private final healthresultholder.resultlistener<healthdataresolver.readresult> mrdlistener = new healthresultholder.resultlistener<healthdataresolver.readresult>() { @override public void onresult(healthdataresolver.readresult result) { try { iterator<healthdata> iterator = result.iterator(); if (iterator.hasnext()) { healthdata data = iterator.next(); // check the result } } finally { result.close(); } } }; } since: 1.0.0 constructor summary constructors constructor and description healthdataobserver(handler handler) creates a healthdataobserver instance. method summary all methods static methods instance methods abstract methods concrete methods modifier and type method and description static void addobserver(healthdatastore store, string datatypename, healthdataobserver observer) adds an observer that wants to follow data change for the given health data type. abstract void onchange(string datatypename) called if health data registered as an observer is changed. static void removeobserver(healthdatastore store, healthdataobserver observer) removes a registered observer. constructor detail healthdataobserver public healthdataobserver(handler handler) creates a healthdataobserver instance. parameters: handler - the handler to run onchange(string). if it's null, onchange(string) event is run on binder thread which is invoked by samsung health. since: 1.0.0 method detail onchange public abstract void onchange(string datatypename) called if health data registered as an observer is changed. parameters: datatypename - the data type name that health data is changed since: 1.0.0 addobserver public static void addobserver(healthdatastore store, string datatypename, healthdataobserver observer) adds an observer that wants to follow data change for the given health data type. parameters: store - the health data store for connection datatypename - the health data type name to follow change observer - an observer to receive notification if health data is changed throws: illegalargumentexception - if the data type or observer is invalid illegalstateexception - if the instance of health data store is invalid or a remote-invocation error occurs in the connection since: 1.0.0 removeobserver public static void removeobserver(healthdatastore store, healthdataobserver observer) removes a registered observer. parameters: store - health data store for connection observer - the added observer throws: illegalargumentexception - if the observer is invalid illegalstateexception - if the instance of health data store is invalid or a remote-invocation error occurs in the connection since: 1.0.0

verification tool verification tool download | sep 26, 2019 (211.32 kb) samsung health device sdk’s verification tool covers implementation checks for whole samsung health’s device specs on your health. test apps are useful to a simple check for the measured health data’s transmission. use the verification tool after the test apps. the verification tool’s test result file is attached to apply for partner. prerequisites verification tool downloads the verification tool and install it on an android phone. it runs on android 6.0 marshmallow (api level 23) or above. ble health device turn on the phone’s bluetooth. turn on your ble health device that follows samsung health device specs. how to use test apps 1. run the verification tool and select one of health devices in the list. 2. allow the location permission. 3. tap start scan button. 4. select your ble health device. if it is not shown up, check the phone’s bluetooth state or your ble health device. 5. select ok. 6. after few seconds, the test is started automatically. select ok. 7. follow a test guide. measure the blood pressure in your ble health device to send the data to the paired phone. the sending time or method can be different for the health device model. select ok after sending the measured data to the phone. 8. this test guide is shown after finishing the test. 9. a test result is shown. 10. select the top-right more menu and save to file for the test result. the saved file’s location is in android/data/shealth.devicesdk. restart helps a re-test without scanning and pairing steps.

developer mode a partner app can connect with samsung health if its package name and signature (sha256) are same with the registered info in samsung health. the registered app signature is from the partner app's release key. but in many cases, developers use a different app signing key to test or debug the app. to make it easy, samsung health provides a developer mode. the developer mode is not activated by default. activating the developer mode requires an access key from samsung health 6.11. the access key is shared by samsung health team after a partnership approval. how to activate the developer mode you can activate it with the following steps: select the action overflow of samsung health on the top-left. select the settings icon in the action list's top-right. select about samsung health. tap the version line region quickly 10 times or more. the exact region to tap is illustrated with the blue box in the figure below. if it succeeds, a developer mode button displays. select the developer mode button and enter the developer mode page. enter your app package name and access code that samsung health team shared and select the add button. the access code is case-sensitive. if it succeeds, your app package name will be listed up below. it means the developer mode is activated for your app. back to about samsung health with the back button on the top-left and select the info icon on the top-right. now you can test your app with samsung health. if your app package name is not added well please check the entered app package name and access code carefully. they should be matched exactly. a failure can be from entering: a different app package name unmatched case for an access key how long will be maintained the added app's developer mode in the developer mode page is valid until uninstalling samsung health. and it doesn't work for another app that has a different app package name. if samsung health is reinstalled, enter your app package name and its access code. if you remove your app from the developer mode page by selecting the "-" icon, the developer mode will be deactivated for your app.

privacy privacy is a key for handling health data. samsung health sdk for android enables your application to access health data based on the user's consent. permission manager the sdk's supported data types except health document need to gain permission through permissionmanager. an application needs to declare proper permissions for handling required health data types and to consider secureexception when the application didn't gain a user consent. the user can withdraw consent at any time. see permissionmanager for permission declaration and request. samsung health add the partner app's permission info under samsung health > settings > data permissions > [partner app] after a success of healthpermissionmanager.requestpermission() in the partner app. on the other hand, the partner app needs to make a permission setting menu separately. in the menu, the app calls healthpermissionmanager.requestpermission() with required permissions. the samsung health's health data framework pops up the permission ui. a permission result event is retreived after the user's agreement or denial on the permission popup. the app should provide an interface that the user may change data permission at any time. the user consent is limited to the device. even if multiple devices use the same samsung account, the application has to acquire the user consent on each device independently. instant permission a very sensitive data type like a health document requires gaining instant permission. instant permission is created for one-time data access. an app that handles a health document has to call the instant permission api whenever it needs to access data. related apis are: healthdataresolver.insertwithpermission() healthdataresolver.readwithpermission() healthdataresolver.deletewithpermission()