@emdzej/j2534-usb 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Michał Jaskólski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# @emdzej/j2534-usb
+
+Node.js libusb bulk-endpoint transport for
+[`@emdzej/j2534-driver`](https://www.npmjs.com/package/@emdzej/j2534-driver).
+Talks directly to the Tactrix OpenPort 2.0 (VID `0x0403` / PID
+`0xCC4D`) bypassing the kernel CDC ACM driver.
+
+**Requires elevated privileges** on macOS and Linux (libusb needs to
+detach the kernel driver to claim the interface). On Windows you may
+need to install a generic WinUSB driver via Zadig.
+
+Most users should prefer
+[`@emdzej/j2534-serial`](https://www.npmjs.com/package/@emdzej/j2534-serial)
+unless they need raw USB control.
+
+## Install
+
+```bash
+npm install @emdzej/j2534-driver @emdzej/j2534-usb
+```
+
+## Use
+
+```ts
+import { J2534Device } from '@emdzej/j2534-driver';
+import { createUsbTransport } from '@emdzej/j2534-usb';
+
+const transport = await createUsbTransport();   // auto-detect by VID/PID
+const dev = new J2534Device(transport);
+await dev.open();
+// … see @emdzej/j2534-driver
+```
+
+## See also
+
+- [Root README](https://github.com/emdzej/j2534#readme)
+- [`@emdzej/j2534-serial`](https://www.npmjs.com/package/@emdzej/j2534-serial) —
+  no-sudo alternative
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { type Transport, type DeviceInfo } from "@emdzej/j2534-types";
+/**
+ * Node.js USB transport using the `usb` package (libusb bindings).
+ */
+export declare class NodeUsbTransport implements Transport {
+    private vendorId;
+    private productId;
+    private device;
+    private inEndpoint;
+    private outEndpoint;
+    private _isConnected;
+    constructor(vendorId?: number, productId?: number);
+    get isConnected(): boolean;
+    open(): Promise<void>;
+    private claimedInterface;
+    close(): Promise<void>;
+    write(data: Uint8Array): Promise<number>;
+    read(timeout?: number): Promise<Uint8Array>;
+}
+/**
+ * List connected Openport devices.
+ */
+export declare function listDevices(vid?: number, pid?: number): DeviceInfo[];
+export default NodeUsbTransport;
+//# 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":"AAAA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,UAAU,EAGhB,MAAM,qBAAqB,CAAC;AAG7B;;GAEG;AACH,qBAAa,gBAAiB,YAAW,SAAS;IAO9C,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,SAAS;IAPnB,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,YAAY,CAAS;gBAGnB,QAAQ,SAAe,EACvB,SAAS,SAAe;IAGlC,IAAI,WAAW,IAAI,OAAO,CAEzB;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAqD3B,OAAO,CAAC,gBAAgB,CAAuB;IAEzC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBtB,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAYxC,IAAI,CAAC,OAAO,SAAO,GAAG,OAAO,CAAC,UAAU,CAAC;CAYhD;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,GAAG,SAAe,EAClB,GAAG,SAAe,GACjB,UAAU,EAAE,CAYd;AAED,eAAe,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,120 @@
+import { OPENPORT_VID, OPENPORT_PID, } from "@emdzej/j2534-types";
+import { usb } from "usb";
+/**
+ * Node.js USB transport using the `usb` package (libusb bindings).
+ */
+export class NodeUsbTransport {
+    vendorId;
+    productId;
+    device = null;
+    inEndpoint = null;
+    outEndpoint = null;
+    _isConnected = false;
+    constructor(vendorId = OPENPORT_VID, productId = OPENPORT_PID) {
+        this.vendorId = vendorId;
+        this.productId = productId;
+    }
+    get isConnected() {
+        return this._isConnected;
+    }
+    async open() {
+        const devices = usb.getDeviceList();
+        const device = devices.find((d) => d.deviceDescriptor.idVendor === this.vendorId &&
+            d.deviceDescriptor.idProduct === this.productId);
+        if (!device) {
+            throw new Error(`Device not found (VID=${this.vendorId.toString(16)} PID=${this.productId.toString(16)})`);
+        }
+        this.device = device;
+        this.device.open();
+        // Find the interface with exactly 2 bulk endpoints (the data interface).
+        // The OpenPort 2.0 is a CDC device — interface 0 is control (interrupt),
+        // interface 1 is data (bulk IN + bulk OUT).
+        const config = this.device.configDescriptor;
+        let claimedIface = null;
+        for (let i = 0; i < config.interfaces.length; i++) {
+            const iface = this.device.interface(i);
+            const bulkEps = iface.endpoints.filter((ep) => ep.transferType === usb.LIBUSB_TRANSFER_TYPE_BULK);
+            if (bulkEps.length === 2) {
+                if (iface.isKernelDriverActive()) {
+                    iface.detachKernelDriver();
+                }
+                iface.claim();
+                this.claimedInterface = i;
+                for (const ep of bulkEps) {
+                    if (ep.direction === "in") {
+                        this.inEndpoint = ep;
+                    }
+                    else {
+                        this.outEndpoint = ep;
+                    }
+                }
+                break;
+            }
+        }
+        if (!this.inEndpoint || !this.outEndpoint) {
+            throw new Error("Could not find bulk IN/OUT endpoints");
+        }
+        this._isConnected = true;
+    }
+    claimedInterface = null;
+    async close() {
+        if (this.device) {
+            try {
+                if (this.claimedInterface !== null) {
+                    this.device.interface(this.claimedInterface).release();
+                }
+            }
+            catch {
+                // ignore
+            }
+            this.device.close();
+            this.device = null;
+        }
+        this.inEndpoint = null;
+        this.outEndpoint = null;
+        this.claimedInterface = null;
+        this._isConnected = false;
+    }
+    async write(data) {
+        if (!this.outEndpoint) {
+            throw new Error("Transport not connected");
+        }
+        return new Promise((resolve, reject) => {
+            this.outEndpoint.transfer(Buffer.from(data), (err) => {
+                if (err)
+                    reject(err);
+                else
+                    resolve(data.length);
+            });
+        });
+    }
+    async read(timeout = 1000) {
+        if (!this.inEndpoint) {
+            throw new Error("Transport not connected");
+        }
+        this.inEndpoint.timeout = timeout;
+        return new Promise((resolve, reject) => {
+            this.inEndpoint.transfer(512, (err, data) => {
+                if (err)
+                    reject(err);
+                else
+                    resolve(new Uint8Array(data ?? Buffer.alloc(0)));
+            });
+        });
+    }
+}
+/**
+ * List connected Openport devices.
+ */
+export function listDevices(vid = OPENPORT_VID, pid = OPENPORT_PID) {
+    return usb
+        .getDeviceList()
+        .filter((d) => d.deviceDescriptor.idVendor === vid &&
+        d.deviceDescriptor.idProduct === pid)
+        .map((d) => ({
+        vendorId: d.deviceDescriptor.idVendor,
+        productId: d.deviceDescriptor.idProduct,
+    }));
+}
+export default NodeUsbTransport;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EACZ,YAAY,GACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,GAAG,EAAkD,MAAM,KAAK,CAAC;AAE1E;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAOjB;IACA;IAPF,MAAM,GAAkB,IAAI,CAAC;IAC7B,UAAU,GAAsB,IAAI,CAAC;IACrC,WAAW,GAAuB,IAAI,CAAC;IACvC,YAAY,GAAG,KAAK,CAAC;IAE7B,YACU,WAAW,YAAY,EACvB,YAAY,YAAY;QADxB,aAAQ,GAAR,QAAQ,CAAe;QACvB,cAAS,GAAT,SAAS,CAAe;IAC/B,CAAC;IAEJ,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,OAAO,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;QACpC,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,gBAAgB,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ;YAC7C,CAAC,CAAC,gBAAgB,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAClD,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CACb,yBAAyB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAC1F,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAEnB,yEAAyE;QACzE,yEAAyE;QACzE,4CAA4C;QAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAiB,CAAC;QAC7C,IAAI,YAAY,GAAkB,IAAI,CAAC;QAEvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CACpC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,YAAY,KAAK,GAAG,CAAC,yBAAyB,CAC1D,CAAC;YACF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,IAAI,KAAK,CAAC,oBAAoB,EAAE,EAAE,CAAC;oBACjC,KAAK,CAAC,kBAAkB,EAAE,CAAC;gBAC7B,CAAC;gBACD,KAAK,CAAC,KAAK,EAAE,CAAC;gBACd,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;gBAE1B,KAAK,MAAM,EAAE,IAAI,OAAO,EAAE,CAAC;oBACzB,IAAI,EAAE,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;wBAC1B,IAAI,CAAC,UAAU,GAAG,EAAgB,CAAC;oBACrC,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,WAAW,GAAG,EAAiB,CAAC;oBACvC,CAAC;gBACH,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAEO,gBAAgB,GAAkB,IAAI,CAAC;IAE/C,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC;gBACH,IAAI,IAAI,CAAC,gBAAgB,KAAK,IAAI,EAAE,CAAC;oBACnC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,OAAO,EAAE,CAAC;gBACzD,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,SAAS;YACX,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAgB;QAC1B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,WAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE;gBACpD,IAAI,GAAG;oBAAE,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAChB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI;QACvB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;QAClC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC3C,IAAI,GAAG;oBAAE,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAChB,OAAO,CAAC,IAAI,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,GAAG,GAAG,YAAY,EAClB,GAAG,GAAG,YAAY;IAElB,OAAO,GAAG;SACP,aAAa,EAAE;SACf,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,gBAAgB,CAAC,QAAQ,KAAK,GAAG;QACnC,CAAC,CAAC,gBAAgB,CAAC,SAAS,KAAK,GAAG,CACvC;SACA,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACX,QAAQ,EAAE,CAAC,CAAC,gBAAgB,CAAC,QAAQ;QACrC,SAAS,EAAE,CAAC,CAAC,gBAAgB,CAAC,SAAS;KACxC,CAAC,CAAC,CAAC;AACR,CAAC;AAED,eAAe,gBAAgB,CAAC"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@emdzej/j2534-usb",
+  "version": "0.1.0",
+  "description": "Node.js libusb bulk-endpoint transport for @emdzej/j2534-driver. Talks directly to the Tactrix OpenPort 2.0 (VID 0x0403 / PID 0xCC4D) bypassing the kernel CDC ACM driver. Requires elevated privileges on macOS/Linux.",
+  "keywords": [
+    "j2534",
+    "passthru",
+    "tactrix",
+    "openport",
+    "diagnostics",
+    "usb",
+    "libusb",
+    "transport",
+    "node",
+    "typescript"
+  ],
+  "homepage": "https://github.com/emdzej/j2534#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/emdzej/j2534.git",
+    "directory": "packages/usb"
+  },
+  "bugs": {
+    "url": "https://github.com/emdzej/j2534/issues"
+  },
+  "license": "MIT",
+  "author": "Michał Jaskólski",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "usb": "^2.14.0",
+    "@emdzej/j2534-types": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.6.0",
+    "typescript": "^5.7.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist"
+  }
+}