@cpzxrobot/sdk 1.3.88 → 1.3.90

package/device_gateway.ts

@@ -11,6 +11,10 @@ import type {
   DeviceAlarmStatisticsResponse,
   AlarmStatisticsByTypeResponse,
   AlarmTrendResponse,
+  CreateAlarmRuleRequest,
+  CreateAlarmRuleResponse,
+  AlarmRuleListResponse,
+  AlarmRuleDetailResponse,
 } from ".";
 
 class DeviceFault {
@@ -199,6 +203,86 @@ export class DeviceGateway extends Object {
     };
   }
 
+  get rule() {
+    return {
+      /**
+       * 按工厂id查询报警规则列表
+       * @param factoryId 工厂ID
+       * @returns Promise 包含报警规则列表
+       */
+      list: async (factoryId?: number): Promise<AlarmRuleListResponse> => {
+        const axios = await this.context.ready;
+
+        // 参数验证
+        if (!factoryId) {
+          let farm = await this.context.user.getSelectedFarm();
+          factoryId = farm?.id;
+        }
+
+        return axios.get(`/api/v2/device/stat/alarms/rule`, {
+          params: { factoryId }
+        }).then((res) => {
+          if (res.data.code !== 200) {
+            throw new Error(res.data.message || '获取报警规则列表失败');
+          }
+          return res.data;
+        });
+      },
+
+      /**
+       * 按规则id查询报警规则详情
+       * @param ruleId 规则ID
+       * @returns Promise 包含报警规则详情
+       */
+      get: async (ruleId: number): Promise<AlarmRuleDetailResponse> => {
+        const axios = await this.context.ready;
+
+        // 参数验证
+        if (!ruleId || ruleId <= 0) {
+          throw new Error('规则ID不能为空且必须大于0');
+        }
+
+        return axios.get(`/api/v2/device/stat/alarms/rule/${ruleId}`).then((res) => {
+          if (res.data.code !== 200) {
+            throw new Error(res.data.message || '获取报警规则详情失败');
+          }
+          return res.data;
+        });
+      },
+
+      /**
+       * 创建报警规则
+       * @param request 创建报警规则的请求参数
+       * @returns Promise 包含创建结果
+       */
+      create: async (request: CreateAlarmRuleRequest): Promise<CreateAlarmRuleResponse> => {
+        const axios = await this.context.ready;
+
+        // 参数验证
+        if (!request.factoryId) {
+          let farm = await this.context.user.getSelectedFarm();
+          request.factoryId = farm?.id;
+        }
+        if (!request.ruleName) {
+          throw new Error('规则名称不能为空');
+        }
+
+        // 设置默认值
+        const requestData: CreateAlarmRuleRequest = {
+          ...request,
+          ruleActive: request.ruleActive !== undefined ? request.ruleActive : true
+        };
+
+        return axios.post(`/api/v2/device/stat/alarms/rule`, requestData).then((res) => {
+          if (res.data.code !== 200) {
+            throw new Error(res.data.message || '创建报警规则失败');
+          }
+          return res.data;
+        });
+      },
+    };
+  }
+
   constructor(context: Cpzxrobot) {
     super();
     this.context = context;
@@ -1193,5 +1277,4 @@ export class DeviceGateway extends Object {
     });
   }
 
-
 }

package/dist/device_gateway.js

@@ -147,6 +147,73 @@ class DeviceGateway extends Object {
             }),
         };
     }
+    get rule() {
+        return {
+            /**
+             * 按工厂id查询报警规则列表
+             * @param factoryId 工厂ID
+             * @returns Promise 包含报警规则列表
+             */
+            list: (factoryId) => __awaiter(this, void 0, void 0, function* () {
+                const axios = yield this.context.ready;
+                // 参数验证
+                if (!factoryId) {
+                    let farm = yield this.context.user.getSelectedFarm();
+                    factoryId = farm === null || farm === void 0 ? void 0 : farm.id;
+                }
+                return axios.get(`/api/v2/device/stat/alarms/rule`, {
+                    params: { factoryId }
+                }).then((res) => {
+                    if (res.data.code !== 200) {
+                        throw new Error(res.data.message || '获取报警规则列表失败');
+                    }
+                    return res.data;
+                });
+            }),
+            /**
+             * 按规则id查询报警规则详情
+             * @param ruleId 规则ID
+             * @returns Promise 包含报警规则详情
+             */
+            get: (ruleId) => __awaiter(this, void 0, void 0, function* () {
+                const axios = yield this.context.ready;
+                // 参数验证
+                if (!ruleId || ruleId <= 0) {
+                    throw new Error('规则ID不能为空且必须大于0');
+                }
+                return axios.get(`/api/v2/device/stat/alarms/rule/${ruleId}`).then((res) => {
+                    if (res.data.code !== 200) {
+                        throw new Error(res.data.message || '获取报警规则详情失败');
+                    }
+                    return res.data;
+                });
+            }),
+            /**
+             * 创建报警规则
+             * @param request 创建报警规则的请求参数
+             * @returns Promise 包含创建结果
+             */
+            create: (request) => __awaiter(this, void 0, void 0, function* () {
+                const axios = yield this.context.ready;
+                // 参数验证
+                if (!request.factoryId) {
+                    let farm = yield this.context.user.getSelectedFarm();
+                    request.factoryId = farm === null || farm === void 0 ? void 0 : farm.id;
+                }
+                if (!request.ruleName) {
+                    throw new Error('规则名称不能为空');
+                }
+                // 设置默认值
+                const requestData = Object.assign(Object.assign({}, request), { ruleActive: request.ruleActive !== undefined ? request.ruleActive : true });
+                return axios.post(`/api/v2/device/stat/alarms/rule`, requestData).then((res) => {
+                    if (res.data.code !== 200) {
+                        throw new Error(res.data.message || '创建报警规则失败');
+                    }
+                    return res.data;
+                });
+            }),
+        };
+    }
     constructor(context) {
         super();
         this.categories = [

package/dist/test_alarm_rule_apis.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * 测试报警规则查询接口
+ * 验证rule.list和rule.get方法的语法正确性
+ */
+// 验证方法签名
+function validateMethodSignature() {
+    console.log("验证报警规则查询接口方法签名...");
+    // 模拟方法调用参数验证
+    const factoryId = 1830745839850088;
+    const ruleId = 1;
+    console.log("✅ factoryId参数验证通过:", factoryId);
+    console.log("✅ ruleId参数验证通过:", ruleId);
+    console.log("✅ 方法签名验证完成");
+}
+// 运行验证
+validateMethodSignature();
+console.log("\n📋 报警规则查询接口使用示例：");
+console.log(`
+// 按工厂ID查询报警规则列表
+const ruleListResult = await deviceGateway.rule.list(1830745839850088);
+console.log("规则列表:", ruleListResult.data);
+
+// 按规则ID查询报警规则详情
+const ruleDetailResult = await deviceGateway.rule.get(1);
+console.log("规则详情:", ruleDetailResult.data);
+`);
+console.log("\n📋 与创建报警规则配合使用：");
+console.log(`
+// 1. 创建报警规则
+const createRequest = {
+  factoryId: 1830745839850088,
+  ruleName: "温度异常报警规则",
+  ruleDescription: "监控温度，当超出设定阈值时触发多级报警。",
+  ruleActive: true,
+  alarmConfigs: [
+    {
+      alarmLevel: 1,
+      alarmMethods: ["SMS"],
+      triggerCondition: 0,
+      active: true
+    }
+  ]
+};
+
+const createResult = await deviceGateway.createAlarmRule(createRequest);
+
+// 2. 查询刚创建的规则
+const newRuleId = 123; // 假设创建成功返回的规则ID
+const ruleDetail = await deviceGateway.rule.get(newRuleId);
+
+// 3. 按工厂查询所有规则
+const allRules = await deviceGateway.rule.list(1830745839850088);
+console.log("工厂所有规则:", allRules.data);
+`);
+console.log("\n✅ 报警规则查询接口测试完成");

package/package.json

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

package/test_alarm_rule_apis.ts

@@ -0,0 +1,62 @@
+/**
+ * 测试报警规则查询接口
+ * 验证rule.list和rule.get方法的语法正确性
+ */
+
+// 验证方法签名
+function validateMethodSignature(): void {
+  console.log("验证报警规则查询接口方法签名...");
+  
+  // 模拟方法调用参数验证
+  const factoryId = 1830745839850088;
+  const ruleId = 1;
+  
+  console.log("✅ factoryId参数验证通过:", factoryId);
+  console.log("✅ ruleId参数验证通过:", ruleId);
+  console.log("✅ 方法签名验证完成");
+}
+
+// 运行验证
+validateMethodSignature();
+
+console.log("\n📋 报警规则查询接口使用示例：");
+console.log(`
+// 按工厂ID查询报警规则列表
+const ruleListResult = await deviceGateway.rule.list(1830745839850088);
+console.log("规则列表:", ruleListResult.data);
+
+// 按规则ID查询报警规则详情
+const ruleDetailResult = await deviceGateway.rule.get(1);
+console.log("规则详情:", ruleDetailResult.data);
+`);
+
+console.log("\n📋 与创建报警规则配合使用：");
+console.log(`
+// 1. 创建报警规则
+const createRequest = {
+  factoryId: 1830745839850088,
+  ruleName: "温度异常报警规则",
+  ruleDescription: "监控温度，当超出设定阈值时触发多级报警。",
+  ruleActive: true,
+  alarmConfigs: [
+    {
+      alarmLevel: 1,
+      alarmMethods: ["SMS"],
+      triggerCondition: 0,
+      active: true
+    }
+  ]
+};
+
+const createResult = await deviceGateway.createAlarmRule(createRequest);
+
+// 2. 查询刚创建的规则
+const newRuleId = 123; // 假设创建成功返回的规则ID
+const ruleDetail = await deviceGateway.rule.get(newRuleId);
+
+// 3. 按工厂查询所有规则
+const allRules = await deviceGateway.rule.list(1830745839850088);
+console.log("工厂所有规则:", allRules.data);
+`);
+
+console.log("\n✅ 报警规则查询接口测试完成");

package/types.d.ts

@@ -537,6 +537,126 @@ interface AlarmTrendResponse {
   message: string;
 }
 
+/**
+ * 报警规则阈值配置接口
+ */
+interface AlarmRuleThresholdConfig {
+  /** 栋舍类型id */
+  unitType?: number;
+  /** 设备类型id */
+  deviceType?: number;
+  /** 报警阈值最小值 */
+  thresholdMin?: number;
+  /** 阈值最大值 */
+  thresholdMax?: number;
+}
+
+/**
+ * 报警规则报警配置接口
+ */
+interface AlarmRuleAlarmConfig {
+  /** 报警级别（1级、2级、3级） */
+  alarmLevel: number;
+  /** 报警方式（短信、邮件等） */
+  alarmMethods: ("SMS" | "EMAIL" | "APP" | "PHONE")[];
+  /** 报警角色id列表 */
+  alarmRoles?: number[];
+  /** 触发条件（报警需要持续的时长，以分钟计） */
+  triggerCondition?: number;
+  /** 分级后的报警是否生效 */
+  active?: boolean;
+}
+
+/**
+ * 创建报警规则请求接口
+ */
+interface CreateAlarmRuleRequest {
+  /** 工厂id */
+  factoryId: number;
+  /** 规则名称 */
+  ruleName: string;
+  /** 规则描述 */
+  ruleDescription?: string;
+  /** 规则是否启用 */
+  ruleActive?: boolean;
+  /** 栋舍id */
+  unitIds?: number[];
+  /** 报警方式id（离线、故障、阈值、变化趋势等） */
+  alarmType?: "OFFLINE" | "FAULT" | "THRESHOLD" | "TREND";
+  /** 报警设备类型（网关、传感器、生产设备等） */
+  deviceTypes?: ("GATEWAY" | "SENSOR" | "DEVICE")[];
+  /** 阈值配置列表 */
+  thresholdConfigs?: AlarmRuleThresholdConfig[];
+  /** 报警配置列表 */
+  alarmConfigs?: AlarmRuleAlarmConfig[];
+}
+
+/**
+ * 创建报警规则响应接口
+ */
+interface CreateAlarmRuleResponse {
+  /** 响应码 */
+  code: number;
+  /** 响应数据 */
+  data: null;
+  /** 响应消息 */
+  message: string;
+}
+
+/**
+ * 报警规则详情接口
+ */
+interface AlarmRuleDetail {
+  /** 规则id */
+  ruleId: number;
+  /** 工厂id */
+  factoryId: number;
+  /** 规则名称 */
+  ruleName: string;
+  /** 规则描述 */
+  ruleDescription?: string;
+  /** 规则是否启用 */
+  ruleActive: boolean;
+  /** 栋舍id列表 */
+  unitIds?: number[];
+  /** 报警方式 */
+  alarmType?: "OFFLINE" | "FAULT" | "THRESHOLD" | "TREND";
+  /** 设备类型列表 */
+  deviceTypes?: ("GATEWAY" | "SENSOR" | "DEVICE")[];
+  /** 创建时间 */
+  createTime: string;
+  /** 最后修改时间 */
+  latestModifyTime: string;
+  /** 阈值配置列表 */
+  thresholdConfigs?: AlarmRuleThresholdConfig[];
+  /** 报警配置列表 */
+  alarmConfigs?: AlarmRuleAlarmConfig[];
+}
+
+/**
+ * 报警规则列表响应接口
+ */
+interface AlarmRuleListResponse {
+  /** 响应码 */
+  code: number;
+  /** 报警规则列表 */
+  data: AlarmRuleDetail[];
+  /** 响应消息 */
+  message: string;
+}
+
+/**
+ * 报警规则详情响应接口
+ */
+interface AlarmRuleDetailResponse {
+  /** 响应码 */
+  code: number;
+  /** 报警规则详情 */
+  data: AlarmRuleDetail;
+  /** 响应消息 */
+  message: string;
+}
+
 declare class Cpzxrobot {
   transport: TransportGateway;
   ready: Promise<MyAxiosInstance>;
@@ -629,6 +749,13 @@ declare module "@cpzxrobot/sdk" {
     AlarmStatisticsByTypeResponse,
     AlarmTrendItem,
     AlarmTrendResponse,
+    AlarmRuleThresholdConfig,
+    AlarmRuleAlarmConfig,
+    CreateAlarmRuleRequest,
+    CreateAlarmRuleResponse,
+    AlarmRuleDetail,
+    AlarmRuleListResponse,
+    AlarmRuleDetailResponse,
     ElectricMeterRate,
     DevicePurpose,
   };

package/test_alarm_trend.ts

@@ -1,16 +0,0 @@
-// 测试报警趋势查询功能
-// 简单的类型检查测试
-
-// 方法签名验证
-function validateMethodSignature() {
-  console.log('报警趋势查询功能语法检查通过！');
-  console.log('方法签名：getAlarmTrend(factoryId?: number, fromDate?: string, toDate?: string)');
-  console.log('参数说明：');
-  console.log('  - factoryId: 工厂ID（必填）');
-  console.log('  - fromDate: 查询起始时间（格式：YYYY-MM-DDTHH:mm:ss.sssZ，可选）');
-  console.log('  - toDate: 查询终止时间（格式：YYYY-MM-DDTHH:mm:ss.sssZ，可选）');
-  console.log('返回值：Promise<AlarmTrendResponse>');
-}
-
-// 运行验证
-validateMethodSignature();