@signalk/vedirect-serial-usb 1.5.0 → 1.7.0

package/dist/standalone.js

@@ -0,0 +1,73 @@
+"use strict";
+/**
+ * Standalone library wrapper.
+ *
+ * Shims the signalk-server host so the plugin can be consumed as a plain
+ * Node.js library (see the README "Usage as a library" section). The plugin's
+ * `app.handleMessage` deltas are re-emitted as `delta` events on this
+ * EventEmitter; functionality is otherwise identical to running inside
+ * signalk-server.
+ */
+const events_1 = require("events");
+const createPlugin = require("./index");
+class VEDirect extends events_1.EventEmitter {
+    _debug;
+    app;
+    plugin;
+    constructor(config = {}, _debug = false) {
+        super();
+        this._debug = _debug;
+        const options = {
+            device: 'Serial',
+            connection: '/dev/ttyUSB0',
+            port: 7878,
+            ignoreChecksum: true,
+            mainBatt: 'House',
+            auxBatt: 'Starter',
+            bmv: 'bmv',
+            solar: 'Main',
+            ...config
+        };
+        this.app = {
+            handleMessage: (kind, data) => {
+                // The plugin posts its parsed deltas under its own id; re-emit those as
+                // `delta` events. Anything else the host might receive passes through
+                // on a channel named for its kind.
+                if (kind === this.plugin.id) {
+                    this.emit('delta', data);
+                    return;
+                }
+                this.emit(kind, data);
+            },
+            debug: (msg) => this.debug(msg),
+            // The standalone library has no PUT transport, so relay handler
+            // registrations are accepted and dropped; the returned no-op unregister
+            // keeps start()/stop() symmetric with the server host.
+            registerPutHandler: () => () => { },
+            options
+        };
+        this.plugin = createPlugin(this.app);
+        this.start();
+    }
+    start() {
+        if (typeof this.plugin.start !== 'function') {
+            this.debug("Plugin not initialised, can't start");
+            return;
+        }
+        this.plugin.start(this.app.options);
+    }
+    stop() {
+        if (typeof this.plugin.stop !== 'function') {
+            this.debug("Plugin not initialised, can't stop");
+            return;
+        }
+        this.plugin.stop();
+    }
+    debug(...args) {
+        if (this._debug) {
+            console.log(...args);
+        }
+    }
+}
+module.exports = VEDirect;
+//# sourceMappingURL=standalone.js.map

package/dist/standalone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"standalone.js","sourceRoot":"","sources":["../src/standalone.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;AACH,mCAAqC;AACrC,wCAAwC;AASxC,MAAM,QAAS,SAAQ,qBAAY;IAChB,MAAM,CAAS;IACf,GAAG,CAA0C;IAC7C,MAAM,CAAQ;IAE/B,YAAY,SAAyB,EAAE,EAAE,MAAM,GAAG,KAAK;QACrD,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,MAAM,OAAO,GAAmB;YAC9B,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,cAAc;YAC1B,IAAI,EAAE,IAAI;YACV,cAAc,EAAE,IAAI;YACpB,QAAQ,EAAE,OAAO;YACjB,OAAO,EAAE,SAAS;YAClB,GAAG,EAAE,KAAK;YACV,KAAK,EAAE,MAAM;YACb,GAAG,MAAM;SACV,CAAA;QAED,IAAI,CAAC,GAAG,GAAG;YACT,aAAa,EAAE,CAAC,IAAY,EAAE,IAAa,EAAE,EAAE;gBAC7C,wEAAwE;gBACxE,sEAAsE;gBACtE,mCAAmC;gBACnC,IAAI,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;oBAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;oBACxB,OAAM;gBACR,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YACvB,CAAC;YACD,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;YACvC,gEAAgE;YAChE,wEAAwE;YACxE,uDAAuD;YACvD,kBAAkB,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,GAAE,CAAC;YAClC,OAAO;SACR,CAAA;QAED,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACpC,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAED,KAAK;QACH,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;YAC5C,IAAI,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAA;YACjD,OAAM;QACR,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAwB,CAAC,CAAA;IACtD,CAAC;IAED,IAAI;QACF,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;YAChD,OAAM;QACR,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,GAAG,IAAe;QACtB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAA;QACtB,CAAC;IACH,CAAC;CACF;AAED,iBAAS,QAAQ,CAAA"}

package/dist/tcp.d.ts

@@ -0,0 +1,5 @@
+import type { VEDirectParser } from './Parser';
+import type { DebugFn } from './types';
+export declare function connect(host: string, port: number, parser: VEDirectParser[], debug: DebugFn, connectionIndex: number): void;
+export declare function close(debug: DebugFn, connectionIndex: number): void;
+//# sourceMappingURL=tcp.d.ts.map

package/dist/tcp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tcp.d.ts","sourceRoot":"","sources":["../src/tcp.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAkDtC,wBAAgB,OAAO,CACrB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,cAAc,EAAE,EACxB,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,MAAM,GACtB,IAAI,CAsBN;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,GAAG,IAAI,CAanE"}

package/dist/tcp.js

@@ -0,0 +1,106 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connect = connect;
+exports.close = close;
+/**
+ * TCP transport.
+ *
+ * Connects to a host:port that bridges a remote VE.Direct device onto the
+ * network and feeds the received bytes into the matching parser. On close the
+ * socket is re-dialled after a back-off, unless it was deliberately closed via
+ * `close()` (which clears the slot and cancels any pending reconnect).
+ */
+const Net = __importStar(require("net"));
+const RECONNECT_DELAY_MS = 10000;
+const SOCKET_TIMEOUT_MS = 5000;
+const client = [];
+const reconnectTimer = [];
+function makeConnection(host, port, debug, connectionIndex) {
+    const socket = new Net.Socket();
+    socket.connect({ port, host });
+    socket.setTimeout(SOCKET_TIMEOUT_MS);
+    debug(`Connection to ${host}:${port}`);
+    client[connectionIndex] = socket;
+    return socket;
+}
+function onData(msg, parser, debug, connectionIndex) {
+    parser[connectionIndex]?.addChunk(msg, connectionIndex);
+    debug(`${msg}`);
+}
+function onClose(host, port, parser, debug, connectionIndex) {
+    // Only reconnect if the slot is still active (not cleared by close()). The
+    // timer handle is tracked so close() can cancel a pending reconnect.
+    if (client[connectionIndex] !== undefined) {
+        reconnectTimer[connectionIndex] = setTimeout(() => {
+            reconnectTimer[connectionIndex] = undefined;
+            debug(`Trying to reconnect to ${host}:${port}`);
+            connect(host, port, parser, debug, connectionIndex);
+        }, RECONNECT_DELAY_MS);
+    }
+}
+function connect(host, port, parser, debug, connectionIndex) {
+    const socket = makeConnection(host, port, debug, connectionIndex);
+    socket.on('data', (msg) => {
+        onData(msg, parser, debug, connectionIndex);
+    });
+    socket.on('close', () => {
+        debug(`TCP connection to ${host}:${port} closed`);
+        socket.destroy();
+        onClose(host, port, parser, debug, connectionIndex);
+    });
+    socket.on('error', (err) => {
+        debug(`TCP connection error ${host}:${port}: ${err.message}`);
+        socket.destroy();
+    });
+    socket.on('timeout', () => {
+        debug(`TCP connection timeout ${host}:${port}`);
+        socket.destroy();
+    });
+}
+function close(debug, connectionIndex) {
+    const timer = reconnectTimer[connectionIndex];
+    if (timer !== undefined) {
+        clearTimeout(timer);
+        reconnectTimer[connectionIndex] = undefined;
+    }
+    const socket = client[connectionIndex];
+    if (socket !== undefined) {
+        client[connectionIndex] = undefined;
+        socket.destroy();
+        debug('TCP port closed');
+    }
+}
+//# sourceMappingURL=tcp.js.map

package/dist/tcp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tcp.js","sourceRoot":"","sources":["../src/tcp.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,0BA4BC;AAED,sBAaC;AAvGD;;;;;;;GAOG;AACH,yCAA0B;AAI1B,MAAM,kBAAkB,GAAG,KAAK,CAAA;AAChC,MAAM,iBAAiB,GAAG,IAAI,CAAA;AAE9B,MAAM,MAAM,GAA+B,EAAE,CAAA;AAC7C,MAAM,cAAc,GAAkD,EAAE,CAAA;AAExE,SAAS,cAAc,CACrB,IAAY,EACZ,IAAY,EACZ,KAAc,EACd,eAAuB;IAEvB,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,CAAA;IAC/B,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;IAC9B,MAAM,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAA;IACpC,KAAK,CAAC,iBAAiB,IAAI,IAAI,IAAI,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,eAAe,CAAC,GAAG,MAAM,CAAA;IAChC,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,MAAM,CACb,GAAW,EACX,MAAwB,EACxB,KAAc,EACd,eAAuB;IAEvB,MAAM,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC,CAAA;IACvD,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;AACjB,CAAC;AAED,SAAS,OAAO,CACd,IAAY,EACZ,IAAY,EACZ,MAAwB,EACxB,KAAc,EACd,eAAuB;IAEvB,2EAA2E;IAC3E,qEAAqE;IACrE,IAAI,MAAM,CAAC,eAAe,CAAC,KAAK,SAAS,EAAE,CAAC;QAC1C,cAAc,CAAC,eAAe,CAAC,GAAG,UAAU,CAAC,GAAG,EAAE;YAChD,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAA;YAC3C,KAAK,CAAC,0BAA0B,IAAI,IAAI,IAAI,EAAE,CAAC,CAAA;YAC/C,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,CAAC,CAAA;QACrD,CAAC,EAAE,kBAAkB,CAAC,CAAA;IACxB,CAAC;AACH,CAAC;AAED,SAAgB,OAAO,CACrB,IAAY,EACZ,IAAY,EACZ,MAAwB,EACxB,KAAc,EACd,eAAuB;IAEvB,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,eAAe,CAAC,CAAA;IAEjE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAW,EAAE,EAAE;QAChC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;IAEF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QACtB,KAAK,CAAC,qBAAqB,IAAI,IAAI,IAAI,SAAS,CAAC,CAAA;QACjD,MAAM,CAAC,OAAO,EAAE,CAAA;QAChB,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,CAAC,CAAA;IACrD,CAAC,CAAC,CAAA;IAEF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;QAChC,KAAK,CAAC,wBAAwB,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;QAC7D,MAAM,CAAC,OAAO,EAAE,CAAA;IAClB,CAAC,CAAC,CAAA;IAEF,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;QACxB,KAAK,CAAC,0BAA0B,IAAI,IAAI,IAAI,EAAE,CAAC,CAAA;QAC/C,MAAM,CAAC,OAAO,EAAE,CAAA;IAClB,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAgB,KAAK,CAAC,KAAc,EAAE,eAAuB;IAC3D,MAAM,KAAK,GAAG,cAAc,CAAC,eAAe,CAAC,CAAA;IAC7C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,YAAY,CAAC,KAAK,CAAC,CAAA;QACnB,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAA;IAC7C,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,CAAA;IACtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,CAAC,eAAe,CAAC,GAAG,SAAS,CAAA;QACnC,MAAM,CAAC,OAAO,EAAE,CAAA;QAChB,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAC1B,CAAC;AACH,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,181 @@
+/**
+ * Shared types for the vedirect-serial-usb plugin.
+ *
+ * `SignalKApp` and `Plugin` are minimal structural descriptions of the
+ * objects exchanged with the signalk-server host: only the members the
+ * plugin actually uses are modelled.
+ *
+ * The `Field` / `FieldContext` / `StoredField` triple decouples the field
+ * definition table (src/fields.ts) from the parser (src/Parser.ts). Field
+ * value functions receive a `FieldContext` rather than the concrete parser
+ * class, which keeps the two modules free of a runtime import cycle.
+ */
+/** Best-effort log sink. signalk-server passes `app.debug`; the standalone
+ *  shim and the network modules use the same shape. */
+export type DebugFn = (message: string) => void;
+/**
+ * What kind of Victron device a connection talks to. VE.Direct reuses the
+ * `V`/`I` labels for both battery monitors and solar chargers, so the device
+ * type decides where those readings land (see `Field.solarCharger`). Treated as
+ * a battery monitor when unset, which preserves the historical paths.
+ */
+export type DeviceType = 'Battery monitor' | 'Solar charger';
+/** One VE.Direct connection as configured in the plugin schema. */
+export interface VEDirectConnection {
+    device: 'Serial' | 'UDP' | 'TCP';
+    connection: string;
+    port: number;
+    deviceType?: DeviceType;
+    ignoreChecksum: boolean;
+    mainBatt: string;
+    auxBatt: string;
+    bmv: string;
+    solar: string;
+}
+/**
+ * Plugin options. The current schema uses the `vedirect[]` array; the flat
+ * fields are the legacy single-connection format kept so that configs
+ * written before the multi-connection rework still start (the in-memory
+ * fallback in src/index.ts).
+ */
+export interface PluginOptions {
+    vedirect?: VEDirectConnection[];
+    device?: string;
+    host?: string;
+    udpPort?: number;
+    tcpPort?: number;
+    ignoreChecksum?: boolean;
+    mainBatt?: string;
+    auxBatt?: string;
+    bmv?: string;
+    solar?: string;
+    deviceType?: DeviceType;
+}
+/** Flat single-connection configuration accepted by the standalone library
+ *  wrapper (src/standalone.ts). */
+export interface VEDirectConfig {
+    device?: string;
+    connection?: string;
+    port?: number;
+    host?: string;
+    udpPort?: number;
+    tcpPort?: number;
+    ignoreChecksum?: boolean;
+    mainBatt?: string;
+    auxBatt?: string;
+    bmv?: string;
+    solar?: string;
+    deviceType?: DeviceType;
+}
+/**
+ * Result of a Signal K PUT action. A handler returns `COMPLETED` (with an
+ * HTTP-like `statusCode`) to answer synchronously, or `PENDING` when it will
+ * call the async callback later. This plugin only answers synchronously.
+ */
+export interface PutResult {
+    state: 'COMPLETED' | 'PENDING';
+    statusCode?: number;
+    message?: string;
+}
+/**
+ * Handler for a PUT request on a registered context/path. `value` is whatever
+ * the requester sent (hence `unknown`; the handler narrows it). The trailing
+ * callback is for `PENDING` async replies and is unused here.
+ */
+export type PutHandler = (context: string, path: string, value: unknown, callback: (result: PutResult) => void) => PutResult | void;
+/** Minimal structural type for the `app` the signalk-server host passes to
+ *  the plugin factory. */
+export interface SignalKApp {
+    handleMessage(id: string, delta: SKDelta): void;
+    debug: DebugFn;
+    /**
+     * Registers a handler for PUT requests on `context`/`path`. Returns a
+     * function that unregisters it again, which the plugin calls on `stop()` so a
+     * config reload does not leave a stale handler writing to a closed port.
+     */
+    registerPutHandler(context: string, path: string, handler: PutHandler, source?: string): () => void;
+}
+/** Shape of the plugin object returned to the signalk-server host. */
+export interface Plugin {
+    id: string;
+    name: string;
+    description: string;
+    start(options: PluginOptions): void;
+    stop(): void;
+    schema: object;
+}
+/** A Signal K delta message emitted for a parsed VE.Direct block.
+ *
+ * The source is carried as a `$source` ref string (`vedirect-signalk.<index>`)
+ * rather than a structured `source` object: a `source.src` field would make
+ * signalk-server misclassify the stream as NMEA 2000. See src/Parser.ts. */
+export interface SKDelta {
+    context: string;
+    updates: Array<{
+        $source: string;
+        timestamp: string;
+        values: Array<{
+            path: string;
+            value: number | string | null;
+        }>;
+    }>;
+}
+/** Converts a raw VE.Direct token into a Signal K value. Receives the raw
+ *  token and the parser (for cross-field lookups and enum decoding). Returns
+ *  the value to store; `undefined` to skip the field, leaving any prior value
+ *  untouched; or `null` to store an explicit null, which clears the value in
+ *  Signal K (e.g. TTG -1, an infinite time-to-go). */
+export type FieldValue = (value: string, instance: FieldContext) => number | string | null | undefined;
+export type FieldType = 'metric' | 'ratio' | 'text' | 'boolean' | 'count';
+/**
+ * Identifies which configured device name fills a field path's `*` placeholder.
+ * `mainBatt`/`auxBatt`/`bmv`/`solar` map to the per-connection config;
+ * `aux2Batt`/`inverter` have no config slot and fall back to the parser's
+ * `defaultUnitId`. Keeping this a union (rather than `string`) ties the field
+ * table to the resolver in `getPath`: adding a new unit here forces the switch
+ * there to handle it.
+ */
+export type UnitId = 'mainBatt' | 'auxBatt' | 'aux2Batt' | 'bmv' | 'solar' | 'inverter';
+/** A field definition: how to name, place and convert one VE.Direct token. */
+export interface Field {
+    name: string;
+    path?: string;
+    unitId?: UnitId;
+    /**
+     * Alternative path and unit used when the connection is a solar charger.
+     * VE.Direct sends battery-monitor and charger data under the same labels, but
+     * a charger's reading describes its DC output, which belongs under
+     * electrical.solar, not electrical.batteries where it would clash with a
+     * monitor on the same bank.
+     */
+    solarCharger?: {
+        path: string;
+        unitId: UnitId;
+    };
+    units?: string;
+    type?: FieldType;
+    value?: FieldValue;
+}
+export type FieldMap = Record<string, Field>;
+/** A field whose `value` has been resolved to a concrete reading and stored
+ *  on the parser. */
+export interface StoredField {
+    name: string;
+    value: number | string | null;
+    path?: string;
+    unitId?: UnitId;
+    units?: string;
+    type?: FieldType;
+}
+/** The slice of the parser that field value functions are allowed to call.
+ *  Implemented by VEDirectParser. */
+export interface FieldContext {
+    set(key: string, value: StoredField): void;
+    getAlarmReason(value: string | number): string | undefined;
+    getErrorString(value: string | number): string | undefined;
+    getStateOfOperation(value: string | number): string | undefined;
+    getMode(value: string | number): string | undefined;
+    getTrackerOperationMode(value: string | number): string | undefined;
+    getProductLongname(value: string): string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH;uDACuD;AACvD,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,iBAAiB,GAAG,eAAe,CAAA;AAE5D,mEAAmE;AACnE,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,QAAQ,GAAG,KAAK,GAAG,KAAK,CAAA;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,cAAc,EAAE,OAAO,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB;AAED;mCACmC;AACnC,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,WAAW,GAAG,SAAS,CAAA;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,CACvB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,KAClC,SAAS,GAAG,IAAI,CAAA;AAErB;0BAC0B;AAC1B,MAAM,WAAW,UAAU;IACzB,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IAC/C,KAAK,EAAE,OAAO,CAAA;IACd;;;;OAIG;IACH,kBAAkB,CAChB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,UAAU,EACnB,MAAM,CAAC,EAAE,MAAM,GACd,MAAM,IAAI,CAAA;CACd;AAED,sEAAsE;AACtE,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAA;IACnC,IAAI,IAAI,IAAI,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;4EAI4E;AAC5E,MAAM,WAAW,OAAO;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,KAAK,CAAC;QACb,OAAO,EAAE,MAAM,CAAA;QACf,SAAS,EAAE,MAAM,CAAA;QACjB,MAAM,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC,CAAA;KAC/D,CAAC,CAAA;CACH;AAED;;;;sDAIsD;AACtD,MAAM,MAAM,UAAU,GAAG,CACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,YAAY,KACnB,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;AAEvC,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;AAEzE;;;;;;;GAOG;AACH,MAAM,MAAM,MAAM,GACd,UAAU,GACV,SAAS,GACT,UAAU,GACV,KAAK,GACL,OAAO,GACP,UAAU,CAAA;AAEd,8EAA8E;AAC9E,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;OAMG;IACH,YAAY,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,KAAK,CAAC,EAAE,UAAU,CAAA;CACnB;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAE5C;qBACqB;AACrB,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB;AAED;qCACqC;AACrC,MAAM,WAAW,YAAY;IAC3B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,IAAI,CAAA;IAC1C,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC1D,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC1D,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/D,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IACnD,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IACnE,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CAC1C"}

package/dist/types.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * Shared types for the vedirect-serial-usb plugin.
+ *
+ * `SignalKApp` and `Plugin` are minimal structural descriptions of the
+ * objects exchanged with the signalk-server host: only the members the
+ * plugin actually uses are modelled.
+ *
+ * The `Field` / `FieldContext` / `StoredField` triple decouples the field
+ * definition table (src/fields.ts) from the parser (src/Parser.ts). Field
+ * value functions receive a `FieldContext` rather than the concrete parser
+ * class, which keeps the two modules free of a runtime import cycle.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG"}

package/dist/udp.d.ts

@@ -0,0 +1,5 @@
+import type { VEDirectParser } from './Parser';
+import type { DebugFn } from './types';
+export declare function listen(port: number, parser: VEDirectParser[], debug: DebugFn, connectionIndex: number): void;
+export declare function close(debug: DebugFn, connectionIndex: number): void;
+//# sourceMappingURL=udp.d.ts.map

package/dist/udp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"udp.d.ts","sourceRoot":"","sources":["../src/udp.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAItC,wBAAgB,MAAM,CACpB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,cAAc,EAAE,EACxB,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,MAAM,GACtB,IAAI,CAcN;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,GAAG,IAAI,CAOnE"}

package/dist/udp.js

@@ -0,0 +1,67 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listen = listen;
+exports.close = close;
+/**
+ * UDP transport.
+ *
+ * Binds a UDP socket per connection index and feeds each received datagram
+ * into the matching parser. Used when a bridge forwards a remote VE.Direct
+ * device's serial data as UDP packets.
+ */
+const dgram = __importStar(require("dgram"));
+const socket = [];
+function listen(port, parser, debug, connectionIndex) {
+    const sock = dgram.createSocket({ type: 'udp4', reuseAddr: true });
+    socket[connectionIndex] = sock;
+    sock.on('listening', () => {
+        debug(`listening on UDP ${port}`);
+    });
+    sock.on('message', (msg, rinfo) => {
+        debug(`${rinfo.address}:${rinfo.port}:${msg}`);
+        parser[connectionIndex]?.addChunk(msg, connectionIndex);
+    });
+    sock.bind(port);
+}
+function close(debug, connectionIndex) {
+    const sock = socket[connectionIndex];
+    if (sock !== undefined) {
+        sock.close();
+        socket[connectionIndex] = undefined;
+        debug('UDP port closed');
+    }
+}
+//# sourceMappingURL=udp.js.map

package/dist/udp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"udp.js","sourceRoot":"","sources":["../src/udp.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAaA,wBAmBC;AAED,sBAOC;AAzCD;;;;;;GAMG;AACH,6CAA8B;AAI9B,MAAM,MAAM,GAAiC,EAAE,CAAA;AAE/C,SAAgB,MAAM,CACpB,IAAY,EACZ,MAAwB,EACxB,KAAc,EACd,eAAuB;IAEvB,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAClE,MAAM,CAAC,eAAe,CAAC,GAAG,IAAI,CAAA;IAE9B,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;QACxB,KAAK,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAW,EAAE,KAAuB,EAAE,EAAE;QAC1D,KAAK,CAAC,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC,CAAA;QAC9C,MAAM,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC,CAAA;IACzD,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACjB,CAAC;AAED,SAAgB,KAAK,CAAC,KAAc,EAAE,eAAuB;IAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,eAAe,CAAC,CAAA;IACpC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,MAAM,CAAC,eAAe,CAAC,GAAG,SAAS,CAAA;QACnC,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAC1B,CAAC;AACH,CAAC"}

package/logo.svg

@@ -0,0 +1,46 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" role="img" aria-label="Victron VE.Direct">
+  <defs>
+    <linearGradient id="sea" x1="0" y1="0" x2="0" y2="1">
+      <stop offset="0" stop-color="#1b6ea8"/>
+      <stop offset="1" stop-color="#0b3a5e"/>
+    </linearGradient>
+    <clipPath id="card">
+      <rect x="0" y="0" width="128" height="128" rx="22"/>
+    </clipPath>
+  </defs>
+
+  <g clip-path="url(#card)">
+    <rect width="128" height="128" fill="url(#sea)"/>
+
+    <g stroke="#bee3f4" stroke-opacity="0.25" stroke-width="1" fill="none">
+      <path d="M0 24 H128 M0 48 H128 M0 72 H128 M0 96 H128"/>
+      <path d="M24 0 V128 M48 0 V128 M72 0 V128 M96 0 V128"/>
+    </g>
+
+    <!-- Victron-style energy waves radiating from the device -->
+    <g stroke="#35aee0" stroke-width="2.8" fill="none" stroke-linecap="round">
+      <path d="M53 37 Q61 29 69 37"/>
+      <path d="M48 37 Q61 23 74 37"/>
+      <path d="M43 37 Q61 17 79 37"/>
+    </g>
+
+    <!-- battery (monitor / charger that VE.Direct reads) -->
+    <rect x="53" y="40" width="16" height="7" rx="2.5" fill="#cbd5e1" stroke="#0b3a5e" stroke-width="2"/>
+    <rect x="40" y="47" width="42" height="56" rx="7" fill="#e7eef5" stroke="#0b3a5e" stroke-width="2.6"/>
+    <!-- charge level -->
+    <path d="M44 73 H78 V95 Q78 99 74 99 H48 Q44 99 44 95 Z" fill="#1f9bd7"/>
+
+    <!-- charge bolt -->
+    <polygon points="65,53 52,79 60,79 56,98 75,71 64,71 70,53" fill="#e63946" stroke="#0b3a5e" stroke-width="1.6" stroke-linejoin="round"/>
+
+    <!-- compass rose -->
+    <g transform="translate(104 104)">
+      <circle r="11" fill="#0b3a5e" fill-opacity="0.7" stroke="#bee3f4" stroke-width="0.8"/>
+      <polygon points="0,-9 2.2,0 0,0" fill="#e63946"/>
+      <polygon points="0,-9 -2.2,0 0,0" fill="#b5232f"/>
+      <polygon points="0,9 2.2,0 0,0" fill="#e2e8f0"/>
+      <polygon points="0,9 -2.2,0 0,0" fill="#cbd5e1"/>
+      <circle r="1.1" fill="#e2e8f0"/>
+    </g>
+  </g>
+</svg>

package/package.json

@@ -1,12 +1,52 @@
 {
   "name": "@signalk/vedirect-serial-usb",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Signal K Node.js server plugin to read VE.Direct data via serial USB",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./standalone": {
+      "types": "./dist/standalone.d.ts",
+      "require": "./dist/standalone.js",
+      "default": "./dist/standalone.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "dist",
+    "logo.svg",
+    "docs/screenshots",
+    "README.md",
+    "LICENSE"
+  ],
+  "signalk": {
+    "displayName": "Victron VE.Direct",
+    "appIcon": "./logo.svg",
+    "screenshots": [
+      "./docs/screenshots/1_config.png"
+    ]
+  },
   "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "typecheck": "tsc --noEmit",
     "test": "mocha",
-    "push": "npm publish --access public --scope @signalk .",
-    "postinstall": "node ./migration.js"
+    "coverage": "c8 --reporter=text --reporter=lcov npm test",
+    "mutation": "stryker run",
+    "prettier:check": "prettier --check .",
+    "prettier": "prettier --write .",
+    "format": "npm run prettier",
+    "prepublishOnly": "npm run build"
   },
   "keywords": [
     "signalk-node-server-plugin"
@@ -21,23 +61,43 @@
     "type": "git",
     "url": "https://github.com/SignalK/vedirect-serial-usb"
   },
-  "contributors": [],
   "dependencies": {
-    "debug": "^4.0.1",
-    "package-lock.json": "^1.0.0",
-    "serialport": "^11.0.0"
-  },
-  "standard": {
-    "globals": [
-      "describe",
-      "it",
-      "expect",
-      "before"
-    ]
+    "@serialport/parser-delimiter": "^13.0.0",
+    "debug": "^4.4.3",
+    "serialport": "^13.0.0"
   },
   "devDependencies": {
-    "chai": "^4.1.2",
-    "chai-things": "^0.2.0",
-    "mocha": "^10.2.0"
+    "@stryker-mutator/core": "^9.6.1",
+    "@stryker-mutator/mocha-runner": "^9.6.1",
+    "@types/chai": "^5.2.3",
+    "@types/debug": "^4.1.12",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.9.2",
+    "c8": "^11.0.0",
+    "chai": "^6.2.2",
+    "mocha": "^11.7.1",
+    "prettier": "^3.8.2",
+    "rimraf": "^6.1.3",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.3"
+  },
+  "c8": {
+    "extension": [
+      ".ts"
+    ],
+    "include": [
+      "src/**/*.ts"
+    ],
+    "exclude": [
+      "test/**",
+      "coverage/**",
+      "dist/**",
+      "src/types.ts"
+    ],
+    "all": true,
+    "reporter": [
+      "text",
+      "lcov"
+    ]
   }
 }

package/.github/FUNDING.yml

@@ -1 +0,0 @@
-github: joabakk