zdjn-common-utils 1.0.0

package/README.md

@@ -0,0 +1,115 @@
+# zdjn-common-utils
+
+中电节能常用工具库。
+
+## 安装
+
+```bash
+npm install zdjn-common-utils
+```
+
+## 更新版本
+
+为确保使用最新的功能，请定期更新包版本：
+
+```bash
+# 检查是否有更新版本
+npm outdated zdjn-common-utils
+
+# 更新到最新版本
+npm update zdjn-common-utils
+
+# 或者安装指定版本
+npm install zdjn-common-utils@latest
+```
+
+**注意**：版本更新可能包含新增的报警类型或功能优化，建议每次更新后查看版本日志。
+
+## 使用
+
+```typescript
+import { parseSystemAlarmBits, SystemAlarmType } from 'zdjn-common-utils';
+
+// 解析位标志值
+const alarms = parseSystemAlarmBits(5); // bit0 + bit2 = 1 + 4 = 5
+
+console.log(alarms);
+// 输出: [
+//   '供水温度上限报警',
+//   '供水温度传感器断线报警'
+// ]
+
+// 检查特定报警类型
+const hasAlarm = alarms.includes(SystemAlarmType.WaterSupplyTempHigh);
+console.log(hasAlarm); // true
+```
+
+## API
+
+### SystemAlarmType
+
+系统报警类型枚举：
+
+- `WaterSupplyTempHigh` - 供水温度上限报警
+- `WaterSupplyTempLow` - 供水温度下限报警
+- `WaterSupplyTempSensorBreak` - 供水温度传感器断线报警
+- `WaterSupplyTempStatus` - 供水温度状态报警
+- `ReturnWaterTempHigh` - 回水温度上限报警
+- `ReturnWaterTempLow` - 回水温度下限报警
+- `ReturnWaterTempSensorBreak` - 回水温度传感器断线报警
+- `ReturnWaterTempStatus` - 回水温度状态报警
+- `ElectromagneticFlowmeterFault` - 电磁流量计连接故障
+- `ExcitationAlarm` - 励磁报警
+- `EmptyPipeAlarm` - 空管报警
+- `BatteryVoltageFault` - 电池电压故障
+- `SystemAlarm` - 系统报警
+
+### parseSystemAlarmBits(bitValue)
+
+解析系统报警位标志值，返回激活的报警类型数组。
+
+**参数：**
+- `bitValue` (number): 位标志值，每个 bit 代表一种报警状态
+
+**返回值：**
+- `SystemAlarmType[]`: 激活的报警类型数组
+
+**示例：**
+
+```typescript
+// 单个报警
+parseSystemAlarmBits(1);  // ['供水温度上限报警']
+
+// 多个报警
+parseSystemAlarmBits(7);  // bit0 + bit1 + bit2
+// ['供水温度上限报警', '供水温度下限报警', '供水温度传感器断线报警']
+
+// 所有报警
+parseSystemAlarmBits(8191);  // 所有位都为1
+```
+
+## 位标志说明
+
+| 位 | 值 | 报警类型 |
+|---|---|---|
+| bit0 | 1 | 供水温度上限报警 |
+| bit1 | 2 | 供水温度下限报警 |
+| bit2 | 4 | 供水温度传感器断线报警 |
+| bit3 | 8 | 供水温度状态报警 |
+| bit4 | 16 | 回水温度上限报警 |
+| bit5 | 32 | 回水温度下限报警 |
+| bit6 | 64 | 回水温度传感器断线报警 |
+| bit7 | 128 | 回水温度状态报警 |
+| bit8 | 256 | 电磁流量计连接故障 |
+| bit9 | 512 | 励磁报警 |
+| bit10 | 1024 | 空管报警 |
+| bit11 | 2048 | 电池电压故障 |
+| bit12 | 4096 | 系统报警 |
+
+## 类型定义
+
+完整的 TypeScript 类型支持，无需额外配置。
+
+## 许可证
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+export declare enum SystemAlarmType {
+    WaterSupplyTempHigh = "\u4F9B\u6C34\u6E29\u5EA6\u4E0A\u9650\u62A5\u8B66",
+    WaterSupplyTempLow = "\u4F9B\u6C34\u6E29\u5EA6\u4E0B\u9650\u62A5\u8B66",
+    WaterSupplyTempSensorBreak = "\u4F9B\u6C34\u6E29\u5EA6\u4F20\u611F\u5668\u65AD\u7EBF\u62A5\u8B66",
+    WaterSupplyTempStatus = "\u4F9B\u6C34\u6E29\u5EA6\u72B6\u6001\u62A5\u8B66",
+    ReturnWaterTempHigh = "\u56DE\u6C34\u6E29\u5EA6\u4E0A\u9650\u62A5\u8B66",
+    ReturnWaterTempLow = "\u56DE\u6C34\u6E29\u5EA6\u4E0B\u9650\u62A5\u8B66",
+    ReturnWaterTempSensorBreak = "\u56DE\u6C34\u6E29\u5EA6\u4F20\u611F\u5668\u65AD\u7EBF\u62A5\u8B66",
+    ReturnWaterTempStatus = "\u56DE\u6C34\u6E29\u5EA6\u72B6\u6001\u62A5\u8B66",
+    ElectromagneticFlowmeterFault = "\u7535\u78C1\u6D41\u91CF\u8BA1\u8FDE\u63A5\u6545\u969C",
+    ExcitationAlarm = "\u52B1\u78C1\u62A5\u8B66",
+    EmptyPipeAlarm = "\u7A7A\u7BA1\u62A5\u8B66",
+    BatteryVoltageFault = "\u7535\u6C60\u7535\u538B\u6545\u969C",
+    SystemAlarm = "\u7CFB\u7EDF\u62A5\u8B66"
+}
+export declare function parseSystemAlarmBits(bitValue: number): SystemAlarmType[];
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,oBAAY,eAAe;IACzB,mBAAmB,qDAAa;IAChC,kBAAkB,qDAAa;IAC/B,0BAA0B,uEAAgB;IAC1C,qBAAqB,qDAAa;IAClC,mBAAmB,qDAAa;IAChC,kBAAkB,qDAAa;IAC/B,0BAA0B,uEAAgB;IAC1C,qBAAqB,qDAAa;IAClC,6BAA6B,2DAAc;IAC3C,eAAe,6BAAS;IACxB,cAAc,6BAAS;IACvB,mBAAmB,yCAAW;IAC9B,WAAW,6BAAS;CACrB;AA0BD,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,EAAE,CAaxE"}

package/dist/index.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SystemAlarmType = void 0;
+exports.parseSystemAlarmBits = parseSystemAlarmBits;
+var SystemAlarmType;
+(function (SystemAlarmType) {
+    SystemAlarmType["WaterSupplyTempHigh"] = "\u4F9B\u6C34\u6E29\u5EA6\u4E0A\u9650\u62A5\u8B66";
+    SystemAlarmType["WaterSupplyTempLow"] = "\u4F9B\u6C34\u6E29\u5EA6\u4E0B\u9650\u62A5\u8B66";
+    SystemAlarmType["WaterSupplyTempSensorBreak"] = "\u4F9B\u6C34\u6E29\u5EA6\u4F20\u611F\u5668\u65AD\u7EBF\u62A5\u8B66";
+    SystemAlarmType["WaterSupplyTempStatus"] = "\u4F9B\u6C34\u6E29\u5EA6\u72B6\u6001\u62A5\u8B66";
+    SystemAlarmType["ReturnWaterTempHigh"] = "\u56DE\u6C34\u6E29\u5EA6\u4E0A\u9650\u62A5\u8B66";
+    SystemAlarmType["ReturnWaterTempLow"] = "\u56DE\u6C34\u6E29\u5EA6\u4E0B\u9650\u62A5\u8B66";
+    SystemAlarmType["ReturnWaterTempSensorBreak"] = "\u56DE\u6C34\u6E29\u5EA6\u4F20\u611F\u5668\u65AD\u7EBF\u62A5\u8B66";
+    SystemAlarmType["ReturnWaterTempStatus"] = "\u56DE\u6C34\u6E29\u5EA6\u72B6\u6001\u62A5\u8B66";
+    SystemAlarmType["ElectromagneticFlowmeterFault"] = "\u7535\u78C1\u6D41\u91CF\u8BA1\u8FDE\u63A5\u6545\u969C";
+    SystemAlarmType["ExcitationAlarm"] = "\u52B1\u78C1\u62A5\u8B66";
+    SystemAlarmType["EmptyPipeAlarm"] = "\u7A7A\u7BA1\u62A5\u8B66";
+    SystemAlarmType["BatteryVoltageFault"] = "\u7535\u6C60\u7535\u538B\u6545\u969C";
+    SystemAlarmType["SystemAlarm"] = "\u7CFB\u7EDF\u62A5\u8B66";
+})(SystemAlarmType || (exports.SystemAlarmType = SystemAlarmType = {}));
+const ALARM_BIT_MAP = {
+    0: SystemAlarmType.WaterSupplyTempHigh,
+    1: SystemAlarmType.WaterSupplyTempLow,
+    2: SystemAlarmType.WaterSupplyTempSensorBreak,
+    3: SystemAlarmType.WaterSupplyTempStatus,
+    4: SystemAlarmType.ReturnWaterTempHigh,
+    5: SystemAlarmType.ReturnWaterTempLow,
+    6: SystemAlarmType.ReturnWaterTempSensorBreak,
+    7: SystemAlarmType.ReturnWaterTempStatus,
+    8: SystemAlarmType.ElectromagneticFlowmeterFault,
+    9: SystemAlarmType.ExcitationAlarm,
+    10: SystemAlarmType.EmptyPipeAlarm,
+    11: SystemAlarmType.BatteryVoltageFault,
+    12: SystemAlarmType.SystemAlarm
+};
+function parseSystemAlarmBits(bitValue) {
+    const alarms = [];
+    for (let bit = 0; bit <= 12; bit++) {
+        const mask = 1 << bit;
+        if ((bitValue & mask) !== 0) {
+            if (ALARM_BIT_MAP[bit]) {
+                alarms.push(ALARM_BIT_MAP[bit]);
+            }
+        }
+    }
+    return alarms;
+}

package/dist/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index.test.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const node_assert_1 = __importDefault(require("node:assert"));
+const index_js_1 = require("./index.js");
+(0, node_test_1.describe)('parseSystemAlarmBits', () => {
+    (0, node_test_1.it)('应该返回空数组，当所有位都为0时', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(0);
+        node_assert_1.default.strictEqual(result.length, 0);
+    });
+    (0, node_test_1.it)('应该正确解析单个位标志', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(1);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.WaterSupplyTempHigh);
+    });
+    (0, node_test_1.it)('应该正确解析供水温度上限报警 (bit0)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(1);
+        node_assert_1.default.strictEqual(result.includes(index_js_1.SystemAlarmType.WaterSupplyTempHigh), true);
+    });
+    (0, node_test_1.it)('应该正确解析供水温度下限报警 (bit1)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(2);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.WaterSupplyTempLow);
+    });
+    (0, node_test_1.it)('应该正确解析供水温度传感器断线报警 (bit2)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(4);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.WaterSupplyTempSensorBreak);
+    });
+    (0, node_test_1.it)('应该正确解析供水温度状态报警 (bit3)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(8);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.WaterSupplyTempStatus);
+    });
+    (0, node_test_1.it)('应该正确解析回水温度上限报警 (bit4)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(16);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.ReturnWaterTempHigh);
+    });
+    (0, node_test_1.it)('应该正确解析回水温度下限报警 (bit5)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(32);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.ReturnWaterTempLow);
+    });
+    (0, node_test_1.it)('应该正确解析回水温度传感器断线报警 (bit6)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(64);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.ReturnWaterTempSensorBreak);
+    });
+    (0, node_test_1.it)('应该正确解析回水温度状态报警 (bit7)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(128);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.ReturnWaterTempStatus);
+    });
+    (0, node_test_1.it)('应该正确解析电磁流量计连接故障 (bit8)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(256);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.ElectromagneticFlowmeterFault);
+    });
+    (0, node_test_1.it)('应该正确解析励磁报警 (bit9)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(512);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.ExcitationAlarm);
+    });
+    (0, node_test_1.it)('应该正确解析空管报警 (bit10)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(1024);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.EmptyPipeAlarm);
+    });
+    (0, node_test_1.it)('应该正确解析电池电压故障 (bit11)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(2048);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.BatteryVoltageFault);
+    });
+    (0, node_test_1.it)('应该正确解析系统报警 (bit12)', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(4096);
+        node_assert_1.default.strictEqual(result.length, 1);
+        node_assert_1.default.strictEqual(result[0], index_js_1.SystemAlarmType.SystemAlarm);
+    });
+    (0, node_test_1.it)('应该正确解析多个位标志', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(3);
+        node_assert_1.default.strictEqual(result.length, 2);
+        node_assert_1.default.strictEqual(result.includes(index_js_1.SystemAlarmType.WaterSupplyTempHigh), true);
+        node_assert_1.default.strictEqual(result.includes(index_js_1.SystemAlarmType.WaterSupplyTempLow), true);
+    });
+    (0, node_test_1.it)('应该正确解析所有位标志', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(8191);
+        node_assert_1.default.strictEqual(result.length, 13);
+        const expectedAlarms = [
+            index_js_1.SystemAlarmType.WaterSupplyTempHigh,
+            index_js_1.SystemAlarmType.WaterSupplyTempLow,
+            index_js_1.SystemAlarmType.WaterSupplyTempSensorBreak,
+            index_js_1.SystemAlarmType.WaterSupplyTempStatus,
+            index_js_1.SystemAlarmType.ReturnWaterTempHigh,
+            index_js_1.SystemAlarmType.ReturnWaterTempLow,
+            index_js_1.SystemAlarmType.ReturnWaterTempSensorBreak,
+            index_js_1.SystemAlarmType.ReturnWaterTempStatus,
+            index_js_1.SystemAlarmType.ElectromagneticFlowmeterFault,
+            index_js_1.SystemAlarmType.ExcitationAlarm,
+            index_js_1.SystemAlarmType.EmptyPipeAlarm,
+            index_js_1.SystemAlarmType.BatteryVoltageFault,
+            index_js_1.SystemAlarmType.SystemAlarm
+        ];
+        expectedAlarms.forEach(alarm => {
+            node_assert_1.default.strictEqual(result.includes(alarm), true);
+        });
+    });
+    (0, node_test_1.it)('应该正确解析不连续的位标志', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(4233);
+        node_assert_1.default.strictEqual(result.length, 4);
+        node_assert_1.default.strictEqual(result.includes(index_js_1.SystemAlarmType.WaterSupplyTempHigh), true);
+        node_assert_1.default.strictEqual(result.includes(index_js_1.SystemAlarmType.WaterSupplyTempStatus), true);
+        node_assert_1.default.strictEqual(result.includes(index_js_1.SystemAlarmType.ReturnWaterTempStatus), true);
+        node_assert_1.default.strictEqual(result.includes(index_js_1.SystemAlarmType.SystemAlarm), true);
+    });
+    (0, node_test_1.it)('应该处理负数输入', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(-1);
+        node_assert_1.default.ok(Array.isArray(result));
+    });
+    (0, node_test_1.it)('应该处理大数值输入', () => {
+        const result = (0, index_js_1.parseSystemAlarmBits)(999999);
+        node_assert_1.default.ok(Array.isArray(result));
+    });
+});

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "zdjn-common-utils",
+  "version": "1.0.0",
+  "description": "中电节能常用工具库",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build",
+    "test": "node --test dist/index.test.js"
+  },
+  "keywords": [
+    "utils",
+    "utilities",
+    "helper",
+    "common",
+    "typescript"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "typescript": "^5.3.3"
+  }
+}