device-communication-node 1.0.0-beta.1

package/src/device/model/Task.js

@@ -0,0 +1,155 @@
+const InteractionPattern = require('./InteractionPattern')
+
+class Task {
+
+    /**
+     * 全局序列生成器
+     */
+    static seqGenerator = 0
+
+    /**
+     * 写入数据 Buffer
+     * @type {Buffer}
+     */
+    writeBytes
+
+    /**
+     * 回调函数 (readBytes, writeBytes)
+     * @type {Function}
+     */
+    dataReceived
+
+    /**
+     * 响应超时时间
+     * @type {number}
+     */
+    timeout = 500
+
+    /**
+     * 重试次数
+     * @type {number}
+     */
+    retryCount = 0
+
+    /**
+     * 优先级（越小越优先）
+     * @type {number}
+     */
+    priority = 0
+
+    /**
+     * 通信模式
+     */
+    interactionPattern = InteractionPattern.FIRE_AND_FORGET
+
+    /**
+     * 序列号
+     */
+    sequence
+
+    /**
+     * 构造函数
+     * @param {*} writeBytes 写入的字节数组
+     * @param {*} priority 优先级
+     * @param {*} retryCount 重试次数
+     * @param {*} dataReceived 回调函数
+     * @param {*} timeout 超时时间
+     * @param {*} interactionPattern 任务交互模式
+     */
+    constructor(
+        writeBytes,
+        priority,
+        retryCount,
+        dataReceived,
+        timeout,
+        interactionPattern
+    ) {
+        this.writeBytes = writeBytes
+        this.priority = priority
+        this.retryCount = retryCount
+        this.dataReceived = dataReceived
+        this.interactionPattern = interactionPattern
+
+        if (typeof timeout === 'number') {
+            this.timeout = timeout
+        }
+        this.sequence = Task.seqGenerator++
+    }
+    compareTo(other) {
+
+        // 优先级（越小越优先）
+        let res = this.priority - other.priority
+
+        // 序列号（先进先出）
+        if (res === 0) {
+            res = this.sequence - other.sequence
+        }
+
+        return res
+    }
+
+    /**
+     * getter: writeBytes
+     */
+    getWriteBytes() {
+        return this.writeBytes
+    }
+
+    /**
+     * getter: callback
+     */
+    getDataReceived() {
+        return this.dataReceived
+    }
+
+    /**
+     * timeout
+     */
+    getTimeout() {
+        return this.timeout
+    }
+
+    /**
+     * retry
+     */
+    getRetryCount() {
+        return this.retryCount
+    }
+
+    /**
+     * priority
+     */
+    getPriority() {
+        return this.priority
+    }
+
+    /**
+     * sequence
+     */
+    getSequence() {
+        return this.sequence
+    }
+
+    /**
+     * set retry
+     */
+    setRetryCount(retryCount) {
+        this.retryCount = retryCount
+    }
+
+    /**
+     * getter interactionPattern
+     */
+    getSchedulingStrategy() {
+        return this.interactionPattern
+    }
+
+    /**
+     * setter interactionPattern
+     */
+    setInteractionPattern(interactionPattern) {
+        this.interactionPattern = interactionPattern
+    }
+}
+
+module.exports = Task

package/src/device/utils/ByteUtils.js

@@ -0,0 +1,62 @@
+
+/**
+ * 截取 Buffer
+ *
+ * @param {Buffer|Uint8Array} buffer 原始数据
+ * @param {number} start 起始索引
+ * @param {number} end 结束索引 (包含此位)
+ * @returns {Buffer} 新的子数组
+ */
+const slice = (buffer, start, end) => {
+    if (!buffer || !(buffer instanceof Uint8Array)) {
+        throw new Error("Input must be a Buffer or Uint8Array");
+    }
+
+    if (start < 0 || end >= buffer.length || start > end) {
+        throw new Error(`Invalid start or end index: start=${start}, end=${end}, length=${buffer.length}`);
+    }
+    return Buffer.from(buffer.subarray(start, end + 1));
+}
+
+/**
+ * 合并多个 Buffer
+ *
+ * @param {...(Buffer|Uint8Array)} buffers 多个数组参数
+ * @returns {Buffer} 合并后的新 Buffer
+ */
+const merge = (...buffers) => {
+    if (!buffers || buffers.length === 0) {
+        return Buffer.alloc(0);
+    }
+
+    // 过滤掉 null 或 undefined 的部分
+    const validBuffers = buffers.filter(b => b !== null && b !== undefined);
+
+    if (validBuffers.length === 0) {
+        return Buffer.alloc(0);
+    }
+    return Buffer.concat(validBuffers);
+}
+/**
+ * CIDR 转子网掩码 byte 数组
+ * 例如：24 => 255.255.255.0 => [0xFF, 0xFF, 0xFF, 0x00]
+ */
+const cidrToSubnetBytes = (cidr) => {
+    const mask = [];
+
+    for (let i = 0; i < 4; i++) {
+        if (cidr >= 8) {
+            mask.push(255);
+            cidr -= 8;
+        } else if (cidr > 0) {
+            const value = (0xFF << (8 - cidr)) & 0xFF;
+            mask.push(value);
+            cidr = 0;
+        } else {
+            mask.push(0);
+        }
+    }
+
+    return mask;
+}
+module.exports = { slice, merge, cidrToSubnetBytes }

package/src/device/utils/CheckUtils.js

@@ -0,0 +1,57 @@
+
+/**
+ * 针对分子筛硬件的CRC8计算
+ * @param {Buffer|Uint8Array} data
+ * @param {number} offset
+ * @param {number} length
+ * @returns {number}
+ */
+const calculateCrc8 = (data, offset, length) => {
+    let crc = 0xFF
+
+    for (let idx = 0; idx < length; idx++) {
+        let ch1 = data[idx + offset] & 0xFF
+
+        for (let i = 0; i < 8; i++) {
+            if (((crc ^ ch1) & 0x80) > 0) {
+                crc = ((crc << 1) ^ 0x1D) & 0xFF
+            } else {
+                crc = (crc << 1) & 0xFF
+            }
+
+            ch1 = (ch1 << 1) & 0xFF
+        }
+    }
+
+    return (crc ^ 0xFF) & 0xFF
+}
+
+/**
+ * 计算 Modbus CRC16
+ * 遵循低位在前（Little-endian）的标准输出
+ *
+ * @param {Uint8Array|number[]} data 数据字节数组
+ * @returns {number[]} [CRC低字节, CRC高字节]
+ */
+const getModbusCRC16 = (data) => {
+    let crc = 0xFFFF;
+
+    for (const b of data) {
+        crc ^= (b & 0xFF);
+
+        for (let i = 0; i < 8; i++) {
+            if ((crc & 0x0001) !== 0) {
+                crc = (crc >>> 1) ^ 0xA001;
+            } else {
+                crc >>>= 1;
+            }
+        }
+    }
+
+    const low = crc & 0xFF;
+    const high = (crc >>> 8) & 0xFF;
+
+    return [low, high];
+}
+
+module.exports = { calculateCrc8, getModbusCRC16 }

package/src/device/utils/HexUtils.js

@@ -0,0 +1,100 @@
+
+/**
+ * 将 16 进制字符串转回 Buffer
+ */
+const hexToBytes = (hexString) => {
+    if (!hexString || typeof hexString !== 'string') {
+        return Buffer.alloc(0)
+    }
+
+    try {
+        const cleanHex = hexString.replace(/\s+/g, '')
+        return Buffer.from(cleanHex, 'hex')
+    } catch (e) {
+        console.error('非法 16 进制字符串:', e.message)
+        return Buffer.alloc(0)
+    }
+}
+
+/**
+ * Buffer 转 HEX字符串
+ */
+const bytesToHexString = (bytes) => {
+    if (!bytes || bytes.length === 0) {
+        return ''
+    }
+
+    const hex = Buffer.from(bytes).toString('hex')
+
+    return hex
+        .replace(/.{2}/g, '$& ')
+        .trim()
+        .toUpperCase()
+}
+
+/**
+* 单个字节转 HEX 字符串
+* @param {number} byte - 0-255 的整数
+*/
+const byteToHexString = (byte) => {
+    // 确保是 0xFF 范围内的单字节，并转为16进制字符串
+    // padStart(2, '0') 确保结果始终是两位数，例如 9 变成 09
+    return (byte & 0xFF)
+        .toString(16)
+        .padStart(2, '0')
+        .toUpperCase();
+}
+
+/**
+ * 10进制转2位HEX
+ */
+const toHexByteFast = (value) => {
+    return (value & 0xFF)
+        .toString(16)
+        .toUpperCase()
+        .padStart(2, '0')
+}
+
+/**
+ * 单字节转HEX
+ */
+const byteToHex = (b) => {
+    return this.toHexByteFast(b)
+}
+
+/**
+ * 10进制转2字节数组（高字节在前）
+ * 例如：
+ * 258 => [0x01, 0x02]
+ */
+const intTo2Bytes = (value) => {
+    return Buffer.from([
+        (value >> 8) & 0xFF,
+        value & 0xFF
+    ])
+}
+
+/**
+ * 10进制转2字节数组（低字节在前）
+ * @param {*} value 
+ * @returns 
+ */
+const intTo2BytesLE = (value) => {
+    return Buffer.from([
+        value & 0xFF,        // 先放低位
+        (value >> 8) & 0xFF  // 后放高位
+    ])
+}
+
+/**
+ * 10进制转1字节数组
+ * @param {*} value 
+ * @returns 
+ */
+const intTo1Byte = (value) => {
+    return Buffer.from([
+        value & 0xFF
+    ])
+}
+
+module.exports = { hexToBytes, bytesToHexString, byteToHexString, toHexByteFast, byteToHex, intTo2Bytes, intTo2BytesLE, intTo1Byte }

package/src/device/utils/NetworkUtils.js

@@ -0,0 +1,50 @@
+const os = require('os');
+
+/**
+ * 获取真实局域网 IPv4
+ * 自动过滤：
+ * - 127.0.0.1
+ * - VMware
+ * - VirtualBox
+ * - Hyper-V
+ * - Docker
+ * - WSL
+ * - vEthernet
+ */
+const getLocalIP = () => {
+    const interfaces = os.networkInterfaces();
+
+    for (const name of Object.keys(interfaces)) {
+
+        // 过滤虚拟网卡
+        const lowerName = name.toLowerCase();
+
+        if (
+            lowerName.includes('vmware') ||
+            lowerName.includes('virtual') ||
+            lowerName.includes('hyper-v') ||
+            lowerName.includes('vethernet') ||
+            lowerName.includes('docker') ||
+            lowerName.includes('wsl')
+        ) {
+            continue;
+        }
+
+        for (const net of interfaces[name]) {
+
+            // 只要 IPv4 且不是回环地址
+            if (
+                net.family === 'IPv4' &&
+                !net.internal
+            ) {
+                return net.address;
+            }
+        }
+    }
+
+    return null;
+}
+
+module.exports = {
+    getLocalIP
+};

package/src/drivers/test/DeviceTest.js

@@ -0,0 +1,49 @@
+const DeviceCore = require('../../device/core/DeviceCore');
+const checkUtils = require('../../device/utils/checkUtils');
+const hexUtils = require('../../device/utils/hexUtils');
+/**
+ * 测试设备
+ */
+class DeviceTest extends DeviceCore {
+    constructor() {
+        super();
+    }
+    /**
+     * 发送
+     */
+    async tesetSend() {
+        // 构建的完整协议帧
+        const completeFrame = Buffer.from([0x02, 0x03, 0x00, 0x0A, 0x00, 0x03, 0x25, 0xFA]);
+
+        return await this.sendSync(completeFrame, {
+            retry: 0,
+            timeout: 500,
+            parser: (readyBytes, writeBytes) => {
+
+                // 数据长度校验，应为 6
+                if (readyBytes[2] !== 6) {
+                    throw new Error(`返回数据长度异常：${readyBytes[2]}`);
+                }
+
+                if (readyBytes.length < 11) {
+                    throw new Error(`返回数据长度不足：${readyBytes.length}`);
+                }
+
+                const readUInt16 = (offset) =>
+                    ((readyBytes[offset] << 8) | readyBytes[offset + 1]) >>> 0;
+
+                const internalTemperature = readUInt16(3) / 10 - 25;
+                const externalTemperature = readUInt16(5) / 10 - 25;
+                const humidity = readUInt16(7) / 10;
+
+                return {
+                    internalTemperature,
+                    externalTemperature,
+                    humidity
+                };
+            }
+        });
+    }
+}
+
+module.exports = DeviceTest;

package/src/index.js

@@ -0,0 +1,14 @@
+const CommDispatcherManager = require('./device/core/commDispatcherManager')
+const DeviceTest = require('./drivers/test/DeviceTest')
+
+const main = async () => {
+
+    const dispatcher = CommDispatcherManager.create("tcp", "192.168.1.113:8234")
+    const device = new DeviceTest();
+    device.setCommDispatcher(dispatcher)
+    dispatcher.setDevice(device)
+    console.log(await device.tesetSend())
+
+}
+
+main();