@totemsdk/edge-modbus 0.2.0 → 0.2.2

package/dist/sensor-bridge.js

@@ -1,25 +1,23 @@
-"use strict";
 /**
  * Modbus Sensor Bridge — maps Modbus register reads to Edge proof inputs.
  *
- * Uses RTU frame format (no MBAP header) to match the Go native binary.
+ * Shares gateway validation so malformed responses never become sensor proofs.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createModbusSensorBridge = createModbusSensorBridge;
-function createModbusSensorBridge(config) {
+import { createModbusGateway } from './gateway.js';
+export function createModbusSensorBridge(config) {
     const timers = [];
     let running = false;
+    const gateway = config.gateway ?? createModbusGateway({ runtime: config.runtime, transport: config.transport });
     async function pollBinding(binding) {
         try {
-            let values;
-            const frame = buildReadFrame(binding.unitId, binding.functionCode, binding.address, binding.count);
-            const response = await config.transport.sendFrame(frame);
-            if (binding.functionCode === 1 || binding.functionCode === 2) {
-                values = parseCoils(response, binding.count);
-            }
-            else if (binding.functionCode === 3 || binding.functionCode === 4) {
-                values = parseRegisters(response, binding.count);
-            }
+            const args = [binding.unitId, binding.address, binding.count];
+            const result = binding.functionCode === 1 ? await gateway.readCoils(...args)
+                : binding.functionCode === 2 ? await gateway.readDiscreteInputs(...args)
+                    : binding.functionCode === 3 ? await gateway.readHoldingRegisters(...args)
+                        : binding.functionCode === 4 ? await gateway.readInputRegisters(...args) : undefined;
+            if (!result?.ok || !result.data)
+                return;
+            const values = result.data.values;
             if (config.runtime.ports.proof) {
                 await config.runtime.ports.proof.createProof({
                     subject: `sensor:${binding.sensorId}`,
@@ -61,30 +59,3 @@ function createModbusSensorBridge(config) {
         },
     };
 }
-// ── RTU frame builder (no MBAP header — matches Go binary) ────────────────
-function buildReadFrame(unitId, fc, address, count) {
-    const buf = new Uint8Array(8);
-    buf[0] = unitId;
-    buf[1] = fc;
-    new DataView(buf.buffer).setUint16(2, address, false);
-    new DataView(buf.buffer).setUint16(4, count, false);
-    buf[6] = 0;
-    buf[7] = 0;
-    return buf;
-}
-// ── Response parsers (RTU format — no MBAP header) ────────────────────────
-function parseCoils(response, count) {
-    const result = [];
-    for (let i = 0; i < count; i++) {
-        const byte = response[3 + Math.floor(i / 8)] ?? 0;
-        result.push(((byte >> (i % 8)) & 1) === 1);
-    }
-    return result;
-}
-function parseRegisters(response, count) {
-    const result = [];
-    for (let i = 0; i < count; i++) {
-        result.push(new DataView(response.buffer, response.byteOffset + 3 + i * 2, 2).getUint16(0, false));
-    }
-    return result;
-}

package/dist/transport.d.ts

@@ -9,7 +9,13 @@ export interface ModbusTransportPort {
     connect(): Promise<void>;
     /** Close the connection. */
     disconnect(): Promise<void>;
-    /** Send a raw Modbus frame and receive the response. */
+    /**
+     * Exchange [unitId, functionCode, ...PDU data], with no CRC or MBAP header.
+     * Reads return [unitId, functionCode, byteCount, ...data]; successful writes
+     * return [unitId, functionCode, addressHi, addressLo, valueOrCountHi, valueOrCountLo].
+     * The binding must validate wire CRC/MBAP transaction identity and must not
+     * retry writes automatically when the physical outcome is uncertain.
+     */
     sendFrame(frame: Uint8Array): Promise<Uint8Array>;
     /** Register a handler for unsolicited/inbound frames. */
     onFrame(handler: (frame: Uint8Array) => void): () => void;

package/dist/transport.js

@@ -1,8 +1,7 @@
-"use strict";
 /**
  * Modbus transport port — injected by the caller.
  *
  * Supports Modbus TCP (port 502) and Modbus RTU (serial).
  * The caller provides the actual socket/serial implementation.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/package.json

@@ -1,29 +1,33 @@
 {
   "name": "@totemsdk/edge-modbus",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Edge runtime adapter for Modbus — PLCs, RTUs, industrial sensors over serial/TCP",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "types": "dist/cjs/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.js"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
   "files": [
     "dist",
+    "sidecar.json",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "NOTICE"
   ],
   "dependencies": {
-    "@totemsdk/edge": "^1.0.0"
+    "@totemsdk/edge": "^1.5.1"
   },
   "devDependencies": {
-    "@types/jest": "^30.0.0",
     "@types/node": "^20.0.0",
-    "jest": "^30.4.2",
-    "ts-jest": "^29.0.0",
     "typescript": "^7.0.2"
   },
   "engines": {
@@ -32,9 +36,9 @@
   "publishConfig": {
     "access": "public"
   },
-  "license": "MIT",
+  "license": "Apache-2.0",
   "author": "Totem SDK",
-  "homepage": "https://totem.ing",
+  "homepage": "https://docs.totem.ing",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Totem-Edge/totem-sdk.git",
@@ -52,10 +56,16 @@
   "bugs": {
     "url": "https://github.com/Totem-Edge/totem-sdk/issues"
   },
+  "type": "module",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && tsc -p tsconfig.cjs.json && node -e \"require('fs').writeFileSync('dist/cjs/package.json', JSON.stringify({type:'commonjs'})+'\\n')\"",
     "build:go": "cd go && go build -o ../bin/edge-modbus .",
     "clean": "rm -rf dist bin",
-    "test": "jest"
+    "test": "jest --config ../../tests/jest/edge-modbus.cjs",
+    "test:go": "cd go && go test -race ./... && go vet ./...",
+    "test:integration": "node --test ../../tests/qualification/edge-modbus/test/sidecar.integration.mjs",
+    "test:conformance": "cd go && go test -race ./...",
+    "test:recovery": "node --test ../../tests/qualification/edge-modbus/test/sidecar.integration.mjs",
+    "test:consumer": "node --test ../../tests/qualification/edge-modbus/test/packed-consumer.test.mjs"
   }
 }

package/sidecar.json

@@ -0,0 +1,34 @@
+{
+  "name": "edge-modbus-sidecar",
+  "protocolVersion": 1,
+  "distribution": {
+    "mode": "source-build",
+    "bundledInNpmPackage": false,
+    "binary": "bin/edge-modbus",
+    "build": "pnpm --filter @totemsdk/edge-modbus build:go",
+    "autoDownload": false
+  },
+  "compatibility": {
+    "protocolMajor": 1,
+    "healthCheck": "edge-modbus --version",
+    "rule": "Rebuild the sidecar from the matching package source. The npm package does not bundle platform binaries."
+  },
+  "configuration": {
+    "mode": "MODBUS_MODE=tcp|rtu",
+    "listen": "MODBUS_LISTEN_ADDR=127.0.0.1:15002",
+    "tcpTarget": "MODBUS_TCP_ADDR=host:502",
+    "serial": "MODBUS_SERIAL_PORT=/dev/ttyUSB0",
+    "timeout": "MODBUS_TIMEOUT_MS=2000"
+  },
+  "qualified": [
+    "darwin-arm64 source build",
+    "loopback Modbus TCP simulator",
+    "RTU codec/CRC unit coverage"
+  ],
+  "unqualified": [
+    "modbus serial hardware",
+    "Windows and Linux prebuilt binaries",
+    "broker/PLC vendor matrix",
+    "hot upgrade or rolling sidecar replacement"
+  ]
+}