@moshenguo/ms-data-sdk 0.1.5 → 0.1.7

package/build/sdk/models.d.ts

@@ -1,132 +1,125 @@
+/**
+ * Week information
+ */
+export interface MyWeeksV4 {
+    /** Whether Sunday is enabled */
+    sunday: boolean;
+    /** Whether Monday is enabled */
+    monday: boolean;
+    /** Whether Tuesday is enabled */
+    tuesday: boolean;
+    /** Whether Wednesday is enabled */
+    wednesday: boolean;
+    /** Whether Thursday is enabled */
+    thursday: boolean;
+    /** Whether Friday is enabled */
+    friday: boolean;
+    /** Whether Saturday is enabled */
+    saturday: boolean;
+}
+/**
+ * Personal information
+ */
 export interface MyPersonalInfo {
+    /** Gender, 0 = female, 1 = male */
     sex: number;
+    /** Age in years */
     age: number;
+    /** Height in centimeters */
     height: number;
+    /** Weight in kilograms */
     weight: number;
+    /** Step length (optional), in centimeters */
     stepLength?: number;
 }
+/**
+ * Device details
+ */
 export interface MyDeviceInfo {
-    DistanceUnit: boolean;
+    /** Distance unit, true = kilometers, false = miles */
+    distanceUnit: boolean;
+    /** Whether using 12-hour format, true = 12-hour, false = 24-hour */
     is12Hour: boolean;
-    Hand_up_light_screen_switch: boolean;
-    Fahrenheit: boolean;
-    Nightmode: boolean;
-    baseheart: number;
+    /** Hand-up screen light switch, true = on, false = off */
+    handUpLightScreenSwitch: boolean;
+    /** Temperature unit, true = Fahrenheit, false = Celsius */
+    fahrenheit: boolean;
+    /** Night mode, true = on, false = off */
+    nightMode: boolean;
+    /** Base heart rate */
+    baseHeart: number;
+    /** Screen brightness (0-100) */
     screenBrightness: number;
+    /** Dial index */
     indexDial: number;
+    /** Language setting, e.g., 0 = Chinese, 1 = English */
     languages: number;
 }
 /**
- * 自动心率监测配置
+ * Automatic heart rate monitoring configuration
  *
- * 用于定义用户在一周内自动心率监测的时间段、周期和类型。
+ * Defines the time periods, cycles, and types for automatic heart rate monitoring in a week.
  */
 export interface MyAutomaticHRMonitoring {
     /**
-     * 是否开启监测
-     * - 0 = 关闭
-     * - 1 = 开启
+     * Whether monitoring is enabled
+     * - 0 = off
+     * - 1 = on
      */
     open: number;
-    /**
-     * 开始监测的小时数（0-23）
-     */
+    /** Start hour of monitoring (0-23) */
     startHour: number;
-    /**
-     * 开始监测的分钟数（0-59）
-     */
+    /** Start minute of monitoring (0-59) */
     startMinute: number;
-    /**
-     * 结束监测的小时数（0-23）
-     */
+    /** End hour of monitoring (0-23) */
     endHour: number;
-    /**
-     * 结束监测的分钟数（0-59）
-     */
+    /** End minute of monitoring (0-59) */
     endMinute: number;
     /**
-     * 星期设置（按位表示）
-     * - 1 = 周一
-     * - 2 = 周二
-     * - 4 = 周三
-     * - 8 = 周四
-     * - 16 = 周五
-     * - 32 = 周六
-     * - 64 = 周日
+     * Week configuration (bitmask)
+     * - 1 = Monday
+     * - 2 = Tuesday
+     * - 4 = Wednesday
+     * - 8 = Thursday
+     * - 16 = Friday
+     * - 32 = Saturday
+     * - 64 = Sunday
      *
-     * 可组合，例如：`1 + 2 + 4 = 7` 表示周一到周三
+     * Can be combined, e.g., `1 + 2 + 4 = 7` means Monday to Wednesday
      */
     week: number;
-    /**
-     * 采样时间间隔（秒）
-     */
+    /** Sampling interval in seconds */
     time: number;
-    /**
-     * 1、设置心率 2、设置血氧  4、设置HRV
-     */
+    /** 1 = heart rate, 2 = SpO2, 4 = HRV */
     type: number;
 }
-export interface MyWeeksV4 {
-    sunday: boolean;
-    monday: boolean;
-    Tuesday: boolean;
-    Wednesday: boolean;
-    Thursday: boolean;
-    Friday: boolean;
-    Saturday: boolean;
-}
 /**
- * 久坐提醒配置（V4）
+ * Sedentary reminder configuration (V4)
  *
- * 用于定义用户在一天内的久坐提醒时间段、周期和规则。
+ * Defines the time periods, cycles, and rules for sedentary reminders in a day.
  */
 export interface MySedentaryReminderV4 {
-    /**
-     * 开始提醒的小时数（0–23）
-     */
+    /** Start hour of reminder (0–23) */
     startTime_Hour: number;
-    /**
-     * 开始提醒的分钟数（0–59）
-     */
+    /** Start minute of reminder (0–59) */
     startTime_Minutes: number;
-    /**
-     * 结束提醒的小时数（0–23）
-     */
+    /** End hour of reminder (0–23) */
     endTime_Hour: number;
-    /**
-     * 结束提醒的分钟数（0–59）
-     */
+    /** End minute of reminder (0–59) */
     endTime_Minutes: number;
-    /**
-     * 一周中的提醒天数配置
-     *
-     */
+    /** Weekdays configuration for reminders */
     weeks: MyWeeksV4;
-    /**
-     * 提醒间隔时间（分钟）
-     */
+    /** Reminder interval time in minutes */
     intervalTime: number;
-    /**
-     * 最低步数门槛
-     *
-     * 如果在间隔时间内步数少于此值，则触发久坐提醒。
+    /** Minimum step threshold
+     *  If steps within the interval are below this value, the sedentary reminder is triggered.
      */
     leastSteps: number;
     /**
-     * 提醒模式
-     * - 0 = 震动
-     * - 1 = 声音
-     * - 2 = 混合提醒
+     * Reminder mode
+     * - 0 = vibration
+     * - 1 = sound
+     * - 2 = mixed
      */
     mode: number;
 }
-export interface MyAlarmClockV4 {
-    openOrClose: number;
-    clockType: number;
-    endTime_Hour: number;
-    endTime_Minutes: number;
-    weeks: number;
-    intervalTime: number;
-    leastSteps: number;
-    mode: number;
-}

package/build/sdk/resolveUtil.d.ts

@@ -1,30 +1,120 @@
+/**
+ * Byte operation utility class Data parsing class.
+ * Takes Bluetooth data as input and returns it as a dictionary object.
+ */
 export declare class ResolveUtil {
-    static crcValue(value: number[]): void;
     private static hexByte2Int;
     private static bcd2String;
     static intList2String(bytes: number[]): string;
     static intList3String(bytes: number[]): string;
+    /**
+   * Device time parser
+   * @param value - The raw value from the device
+   * @returns The parsed device time
+   */
     static setMacSuccessful(): {
         [key: string]: any;
     };
     private static intBitToDouble;
+    /**
+    * Get device time
+    * @param value - The raw value from the device
+    * @returns The parsed device time
+    */
     static getDeviceTime(value: number[]): any;
     private static int2Ascll;
+    /**
+   * Parse GPS time
+   * @param value - The raw GPS data
+   * @returns The parsed GPS time
+   */
     static getGpsTime(value: number[]): string;
+    /**
+   * Parse user information
+   * @param value - The raw user data
+   * @returns The parsed user information
+   */
     static getUserInfo(value: number[]): any;
+    /**
+   * Parse device information
+   * @param value - Raw data from the device
+   * @returns Parsed device information
+   */
     static getDeviceInfo(value: number[]): any;
+    /**
+   * Parse real-time step information
+   * @param value - Raw data from the device
+   * @returns Parsed real-time step data
+   */
     static getActivityData(value: number[]): any;
+    /**
+   * Parse step goal information
+   * @param value - Raw data from the device
+   * @returns Parsed step goal data
+   */
     static getGoal(value: number[]): any;
+    /**
+     * Device Power Analysis
+     * @param value
+     * @returns
+     */
     static getDeviceBattery(value: number[]): any;
+    /**
+     * Device MAC Address Resolution
+     * @param value
+     * @returns
+     */
     static getDeviceAddress(value: number[]): any;
+    /**
+     * Device Version Number Parsing
+     * @param value
+     * @returns
+     */
     static getDeviceVersion(value: number[]): any;
-    static Reset(): any;
-    static MCUReset(): any;
-    static Notify(): any;
+    /**
+     * Restore factory settings
+     * @returns
+     */
+    static reset(): any;
+    /**
+     * MCU Software Reset Instruction
+     * @returns
+     */
+    static mcuReset(): any;
+    /**
+     * Third-Party Reminder Command
+     * @returns
+     */
+    static notify(): any;
+    /**
+     * Device Name Resolution
+     * @param value
+     * @returns
+     */
     static getDeviceName(value: number[]): any;
+    /**
+     * Analysis of Automatic Heart Rate Measurement Time Intervals
+     * @param value
+     * @returns
+     */
     static getAutoHeart(value: number[]): any;
+    /**
+     * Weekly Analysis Tool
+     * @param ar
+     * @returns Byte data
+     */
     static getWeekInt(ar: number[]): number;
+    /**
+     * Byte to string
+     * @param b
+     * @returns
+     */
     static getByteString(b: number): string;
+    /**
+     * Byte Array Parsing
+     * @param b
+     * @returns
+     */
     static getByteArray(b: number): string;
     /**
      * 字节转整数（对应原 _hexByte2Int）
@@ -38,75 +128,276 @@ export declare class ResolveUtil {
      */
     private static _bcd2String;
     /**
-     * 久坐提醒
+     * Sedentary Reminder
+     * @param value
+     * @returns
      */
-    static getActivityAlarm(value: number[]): object;
+    static getActivityAlarm(value: number[]): any;
     /**
-     * 总运动数据解析
+     * Analysis of Overall Movement Data
+     * @param value
+     * @returns
      */
     static getTotalStepData(value: number[]): object;
     /**
-     * 详细运动数据解析
+     * Detailed Analysis of Sports Data
+     * @param value
+     * @returns
      */
-    static getDetailData(value: number[]): object;
+    static getDetailData(value: number[]): any;
     /**
-     * 睡眠数据解析
+     *  Sleep Data Analysis
+     * @param value
+     * @returns
      */
-    static getSleepData(value: number[]): object;
+    static getSleepData(value: number[]): any;
     /**
-     * 自动血氧数据解析
+     * Automated Blood Oxygen Data Analysis
+     * @param value
+     * @returns
      */
-    static getAutoBloodOxygen(value: number[]): object;
+    static getAutoBloodOxygen(value: number[]): any;
     /**
-     * 历史血氧数据解析（与自动血氧逻辑一致，复用代码）
+     * Historical Blood Oxygen Data Analysis (Consistent with automatic blood oxygen logic, reusing code)
+     * @param value
+     * @returns
      */
-    static getBloodoxygen(value: number[]): object;
+    static getBloodoxygen(value: number[]): any;
     /**
-     * 历史心率数据解析
+     * Historical Heart Rate Data Analysis
+     * @param value
+     * @returns
      */
-    static getHeartData(value: number[]): object;
+    static getHeartData(value: number[]): any;
     /**
-     * 单次历史心率数据解析
+     * Single-Session Historical Heart Rate Data Analysis
+     * @param value
+     * @returns
+     */
+    static getOnceHeartData(value: number[]): any;
+    /**
+     * HRV Test Data Analysis HRV Test Data Analysis
+     * @param value
+     * @returns
      */
-    static getOnceHeartData(value: number[]): object;
     static getHrvTestData(value: number[]): any;
+    /**
+     * Alarm Clock Data Analysis
+     * @param value
+     * @returns
+     */
     static getClockData(value: number[]): any;
+    /**
+     * Analysis of Axillary Temperature Data
+     * @param value
+     * @returns
+     */
     static getTempDataer(value: number[]): any;
+    /**
+     * QR Code-Related Functions
+     * @param value
+     * @param flag
+     * @returns
+     */
     static getQrCode(value: number[], flag: boolean): any;
+    /**
+     * Analysis of Historical Temperature Data
+     * @param value
+     * @returns
+     */
     static getTempData(value: number[]): any;
+    /**
+     * Analysis of Sports Mode Data
+     * @param value
+     * @returns
+     */
     static getExerciseData(value: number[]): any;
+    /**
+     * Activity and Exercise Data Analysis
+     * @param value
+     * @returns
+     */
     static getActivityExerciseData(value: number[]): any;
+    /**
+     *  Time setting successful response
+     * @param value
+     * @returns
+     */
     static setTimeSuccessful(value: number[]): any;
+    /**
+     * 辅助方法：获取数据块
+     * @param length
+     * @param start
+     * @param value
+     * @returns
+     */
     private static getData;
     private static getFloat;
     private static getInt;
+    /**
+     * Setup successful response
+     * @param dataType
+     * @returns
+     */
     static setMethodSuccessful(dataType: string): any;
+    /**
+     * ECG Data Analysis
+     * @param value
+     * @returns
+     */
     static getEcgHistoryData(value: number[]): any;
     private static getEcgDataString;
+    /**
+     * ECG Data Analysis
+     * @param value
+     * @returns
+     */
     static ecgData(value: number[]): any;
+    /**
+     * PPG Data Analysis
+     * @param value
+     * @returns
+     */
     static ppgData(value: number[]): any;
+    /**
+     *  ECG Interpretation ECG Interpretation
+     * @param value
+     * @returns
+     */
     static ecgResult(value: number[]): any;
+    /**
+     * Enter ECG mode
+     * @param value
+     * @returns
+     */
     static enterEcg(value: number[]): any;
+    /**
+   * Measurement type handling
+   * @param flag Enable measurement. true: real-time blood glucose measurement returns
+   * @param value Data returned by the firmware
+   * @returns
+   */
     static measurementWithType(flag: boolean, value: number[]): any;
+    /**
+   * Smartband watch face settings
+   * @param isRunning
+   * @param value
+   * @returns
+   */
     static braceletdial(isruning: boolean, value: number[]): any;
+    /**
+     * Get Exercise Mode
+     * @param value
+     * @returns
+     */
     static getSportMode(value: number[]): any;
+    /**
+     * GPS Control Command Parsing
+     * @param value
+     * @returns
+     */
     static gPSControlCommand(value: number[]): any;
+    /**
+     * Set social distancing
+     * @param value
+     * @returns
+     */
     static setSocial(value: number[]): any;
-    static eCGQuality(value: number[]): any;
+    /**
+     * ECG Quality Data
+     * @param value
+     * @returns
+     */
+    static ecgQuality(value: number[]): any;
+    /**
+     * Enter Photo Mode Return
+     * @param value
+     * @returns
+     */
     static enterPhotoModeback(value: number[]): any;
+    /**
+     * Set up new device information
+     * @param value
+     * @returns
+     */
     static setNewDeviceInfo(value: number[]): any;
+    /**
+     * Retrieve new device information
+     * @param value
+     * @returns
+     */
     static getNewDeviceInfo(value: number[]): any;
+    /**
+     * Alarm updated successfully
+     * @param value
+     * @returns
+     */
     static updateClockSuccessful(value: number[]): any;
+    /**
+     * Set Blood Glucose Status
+     * @param value
+     * @returns
+     */
     static setBoolSugarStatus(value: number[]): any;
+    /**
+     * Set blood glucose level Set blood glucose levels
+     * @param value
+     * @returns
+     */
     static setBoolSugarValue(value: number[]): any;
+    /**
+     * Incorrect setup method
+     * @param dataType
+     * @returns
+     */
     static setMethodError(dataType: string): any;
+    /**
+     * Read pregnancy cycle data
+     * @param value
+     * @returns
+     */
     static readPregnancyCycle(value: number[]): any;
+    /**
+     * Analysis of Women's Health Data
+     * @param value
+     * @returns
+     */
     static readWomenHealth(value: number[]): any;
+    /**
+     *Analysis of Temperature Correction Values
+     * @param value
+     * @returns
+     */
     static getTemperatureCorrectionValue(value: number[]): any;
     private static byteArrayToInt;
+    /**
+     * Retrieve historical GPS data
+     * @param value
+     * @returns
+     */
     static getHistoryGpsData(value: number[]): any;
+    /**
+     * PPI Test Data Analysis
+     * @param value
+     * @returns
+     */
     static getPPITestData(value: number[]): any;
+    /**
+     * Acquire HRV measurement time data
+     * @param value
+     * @returns
+     */
     static getHrvTimeData(value: number[]): any;
+    /**
+     * Disconnect Bluetooth
+     * @param value
+     * @returns
+     */
     static closeDevices(value: number[]): any;
+    /**
+     * Detach Detection Status Reporting
+     * @param value
+     * @returns
+     */
     static getOffCheckStatus(value: number[]): any;
 }