@moshenguo/ms-data-sdk 0.1.5 → 0.1.7

package/build/sdk/bleSDK.d.ts

@@ -1,4 +1,8 @@
 import { MyPersonalInfo, MyDeviceInfo, MyAutomaticHRMonitoring, MySedentaryReminderV4 } from './models';
+/**
+ * Convert data into firmware commands. Call the corresponding method to get the appropriate command, and send this command to the firmware.
+ * The `dataParsingWithData` method parses the firmware response into an object form.
+ */
 export declare class BleSDK {
     static DATA_READ_START: number;
     static DATA_READ_CONTINUE: number;
@@ -26,209 +30,231 @@ export declare class BleSDK {
     private static crcDynamicValue;
     private static getBcdValue;
     /**
-     * 数据解析方法
-     * @param 蓝牙返回原始数据
-     * @returns 解析后的数据
-     */
+   * Data parsing method
+   * @param rawData The raw data returned from Bluetooth
+   * @returns The parsed data
+   */
     static dataParsingWithData(value: number[]): {
         [key: string]: any;
     };
     /**
-     *  血糖
-     * @param ppgMode
+     * Blood Glucose
+     * @param ppgMode 1: start measurement
      * @param ppgStatus
      * @returns
      */
     static bloodsugarWithMode(ppgMode: number, ppgStatus: number): number[];
     /**
-     *
-     *获得睡眠详细数据
-     * @param {number} mode  0-读最近的睡眠详细数据 2-继续上次读的位置下一段数据 99-删除睡眠数据
-     * @return {*}  {number[]} detailed sleep data
-     */
+    *
+    * Get detailed sleep data
+    * @param {number} mode 0 - read the most recent detailed sleep data
+    *                      2 - continue reading the next segment from the previous position
+    *                      99 - delete sleep data
+    * @return {*} {number[]} detailed sleep data
+    */
     static getDetailSleepDataWithMode(mode: number): number[];
     private static insertDateValue;
     /**
      *
-     *获得HRV测试数据
-     * @param {number} mode 0-读最近的详细数据 2-继续上次读的位置下一段数据 99-删除数据
+     * Get HRV test data
+     * @param {number} mode 0 - read the most recent detailed data
+     *                      2 - continue reading the next segment from the previous position
+     *                      99 - delete data
      * @param {string} time  yyyy-MM-dd HH:mm:ss
-      * @return {*}  {number[]} 指令包,给固件发生指令
+     * @return {*} {number[]} command packet, to be sent to the firmware
      */
     static getHRVDataWithMode(mode: number, time: string): number[];
     /**
-     *
-     *  ppi数据
-     * @param {number} mode
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * PPI data
+   * @param {number} mode 99: Delete PPI data
+   * 0: Read the most recent PPI data
+   * 1: Read PPI data at a specified position
+   * 2: Continue reading the next segment from the last read position
+   * @return {*} {number[]} command packet, to be sent to the firmware
+   */
     static getPPIDDataWithMode(mode: number): number[];
     /**
-     *
-     * hrv测试数据
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * HRV test data
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getHrvTestTime(): number[];
     /**
-     *
-     * 设置Hrv测试时长
-     * @param {number} time
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Set HRV test duration
+   * @param {number} time Duration of the HRV test
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static setHrvTestTime(time: number): number[];
     /**
      *
-     * 断开蓝牙
-      * @return {*}  {number[]} 指令包,给固件发生指令
+     * Disconnect Bluetooth
+     * @return {*} {number[]} Command packet to send to the firmware
      */
     static closeBlueDevice(): number[];
     /**
-     *
-     * 血糖开始测量
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Start blood sugar measurement
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static startBloodSugar(): number[];
     /**
-     *
-     * 血糖进度设置
-     * @param {number} progress
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+    *
+    * Set blood sugar measurement progress
+    * @param {number} progress
+    * @return {*} {number[]} Command packet to send to the firmware
+    */
     static progressBloodSugar(progress: number): number[];
     /**
      *
-     * 结束测量血糖
-      * @return {*}  {number[]} 指令包,给固件发生指令
+     * Stop blood sugar measurement
+     * @return {*} {number[]} Command packet to send to the firmware
      */
     static endBloodSugar(): number[];
     /**
-     *
-     * 获取某天总数据
-     * @param {number} mode 表⽰是从最新的位置开始读取(最多50组数据)  2:表⽰接着读取(当数据总数⼤于50的时候) 0x99:表⽰删除所有运动数据
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get total activity data for a specific day
+   * @param {number} mode Indicates reading from the latest position (up to 50 data sets),
+   *                     2: continue reading from the last position (when total data > 50),
+   *                     0x99: delete all activity data
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getTotalActivityDataWithMode(mode: number): number[];
     /**
-     *
-     * /根据某个日期获取到最新的总数据
-     * @param {number} mode 0-表⽰是从最新的位置开始读取(最多50组数据)  2-表⽰接着读取(当数据总数⼤于50的时候) 99-表⽰删除所有运动数据
-     * @param {string} time  yyyy-MM-dd HH:mm:ss
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get the latest total activity data for a specific date
+   * @param {number} mode 0 - read from the latest position (up to 50 data sets),
+   *                     2 - continue reading from the last position (when total data > 50),
+   *                     99 - delete all activity data
+   * @param {string} time Date string in format yyyy-MM-dd HH:mm:ss
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getTotalActivityDataWithModeForTime(mode: number, time: string): number[];
     /**
-     *
-     * 获得睡眠详细数据
-     * @param {number} mode  0-读最近的睡眠详细数据 2-继续上次读的位置下一段数据 99-删除睡眠数据
-     * @param {string} time yyyy-MM-dd HH:mm:ss
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get detailed sleep data
+   * @param {number} mode 0 - read the latest sleep data,
+   *                     2 - continue from the last read position,
+   *                     99 - delete sleep data
+   * @param {string} time Date string in format yyyy-MM-dd HH:mm:ss
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getDetailSleepDataWithModeForTime(mode: number, time: string): number[];
     /**
-     *
-     * 获得步数详细数据
-   
-     * @param {number} mode 0-读最近的详细数据 2-继续上次读的位置下一段数据 99-删除数据
-     * @param {string} time yyyy-MM-dd HH:mm:ss
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get detailed step data
+   * @param {number} mode 0 - read the latest detailed data,
+   *                     2 - continue from the last read position,
+   *                     99 - delete data
+   * @param {string} time Date string in format yyyy-MM-dd HH:mm:ss
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getDetailActivityDataWithModeForTime(mode: number, time: string): number[];
     /**
-     *
-     * 自动测试温度数据
-     * @param {number} mode 0-读最近的详细数据 2-继续上次读的位置下一段数据 99-删除数据
-     * @param {string} time yyyy-MM-dd HH:mm:ss
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+    *
+    * Automatic temperature test data
+    * @param {number} mode 0 - read the latest detailed data,
+    *                     2 - continue from the last read position,
+    *                     99 - delete data
+    * @param {string} time Date string in format yyyy-MM-dd HH:mm:ss
+    * @return {*} {number[]} Command packet to send to the firmware
+    */
     static getTemperature_historyDataWithMode(mode: number, time: string): number[];
     /**
-     *
-     * 手动测试温度数据
-     * @param {number} mode 0-读最近的详细数据 2-继续上次读的位置下一段数据 99-删除数据
-     * @param {string} time yyyy-MM-dd HH:mm:ss
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Manual temperature test data
+   * @param {number} mode 0 - read the latest detailed data,
+   *                     2 - continue from the last read position,
+   *                     99 - delete data
+   * @param {string} time Date string in format yyyy-MM-dd HH:mm:ss
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getAxillaryTemperatureDataWithMode(mode: number, time: string): number[];
     /**
-     *
-     * 运动模式开关
-     * @param {number} activityMode 运动模式类型
-     * @param {number} WorkMode 1:开始 ，  2：暂停， 3：继续， 4结束。5： 查询状态
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Activity mode control
+   * @param {number} activityMode Type of activity mode
+   * @param {number} workMode 1: Start, 2: Pause, 3: Continue, 4: Stop, 5: Query status
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static enterActivityMode(activityMode: number, WorkMode: number): number[];
     /**
-     * 发送运动模式心跳包(配合"EnterActivityMode"使用)
-     * 当手环是通过APP进入多运动模式后，APP必须每隔1秒发送一个数据给手环，否则手环会退出多运动模式
-     * @param {number} distance 距离，浮点数。单位是KM。
-     * @param {number} space 配速度，MM:分钟，SS秒钟
-     * @param {number} rssi APPGPS信号强度。范围是：1，2，3
-      * @return {*}  {number[]} 指令包,给固件发生指令
+     * Send heartbeat packet for activity mode (used with "EnterActivityMode")
+     * When the band enters multi-activity mode via the APP, the APP must send a data packet to the band every second, otherwise the band will exit multi-activity mode.
+     * @param {number} distance Distance in kilometers (floating point)
+     * @param {number} pace Pace, in minutes (MM) or seconds (SS)
+     * @param {number} rssi APP GPS signal strength. Possible values: 1, 2, 3
+     * @return {*} {number[]} Command packet to send to the firmware
      */
     static sendHeartPackage(distance: number, space: number, rssi: number): number[];
     /**
-     *
-     * 启动或关闭实时计步模式
-     * @param {boolean} enable 1:启动实时计步，0：关闭实时计步
-     * @param {boolean} tempEnable 1:开启实时温度 0：关闭实时温度
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Enable or disable real-time step counting mode
+   * @param {boolean} enable  true: start real-time step counting, false: stop real-time step counting
+   * @param {boolean} tempEnable true: enable real-time temperature, false: disable real-time temperature
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static realTimeStep(enable: boolean, tempEnable: boolean): number[];
     /**
-     *
-     * 停止实时计步
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Stop real-time step counting
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static stopGo(): number[];
     /**
-     * 设置个人信息
-     *
-     * @param {MyPersonalInfo} info
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+    * Set personal information
+    *
+    * @param {MyPersonalInfo} info
+    * @return {*} {number[]} Command packet to send to the firmware
+    */
     static setPersonalInfo(info: MyPersonalInfo): number[];
     /**
-     *
-     * 获取个人信息
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get personal information
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getPersonalInfo(): number[];
-    static enterOTA(): number[];
     /**
-     *
-     * 获取设备版本号
-      * @return {*}  {number[]} 指令包,给固件发生指令
+     * Entering dfu mode
+     * @returns
      */
+    static enterOTA(): number[];
+    /**
+    *
+    * Get device firmware version
+    * @return {*} {number[]} Command packet to send to the device firmware
+    */
     static getDeviceVersion(): number[];
     /**
-     *
-     * 恢复出厂设置
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Restore factory settings
+   * @return {*} {number[]} Command packet to send to the device firmware
+   */
     static reset(): number[];
     /**
-     *
-     * 获取设备mac地址
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get device MAC address
+   * @return {*} {number[]} Command packet to send to the device firmware
+   */
     static getDeviceMacAddress(): number[];
     /**
-     *
-     * 获取设备电量
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get device battery level
+   * @return {*} {number[]} Command packet to send to the device firmware
+   */
     static getDeviceBatteryLevel(): number[];
     /**
-     *
-     * 重启设备
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Reboot the device
+   * @return {*} {number[]} Command packet to send to the device firmware
+   */
     static mcuReset(): number[];
     /**
-     * 设置设备名称
+     * Set the device name
      *
-     * @param {string} deviceName 设备名称（最多14个ASCII字符）
-     * @return {*}  {number[]}  指令包（7字节）
+     * @param {string} deviceName Device name (up to 14 ASCII characters)
+     * @return {*} {number[]} Command packet (7 bytes)
      */
     static setDeviceName(deviceName: string): number[];
     /**
@@ -237,146 +263,163 @@ export declare class BleSDK {
      */
     static getDeviceName(): number[];
     /**
-     *
-     * 设置设备时间
-     * @param {Date} dateTime
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Set the device time
+   * @param {Date} dateTime
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static setDeviceTime(dateTime: Date): number[];
     /**
-     *
-     * 获取设备时间
-     * @return {*}  {number[]}
-     */
+   *
+   * Get the device time
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getDeviceTime(): number[];
     /**
-     *
-     * 设置设备信息
-     * @param {MyDeviceInfo} deviceBaseParameter
-     * @return {*}  {number[]}
-     */
+    *
+    * Set device information
+    * @param {MyDeviceInfo} deviceBaseParameter
+    * @return {*} {number[]} Command packet to send to the firmware
+    */
     static setDeviceInfo(deviceBaseParameter: MyDeviceInfo): number[];
     /**
-     *健康测量控制
-     *
-     * @param {number} dataType 测试类型 0x01,HRV 0x02，心率测量 0x03，血氧测量
-     * @param {boolean} open 1开启测量 0 关闭测量
-     * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   * Health measurement control
+   *
+   * @param {number} dataType Measurement type: 0x01 - HRV, 0x02 - Heart rate, 0x03 - Blood oxygen
+   * @param {boolean} open 1 to start measurement, 0 to stop measurement
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static healthMeasurementWithDataType(dataType: number, open: boolean): number[];
     /**
      *
-     * 设置手环表盘模式
-     * @param {number} mode 表盘模式（0, 1, 2... 根据设备定义）
-     * @return {*}  {number[]} 指令包（7字节）
+     * Set the wristband dial mode
+     * @param {number} mode Dial mode (0, 1, 2... as defined by the device)
+     * @return {*} {number[]} Command packet (7 bytes)
      */
     static setBraceletdial(mode: number): number[];
     /**
-     *
-     * 设置自动检测心率时段
-     * @param {MyAutomaticHRMonitoring} autoHeart
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Read the automatic measurement time periods
+   * @param {number} type 1: Read heart rate time settings, 2: Read SpO2 time settings, 4: Read HRV time periods
+   * @return {*} {number[]} Command packet to send to the device
+   */
     static setAutomaticHRMonitoring(autoHeart: MyAutomaticHRMonitoring): number[];
     /**
      *
-     * 读取自动检测心率时段
-     * @param {number} type 1、读取心率设置时间 2、读取设置血氧时间 4、读取HRV设置时间段
-      * @return {*}  {number[]} 指令包,给固件发生指令
+     * Read automatic heart rate measurement periods
+     * @param {number} type 1: Read heart rate time settings, 2: Read SpO2 time settings, 4: Read HRV time period settings
+     * @return {*} {number[]} Command packet to send to the device
      */
     static getAutomaticHRMonitoring(type: number): number[];
     /**
-     *
-     *获取多模式运动数据
-     * @param {number} mode 0:表⽰是从最新的位置开始读取(最多50组数据)  2:表⽰接着读取(当数据总数⼤于50的时候) 0x99:表⽰删除所有GPS数据
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+    *
+    * Get multi-sport mode data
+    * @param {number} mode 0: Start reading from the latest position (up to 50 records)
+    *                     2: Continue reading from the previous position (when total records exceed 50)
+    *                     0x99: Delete all GPS data
+    * @return {*} {number[]} Command packet to send to the device
+    */
     static getActivityModeDataWithMode(mode: number): number[];
     /**
-      *
-      * 获得单次心率数据（间隔测试心率）
-      * @param {number} mode 0-读最近的详细数据 2-继续上次读的位置下一段数据 99-删除数据
-      * @param {string} time  yyyy-MM-dd HH:mm:ss
-       * @return {*}  {number[]} 指令包,给固件发生指令
-      */
+     *
+     * Get single heart rate data (interval heart rate measurement)
+     * @param {number} mode 0: Read the most recent data
+     *                     2: Continue reading from the previous position
+     *                     99: Delete data
+     * @param {string} time Date and time in format yyyy-MM-dd HH:mm:ss
+     * @return {*} {number[]} Command packet to send to the device
+     */
     static getStaticHRWithMode(mode: number, time: string): number[];
     /**
      *
-     * 获得心率数据
-     * @param {number} mode 0-读最近的详细数据 2-继续上次读的位置下一段数据 99-删除数据
-     * @param {string} time yyyy-MM-dd HH:mm:ss
-      * @return {*}  {number[]} 指令包,给固件发生指令
+     * Get heart rate data
+     * @param {number} mode 0: Read the most recent data
+     *                     2: Continue reading from the previous position
+     *                     99: Delete data
+     * @param {string} time Date and time in format yyyy-MM-dd HH:mm:ss
+     * @return {*} {number[]} Command packet to send to the device
      */
     static getDynamicHRWithMode(mode: number, time: string): number[];
     /**
-     *
-     * 获得血氧数据
-     * @param {number} mode 0-读最近的详细数据 2-继续上次读的位置下一段数据 99-删除数据
-     * @param {string} time yyyy-MM-dd HH:mm:ss
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get blood oxygen (SpO2) data
+   * @param {number} mode 0: Read the most recent data
+   *                     2: Continue reading from the previous position
+   *                     99: Delete data
+   * @param {string} time Date and time in format yyyy-MM-dd HH:mm:ss
+   * @return {*} {number[]} Command packet to send to the device
+   */
     static getBloodOxygen(mode: number, time: string): number[];
     /**
-     *
-     * 获得血氧数据（自动测试）
-     * @param {number} mode 0-读最近的详细数据 2-继续上次读的位置下一段数据 99-删除数据
-     * @param {string} time yyyy-MM-dd HH:mm:ss
-     * @return {*}  {number[]}
-     */
+    *
+    * Get blood oxygen (SpO2) data (automatic measurement)
+    * @param {number} mode 0: Read the most recent data
+    *                     2: Continue reading from the previous position
+    *                     99: Delete data
+    * @param {string} time Date and time in format yyyy-MM-dd HH:mm:ss
+    * @return {*} {number[]} Command packet to send to the device
+    */
     static getAutoBloodOxygen(mode: number, time: string): number[];
     /**
-   * 设置目标步数指令
-   * @param stepGoal 步数目标 (int, 4 bytes, Big-Endian)
-   * @param targetExecutionTime 目标完成时间（分钟）(int, 2 bytes)
-   * @param distance 距离目标（千米）(int, 2 bytes)
-   * @param calorie 卡路里目标 (int, 2 bytes)
-   * @param sleepTime 睡眠时间目标（分钟）(int, 2 bytes)
-   * @returns number[] 指令字节数组（16字节，含CRC）
+   * Set step goal command
+   * @param stepGoal Step goal (int, 4 bytes, Big-Endian)
+   * @param targetExecutionTime Target completion time (minutes) (int, 2 bytes)
+   * @param distance Distance goal (kilometers) (int, 2 bytes)
+   * @param calorie Calorie goal (int, 2 bytes)
+   * @param sleepTime Sleep time goal (minutes) (int, 2 bytes)
+   * @returns number[] Command byte array (16 bytes, including CRC)
    */
     static setStepGoal(stepGoal: number, targetExecutionTime: number, distance: number, calorie: number, sleepTime: number): number[];
     /**
-     *
-     * 读取目标步数
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Read step goal
+   * @return {*} {number[]} Command byte array to send to the device
+   */
     static GetStepGoal(): number[];
     /**
-   * 获取手环基本参数（设备信息）
-   * @returns Uint8Array 指令包（7字节），用于发送 BLE 请求
-   */
+    * Get basic parameters of the wristband (device information)
+    * @returns Uint8Array Command packet (7 bytes) for sending via BLE
+    */
     static getDeviceInfo(): number[];
     static sendHex(data: number[], isCrc: boolean): number[];
     /**
-     *
-     * 获取闹钟
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get alarm clocks
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getAlarmClock(): number[];
     /**
-     *
-     * 删除所有闹钟
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Delete all alarms
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static deleteAllAlarmClock(): number[];
     /**
-     *
-     *设置所有闹钟
-     * @param {any[]} arrayClockAlarm
-     * @return {*}  {number[][]}
-     */
+   *
+   * Set all alarms
+   * @param {any[]} arrayClockAlarm Array of alarm configurations. Each element is an object with the following properties:
+   *   - openOrClose: boolean, whether the alarm is enabled
+   *   - clockType: number, type of alarm (1: standard alarm, 2: medication reminder, 3: water reminder)
+   *   - clockTime: string, alarm time in HH:mm format
+   *   - week: array or bitmask, indicates which weekdays the alarm is active
+   *   - textLength: number, length of the display text
+   *   - text: string, text to display for the alarm
+   * @return {*} {number[][]} Command packets to send to the firmware
+   */
     static setAlarmClock(arrayClockAlarm: any[]): number[][];
     /**
-     *
-     * 获取久坐提醒
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+   *
+   * Get sedentary reminder settings
+   * @return {*} {number[]} Command packet to send to the firmware
+   */
     static getSedentaryReminder(): number[];
     /**
-     * 设置久坐提醒
-     *
-     * @param {MySedentaryReminderV4} reminder
-      * @return {*}  {number[]} 指令包,给固件发生指令
-     */
+    *
+    * Set sedentary reminder
+    *
+    * @param {MySedentaryReminderV4} reminder
+    * @return {*} {number[]} Command packet to send to the firmware
+    */
     static setSedentaryReminder(reminder: MySedentaryReminderV4): number[];
 }
 export default BleSDK;