@iobroker/modbus 7.0.2

package/build/lib/jsmodbus/transports/modbus-server-serial.js

@@ -0,0 +1,206 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const modbus_server_core_1 = __importDefault(require("../modbus-server-core"));
+const crc16modbus_1 = __importDefault(require("../../crc16modbus"));
+let SerialPortClass;
+class ModbusServerSerial extends modbus_server_core_1.default {
+    buffer = Buffer.alloc(0);
+    fifo = [];
+    serialPort = null;
+    deviceId = 1;
+    serial;
+    constructor(options) {
+        super(options);
+        this.serial = options.serial;
+        this.deviceId = options.deviceId || 1;
+        if (!this.serial.portName) {
+            throw new Error('No portname specified for serial server.');
+        }
+        this.serial.baudRate ||= 9600;
+        this.serial.dataBits ||= 8;
+        this.serial.stopBits ||= 1;
+        this.serial.parity ||= 'none';
+        this.log.debug(`Starting serial server on port ${this.serial.portName} with settings`);
+        try {
+            import('serialport')
+                .then(sp => {
+                SerialPortClass = sp.SerialPort;
+                this.serialPort = new SerialPortClass({
+                    path: this.serial.portName,
+                    baudRate: this.serial.baudRate,
+                    parity: this.serial.parity,
+                    dataBits: this.serial.dataBits,
+                    stopBits: this.serial.stopBits,
+                });
+                this.serialPort.on('open', this.#onSerialOpen);
+                this.serialPort.on('data', this.#onSerialData);
+                this.serialPort.on('error', this.#onSerialError);
+                this.serialPort.on('close', this.#onSerialClose);
+            })
+                .catch(e => this.log.error(`Error importing serialPort module: ${e}`));
+        }
+        catch (err) {
+            this.log.error(`Failed to create serial port: ${err.message}`);
+            this.emit('error', err);
+            return;
+        }
+        this.on('newState_ready', this.#flush);
+    }
+    #onSerialOpen = () => {
+        this.log.debug('Serial port opened successfully');
+        this.setState('ready');
+        this.emit('connection', { port: this.serial.portName });
+    };
+    #onSerialClose = () => {
+        this.log.debug('Serial port closed');
+        this.emit('close');
+    };
+    #onSerialError = (err) => {
+        this.log.error(`Serial port error: ${err}`);
+        this.emit('error', err);
+    };
+    #onSerialData = (data) => {
+        this.buffer = Buffer.concat([this.buffer, data]);
+        // Process complete RTU frames
+        while (this.buffer.length >= 4) {
+            // Minimum RTU frame: 1 byte address + 1 byte function + 2 bytes CRC
+            // Look for a valid RTU frame
+            let frameLength = 0;
+            // RTU frame structure: [Address][Function Code][Data][CRC16]
+            // We need to determine frame length based on function code
+            if (this.buffer.length >= 2) {
+                const address = this.buffer.readUInt8(0);
+                const functionCode = this.buffer.readUInt8(1);
+                // Skip frames not for our address (0 = broadcast, our deviceId)
+                const deviceId = this.deviceId || 1;
+                if (address !== 0 && address !== deviceId) {
+                    // Remove first byte and continue looking
+                    this.buffer = this.buffer.slice(1);
+                    continue;
+                }
+                frameLength = this.getExpectedFrameLength(functionCode, this.buffer);
+                if (frameLength > 0 && this.buffer.length >= frameLength) {
+                    // Check CRC
+                    const frameData = this.buffer.slice(0, frameLength - 2);
+                    const receivedCrc = this.buffer.readUInt16LE(frameLength - 2);
+                    const calculatedCrc = (0, crc16modbus_1.default)(frameData);
+                    if (receivedCrc === calculatedCrc) {
+                        // Valid frame found
+                        const pdu = frameData.slice(1); // Remove address byte to get PDU
+                        this.fifo.push({
+                            address,
+                            pdu,
+                            originalFrame: frameData,
+                        });
+                        this.buffer = this.buffer.slice(frameLength);
+                        this.#flush();
+                    }
+                    else {
+                        // Invalid CRC, remove first byte and continue
+                        this.log.debug(`Invalid CRC for RTU frame, expected: ${calculatedCrc.toString(16)}received: ${receivedCrc.toString(16)}`);
+                        this.buffer = this.buffer.slice(1);
+                    }
+                }
+                else if (frameLength === 0) {
+                    // Unknown function code, remove first byte
+                    this.log.debug(`Unknown function code: ${functionCode}`);
+                    this.buffer = this.buffer.slice(1);
+                }
+                else {
+                    // Not enough data yet, wait for more
+                    break;
+                }
+            }
+            else {
+                // Not enough data for address and function code
+                break;
+            }
+        }
+    };
+    getExpectedFrameLength = (functionCode, buffer) => {
+        // Return expected frame length based on function code
+        // Returns 0 if function code is unknown or not enough data
+        switch (functionCode) {
+            case 0x01: // Read Coils
+            case 0x02: // Read Discrete Inputs
+            case 0x03: // Read Holding Registers
+            case 0x04: // Read Input Registers
+                return buffer.length >= 6 ? 8 : 0; // Address + FC + Start + Count + CRC = 8 bytes
+            case 0x05: // Write Single Coil
+            case 0x06: // Write Single Register
+                return buffer.length >= 6 ? 8 : 0; // Address + FC + Address + Value + CRC = 8 bytes
+            case 0x0f: // Write Multiple Coils
+            case 0x10: // Write Multiple Registers
+                if (buffer.length >= 7) {
+                    const byteCount = buffer.readUInt8(6);
+                    return 9 + byteCount; // Address + FC + Start + Count + ByteCount + Data + CRC
+                }
+                return 0;
+            default:
+                return 0; // Unknown function code
+        }
+    };
+    #flush = () => {
+        if (this.inState('processing')) {
+            return;
+        }
+        if (!this.fifo.length) {
+            return;
+        }
+        this.setState('processing');
+        const current = this.fifo.shift();
+        this.onData(current.pdu, response => {
+            this.log.debug('Sending RTU response');
+            // Build RTU response frame: Address + Response PDU + CRC
+            const address = current.address;
+            const responseFrame = Buffer.concat([Buffer.from([address]), response]);
+            // Calculate and append CRC
+            const crcValue = (0, crc16modbus_1.default)(responseFrame);
+            const responseWithCrc = Buffer.concat([
+                responseFrame,
+                Buffer.from([crcValue & 0xff, (crcValue >> 8) & 0xff]), // Little endian CRC
+            ]);
+            if (this.serialPort?.isOpen) {
+                this.serialPort.write(responseWithCrc, err => {
+                    if (err) {
+                        this.log.error(`Error writing to serial port: ${err}`);
+                    }
+                    else {
+                        this.log.debug(`RTU response sent, length: ${responseWithCrc.length}`);
+                    }
+                    this.setState('ready');
+                });
+            }
+            else {
+                this.log.error('Serial port not open, cannot send response');
+                this.setState('ready');
+            }
+        });
+    };
+    close(cb) {
+        if (this.serialPort?.isOpen) {
+            this.serialPort.close(err => {
+                if (err) {
+                    this.log.error(`Error closing serial port: ${err}`);
+                }
+                else {
+                    this.log.debug('Serial port closed');
+                }
+                this.serialPort = null;
+                cb?.(err);
+            });
+        }
+        else {
+            cb?.();
+        }
+    }
+    getClients() {
+        // For serial, we return info about the serial port connection
+        return this.serialPort?.isOpen ? [this.serial.portName] : [];
+    }
+}
+exports.default = ModbusServerSerial;
+//# sourceMappingURL=modbus-server-serial.js.map

package/build/lib/jsmodbus/transports/modbus-server-serial.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modbus-server-serial.js","sourceRoot":"","sources":["../../../../src/lib/jsmodbus/transports/modbus-server-serial.ts"],"names":[],"mappings":";;;;;AAAA,+EAAqD;AACrD,oEAA4C;AAG5C,IAAI,eAAoB,CAAC;AAEzB,MAAqB,kBAAmB,SAAQ,4BAAgB;IACpD,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,GAA8D,EAAE,CAAC;IACrE,UAAU,GAAiC,IAAI,CAAC;IACvC,QAAQ,GAAW,CAAC,CAAC;IAE9B,MAAM,CAMZ;IAEF,YAAY,OAgBX;QACG,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC;QAEtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,CAAC,CAAC;QAC3B,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,CAAC,CAAC;QAC3B,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC;QAE9B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,IAAI,CAAC,MAAM,CAAC,QAAQ,gBAAgB,CAAC,CAAC;QAEvF,IAAI,CAAC;YACD,MAAM,CAAC,YAAY,CAAC;iBACf,IAAI,CAAC,EAAE,CAAC,EAAE;gBACP,eAAe,GAAG,EAAE,CAAC,UAAU,CAAC;gBAEhC,IAAI,CAAC,UAAU,GAAG,IAAI,eAAe,CAAC;oBAClC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;oBAC1B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;oBAC9B,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;oBAC1B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;oBAC9B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;iBACjC,CAAC,CAAC;gBAEH,IAAI,CAAC,UAAW,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;gBAChD,IAAI,CAAC,UAAW,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;gBAChD,IAAI,CAAC,UAAW,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;gBAClD,IAAI,CAAC,UAAW,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YACtD,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sCAAsC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACxB,OAAO;QACX,CAAC;QAED,IAAI,CAAC,EAAE,CAAC,gBAAgB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,aAAa,GAAG,GAAS,EAAE;QACvB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC5D,CAAC,CAAC;IAEF,cAAc,GAAG,GAAS,EAAE;QACxB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC;IAEF,cAAc,GAAG,CAAC,GAAW,EAAQ,EAAE;QACnC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sBAAsB,GAAG,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC5B,CAAC,CAAC;IAEF,aAAa,GAAG,CAAC,IAAY,EAAQ,EAAE;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QAEjD,8BAA8B;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC7B,oEAAoE;YACpE,6BAA6B;YAC7B,IAAI,WAAW,GAAG,CAAC,CAAC;YAEpB,6DAA6D;YAC7D,2DAA2D;YAC3D,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACzC,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAE9C,gEAAgE;gBAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;gBACpC,IAAI,OAAO,KAAK,CAAC,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;oBACxC,yCAAyC;oBACzC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACnC,SAAS;gBACb,CAAC;gBAED,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;gBAErE,IAAI,WAAW,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,WAAW,EAAE,CAAC;oBACvD,YAAY;oBACZ,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC;oBACxD,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;oBAC9D,MAAM,aAAa,GAAG,IAAA,qBAAW,EAAC,SAAS,CAAC,CAAC;oBAE7C,IAAI,WAAW,KAAK,aAAa,EAAE,CAAC;wBAChC,oBAAoB;wBACpB,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,iCAAiC;wBAEjE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;4BACX,OAAO;4BACP,GAAG;4BACH,aAAa,EAAE,SAAS;yBAC3B,CAAC,CAAC;wBAEH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;wBAE7C,IAAI,CAAC,MAAM,EAAE,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACJ,8CAA8C;wBAC9C,IAAI,CAAC,GAAG,CAAC,KAAK,CACV,wCAAwC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,aAAa,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAC5G,CAAC;wBACF,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACvC,CAAC;gBACL,CAAC;qBAAM,IAAI,WAAW,KAAK,CAAC,EAAE,CAAC;oBAC3B,2CAA2C;oBAC3C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;oBACzD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACJ,qCAAqC;oBACrC,MAAM;gBACV,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,gDAAgD;gBAChD,MAAM;YACV,CAAC;QACL,CAAC;IACL,CAAC,CAAC;IAEF,sBAAsB,GAAG,CAAC,YAAoB,EAAE,MAAc,EAAU,EAAE;QACtE,sDAAsD;QACtD,2DAA2D;QAE3D,QAAQ,YAAY,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,CAAC,aAAa;YACxB,KAAK,IAAI,CAAC,CAAC,uBAAuB;YAClC,KAAK,IAAI,CAAC,CAAC,yBAAyB;YACpC,KAAK,IAAI,EAAE,uBAAuB;gBAC9B,OAAO,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,+CAA+C;YAEtF,KAAK,IAAI,CAAC,CAAC,oBAAoB;YAC/B,KAAK,IAAI,EAAE,wBAAwB;gBAC/B,OAAO,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iDAAiD;YAExF,KAAK,IAAI,CAAC,CAAC,uBAAuB;YAClC,KAAK,IAAI,EAAE,2BAA2B;gBAClC,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;oBACrB,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBACtC,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC,wDAAwD;gBAClF,CAAC;gBACD,OAAO,CAAC,CAAC;YAEb;gBACI,OAAO,CAAC,CAAC,CAAC,wBAAwB;QAC1C,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,GAAG,GAAS,EAAE;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAC7B,OAAO;QACX,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO;QACX,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE5B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAG,CAAC;QAEnC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAEvC,yDAAyD;YACzD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAChC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;YAExE,2BAA2B;YAC3B,MAAM,QAAQ,GAAG,IAAA,qBAAW,EAAC,aAAa,CAAC,CAAC;YAC5C,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;gBAClC,aAAa;gBACb,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,GAAG,IAAI,EAAE,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,oBAAoB;aAC/E,CAAC,CAAC;YAEH,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;gBAC1B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,EAAE,GAAG,CAAC,EAAE;oBACzC,IAAI,GAAG,EAAE,CAAC;wBACN,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,GAAG,EAAE,CAAC,CAAC;oBAC3D,CAAC;yBAAM,CAAC;wBACJ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;oBAC3E,CAAC;oBACD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBAC3B,CAAC,CAAC,CAAC;YACP,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;gBAC7D,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC3B,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,KAAK,CAAC,EAAiC;QACnC,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACxB,IAAI,GAAG,EAAE,CAAC;oBACN,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,GAAG,EAAE,CAAC,CAAC;gBACxD,CAAC;qBAAM,CAAC;oBACJ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBACzC,CAAC;gBACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;gBACvB,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACJ,EAAE,EAAE,EAAE,CAAC;QACX,CAAC;IACL,CAAC;IAED,UAAU;QACN,8DAA8D;QAC9D,OAAO,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,CAAC;CACJ;AAvPD,qCAuPC"}

package/build/lib/jsmodbus/transports/modbus-server-tcp.d.ts

@@ -0,0 +1,25 @@
+import ModbusServerCore from '../modbus-server-core';
+export default class ModbusServerTcp extends ModbusServerCore {
+    #private;
+    private server;
+    private socketCount;
+    private fifo;
+    private clients;
+    private buffer;
+    private tcp;
+    constructor(options: {
+        tcp: {
+            port?: number;
+            hostname?: string;
+        };
+        logger: ioBroker.Logger;
+        timeout?: number;
+        responseDelay?: number;
+        coils?: Buffer;
+        holding?: Buffer;
+        input?: Buffer;
+        discrete?: Buffer;
+    });
+    close(cb?: () => void): void;
+    getClients(): string[];
+}

package/build/lib/jsmodbus/transports/modbus-server-tcp.js

@@ -0,0 +1,112 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const modbus_server_core_1 = __importDefault(require("../modbus-server-core"));
+const Put_1 = __importDefault(require("../../Put"));
+const node_net_1 = require("node:net");
+class ModbusServerTcp extends modbus_server_core_1.default {
+    server;
+    socketCount = 0;
+    fifo = [];
+    clients = [];
+    buffer = Buffer.alloc(0);
+    tcp;
+    constructor(options) {
+        super(options);
+        this.tcp = {
+            port: options.tcp.port || 502,
+            hostname: options.tcp.hostname || '0.0.0.0',
+        };
+        this.server = (0, node_net_1.createServer)();
+        this.server.on('connection', s => {
+            this.log.debug(`new connection ${JSON.stringify(s.address())}`);
+            this.clients.push(s);
+            this.#initiateSocket(s);
+            this.emit('connection', s.address());
+        });
+        this.server.on('disconnect', s => this.emit('close', s.address()));
+        this.server.listen(this.tcp.port, this.tcp.hostname, () => {
+            this.log.debug(`server is listening on port ${this.tcp.hostname}:${this.tcp.port}`);
+        });
+        this.on('newState_ready', this.#flush);
+        this.setState('ready');
+    }
+    #onSocketData = (socket) => {
+        return (data) => {
+            this.buffer = Buffer.concat([this.buffer, data]);
+            while (this.buffer.length > 8) {
+                // 1. extract mbap
+                const len = this.buffer.readUInt16BE(4);
+                const request = {
+                    transId: this.buffer.readUInt16BE(0),
+                    protocolVer: this.buffer.readUInt16BE(2),
+                    unitId: this.buffer.readUInt8(6),
+                };
+                // 2. extract pdu
+                if (this.buffer.length < 7 + len - 1) {
+                    break; // wait for next bytes
+                }
+                const pdu = this.buffer.slice(7, 7 + len - 1);
+                // emit data event and let the
+                // listener handle the pdu
+                this.fifo.push({ request, pdu, socket });
+                this.#flush();
+                this.buffer = this.buffer.slice(pdu.length + 7, this.buffer.length);
+            }
+        };
+    };
+    #flush = () => {
+        if (this.inState('processing')) {
+            return;
+        }
+        if (!this.fifo.length) {
+            return;
+        }
+        this.setState('processing');
+        const current = this.fifo.shift();
+        this.onData(current.pdu, response => {
+            this.log.debug('sending tcp data');
+            const pkt = new Put_1.default()
+                .word16be(current.request.transId) // transaction id
+                .word16be(current.request.protocolVer) // protocol version
+                .word16be(response.length + 1) // pdu length
+                .word8(current.request.unitId) // unit id
+                .put(response) // the actual pdu
+                .buffer();
+            current.socket.write(pkt);
+            this.setState('ready');
+        });
+    };
+    #initiateSocket = (socket) => {
+        this.socketCount += 1;
+        socket.on('end', () => {
+            this.emit('close');
+            this.log.debug(`connection closed, socket ${JSON.stringify(socket.address())}`);
+            const pos = this.clients.indexOf(socket);
+            if (pos !== -1) {
+                this.clients.splice(pos, 1);
+            }
+        });
+        socket.on('data', this.#onSocketData(socket));
+        socket.on('error', e => {
+            this.emit('error', e);
+            this.log.error(`Socket error ${e}`);
+        });
+    };
+    close(cb) {
+        for (const socket of this.clients) {
+            socket?.destroy();
+        }
+        this.server.close(() => {
+            this.server.unref();
+            cb?.();
+        });
+    }
+    getClients() {
+        return this.clients?.map(it => it?.address()?.address).filter(it => it) || [];
+    }
+}
+exports.default = ModbusServerTcp;
+//# sourceMappingURL=modbus-server-tcp.js.map

package/build/lib/jsmodbus/transports/modbus-server-tcp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modbus-server-tcp.js","sourceRoot":"","sources":["../../../../src/lib/jsmodbus/transports/modbus-server-tcp.ts"],"names":[],"mappings":";;;;;AAAA,+EAAqD;AACrD,oDAA4B;AAC5B,uCAAoF;AAEpF,MAAqB,eAAgB,SAAQ,4BAAgB;IACjD,MAAM,CAAS;IACf,WAAW,GAAG,CAAC,CAAC;IAChB,IAAI,GAQN,EAAE,CAAC;IACD,OAAO,GAAa,EAAE,CAAC;IACvB,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEzB,GAAG,CAGT;IAEF,YAAY,OAYX;QACG,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,GAAG,GAAG;YACP,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG;YAC7B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,SAAS;SAC9C,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,IAAA,uBAAY,GAAE,CAAC;QAE7B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE;YAC7B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;YAChE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAEnE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAS,EAAE;YAC5D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,IAAI,CAAC,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,gBAAgB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED,aAAa,GAAG,CAAC,MAAc,EAA4B,EAAE;QACzD,OAAO,CAAC,IAAY,EAAQ,EAAE;YAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;YAEjD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,kBAAkB;gBAElB,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBACxC,MAAM,OAAO,GAAG;oBACZ,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;oBACpC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;oBACxC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;iBACnC,CAAC;gBAEF,iBAAiB;gBACjB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC;oBACnC,MAAM,CAAC,sBAAsB;gBACjC,CAAC;gBAED,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC;gBAE9C,8BAA8B;gBAC9B,0BAA0B;gBAE1B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;gBAEzC,IAAI,CAAC,MAAM,EAAE,CAAC;gBAEd,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACxE,CAAC;QACL,CAAC,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,GAAG,GAAS,EAAE;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAC7B,OAAO;QACX,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO;QACX,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE5B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAG,CAAC;QAEnC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACnC,MAAM,GAAG,GAAG,IAAI,aAAG,EAAE;iBAChB,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,iBAAiB;iBACnD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,mBAAmB;iBACzD,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,aAAa;iBAC3C,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,UAAU;iBACxC,GAAG,CAAC,QAAQ,CAAC,CAAC,iBAAiB;iBAC/B,MAAM,EAAE,CAAC;YAEd,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,eAAe,GAAG,CAAC,MAAc,EAAQ,EAAE;QACvC,IAAI,CAAC,WAAW,IAAI,CAAC,CAAC;QACtB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YAClB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;YAChF,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;gBACb,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,KAAK,CAAC,EAAe;QACjB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,MAAM,EAAE,OAAO,EAAE,CAAC;QACtB,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACpB,EAAE,EAAE,EAAE,CAAC;QACX,CAAC,CAAC,CAAC;IACP,CAAC;IAED,UAAU;QACN,OAAO,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAE,EAAE,EAAE,OAAO,EAAkB,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;IACnG,CAAC;CACJ;AAtJD,kCAsJC"}

package/build/lib/loggingUtils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Utility functions for logging management
+ */
+/**
+ * Create a logging wrapper that can filter connection error messages
+ *
+ * @param originalLog - The original logger object
+ * @param disableLogging - Whether to disable connection error logging
+ * @returns The wrapped logger or original logger
+ */
+export declare function createLoggingWrapper(originalLog: ioBroker.Logger, disableLogging?: boolean): ioBroker.Logger;

package/build/lib/loggingUtils.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * Utility functions for logging management
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLoggingWrapper = createLoggingWrapper;
+/**
+ * Create a logging wrapper that can filter connection error messages
+ *
+ * @param originalLog - The original logger object
+ * @param disableLogging - Whether to disable connection error logging
+ * @returns The wrapped logger or original logger
+ */
+function createLoggingWrapper(originalLog, disableLogging) {
+    if (!disableLogging) {
+        return originalLog;
+    }
+    // List of connection error messages that should be suppressed when logging is disabled
+    const suppressedErrorMessages = ['Socket Error', 'Client in error state'];
+    return {
+        silly: originalLog.silly.bind(originalLog),
+        level: originalLog.level,
+        debug: originalLog.debug.bind(originalLog),
+        info: originalLog.info.bind(originalLog),
+        warn: originalLog.warn.bind(originalLog),
+        error: (msg, ...args) => {
+            // Check if this is a connection error message that should be suppressed
+            if (typeof msg === 'string' && suppressedErrorMessages.some(pattern => msg.includes(pattern))) {
+                // Suppress this error message when logging is disabled
+                return;
+            }
+            // Allow all other error messages through
+            originalLog.error(msg.toString() + (args.length > 0 ? ` ${args.join(', ')}` : ''));
+        },
+    };
+}
+//# sourceMappingURL=loggingUtils.js.map

package/build/lib/loggingUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggingUtils.js","sourceRoot":"","sources":["../../src/lib/loggingUtils.ts"],"names":[],"mappings":";AAAA;;GAEG;;AASH,oDAwBC;AA/BD;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,WAA4B,EAAE,cAAwB;IACvF,IAAI,CAAC,cAAc,EAAE,CAAC;QAClB,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,uFAAuF;IACvF,MAAM,uBAAuB,GAAG,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;IAE1E,OAAO;QACH,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC;QAC1C,KAAK,EAAE,WAAW,CAAC,KAAK;QACxB,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC;QAC1C,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;QACxC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;QACxC,KAAK,EAAE,CAAC,GAAmB,EAAE,GAAG,IAAW,EAAQ,EAAE;YACjD,wEAAwE;YACxE,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC5F,uDAAuD;gBACvD,OAAO;YACX,CAAC;YACD,yCAAyC;YACzC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACvF,CAAC;KACJ,CAAC;AACN,CAAC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@iobroker/modbus",
+  "version": "7.0.2",
+  "description": "Template for Modbus protocol in ioBroker",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": {
+    "name": "bluefox",
+    "email": "dogafox@gmail.com"
+  },
+  "contributors": [
+    {
+      "name": "bluefox",
+      "email": "dogafox@gmail.com"
+    }
+  ],
+  "homepage": "https://github.com/ioBroker/modbus",
+  "license": "MIT",
+  "keywords": [
+    "ioBroker",
+    "modbus",
+    "Smart Home",
+    "home automation"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ioBroker/modbus"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "serialport": "^13.0.0"
+  },
+  "dependencies": {
+    "@iobroker/adapter-core": "^3.3.2",
+    "tsv-json": "^2.0.0"
+  },
+  "devDependencies": {
+    "@alcalzone/release-script": "^3.8.0",
+    "@alcalzone/release-script-plugin-license": "^3.7.0",
+    "@iobroker/build-tools": "^2.0.15",
+    "@iobroker/eslint-config": "^2.2.0",
+    "@types/node": "^24.6.2",
+    "@types/serialport": "^10.2.0"
+  },
+  "main": "build/index.js",
+  "files": [
+    "build/",
+    "LICENSE"
+  ],
+  "scripts": {
+    "prepublishOnly": "npm run build",
+    "lint": "eslint -c eslint.config.mjs",
+    "build": "tsc -p tsconfig.build.json",
+    "release": "release-script",
+    "release-patch": "release-script patch --yes",
+    "release-minor": "release-script minor --yes",
+    "release-major": "release-script major --yes",
+    "update-packages": "npx -y npm-check-updates --upgrade",
+    "npm": "npm i"
+  },
+  "bugs": {
+    "url": "https://github.com/ioBroker/modbus/issues"
+  },
+  "readmeFilename": "README.md"
+}