@moshenguo/ms-data-sdk 0.1.5 → 0.1.7

package/build/sdk/bleConst.d.ts

@@ -74,210 +74,422 @@ export declare const DeviceConst: {
     CMD_Set_ActivityAlarm: number;
     CMD_Get_ActivityAlarm: number;
 };
+/**
+ * Bluetooth Feature Constants
+ *
+ * Defines supported Bluetooth commands and feature identifiers for the SDK.
+ */
 export declare const BleConst: {
+    /** Get device time */
     GetDeviceTime: string;
+    /** Get user personal information */
     GetPersonalInfo: string;
+    /** Get device information */
     GetDeviceInfo: string;
+    /** Real-time steps */
     RealTimeStep: string;
+    /** Get step goal */
     GetStepGoal: string;
+    /** Get device battery level */
     GetDeviceBatteryLevel: string;
+    /** Get device MAC address */
     GetDeviceMacAddress: string;
+    /** Get device firmware version */
     GetDeviceVersion: string;
+    /** Device reset command */
     CMD_Reset: string;
+    /** MCU restart command */
     CMD_MCUReset: string;
+    /** Notification event */
     Notify: string;
+    /** Get device name */
     GetDeviceName: string;
+    /** Set alarm clocks (all clocks) */
     SetAlarmClockWithAllClock: string;
+    /** GPS data */
     Gps: string;
+    /** Get PPI data */
     GetPPIData: string;
+    /** Get HRV time values */
     GetHrvTimeValue: string;
+    /** Turn off device */
     CloseDevices: string;
+    /** Get off-wrist detection status */
     GetOffCheckStatus: string;
+    /** Get automatic heart rate monitoring status */
     GetAutomaticHRMonitoring: string;
+    /** Get sedentary reminder settings */
     GetSedentaryReminder: string;
+    /** Get total activity data */
     GetTotalActivityData: string;
+    /** Get detailed activity data */
     GetDetailActivityData: string;
+    /** Get detailed sleep data */
     GetDetailSleepData: string;
+    /** Automatic blood oxygen measurement */
     AutoBloodOxygen: string;
+    /** Get dynamic heart rate */
     GetDynamicHR: string;
+    /** ECG data */
     ECGdata: string;
+    /** Get women’s health data */
     GetWomenHealth: string;
+    /** Temperature calibration command */
     CMD_Set_TemperatureCorrection: string;
+    /** Get static heart rate */
     GetStaticHR: string;
+    /** Blood oxygen */
     Blood_oxygen: string;
+    /** Get HRV data */
     GetHRVData: string;
+    /** Get axillary temperature with mode */
     GetAxillaryTemperatureDataWithMode: string;
+    /** Enter QR code scan mode */
     EnterQrCode: string;
+    /** Return QR code band */
     QrCodeBandBack: string;
+    /** Exit QR code mode */
     ExitQrCode: string;
+    /** Temperature history data */
     Temperature_history: string;
+    /** Get activity mode data */
     GetActivityModeData: string;
+    /** Enter activity mode */
     EnterActivityMode: string;
+    /** Set device time */
     SetDeviceTime: string;
+    /** Get alarm clock */
     GetAlarmClock: string;
+    /** ECG PPG status */
     EcgppGstatus: string;
+    /** Get ECG PPG status */
     GetEcgPpgStatus: string;
+    /** Start ECG measurement */
     ENTERECG: string;
+    /** HRV measurement callback */
     MeasurementHrvCallback: string;
+    /** Heart rate measurement callback */
     MeasurementHeartCallback: string;
+    /** Oxygen measurement callback */
     MeasurementOxygenCallback: string;
+    /** Temperature measurement callback */
     MeasurementTempCallback: string;
+    /** Stop HRV measurement callback */
     StopMeasurementHrvCallback: string;
+    /** Stop heart rate measurement callback */
     StopMeasurementHeartCallback: string;
+    /** Stop oxygen measurement callback */
     StopMeasurementOxygenCallback: string;
+    /** Stop temperature measurement callback */
     StopMeasurementTempCallback: string;
+    /** Watch face setting */
     Braceletdial: string;
+    /** Watch face set successfully */
     Braceletdialok: string;
+    /** Get sport mode */
     GetSportMode: string;
+    /** GPS control command */
     GPSControlCommand: string;
+    /** Get social distance */
     SocialdistanceGetting: string;
+    /** ECG PPG */
     EcgppG: string;
+    /** Device sends data to app */
     DeviceSendDataToAPP: string;
+    /** Set new device info */
     SetNewDeviceInfo: string;
+    /** Get new device info */
     GetNewDeviceInfo: string;
+    /** Blood sugar status */
     BoolsugarStatus: string;
+    /** Blood sugar value */
     BoolsugarValue: string;
+    /** Get pregnancy cycle */
     GetPregnancyCycle: string;
+    /** Set step goal */
     SetStepGoal: string;
+    /** Set personal info */
     SetPersonalInfo: string;
+    /** Set vibration times */
     SetMotorVibrationWithTimes: string;
+    /** Set device info */
     SetDeviceInfo: string;
+    /** Set automatic heart rate monitoring */
     SetAutomaticHRMonitoring: string;
+    /** Set sedentary reminder */
     SetSedentaryReminder: string;
+    /** Enter photo mode */
     EnterPhotoMode: string;
+    /** Return to home screen */
     BackHomeView: string;
+    /** Weather data */
     Weather: string;
+    /** Sport mode */
     SportMode: string;
+    /** Clear bracelet data */
     Clear_Bracelet_data: string;
+    /** Set social distance */
     SocialdistanceSetting: string;
+    /** SOS emergency call */
     Sos: string;
+    /** Set pregnancy cycle */
     SetPregnancyCycle: string;
+    /** Delete ECG data */
     DeleteECGdata: string;
+    /** ECG */
     ECG: string;
+    /** Set women health data */
     SetWomenHealth: string;
+    /** PPG measurement start successful */
     ppgStartSucessed: string;
+    /** PPG measurement result */
     ppgResult: string;
+    /** PPG measurement stop */
     ppgStop: string;
+    /** PPG measurement progress */
     ppgMeasurementProgress: string;
+    /** PPG measurement exit */
     ppgQuit: string;
+    /** PPG measurement start failed */
     ppgStartFailed: string;
+    /** Set MAC address */
     CMD_Set_Mac: string;
+    /** Close ECG */
     CloseECG: string;
+    /** Get alarm clock V4 */
     GetAlarmClock_V4: string;
+    /** Delete all alarm clocks V4 */
     DeleteAllAlarmClock_V4: string;
+    /** Set alarm clock V4 */
     SetAlarmClock_V4: string;
+    /** Get sedentary reminder V4 */
     GetSedentaryReminder_V4: string;
+    /** Set sedentary reminder V4 */
     SetSedentaryReminder_V4: string;
 };
+/**
+ * Device key constants, used for reading/writing device data.
+ * External calls should use these constants to avoid hardcoded strings.
+ */
 export declare const DeviceKey: {
+    /** Device time */
     DeviceTime: string;
+    /** GPS time */
     GPSTime: string;
+    /** Data type */
     DataType: string;
+    /** End of data */
     End: string;
+    /** Data content */
     Data: string;
+    /** Gender */
     Gender: string;
+    /** Age */
     Age: string;
+    /** Height in cm */
     Height: string;
+    /** Weight in kg */
     Weight: string;
+    /** Stride in cm */
     Stride: string;
+    /** Unique user device ID */
     KUserDeviceId: string;
+    /** Last alarm time */
     KClockLast: string;
+    /** Steps */
     Step: string;
+    /** Calories */
     Calories: string;
+    /** Distance in meters */
     Distance: string;
+    /** Exercise minutes */
     ExerciseMinutes: string;
+    /** Heart rate */
     HeartRate: string;
+    /** Active minutes */
     ActiveMinutes: string;
+    /** Temperature data */
     TempData: string;
+    /** Blood oxygen */
     Blood_oxygen: string;
+    /** Step goal */
     StepGoal: string;
+    /** Distance goal */
     DistanceGoal: string;
+    /** Calorie goal */
     CalorieGoal: string;
+    /** Sleep time goal */
     SleepTimeGoal: string;
+    /** Battery level */
     BatteryLevel: string;
+    /** Device MAC address */
     MacAddress: string;
+    /** Device version */
     DeviceVersion: string;
+    /** Device name */
     DeviceName: string;
+    /** Date */
     Date: string;
+    /** Latitude */
     Latitude: string;
+    /** Longitude */
     Longitude: string;
+    /** Total data ID */
     TOTAL_ID: string;
+    /** PPI data ID */
     PPI_ID: string;
+    /** PPI data list */
     PPI_LIST: string;
+    /** PPI data count */
     PPI_NUM: string;
+    /** HRV time mode */
     HRV_TIME_MODE: string;
+    /** HRV time value */
     HRV_TIME_Value: string;
+    /** Result */
     RESULT: string;
+    /** Get off-wrist flag */
     GET_OFF_TAG: string;
+    /** Get off-wrist state */
     GET_OFF_STATE: string;
+    /** Distance unit, true = km, false = miles */
     DistanceUnit: string;
+    /** Time unit, true = 12h, false = 24h */
     TimeUnit: string;
+    /** Raise hand screen-on status */
     StatusOfTheRaisedHandOnscreen: string;
+    /** Temperature unit, true = Fahrenheit, false = Celsius */
     TempUnit: string;
+    /** Night mode switch */
     NightMode: string;
+    /** Base heart rate */
     KBaseHeart: string;
+    /** Screen brightness (0-100) */
     ScreenBrightness: string;
+    /** Watch face index */
     Dialinterface: string;
+    /** Social distance switch */
     SocialDistancedwitch: string;
+    /** Language display, 0 = Chinese, 1 = English */
     ChineseOrEnglish: string;
+    /** Work mode */
     WorkMode: string;
+    /** Start timestamp */
     StartTime: string;
+    /** Heart rate start minute */
     KHeartStartMinter: string;
+    /** End timestamp */
     EndTime: string;
+    /** Heart rate end minute */
     KHeartEndMinter: string;
+    /** Week number */
     Weeks: string;
+    /** Interval time */
     IntervalTime: string;
+    /** Start hour */
     StartTimeHour: string;
+    /** Start minute */
     StartTimeMin: string;
+    /** End hour */
     EndTimeHour: string;
+    /** End minute */
     EndTimeMin: string;
+    /** Minimum steps */
     LeastSteps: string;
+    /** Day of week */
     Week: string;
+    /** Target value */
     Goal: string;
+    /** Detailed step minutes */
     KDetailMinterStep: string;
+    /** Steps array */
     ArraySteps: string;
+    /** Sleep array */
     ArraySleep: string;
+    /** Sleep unit length */
     sleepUnitLength: string;
+    /** Static heart rate */
     StaticHR: string;
+    /** Women health period */
     WomenHealthPeriod: string;
+    /** Women health duration */
     WomenHealthLength: string;
+    /** Temperature correction value */
     TemperatureCorrectionValue: string;
+    /** HRV data */
     HRV: string;
+    /** ECG mood value */
     ECGMoodValue: string;
+    /** ECG value */
     ECGValue: string;
+    /** Dynamic heart rate array */
     ArrayDynamicHR: string;
+    /** Alarm ID */
     KAlarmId: string;
+    /** Alarm switch */
     OpenOrClose: string;
+    /** Alarm type */
     ClockType: string;
+    /** Alarm time */
     ClockTime: string;
+    /** Alarm minute */
     KAlarmMinter: string;
+    /** Alarm content */
     KAlarmContent: string;
+    /** Alarm length */
     KAlarmLength: string;
+    /** Axillary temperature */
     axillaryTemperature: string;
+    /** Band number */
     Band: string;
+    /** Temperature */
     temperature: string;
+    /** Activity mode */
     ActivityMode: string;
+    /** Pace */
     Pace: string;
+    /** Phone data length */
     KPhoneDataLength: string;
+    /** Vascular aging value */
     VascularAging: string;
+    /** Stress value */
     Stress: string;
+    /** High blood pressure */
     highBP: string;
+    /** Low blood pressure */
     lowBP: string;
+    /** ECG status */
     EcgStatus: string;
+    /** PPG value */
     PPGValue: string;
+    /** ECG HRV value */
     ECGHrvValue: string;
+    /** ECG AV Block value */
     ECGAvBlockValue: string;
+    /** ECG heart rate */
     ECGHrValue: string;
+    /** ECG stress value */
     ECGStreesValue: string;
+    /** ECG high blood pressure */
     ECGhighBpValue: string;
+    /** ECG low blood pressure */
     ECGLowBpValue: string;
+    /** ECG breath value */
     ECGBreathValue: string;
+    /** Activity location time */
     KActivityLocationTime: string;
+    /** Activity location latitude */
     KActivityLocationLatitude: string;
+    /** Activity location longitude */
     KActivityLocationLongitude: string;
+    /** Activity location count */
     KActivityLocationCount: string;
+    /** Day of week */
     DayOfWeek: string;
+    /** Text */
     Text: string;
+    /** Text length */
     TextLength: string;
+    /** Whether to delete data */
     IsDeleteData: string;
 };