@moshenguo/ms-data-sdk 0.1.5 → 0.1.6

package/build/sdk/bleConst.d.ts

@@ -74,210 +74,422 @@ export declare const DeviceConst: {
     CMD_Set_ActivityAlarm: number;
     CMD_Get_ActivityAlarm: number;
 };
+/**
+ * 蓝牙功能常量
+ *
+ * 用于定义 SDK 支持的蓝牙指令和功能标识。
+ */
 export declare const BleConst: {
+    /** 获取设备时间 */
     GetDeviceTime: string;
+    /** 获取用户个人信息 */
     GetPersonalInfo: string;
+    /** 获取设备信息 */
     GetDeviceInfo: string;
+    /** 实时步数 */
     RealTimeStep: string;
+    /** 获取步数目标 */
     GetStepGoal: string;
+    /** 获取设备电池电量 */
     GetDeviceBatteryLevel: string;
+    /** 获取设备 MAC 地址 */
     GetDeviceMacAddress: string;
+    /** 获取设备固件版本 */
     GetDeviceVersion: string;
+    /** 设备重置指令 */
     CMD_Reset: string;
+    /** MCU 重启指令 */
     CMD_MCUReset: string;
+    /** 通知事件 */
     Notify: string;
+    /** 获取设备名称 */
     GetDeviceName: string;
+    /** 设置闹钟（全部闹钟） */
     SetAlarmClockWithAllClock: string;
+    /** GPS 数据 */
     Gps: string;
+    /** 获取 PPI 数据 */
     GetPPIData: string;
+    /** 获取 HRV 时间值 */
     GetHrvTimeValue: string;
+    /** 关闭设备 */
     CloseDevices: string;
+    /** 获取脱落检测状态 */
     GetOffCheckStatus: string;
+    /** 获取自动心率监测状态 */
     GetAutomaticHRMonitoring: string;
+    /** 获取久坐提醒设置 */
     GetSedentaryReminder: string;
+    /** 获取总活动数据 */
     GetTotalActivityData: string;
+    /** 获取详细活动数据 */
     GetDetailActivityData: string;
+    /** 获取详细睡眠数据 */
     GetDetailSleepData: string;
+    /** 自动血氧测量 */
     AutoBloodOxygen: string;
+    /** 获取动态心率 */
     GetDynamicHR: string;
+    /** ECG 数据 */
     ECGdata: string;
+    /** 获取女性健康数据 */
     GetWomenHealth: string;
+    /** 温度校正指令 */
     CMD_Set_TemperatureCorrection: string;
+    /** 获取静态心率 */
     GetStaticHR: string;
+    /** 血氧 */
     Blood_oxygen: string;
+    /** 获取 HRV 数据 */
     GetHRVData: string;
+    /** 获取腋温数据（带模式） */
     GetAxillaryTemperatureDataWithMode: string;
+    /** 进入二维码扫描模式 */
     EnterQrCode: string;
+    /** 返回二维码带 */
     QrCodeBandBack: string;
+    /** 退出二维码模式 */
     ExitQrCode: string;
+    /** 温度历史数据 */
     Temperature_history: string;
+    /** 获取活动模式数据 */
     GetActivityModeData: string;
+    /** 进入活动模式 */
     EnterActivityMode: string;
+    /** 设置设备时间 */
     SetDeviceTime: string;
+    /** 获取闹钟 */
     GetAlarmClock: string;
+    /** ECG PPG 状态 */
     EcgppGstatus: string;
+    /** 获取 ECG PPG 状态 */
     GetEcgPpgStatus: string;
+    /** 开始 ECG 测量 */
     ENTERECG: string;
+    /** HRV 测量回调 */
     MeasurementHrvCallback: string;
+    /** 心率测量回调 */
     MeasurementHeartCallback: string;
+    /** 血氧测量回调 */
     MeasurementOxygenCallback: string;
+    /** 温度测量回调 */
     MeasurementTempCallback: string;
+    /** 停止 HRV 测量回调 */
     StopMeasurementHrvCallback: string;
+    /** 停止心率测量回调 */
     StopMeasurementHeartCallback: string;
+    /** 停止血氧测量回调 */
     StopMeasurementOxygenCallback: string;
+    /** 停止温度测量回调 */
     StopMeasurementTempCallback: string;
+    /** 表盘设置 */
     Braceletdial: string;
+    /** 表盘设置完成 */
     Braceletdialok: string;
+    /** 获取运动模式 */
     GetSportMode: string;
+    /** GPS 控制指令 */
     GPSControlCommand: string;
+    /** 社交距离获取 */
     SocialdistanceGetting: string;
+    /** ECG PPG */
     EcgppG: string;
+    /** 设备发送数据给 APP */
     DeviceSendDataToAPP: string;
+    /** 设置新设备信息 */
     SetNewDeviceInfo: string;
+    /** 获取新设备信息 */
     GetNewDeviceInfo: string;
+    /** 血糖状态 */
     BoolsugarStatus: string;
+    /** 血糖值 */
     BoolsugarValue: string;
+    /** 获取孕期周期 */
     GetPregnancyCycle: string;
+    /** 设置步数目标 */
     SetStepGoal: string;
+    /** 设置个人信息 */
     SetPersonalInfo: string;
+    /** 设置震动次数 */
     SetMotorVibrationWithTimes: string;
+    /** 设置设备信息 */
     SetDeviceInfo: string;
+    /** 设置自动心率监测 */
     SetAutomaticHRMonitoring: string;
+    /** 设置久坐提醒 */
     SetSedentaryReminder: string;
+    /** 进入拍照模式 */
     EnterPhotoMode: string;
+    /** 返回主界面 */
     BackHomeView: string;
+    /** 天气数据 */
     Weather: string;
+    /** 运动模式 */
     SportMode: string;
+    /** 清除手环数据 */
     Clear_Bracelet_data: string;
+    /** 设置社交距离 */
     SocialdistanceSetting: string;
+    /** SOS 紧急呼叫 */
     Sos: string;
+    /** 设置孕期周期 */
     SetPregnancyCycle: string;
+    /** 删除 ECG 数据 */
     DeleteECGdata: string;
+    /** ECG */
     ECG: string;
+    /** 设置女性健康 */
     SetWomenHealth: string;
+    /** PPG 测量开始成功 */
     ppgStartSucessed: string;
+    /** PPG 测量结果 */
     ppgResult: string;
+    /** PPG 测量停止 */
     ppgStop: string;
+    /** PPG 测量进度 */
     ppgMeasurementProgress: string;
+    /** PPG 测量退出 */
     ppgQuit: string;
+    /** PPG 测量开始失败 */
     ppgStartFailed: string;
+    /** 设置 MAC 地址 */
     CMD_Set_Mac: string;
+    /** 关闭 ECG */
     CloseECG: string;
+    /** 获取闹钟 V4 */
     GetAlarmClock_V4: string;
+    /** 删除所有闹钟 V4 */
     DeleteAllAlarmClock_V4: string;
+    /** 设置闹钟 V4 */
     SetAlarmClock_V4: string;
+    /** 获取久坐提醒 V4 */
     GetSedentaryReminder_V4: string;
+    /** 设置久坐提醒 V4 */
     SetSedentaryReminder_V4: string;
 };
+/**
+ * 设备键名常量，用于读取或写入设备数据的键值。
+ * 外部调用时使用这些常量来避免硬编码字符串。
+ */
 export declare const DeviceKey: {
+    /** 设备时间 */
     DeviceTime: string;
+    /** GPS 时间 */
     GPSTime: string;
+    /** 数据类型 */
     DataType: string;
+    /** 数据结束标识 */
     End: string;
+    /** 数据内容 */
     Data: string;
+    /** 性别 */
     Gender: string;
+    /** 年龄 */
     Age: string;
+    /** 身高，单位 cm */
     Height: string;
+    /** 体重，单位 kg */
     Weight: string;
+    /** 步幅，单位 cm */
     Stride: string;
+    /** 用户设备唯一 ID */
     KUserDeviceId: string;
+    /** 上一次闹钟时间 */
     KClockLast: string;
+    /** 步数 */
     Step: string;
+    /** 卡路里 */
     Calories: string;
+    /** 距离，单位米 */
     Distance: string;
+    /** 运动分钟数 */
     ExerciseMinutes: string;
+    /** 心率 */
     HeartRate: string;
+    /** 活跃分钟数 */
     ActiveMinutes: string;
+    /** 体温数据 */
     TempData: string;
+    /** 血氧 */
     Blood_oxygen: string;
+    /** 目标步数 */
     StepGoal: string;
+    /** 目标距离 */
     DistanceGoal: string;
+    /** 目标卡路里 */
     CalorieGoal: string;
+    /** 睡眠时间目标 */
     SleepTimeGoal: string;
+    /** 电量 */
     BatteryLevel: string;
+    /** 设备 MAC 地址 */
     MacAddress: string;
+    /** 设备版本 */
     DeviceVersion: string;
+    /** 设备名称 */
     DeviceName: string;
+    /** 日期 */
     Date: string;
+    /** 纬度 */
     Latitude: string;
+    /** 经度 */
     Longitude: string;
+    /** 总数据 ID */
     TOTAL_ID: string;
+    /** PPI 数据 ID */
     PPI_ID: string;
+    /** PPI 数据列表 */
     PPI_LIST: string;
+    /** PPI 数据数量 */
     PPI_NUM: string;
+    /** HRV 时间模式 */
     HRV_TIME_MODE: string;
+    /** HRV 时间值 */
     HRV_TIME_Value: string;
+    /** 操作结果 */
     RESULT: string;
+    /** 起身检测标识 */
     GET_OFF_TAG: string;
+    /** 起身检测状态 */
     GET_OFF_STATE: string;
+    /** 距离单位，true = 公里，false = 英里 */
     DistanceUnit: string;
+    /** 时间单位，true = 12小时制，false = 24小时制 */
     TimeUnit: string;
+    /** 举手亮屏状态 */
     StatusOfTheRaisedHandOnscreen: string;
+    /** 温度单位，true = 华氏度，false = 摄氏度 */
     TempUnit: string;
+    /** 夜间模式开关 */
     NightMode: string;
+    /** 基础心率 */
     KBaseHeart: string;
+    /** 屏幕亮度 (0-100) */
     ScreenBrightness: string;
+    /** 表盘界面索引 */
     Dialinterface: string;
+    /** 社交距离开关 */
     SocialDistancedwitch: string;
+    /** 中文或英文显示，0 = 中文，1 = 英文 */
     ChineseOrEnglish: string;
+    /** 工作模式 */
     WorkMode: string;
+    /** 开始时间戳 */
     StartTime: string;
+    /** 心率开始分钟 */
     KHeartStartMinter: string;
+    /** 结束时间戳 */
     EndTime: string;
+    /** 心率结束分钟 */
     KHeartEndMinter: string;
+    /** 周数 */
     Weeks: string;
+    /** 间隔时间 */
     IntervalTime: string;
+    /** 开始小时 */
     StartTimeHour: string;
+    /** 开始分钟 */
     StartTimeMin: string;
+    /** 结束小时 */
     EndTimeHour: string;
+    /** 结束分钟 */
     EndTimeMin: string;
+    /** 最少步数 */
     LeastSteps: string;
+    /** 周几 */
     Week: string;
+    /** 目标值 */
     Goal: string;
+    /** 详细步数分钟 */
     KDetailMinterStep: string;
+    /** 步数数组 */
     ArraySteps: string;
+    /** 睡眠数组 */
     ArraySleep: string;
+    /** 睡眠单位长度 */
     sleepUnitLength: string;
+    /** 静态心率 */
     StaticHR: string;
+    /** 女性健康周期 */
     WomenHealthPeriod: string;
+    /** 女性健康时长 */
     WomenHealthLength: string;
+    /** 温度修正值 */
     TemperatureCorrectionValue: string;
+    /** HRV 数据 */
     HRV: string;
+    /** ECG 心情值 */
     ECGMoodValue: string;
+    /** ECG 值 */
     ECGValue: string;
+    /** 动态心率数组 */
     ArrayDynamicHR: string;
+    /** 闹钟 ID */
     KAlarmId: string;
+    /** 闹钟开关 */
     OpenOrClose: string;
+    /** 闹钟类型 */
     ClockType: string;
+    /** 闹钟时间 */
     ClockTime: string;
+    /** 闹钟分钟 */
     KAlarmMinter: string;
+    /** 闹钟内容 */
     KAlarmContent: string;
+    /** 闹钟长度 */
     KAlarmLength: string;
+    /** 腋温 */
     axillaryTemperature: string;
+    /** 手环编号 */
     Band: string;
+    /** 温度 */
     temperature: string;
+    /** 活动模式 */
     ActivityMode: string;
+    /** 步速 */
     Pace: string;
+    /** 手机数据长度 */
     KPhoneDataLength: string;
+    /** 血管衰老值 */
     VascularAging: string;
+    /** 压力值 */
     Stress: string;
+    /** 高血压 */
     highBP: string;
+    /** 低血压 */
     lowBP: string;
+    /** ECG 状态 */
     EcgStatus: string;
+    /** PPG 值 */
     PPGValue: string;
+    /** ECG HRV 值 */
     ECGHrvValue: string;
+    /** ECG AV Block 值 */
     ECGAvBlockValue: string;
+    /** ECG 心率值 */
     ECGHrValue: string;
+    /** ECG 压力值 */
     ECGStreesValue: string;
+    /** ECG 高血压值 */
     ECGhighBpValue: string;
+    /** ECG 低血压值 */
     ECGLowBpValue: string;
+    /** ECG 呼吸值 */
     ECGBreathValue: string;
+    /** 活动位置时间 */
     KActivityLocationTime: string;
+    /** 活动位置纬度 */
     KActivityLocationLatitude: string;
+    /** 活动位置经度 */
     KActivityLocationLongitude: string;
+    /** 活动位置计数 */
     KActivityLocationCount: string;
+    /** 星期几 */
     DayOfWeek: string;
+    /** 文本 */
     Text: string;
+    /** 文本长度 */
     TextLength: string;
+    /** 是否删除数据 */
     IsDeleteData: string;
 };

package/build/sdk/bleSDK.d.ts

@@ -1,4 +1,7 @@
 import { MyPersonalInfo, MyDeviceInfo, MyAutomaticHRMonitoring, MySedentaryReminderV4 } from './models';
+/**
+ * 数据转成固件指令,调用对应方法返回对应指令,发送这个指令给固件;dataParsingWithData方法固件解析成对象形式返回
+ */
 export declare class BleSDK {
     static DATA_READ_START: number;
     static DATA_READ_CONTINUE: number;

package/build/sdk/models.d.ts

@@ -1,19 +1,58 @@
+/**
+ * 周信息
+ */
+export interface MyWeeksV4 {
+    /** 是否周日启用 */
+    sunday: boolean;
+    /** 是否周一启用 */
+    monday: boolean;
+    /** 是否周二启用 */
+    tuesday: boolean;
+    /** 是否周三启用 */
+    wednesday: boolean;
+    /** 是否周四启用 */
+    thursday: boolean;
+    /** 是否周五启用 */
+    friday: boolean;
+    /** 是否周六启用 */
+    saturday: boolean;
+}
+/**
+ * 个人信息
+ */
 export interface MyPersonalInfo {
+    /** 性别，0 = 女，1 = 男 */
     sex: number;
+    /** 年龄，单位岁 */
     age: number;
+    /** 身高，单位厘米 */
     height: number;
+    /** 体重，单位公斤 */
     weight: number;
+    /** 步长，可选，单位厘米 */
     stepLength?: number;
 }
+/**
+ * 设备详情
+ */
 export interface MyDeviceInfo {
-    DistanceUnit: boolean;
+    /** 距离单位，true = 公里，false = 英里 */
+    distanceUnit: boolean;
+    /** 是否使用 12 小时制，true = 12 小时制，false = 24 小时制 */
     is12Hour: boolean;
-    Hand_up_light_screen_switch: boolean;
-    Fahrenheit: boolean;
-    Nightmode: boolean;
-    baseheart: number;
+    /** 举手亮屏开关，true = 开启，false = 关闭 */
+    handUpLightScreenSwitch: boolean;
+    /** 温度单位，true = 华氏度，false = 摄氏度 */
+    fahrenheit: boolean;
+    /** 夜间模式，true = 开启，false = 关闭 */
+    nightMode: boolean;
+    /** 基础心率 */
+    baseHeart: number;
+    /** 屏幕亮度 (0-100) */
     screenBrightness: number;
+    /** 表盘索引 */
     indexDial: number;
+    /** 语言设置，例如 0 = 中文，1 = 英文 */
     languages: number;
 }
 /**
@@ -66,15 +105,6 @@ export interface MyAutomaticHRMonitoring {
      */
     type: number;
 }
-export interface MyWeeksV4 {
-    sunday: boolean;
-    monday: boolean;
-    Tuesday: boolean;
-    Wednesday: boolean;
-    Thursday: boolean;
-    Friday: boolean;
-    Saturday: boolean;
-}
 /**
  * 久坐提醒配置（V4）
  *
@@ -120,13 +150,3 @@ export interface MySedentaryReminderV4 {
      */
     mode: number;
 }
-export interface MyAlarmClockV4 {
-    openOrClose: number;
-    clockType: number;
-    endTime_Hour: number;
-    endTime_Minutes: number;
-    weeks: number;
-    intervalTime: number;
-    leastSteps: number;
-    mode: number;
-}