Mega Ble SDK Document（Android）

name: megablelibopen

• EN | 中文
• Simple Document

Files

• arr v1.6.27
• .so v11449
• demo v1.0.22

Changelog

Quick start

1. Android studio import .arr and .so.
2. Create MegaBleClient by MegaBleBuilder with context, megaBleCallback.
3. Scan for a target by Android standard BLE api.
4. client.connect(target) // client will take care of the interaction with target.
5. Sdk will control BLE state and feedback BLE INFO to user
6. (must)After sdk initialize BLE client：
   1. If no token, use startWithoutToken(userId, mac), to wait for a token which ring will send after shaking.
   2. if there is a token, use startWithToken(userId, token)
7. (must) setUserInfo(...)。The CONNECTION will be stable after this step.
8. Idle. // It's time to control the device, eg. enable/disable monitoring, syncing monitor data
9. Parse data

API：

• final public class MegaBleBuilder

  client = new MegaBleBuilder()
              .withSecretId(id)
              .withSecretKey(key)
              .withContext(context)
              .uploadData(true) //enable upload data to optimize algorithm.(default is false), Pls store data by yourself, if disabled.
              .withCallback(megaBleCallback)
              .build();

• public class MegaBleClient

  client.toggleLive(true); // Turn on/off the global real-time channel.Compatible：liveSPO2/sport/SPO2Monitor/pulse
  client.getV2Mode(); // Get current mode.
  client.enableV2ModeLiveSpo(true); // Turn on liveSPO2 mode
  client.enableV2ModeDaily(true); // Turn off liveSPO2/sport/SPO2Monitor
  client.enableV2ModeSpoMonitor(true); // Turn on SPO2Monitor(Sleep SPO2Monitor) mode
  client.enableV2ModeSport(true); // Turn on sport mode
  client.enableV2ModePulse(true); // Turn on pulse mode
  client.enableRawdataSpo // Turn on SPO2 rawdata(need turn on liveSPO2/sport/SPO2Monitor/pulse)
  client.enableRawdataPulse // Turn on pulse rawdata(need turn on pulse mode)
  client.disableRawdata // Turn off rawdata
  client.enableV2HRV(true) //Turn on HRV
  client.enableV2HRV(false) //Turn off HRV
  client.syncData() // Sync monitor data
  client.syncDailyData() // Sync daily step data
  client.syncHrvData() // Sync HRV data
  client.getRawData() //Get rawdata
  client.getV2PeriodSetting() // Get period monitor setting (MegaBleCallback.onV2PeriodSettingReceived show setting info)
  client.enableV2PeriodMonitor(true, boolean isLoop, int monitorDuration, int timeLeft) // open period monitor params：true、isLoop、duration(s)、timeLeft(s)
  client.enableV2PeriodMonitor(false, false, 0, 0) // close period monitor
  client.parseSpoPr(bytes, callback) // parse SPO2Monitor data
  client.parseSport(bytes, callback) // parse Sport data
  client.parseSpoPrOld(bytes, callback) // parse SPO2Monitor data(Deprecated, use parseSpoPr())
  client.parseSportOld(bytes, callback) // parse Sport data(Deprecated, use parseSport())
  client.startDfu() // enter to dfu mode to upgrade firmware.
  client.getCrashLog() // get crash log, recommend to get crash log after sync data.
  client.parseDailyEntry(bytes) //pasre daily data
  client.enableV2ModeEcgBp(true/false, megaRawdataConfig) // turn on or turn off blood pressure
  client.parseBpData(bytes, timeHHmm, caliSBP, caliDBP) // parse blood pressure data. Params example:bytes=[], timeHHmm= 831, caliSBP=134.0, caliDBP=80.0
  client.parseHrvData(bytes, callback) //parse HRV data

• public abstract class MegaBleCallback

  void onConnectionStateChange(boolean connected);
  void onError(int code)
  void onStart() // call startWithoutToken/startWithToken
  void onSetUserInfo() // call setUserInfo
  void onIdle() // ready to do work
  void onKnockDevice() // only happened when there is no token or token changed
  void onTokenReceived(String token) // user should save
  void onRssiReceived(int rssi)
  void onDeviceInfoReceived(MegaBleDevice device)
  void onBatteryChanged(int value, int status)
  void onReadyToDfu()
  void onSyncingDataProgress(int progress)
  void onSyncMonitorDataComplete(byte[] bytes, int dataStopType, int dataType, String uid, int steps)
  void onSyncDailyDataComplete(byte[] bytes)
  void onSyncNoDataOfMonitor()
  void onSyncNoDataOfDaily()
  void onSyncNoDataOfHrv()
  void onOperationStatus(int status)
  void onHeartBeatReceived(MegaBleHeartBeat heartBeat)
  void onV2LiveSpoMonitor(MegaV2LiveSpoMonitor live); // SPO2/Sleep live data
  void onV2LiveSport(MegaV2LiveSport live); // Sport live data
  void onV2LiveSpoLive(MegaV2LiveSpoLive live); // Live SPO2 data
  void onV2ModeReceived(MegaV2Mode mode) // get current mode
  void onV2PeriodSettingReceived(setting: MegaV2PeriodSetting) // get current periodic monitor setting
  void onCrashLogReceived(bytes: ByteArray?)// return crash log
  //Parse rawdata
  void onRawdataParsed(MegaRawData[]);
  void onRawdataParsed([]);//Deprecated
  void onTotalBpDataReceived(data, duration) // return total blood pressure data and duration
  void onRawDataComplete(String path, int length) //Called when getting rawdata is completed

• public class ParsedSpoPrBean（Deprecated, use MegaSpoPrBean）

  Parse SPO2 data：SPO2、PR、sleep area etc.

• public class ParsedPrBean（Deprecated, use MegaPrBean）

  Parse sport data：PR etc.

• public class MegaDailyParsedResult

  Parse daily data

• public class MegaDailyBean

  daily data detail

• public class ParsedBPBean

  blood pressure data detail

• public class ParsedHRVBean

  HRV data detail

• native library

  • jniLibs

• dfu（firmware upgrade）dependencies

  // dfu lib. higher dfu lib may not work, use this one
  // href：https://github.com/NordicSemiconductor/Android-DFU-Library
  // If you use proguard, add the following line to your proguard rules: -keep class no.nordicsemi.android.dfu.** { *; }
  TargetSdk < 31
  implementation 'no.nordicsemi.android:dfu:1.8.1'
  TargetSdk >= 31
  implementation 'no.nordicsemi.android:dfu:2.0.2'

• Parse MegaAdvertising

  • MegaAdvParse.parse (MegaRing V3)
  • MegaBleClient.parseScanRecord (MegaRing V2)

• Algorithm version

  • MegaBleClient.megaParseVersion()

Description

Recommend workflow

Workflow pdf

Permissions required

bluetooth, write file, internet, GPS minSdkVersion 19 targetSdkVersion 28

• It is recommended to refer to the demo source code and run the experience

Wearing Test

1. Switch to liveSPO2 mode
2. onV2LiveSpoLive() will return MegaV2LiveSpoLive data
3. Guide user to pose the specified gestures. If the user wears the ring correctly: accY = 0 when fingers point to the ground; accZ = 0 when Palms up.

Tips of calculate daily data

1.Start of MegaDailyBean need calculate by yourself. start = MegaDailyBean.time-dailyUnit*60
2.The unit of temp  is ℃ ,temp/10  to get  temperature .
3.Please control the timing of sync daily data by yourself.

How to get temperature in monitoring

1.Stop monitoring
2.Sync daily data
3.Parse daily data
4.Sync monitor data
5.Parse monitor data and combine with filter daily data that synced by step 2
(Daily data's start and end must between in monitor data's startAt and endAt.The developers can store timestamps and temperature by yourself)

How to get blood pressure data

1.Implement MegaBleCallback.onTotalBpDataReceived() //This function will return bp data and test duration.
2.client.enableV2ModeEcgBp(true, megaRawdataConfig) //start blood pressure test
3.Use data from onTotalBpDataReceived() and call client.parseBpData() to get blood pressure data
4.client.enableV2ModeEcgBp(false, megaRawdataConfig) //stop blood pressure if ParsedBPBean.flag = 1 or test duration greater than 60s
(Tips:Please tell user to set caliSBP and caliDBP before blood pressure test.caliSBP is user's history of Systolic Blood Pressure, caliDBP is user's history of Diastolic Blood Pressure.)

How to get HRV data

1.If the ring firmware version is greater than 5.0.11804, you need to call client.enableV2HRV(true) to turn on the HRV switch after entering sleep monitoring.
2.Implement MegaBleCallback.onSyncNoDataOfHrv()// Sync HRV data done.
3.Call client.syncHrvData() to sync HRV data.
4.Use data from onSyncMonitorDataComplete() and call client.parseHrvData() to get HRV data after HRV data synced.
(Tips:HRV data is based on SPO2Monitor(Sleep SPO2Monitor).You can sync hrv data when monitor data synced.HRV data's type is 10.MegaBleCallback.onSyncMonitorDataComplete() will return hrv data)

How to get rawdata

1. Call getRawData() to get rawdata
2. Using onSyncingDataProgress() returns the progress of getting rawdata
3. Using onRawDataComplete() returns the local path of rawdata when getting rawdata is completed

Tips of upgrading firmware

1.Battery value should be greater than 25%
2.Battery status should be normal/charging/full
3.Add FOREGROUND_SERVICE permission(android.permission.FOREGROUND_SERVICE) to AndroidManifest.xml if targetSdkVersion >= 28

Remarks

• Please view the output information with the android studio console
• Please search for the button name in the demo source code to view the response event. For detailed api, please refer to the online java doc
• The Ring can save data in itself when enabling monitoring. So it is not necessary to keep connection between ring and phone. After monitoring started, it's ok to disconnect.
• All data will be wiped out if TOKEN is changed.
• Please check the returned fields carefully, If you change to new parse functions.
• Data and Log path (client.setDebugEnable(true)). Recommend always open both develop environment and official environment.
  • version < 1.6.18：
    log--->sdcard/megaBle/log
    data--->sdcard/megaBle/data
  • version >= 1.6.18：
    log--->Android/data/{applicationId}/files/megaBle/log
    data--->Android/data/{applicationId}/files/megaBle/data
• Developers need to continuously collect 10s-20s real-time values to judge wearing.If the user wears the ring correctly:accY = 0 when fingers point to the ground; accZ = 0 when Palms up.
• Blood Pressure and HRV is only support for ring's sn start with C11E[7|8|9].Please control the calling time by yourself