@cpzxrobot/sdk 1.3.97 → 1.3.99

package/device_gateway.ts

@@ -11,8 +11,11 @@ import type {
   DeviceAlarmStatisticsResponse,
   AlarmStatisticsByTypeResponse,
   AlarmTrendResponse,
+  AlarmHistoryResponse,
   CreateAlarmRuleRequest,
   CreateAlarmRuleResponse,
+  ActiveAlarmRuleRequest,
+  ActiveAlarmRuleResponse,
   AlarmRuleListResponse,
   AlarmRuleDetailResponse,
 } from ".";
@@ -293,6 +296,34 @@ export class DeviceGateway extends Object {
           return res.data;
         });
       },
+
+      /**
+       * 激活报警规则
+       * @param request 激活报警规则的请求参数
+       * @returns Promise 包含激活结果
+       */
+      activeAlarmRule: async (request: ActiveAlarmRuleRequest): Promise<ActiveAlarmRuleResponse> => {
+        const axios = await this.context.ready;
+
+        // 参数验证
+        if (!request.id) {
+          throw new Error('规则ID不能为空');
+        }
+
+        // 设置默认值
+        const requestData: ActiveAlarmRuleRequest = {
+          id: request.id,
+          factoryIds: request.factoryIds || [],
+          allActive: (request.factoryIds?.length || 0) > 0 ? false : request.allActive !== undefined ? request.allActive : true
+        };
+
+        return axios.post(`/api/v2/device/stat/alarms/rule/active`, requestData).then((res) => {
+          if (res.data.code !== 200) {
+            throw new Error(res.data.message || '激活报警规则失败');
+          }
+          return res.data;
+        });
+      },
     };
   }
 
@@ -1089,9 +1120,10 @@ export class DeviceGateway extends Object {
   /**
    * 获取设备告警统计信息
    * @param factoryId 工厂ID
+   * @param faultTypeId 故障类型ID（可选）,如果指定则返回该故障类型的统计信息，如果不指定则返回所有故障类型的统计信息
    * @returns Promise 包含告警统计信息的数据
    */
-  async getAlarmStats(factoryId: number | undefined = undefined): Promise<DeviceAlarmStatsResponse> {
+  async getAlarmStats(factoryId: number | undefined = undefined, faultTypeId: number | undefined = undefined): Promise<DeviceAlarmStatsResponse> {
     const axios = await this.context.ready;
     var _factoryId = factoryId || 0;
     if (!factoryId) {
@@ -1100,7 +1132,7 @@ export class DeviceGateway extends Object {
     }
 
     return axios.get(`/api/v2/device/stat/alarms`, {
-      params: { factoryId: _factoryId }
+      params: { factoryId: _factoryId, category: faultTypeId }
     }).then((res) => {
       if (res.data.code !== 200) {
         throw new Error(res.data.message || '获取设备告警统计信息失败');
@@ -1290,4 +1322,33 @@ export class DeviceGateway extends Object {
     });
   }
 
+  /**
+   * 按工厂ID和故障种类查询最近报警记录
+   * @param factoryId 工厂ID
+   * @param category 故障类型
+   * @param pageNum 页码
+   * @param pageSize 每页数量
+   * @returns Promise 包含报警历史记录数据
+   */
+  async getAlarmHistory(factoryId: number, category: number, pageNum: number = 1, pageSize: number = 5): Promise<AlarmHistoryResponse> {
+    const axios = await this.context.ready;
+
+    // 参数验证
+    if (!factoryId) {
+      throw new Error('工厂ID不能为空');
+    }
+    if (!category && category !== 0) {
+      throw new Error('故障类型不能为空');
+    }
+
+    return axios.get(`/api/v2/device/stat/alarms/history`, {
+      params: { factoryId, category, pageNum, pageSize }
+    }).then((res) => {
+      if (res.data.code !== 200) {
+        throw new Error(res.data.message || '获取报警历史记录失败');
+      }
+      return res.data;
+    });
+  }
+
 }

package/dist/device_gateway.js

@@ -225,6 +225,31 @@ class DeviceGateway extends Object {
                     return res.data;
                 });
             }),
+            /**
+             * 激活报警规则
+             * @param request 激活报警规则的请求参数
+             * @returns Promise 包含激活结果
+             */
+            activeAlarmRule: (request) => __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const axios = yield this.context.ready;
+                // 参数验证
+                if (!request.id) {
+                    throw new Error('规则ID不能为空');
+                }
+                // 设置默认值
+                const requestData = {
+                    id: request.id,
+                    factoryIds: request.factoryIds || [],
+                    allActive: (((_a = request.factoryIds) === null || _a === void 0 ? void 0 : _a.length) || 0) > 0 ? false : request.allActive !== undefined ? request.allActive : true
+                };
+                return axios.post(`/api/v2/device/stat/alarms/rule/active`, requestData).then((res) => {
+                    if (res.data.code !== 200) {
+                        throw new Error(res.data.message || '激活报警规则失败');
+                    }
+                    return res.data;
+                });
+            }),
         };
     }
     constructor(context) {
@@ -863,10 +888,11 @@ class DeviceGateway extends Object {
     /**
      * 获取设备告警统计信息
      * @param factoryId 工厂ID
+     * @param faultTypeId 故障类型ID（可选）,如果指定则返回该故障类型的统计信息，如果不指定则返回所有故障类型的统计信息
      * @returns Promise 包含告警统计信息的数据
      */
     getAlarmStats() {
-        return __awaiter(this, arguments, void 0, function* (factoryId = undefined) {
+        return __awaiter(this, arguments, void 0, function* (factoryId = undefined, faultTypeId = undefined) {
             const axios = yield this.context.ready;
             var _factoryId = factoryId || 0;
             if (!factoryId) {
@@ -874,7 +900,7 @@ class DeviceGateway extends Object {
                 _factoryId = (farm === null || farm === void 0 ? void 0 : farm.id) || 0;
             }
             return axios.get(`/api/v2/device/stat/alarms`, {
-                params: { factoryId: _factoryId }
+                params: { factoryId: _factoryId, category: faultTypeId }
             }).then((res) => {
                 if (res.data.code !== 200) {
                     throw new Error(res.data.message || '获取设备告警统计信息失败');
@@ -1041,5 +1067,33 @@ class DeviceGateway extends Object {
             });
         });
     }
+    /**
+     * 按工厂ID和故障种类查询最近报警记录
+     * @param factoryId 工厂ID
+     * @param category 故障类型
+     * @param pageNum 页码
+     * @param pageSize 每页数量
+     * @returns Promise 包含报警历史记录数据
+     */
+    getAlarmHistory(factoryId_1, category_1) {
+        return __awaiter(this, arguments, void 0, function* (factoryId, category, pageNum = 1, pageSize = 5) {
+            const axios = yield this.context.ready;
+            // 参数验证
+            if (!factoryId) {
+                throw new Error('工厂ID不能为空');
+            }
+            if (!category && category !== 0) {
+                throw new Error('故障类型不能为空');
+            }
+            return axios.get(`/api/v2/device/stat/alarms/history`, {
+                params: { factoryId, category, pageNum, pageSize }
+            }).then((res) => {
+                if (res.data.code !== 200) {
+                    throw new Error(res.data.message || '获取报警历史记录失败');
+                }
+                return res.data;
+            });
+        });
+    }
 }
 exports.DeviceGateway = DeviceGateway;

package/package.json

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

package/types.d.ts

@@ -537,6 +537,44 @@ interface AlarmTrendResponse {
   message: string;
 }
 
+/**
+ * 报警历史记录项接口
+ */
+interface AlarmHistoryItem {
+  /** 报警类型 */
+  category: number;
+  /** 设备ID */
+  deviceId: number;
+  /** 持续时间（秒） */
+  durationSeconds: number;
+  /** 报警结束时间 */
+  endTime: string | null;
+  /** 工厂ID */
+  factoryId: number;
+  /** 故障字段 */
+  field: string;
+  /** 报警记录ID */
+  id: number;
+  /** 是否已解决 */
+  resolved: boolean;
+  /** 报警开始时间 */
+  startTime: string;
+  /** 故障消息 */
+  troubleMessage: string;
+}
+
+/**
+ * 报警历史记录响应接口
+ */
+interface AlarmHistoryResponse {
+  /** 响应码 */
+  code: number;
+  /** 报警历史记录数据 */
+  data: AlarmHistoryItem[];
+  /** 响应消息 */
+  message: string;
+}
+
 /**
  * 报警规则阈值配置接口
  */
@@ -625,6 +663,8 @@ interface AlarmRuleDetail {
   unitIds?: number[];
   /** 栋舍id列表 */
   workshopIds?: number[];
+  /** 栋舍类型列表 */
+  workshopTypes?: number[];
   /** 报警方式 */
   alarmType?: "OFFLINE" | "FAULT" | "THRESHOLD" | "TREND";
   /** 设备类型列表 */
@@ -671,6 +711,30 @@ interface AlarmRuleDetailResponse {
   message: string;
 }
 
+/**
+ * 激活报警规则请求接口
+ */
+interface ActiveAlarmRuleRequest {
+  /** 规则id */
+  id: number;
+  /** 工厂Ids */
+  factoryIds?: number[];
+  /** 是否全部激活 */
+  allActive?: boolean;
+}
+
+/**
+ * 激活报警规则响应接口
+ */
+interface ActiveAlarmRuleResponse {
+  /** 响应码 */
+  code: number;
+  /** 响应数据 */
+  data: null;
+  /** 响应消息 */
+  message: string;
+}
+
 declare class Cpzxrobot {
   transport: TransportGateway;
   ready: Promise<MyAxiosInstance>;
@@ -763,10 +827,14 @@ declare module "@cpzxrobot/sdk" {
     AlarmStatisticsByTypeResponse,
     AlarmTrendItem,
     AlarmTrendResponse,
+    AlarmHistoryItem,
+    AlarmHistoryResponse,
     AlarmRuleThresholdConfig,
     AlarmRuleAlarmConfig,
     CreateAlarmRuleRequest,
     CreateAlarmRuleResponse,
+    ActiveAlarmRuleRequest,
+    ActiveAlarmRuleResponse,
     AlarmRuleDetail,
     AlarmRuleListResponse,
     AlarmRuleDetailResponse,