@cpzxrobot/sdk 1.3.78 → 1.3.80

package/device_gateway.ts

@@ -9,6 +9,7 @@ import type {
   Supplier,
   DeviceAlarmStatsResponse,
   DeviceAlarmStatisticsResponse,
+  AlarmStatisticsByTypeResponse,
 } from ".";
 
 class DeviceFault {
@@ -1060,4 +1061,102 @@ export class DeviceGateway extends Object {
     });
   }
 
+  /**
+   * 获取报警具体信息
+   * @param logId 报警日志ID
+   * @returns Promise 包含报警具体信息的数据
+   */
+  async getAlarmDetails(logId: number): Promise<any> {
+    const axios = await this.context.ready;
+
+    // 参数验证
+    if (!logId || logId <= 0) {
+      throw new Error('报警日志ID不能为空且必须大于0');
+    }
+
+    return axios.get(`/api/v2/device/stat/alarms/details`, {
+      params: { logId }
+    }).then((res) => {
+      if (res.data.code !== 200) {
+        throw new Error(res.data.message || '获取报警具体信息失败');
+      }
+      return res.data;
+    });
+  }
+
+  /**
+   * 获取报警具体信息分类统计
+   * @param factoryId 工厂ID
+   * @param topN 查询发生次数从多到少排名的top几（不传则默认对所有种类的报警信息进行统计）
+   * @param fromDate 查询起始时间（格式：YYYY-MM-DD HH:mm:ss，不传则默认对所有的报警信息进行归类统计）
+   * @param toDate 查询终止时间（格式：YYYY-MM-DD HH:mm:ss，不传则默认对所有的报警信息进行归类统计）
+   * @returns Promise 包含报警分类统计数据
+   */
+  async getAlarmStatisticsByType(
+    factoryId: number | undefined = undefined,
+    topN?: number,
+    fromDate?: string,
+    toDate?: string
+  ): Promise<AlarmStatisticsByTypeResponse> {
+    const axios = await this.context.ready;
+    var _factoryId = factoryId || 0;
+    if (!factoryId) {
+      const farm = await this.context.user.getSelectedFarm();
+      _factoryId = farm?.id || 0;
+    }
+
+    // 参数验证
+    if (!_factoryId) {
+      throw new Error('工厂ID不能为空');
+    }
+    if (topN !== undefined && topN <= 0) {
+      throw new Error('topN参数必须大于0');
+    }
+    if (fromDate && !this.isValidDateTime(fromDate)) {
+      throw new Error('fromDate参数格式错误，应为YYYY-MM-DD HH:mm:ss格式');
+    }
+    if (toDate && !this.isValidDateTime(toDate)) {
+      throw new Error('toDate参数格式错误，应为YYYY-MM-DD HH:mm:ss格式');
+    }
+    if (fromDate && toDate && fromDate > toDate) {
+      throw new Error('fromDate不能晚于toDate');
+    }
+
+    // 构建请求参数
+    const params: any = { factoryId: _factoryId };
+    if (topN !== undefined) {
+      params.topN = topN;
+    }
+    if (fromDate) {
+      params.fromDate = fromDate;
+    }
+    if (toDate) {
+      params.toDate = toDate;
+    }
+
+    return axios.get(`/api/v2/device/stat/alarms/statistics-by-type`, {
+      params: params
+    }).then((res) => {
+      if (res.data.code !== 200) {
+        throw new Error(res.data.message || '获取报警分类统计信息失败');
+      }
+      return res.data;
+    });
+  }
+
+  /**
+   * 验证日期时间格式（YYYY-MM-DD HH:mm:ss）
+   * @param dateTime 日期时间字符串
+   * @returns 是否有效
+   */
+  private isValidDateTime(dateTime: string): boolean {
+    const regex = /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/;
+    if (!regex.test(dateTime)) {
+      return false;
+    }
+    
+    const date = new Date(dateTime);
+    return !isNaN(date.getTime());
+  }
+
 }

package/dist/device_gateway.js

@@ -847,5 +847,93 @@ class DeviceGateway extends Object {
             });
         });
     }
+    /**
+     * 获取报警具体信息
+     * @param logId 报警日志ID
+     * @returns Promise 包含报警具体信息的数据
+     */
+    getAlarmDetails(logId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const axios = yield this.context.ready;
+            // 参数验证
+            if (!logId || logId <= 0) {
+                throw new Error('报警日志ID不能为空且必须大于0');
+            }
+            return axios.get(`/api/v2/device/stat/alarms/details`, {
+                params: { logId }
+            }).then((res) => {
+                if (res.data.code !== 200) {
+                    throw new Error(res.data.message || '获取报警具体信息失败');
+                }
+                return res.data;
+            });
+        });
+    }
+    /**
+     * 获取报警具体信息分类统计
+     * @param factoryId 工厂ID
+     * @param topN 查询发生次数从多到少排名的top几（不传则默认对所有种类的报警信息进行统计）
+     * @param fromDate 查询起始时间（格式：YYYY-MM-DD HH:mm:ss，不传则默认对所有的报警信息进行归类统计）
+     * @param toDate 查询终止时间（格式：YYYY-MM-DD HH:mm:ss，不传则默认对所有的报警信息进行归类统计）
+     * @returns Promise 包含报警分类统计数据
+     */
+    getAlarmStatisticsByType() {
+        return __awaiter(this, arguments, void 0, function* (factoryId = undefined, topN, fromDate, toDate) {
+            const axios = yield this.context.ready;
+            var _factoryId = factoryId || 0;
+            if (!factoryId) {
+                const farm = yield this.context.user.getSelectedFarm();
+                _factoryId = (farm === null || farm === void 0 ? void 0 : farm.id) || 0;
+            }
+            // 参数验证
+            if (!_factoryId) {
+                throw new Error('工厂ID不能为空');
+            }
+            if (topN !== undefined && topN <= 0) {
+                throw new Error('topN参数必须大于0');
+            }
+            if (fromDate && !this.isValidDateTime(fromDate)) {
+                throw new Error('fromDate参数格式错误，应为YYYY-MM-DD HH:mm:ss格式');
+            }
+            if (toDate && !this.isValidDateTime(toDate)) {
+                throw new Error('toDate参数格式错误，应为YYYY-MM-DD HH:mm:ss格式');
+            }
+            if (fromDate && toDate && fromDate > toDate) {
+                throw new Error('fromDate不能晚于toDate');
+            }
+            // 构建请求参数
+            const params = { factoryId: _factoryId };
+            if (topN !== undefined) {
+                params.topN = topN;
+            }
+            if (fromDate) {
+                params.fromDate = fromDate;
+            }
+            if (toDate) {
+                params.toDate = toDate;
+            }
+            return axios.get(`/api/v2/device/stat/alarms/statistics-by-type`, {
+                params: params
+            }).then((res) => {
+                if (res.data.code !== 200) {
+                    throw new Error(res.data.message || '获取报警分类统计信息失败');
+                }
+                return res.data;
+            });
+        });
+    }
+    /**
+     * 验证日期时间格式（YYYY-MM-DD HH:mm:ss）
+     * @param dateTime 日期时间字符串
+     * @returns 是否有效
+     */
+    isValidDateTime(dateTime) {
+        const regex = /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/;
+        if (!regex.test(dateTime)) {
+            return false;
+        }
+        const date = new Date(dateTime);
+        return !isNaN(date.getTime());
+    }
 }
 exports.DeviceGateway = DeviceGateway;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cpzxrobot/sdk",
-  "version": "1.3.78",
+  "version": "1.3.80",
   "description": "提供给上海正芯数智APP第三方H5应用使用的SDK",
   "main": "dist/index.js",
   "scripts": {

package/types.d.ts

@@ -483,6 +483,32 @@ interface DeviceAlarmStatisticsResponse {
   message: string;
 }
 
+/**
+ * 报警分类统计项接口
+ */
+interface AlarmStatisticsByTypeItem {
+  /** 报警类型（0，1，2等） */
+  category: number;
+  /** 时间范围内的指定种类的报警数量 */
+  count: number;
+  /** 上次发生此类报警的时间 */
+  lastOccurred: string;
+  /** 此类报警还没恢复的总数 */
+  unresolvedCount: number;
+}
+
+/**
+ * 报警分类统计响应接口
+ */
+interface AlarmStatisticsByTypeResponse {
+  /** 响应码 */
+  code: number;
+  /** 报警分类统计数据 */
+  data: AlarmStatisticsByTypeItem[];
+  /** 响应消息 */
+  message: string;
+}
+
 declare class Cpzxrobot {
   transport: TransportGateway;
   ready: Promise<MyAxiosInstance>;
@@ -571,6 +597,8 @@ declare module "@cpzxrobot/sdk" {
     DeviceAlarmStatisticsItem,
     DeviceAlarmStatisticsPage,
     DeviceAlarmStatisticsResponse,
+    AlarmStatisticsByTypeItem,
+    AlarmStatisticsByTypeResponse,
     ElectricMeterRate,
     DevicePurpose,
   };