@rhizomatics/signalk-einklabel-plugin 0.6.4 → 0.7.1

package/dist/cli/liveContext.js

@@ -8,38 +8,16 @@ exports.assembleExampleContext = assembleExampleContext;
 const promises_1 = require("fs/promises");
 const path_1 = __importDefault(require("path"));
 const formatters_1 = require("../render/formatters");
+const unwrapSignalkTree_1 = require("../render/unwrapSignalkTree");
 const httpJson_1 = require("../httpJson");
 const unitCategories_1 = require("../unitCategories");
 const pathMeta_1 = require("../pathMeta");
 const pluginVersion_1 = require("../pluginVersion");
 const log_1 = require("./log");
-const RESOURCES_API_PATH = '/signalk/v2/api/resources';
+const RESOURCES_API_PATH = "/signalk/v2/api/resources";
 /** `context=self` -> `vessels/self`, `context=vessels.urn:mrn:imo:mmsi:1` -> `vessels/urn:mrn:imo:mmsi:1` - matches the REST path for that context's full-data-model subtree. */
 function contextPath(context) {
-    return context === 'self' ? 'vessels/self' : context.replace(/\./g, '/');
-}
-/**
- * `GET .../vessels/self` (or any other subtree) returns SignalK's full delta-tree shape, where every
- * leaf is wrapped as `{ value, $source, timestamp, ... }` rather than the bare value - unlike
- * `app.getSelfPath`/`getPath` in the live plugin (repaintScheduler.ts), which already return bare
- * values. Recursively unwraps every such leaf so `path=` bindings resolve the same way over HTTP as
- * they do live. Only applied to `signalk` fetches - `resources` responses have no such wrapper.
- *
- * Keys off `value` alone, not also requiring `timestamp`/`$source` - not every server includes both on
- * every leaf, and a `value` key is otherwise meaningless on a SignalK data-model node (it isn't a
- * regular vessel property name), so there's no real risk of unwrapping something that isn't this
- * wrapper.
- */
-function unwrapSignalkTree(node) {
-    if (node === null || typeof node !== 'object')
-        return node;
-    if (Array.isArray(node))
-        return node.map(unwrapSignalkTree);
-    const obj = node;
-    if ('value' in obj) {
-        return obj.value;
-    }
-    return Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, unwrapSignalkTree(value)]));
+    return context === "self" ? "vessels/self" : context.replace(/\./g, "/");
 }
 /**
  * CLI counterpart to `assembleRawContext` + `considerRepaint`'s `meta` injection in
@@ -52,11 +30,11 @@ function unwrapSignalkTree(node) {
  */
 async function assembleLiveContext(signalkUrl, bindings) {
     const signalk = {};
-    const contexts = new Set(bindings.filter((binding) => binding.source === 'signalk').map((binding) => binding.context));
+    const contexts = new Set(bindings.filter((binding) => binding.source === "signalk").map((binding) => binding.context));
     for (const context of contexts) {
         const url = `${signalkUrl}/signalk/v1/api/${contextPath(context)}`;
         (0, log_1.logDebug)(`GET ${url}`);
-        signalk[context] = unwrapSignalkTree(await (0, httpJson_1.fetchJson)(url));
+        signalk[context] = (0, unwrapSignalkTree_1.unwrapSignalkTree)(await (0, httpJson_1.fetchJson)(url));
     }
     const pathMeta = {};
     for (const context of contexts) {
@@ -69,7 +47,7 @@ async function assembleLiveContext(signalkUrl, bindings) {
         }
     }
     const resources = {};
-    const resourceNames = new Set(bindings.filter((binding) => binding.source === 'resources').map((binding) => binding.resource));
+    const resourceNames = new Set(bindings.filter((binding) => binding.source === "resources").map((binding) => binding.resource));
     for (const name of resourceNames) {
         const url = `${signalkUrl}${RESOURCES_API_PATH}/${name}`;
         (0, log_1.logDebug)(`GET ${url}`);
@@ -89,7 +67,7 @@ async function assembleLiveContext(signalkUrl, bindings) {
 async function readJsonFile(filePath) {
     let raw;
     try {
-        raw = await (0, promises_1.readFile)(filePath, 'utf-8');
+        raw = await (0, promises_1.readFile)(filePath, "utf-8");
     }
     catch (err) {
         throw new Error(`could not read example data file ${filePath} - ${err.message}`);
@@ -116,34 +94,34 @@ async function readJsonFile(filePath) {
  */
 async function assembleExampleContext(examplesDir, bindings) {
     const signalk = {};
-    const contexts = new Set(bindings.filter((binding) => binding.source === 'signalk').map((binding) => binding.context));
+    const contexts = new Set(bindings.filter((binding) => binding.source === "signalk").map((binding) => binding.context));
     if (contexts.size > 0) {
-        const vesselsPath = path_1.default.join(examplesDir, 'vessels.json');
+        const vesselsPath = path_1.default.join(examplesDir, "vessels.json");
         (0, log_1.logDebug)(`reading ${vesselsPath}`);
         const vessels = await readJsonFile(vesselsPath);
         for (const context of contexts) {
-            const segments = contextPath(context).split('/');
+            const segments = contextPath(context).split("/");
             let node = vessels;
             for (const segment of segments) {
-                node = node === null || typeof node !== 'object' ? undefined : node[segment];
+                node = node === null || typeof node !== "object" ? undefined : node[segment];
             }
             if (node === undefined) {
-                throw new Error(`example data file ${vesselsPath} has no "${segments.join('.')}" subtree for context "${context}"`);
+                throw new Error(`example data file ${vesselsPath} has no "${segments.join(".")}" subtree for context "${context}"`);
             }
-            signalk[context] = unwrapSignalkTree(node);
+            signalk[context] = (0, unwrapSignalkTree_1.unwrapSignalkTree)(node);
         }
     }
     const resources = {};
-    const resourceNames = new Set(bindings.filter((binding) => binding.source === 'resources').map((binding) => binding.resource));
+    const resourceNames = new Set(bindings.filter((binding) => binding.source === "resources").map((binding) => binding.resource));
     for (const name of resourceNames) {
-        const resourcePath = path_1.default.join(examplesDir, 'resources', `${name}.json`);
+        const resourcePath = path_1.default.join(examplesDir, "resources", `${name}.json`);
         (0, log_1.logDebug)(`reading ${resourcePath}`);
         resources[name] = await readJsonFile(resourcePath);
     }
     const categoryNames = new Set(bindings.filter((binding) => binding.category).map((binding) => binding.category));
     let categories = {};
     if (categoryNames.size > 0) {
-        const categoriesPath = path_1.default.join(examplesDir, 'categories.json');
+        const categoriesPath = path_1.default.join(examplesDir, "categories.json");
         (0, log_1.logDebug)(`reading ${categoriesPath}`);
         categories = (await readJsonFile(categoriesPath));
         for (const category of categoryNames) {

package/dist/cli/log.d.ts

@@ -1,4 +1,4 @@
-export type LogLevel = 'info' | 'debug';
+export type LogLevel = "info" | "debug";
 /** Set once from the global `--log-level` option (see index.ts's `preAction` hook) - applies to every command. */
 export declare function setLogLevel(level: string): void;
 /** Internal tracing (e.g. which URL is being fetched) - silent unless --log-level debug, so default output stays uncluttered. */

package/dist/cli/log.js

@@ -2,17 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setLogLevel = setLogLevel;
 exports.logDebug = logDebug;
-const LEVELS = ['info', 'debug'];
-let currentLevel = 'info';
+const LEVELS = ["info", "debug"];
+let currentLevel = "info";
 /** Set once from the global `--log-level` option (see index.ts's `preAction` hook) - applies to every command. */
 function setLogLevel(level) {
     if (!LEVELS.includes(level)) {
-        throw new Error(`unknown --log-level "${level}" - expected one of ${LEVELS.join(', ')}`);
+        throw new Error(`unknown --log-level "${level}" - expected one of ${LEVELS.join(", ")}`);
     }
     currentLevel = level;
 }
 /** Internal tracing (e.g. which URL is being fetched) - silent unless --log-level debug, so default output stays uncluttered. */
 function logDebug(message) {
-    if (currentLevel === 'debug')
+    if (currentLevel === "debug")
         console.error(`[debug] ${message}`);
 }

package/dist/config.d.ts

@@ -1,5 +1,5 @@
-import { ServerAPI } from '@signalk/server-api';
-import { DiscoveredDevice } from './devices/types';
+import { ServerAPI } from "@signalk/server-api";
+import { DiscoveredDevice } from "./devices/types";
 export interface DeviceConfig {
     friendlyName: string;
     /**
@@ -11,7 +11,7 @@ export interface DeviceConfig {
     /** Per-device override; if omitted, the vendor driver may fall back to a stock/manufacturer-default key. */
     aesKey?: string;
     templateName: string;
-    repaintTrigger: 'subscription' | 'interval';
+    repaintTrigger: "subscription" | "interval";
     /** SignalK path to subscribe to when `repaintTrigger` is `subscription` - a repaint is considered on every delta. */
     triggerPath?: string;
     /** When `repaintTrigger` is `interval`: repaint every N hours... */
@@ -54,6 +54,15 @@ export interface PluginConfig {
     signalkApiUrl?: string;
     devices: DeviceConfig[];
 }
+/**
+ * The package's own bundled `templates/` directory (ships alongside `dist/`, see
+ * package.json's `files`) - templates here are always available, but a same-named template in the
+ * user's `templatesDir` takes priority. Exported so `SvgRenderer` can fall back to it when resolving
+ * an `assets=` binding's directory (see `resolveAssetPath` in `./render/assets.ts`) - overriding a
+ * bundled template shouldn't also require duplicating its bundled asset sets (e.g.
+ * `templates/assets/lunar_phases`) just to keep a binding the override never touched working.
+ */
+export declare const BUNDLED_TEMPLATES_DIR: string;
 export declare function defaultConfig(): PluginConfig;
 /**
  * Resolves the user-facing `templatesDir` setting to an actual directory, mirroring

package/dist/config.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BUNDLED_TEMPLATES_DIR = void 0;
 exports.defaultConfig = defaultConfig;
 exports.resolveTemplatesDir = resolveTemplatesDir;
 exports.parseDevice = parseDevice;
@@ -10,13 +11,20 @@ const fs_1 = require("fs");
 const os_1 = require("os");
 const path_1 = require("path");
 const resolveApiUrl_1 = require("./resolveApiUrl");
-/** The package's own bundled `templates/` directory (ships alongside `dist/`, see package.json's `files`) - templates here are always available, but a same-named template in the user's `templatesDir` takes priority. */
-const BUNDLED_TEMPLATES_DIR = (0, path_1.join)(__dirname, '..', 'templates');
-const SIGNALK_HOME_DIR = (0, path_1.join)((0, os_1.homedir)(), '.signalk');
-const DEFAULT_TEMPLATES_DIR = (0, path_1.join)(SIGNALK_HOME_DIR, 'einklabel', 'templates');
+/**
+ * The package's own bundled `templates/` directory (ships alongside `dist/`, see
+ * package.json's `files`) - templates here are always available, but a same-named template in the
+ * user's `templatesDir` takes priority. Exported so `SvgRenderer` can fall back to it when resolving
+ * an `assets=` binding's directory (see `resolveAssetPath` in `./render/assets.ts`) - overriding a
+ * bundled template shouldn't also require duplicating its bundled asset sets (e.g.
+ * `templates/assets/lunar_phases`) just to keep a binding the override never touched working.
+ */
+exports.BUNDLED_TEMPLATES_DIR = (0, path_1.join)(__dirname, "..", "templates");
+const SIGNALK_HOME_DIR = (0, path_1.join)((0, os_1.homedir)(), ".signalk");
+const DEFAULT_TEMPLATES_DIR = (0, path_1.join)(SIGNALK_HOME_DIR, "einklabel", "templates");
 function defaultConfig() {
     return {
-        templatesDir: '',
+        templatesDir: "",
         scanOnStart: true,
         scanDurationSeconds: 20,
         paintConnectTimeoutSeconds: 30,
@@ -53,7 +61,7 @@ function deviceOptions(discovered, current) {
         if (found.pid === undefined) {
             continue;
         }
-        const modelToken = [found.vendor, found.pid, found.hwVersion].filter((part) => part !== undefined).join(':');
+        const modelToken = [found.vendor, found.pid, found.hwVersion].filter((part) => part !== undefined).join(":");
         const value = `${modelToken}@${found.address}`;
         if (seen.has(value)) {
             continue;
@@ -62,7 +70,7 @@ function deviceOptions(discovered, current) {
         values.push(value);
         const label = found.metadata
             ? `${found.vendor} ${found.metadata.label} (${found.address})`
-            : `${found.vendor} unrecognised PID 0x${found.pid.toString(16).padStart(4, '0')} (${found.address})`;
+            : `${found.vendor} unrecognised PID 0x${found.pid.toString(16).padStart(4, "0")} (${found.address})`;
         labels.push(label);
     }
     for (const device of current.devices) {
@@ -75,14 +83,14 @@ function deviceOptions(discovered, current) {
     return { values, labels };
 }
 function parseDevice(device) {
-    const [modelToken, address] = device.split('@');
-    const [vendor, pidStr, hwVersion] = (modelToken ?? '').split(':');
+    const [modelToken, address] = device.split("@");
+    const [vendor, pidStr, hwVersion] = (modelToken ?? "").split(":");
     const pid = Number(pidStr);
     return vendor && address && Number.isInteger(pid) ? { vendor, pid, hwVersion, address } : undefined;
 }
 function listSvgFiles(dir) {
     try {
-        return (0, fs_1.readdirSync)(dir).filter((name) => name.endsWith('.svg'));
+        return (0, fs_1.readdirSync)(dir).filter((name) => name.endsWith(".svg"));
     }
     catch {
         return [];
@@ -91,13 +99,13 @@ function listSvgFiles(dir) {
 /** Local templates take priority over a same-named bundled one; both show up as options. */
 function templateNameOptions(templatesDir) {
     const local = listSvgFiles(templatesDir);
-    const bundled = listSvgFiles(BUNDLED_TEMPLATES_DIR).filter((name) => !local.includes(name));
+    const bundled = listSvgFiles(exports.BUNDLED_TEMPLATES_DIR).filter((name) => !local.includes(name));
     return [...local, ...bundled];
 }
 /** Resolves a template name to an actual file path - a local template overrides the bundled one of the same name. */
 function resolveTemplatePath(templatesDir, templateName) {
     const localPath = (0, path_1.join)(templatesDir, templateName);
-    return (0, fs_1.existsSync)(localPath) ? localPath : (0, path_1.join)(BUNDLED_TEMPLATES_DIR, templateName);
+    return (0, fs_1.existsSync)(localPath) ? localPath : (0, path_1.join)(exports.BUNDLED_TEMPLATES_DIR, templateName);
 }
 /** JSON Schema forbids an empty `enum` array, so only attach one when there's at least one option - otherwise the whole config schema fails validation. */
 function withEnum(schema, values, names) {
@@ -108,78 +116,92 @@ function configSchema(app, discovered = []) {
     const current = { ...defaults, ...app.readPluginOptions() };
     const { values: deviceValues, labels: deviceLabels } = deviceOptions(discovered, current);
     return {
-        type: 'object',
+        type: "object",
         properties: {
             templatesDir: {
-                type: 'string',
-                title: 'Templates directory',
+                type: "string",
+                title: "Templates directory",
                 description: `Relative path from ~/.signalk (e.g., "esl/templates" becomes ~/.signalk/esl/templates). ` +
                     `Leave empty for default (${DEFAULT_TEMPLATES_DIR}). Absolute paths also supported. A template here ` +
-                    'with the same name as a bundled one takes priority.',
+                    "with the same name as a bundled one takes priority. Also used to override SVG assets, like the bundled lunar_phases.",
                 default: defaults.templatesDir,
             },
             scanOnStart: {
-                type: 'boolean',
-                title: 'Scan for devices on plugin start',
+                type: "boolean",
+                title: "Scan for devices on plugin start",
                 description: 'Runs a short BLE scan so discovered devices show up in a device\'s "Device" picker below.',
                 default: defaults.scanOnStart,
             },
             scanDurationSeconds: {
-                type: 'number',
-                title: 'Scan duration (seconds)',
+                type: "number",
+                title: "Scan duration (seconds)",
                 description: 'How long the startup scan runs - increase if devices are missing from the "Device" picker below.',
                 minimum: 1,
                 default: defaults.scanDurationSeconds,
             },
             paintConnectTimeoutSeconds: {
-                type: 'number',
-                title: 'Paint connect timeout (seconds)',
-                description: 'How long to wait for a device to accept a BLE connection before giving up on a repaint attempt.',
+                type: "number",
+                title: "Paint connect timeout (seconds)",
+                description: "How long to wait for a device to accept a BLE connection before giving up on a repaint attempt.",
                 minimum: 1,
                 default: defaults.paintConnectTimeoutSeconds,
             },
             paintRetries: {
-                type: 'number',
-                title: 'Paint retries',
-                description: 'How many times to attempt a repaint (including the first try) before giving up and reporting failure.',
+                type: "number",
+                title: "Paint retries",
+                description: "How many times to attempt a repaint (including the first try) before giving up and reporting failure.",
                 minimum: 1,
                 default: defaults.paintRetries,
             },
             signalkApiUrl: {
-                type: 'string',
-                title: 'SignalK API base URL (leave blank to auto-detect)',
-                description: 'Used for plugin access to SignalK REST APIs not yet integrated for direct plugin access. Left blank, the plugin probes the likely options at startup (3000, 80, 443 ) - only set this manually to skip probing. Anonymous read access is required.',
-                enum: ['', ...resolveApiUrl_1.SIGNALK_API_URL_OPTIONS],
+                type: "string",
+                title: "SignalK API base URL (leave blank to auto-detect)",
+                description: "Used for plugin access to SignalK REST APIs not yet integrated for direct plugin access. Left blank, the plugin probes the likely options at startup (3000, 80, 443 ) - only set this manually to skip probing. Anonymous read access is required.",
+                enum: ["", ...resolveApiUrl_1.SIGNALK_API_URL_OPTIONS],
             },
             devices: {
-                type: 'array',
-                title: 'Devices',
+                type: "array",
+                title: "Devices",
                 items: {
-                    type: 'object',
-                    required: ['friendlyName', 'device', 'templateName', 'repaintTrigger'],
+                    type: "object",
+                    required: ["friendlyName", "device", "templateName", "repaintTrigger"],
                     properties: {
-                        friendlyName: { type: 'string', title: 'Friendly name' },
+                        friendlyName: { type: "string", title: "Friendly name" },
                         device: withEnum({
-                            type: 'string',
-                            title: 'Device',
-                            description: 'Picked from devices found by a scan (plugin start, or `esl-cli scan`) - sets both the model and BLE address.',
+                            type: "string",
+                            title: "Device",
+                            description: "Picked from devices found by a scan (plugin start, or `esl-cli scan`) - sets both the model and BLE address.",
                         }, deviceValues, deviceLabels),
-                        templateName: withEnum({ type: 'string', title: 'Template' }, templateNameOptions(resolveTemplatesDir(current.templatesDir))),
-                        repaintTrigger: { type: 'string', title: 'Repaint trigger', enum: ['subscription', 'interval'] },
-                        triggerPath: { type: 'string', title: 'Trigger SignalK path (if repaint trigger is subscription)' },
-                        intervalHours: { type: 'number', title: 'Repaint every N hours (if repaint trigger is interval)', minimum: 1 },
+                        templateName: withEnum({ type: "string", title: "Template" }, templateNameOptions(resolveTemplatesDir(current.templatesDir))),
+                        repaintTrigger: {
+                            type: "string",
+                            title: "Repaint trigger",
+                            enum: ["subscription", "interval"],
+                        },
+                        triggerPath: {
+                            type: "string",
+                            title: "Trigger SignalK path (if repaint trigger is subscription)",
+                        },
+                        intervalHours: {
+                            type: "number",
+                            title: "Repaint every N hours (if repaint trigger is interval)",
+                            minimum: 1,
+                        },
                         intervalMinute: {
-                            type: 'number',
-                            title: 'Minutes past the hour (if repaint trigger is interval)',
+                            type: "number",
+                            title: "Minutes past the hour (if repaint trigger is interval)",
                             minimum: 0,
                             maximum: 59,
                             default: 0,
                         },
-                        aesKey: { type: 'string', title: 'BLE AES key (vendor-specific; leave blank to use a default key)' },
+                        aesKey: {
+                            type: "string",
+                            title: "BLE AES key (vendor-specific; leave blank to use a default key)",
+                        },
                         forceRepaint: {
-                            type: 'boolean',
-                            title: 'Force repaint',
-                            description: 'Repaint even if the data is unchanged - clears itself automatically once that repaint completes',
+                            type: "boolean",
+                            title: "Force repaint",
+                            description: "Repaint even if the data is unchanged - clears itself automatically once that repaint completes",
                             default: false,
                         },
                     },
@@ -192,7 +214,7 @@ function configUiSchema() {
     return {
         devices: {
             items: {
-                repaintTrigger: { 'ui:widget': 'radio' },
+                repaintTrigger: { "ui:widget": "radio" },
             },
         },
     };

package/dist/devices/bleDiscovery.d.ts

@@ -1,4 +1,4 @@
-import { Adapter, Bluetooth, Device } from '@naugehyde/node-ble';
+import { Adapter, Bluetooth, Device } from "@naugehyde/node-ble";
 export declare function sleep(ms: number): Promise<void>;
 /**
  * Drop-in replacement for `node-ble`'s `createBluetooth` that fails fast and clearly when

package/dist/devices/bleDiscovery.js

@@ -23,9 +23,9 @@ function sleep(ms) {
  * `createBluetooth()` or its callers can see it; it takes the whole process down.
  */
 function createBluetooth() {
-    if (process.platform !== 'linux') {
+    if (process.platform !== "linux") {
         throw new Error(`BLE support requires Linux (BlueZ over D-Bus); "${process.platform}" is not supported - ` +
-            'run this on the target Linux host (e.g. the NanoPi), not on macOS/Windows.');
+            "run this on the target Linux host (e.g. the NanoPi), not on macOS/Windows.");
     }
     return (0, node_ble_1.createBluetooth)();
 }
@@ -53,7 +53,13 @@ async function forEachAdvertisedDevice(adapter, fn) {
         const manufacturerData = await device.getManufacturerData().catch(() => undefined);
         const [key] = Object.keys(manufacturerData ?? {});
         const manufacturerId = key === undefined ? undefined : Number(key);
-        await fn({ address, device, name, manufacturerId, manufacturerData: key === undefined ? undefined : manufacturerData[key] });
+        await fn({
+            address,
+            device,
+            name,
+            manufacturerId,
+            manufacturerData: key === undefined ? undefined : manufacturerData[key],
+        });
     }
 }
 /**

package/dist/devices/registry.d.ts

@@ -1,4 +1,4 @@
-import { VendorDriver } from './types';
+import { VendorDriver } from "./types";
 export declare function registerDriver(driver: VendorDriver): void;
 export declare function getDriver(vendor: string): VendorDriver | undefined;
 export declare function allDrivers(): VendorDriver[];

package/dist/devices/types.d.ts

@@ -1,6 +1,6 @@
-import { Device } from '@naugehyde/node-ble';
-import { Bitmap } from '../render/types';
-export type Colour = 'black' | 'white' | 'red' | 'yellow';
+import { Device } from "@naugehyde/node-ble";
+import { Bitmap } from "../render/types";
+export type Colour = "black" | "white" | "red" | "yellow";
 /**
  * Static facts about one device model, keyed by (vendor, pid) by the registry —
  * PID alone is not assumed unique across vendors.
@@ -39,7 +39,7 @@ export interface DiscoveredDevice {
     batteryMv?: number;
 }
 /** Manual model facts a user can supply for hardware that isn't yet in a driver's PID table. */
-export type DeviceModelOverride = Omit<DeviceMetadata, 'pid'>;
+export type DeviceModelOverride = Omit<DeviceMetadata, "pid">;
 /** Per-device settings the user supplies when registering a device, beyond what's in DeviceMetadata. */
 export interface VendorDeviceConfig {
     address: string;

package/dist/devices/zhsunyco/encode.d.ts

@@ -1,5 +1,5 @@
-import { Bitmap } from '../../render/types';
-import { DeviceMetadata } from '../types';
+import { Bitmap } from "../../render/types";
+import { DeviceMetadata } from "../types";
 /**
  * Quantises a common RGBA bitmap and packs it into the Wolink wire format: 2 bits per
  * pixel, 4 pixels per byte, column-major, with both axes flipped (RAM is x/y-flipped

package/dist/devices/zhsunyco/index.d.ts

@@ -1,6 +1,6 @@
-import { Device } from '@naugehyde/node-ble';
-import { Bitmap } from '../../render/types';
-import { DeviceMetadata, DiscoveredDevice, VendorDeviceConfig, VendorDriver } from '../types';
+import { Device } from "@naugehyde/node-ble";
+import { Bitmap } from "../../render/types";
+import { DeviceMetadata, DiscoveredDevice, VendorDeviceConfig, VendorDriver } from "../types";
 export declare class ZhsunycoDriver implements VendorDriver {
     readonly vendor = "zhsunyco";
     matchesAdvertisement(name: string | undefined, manufacturerId: number | undefined): boolean;

package/dist/devices/zhsunyco/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZhsunycoDriver = void 0;
 const bleDiscovery_1 = require("../bleDiscovery");
+const pluginVersion_1 = require("../../pluginVersion");
 const metadata_1 = require("./metadata");
 const encode_1 = require("./encode");
 const protocol_1 = require("./protocol");
@@ -17,10 +18,10 @@ const SCAN_CONNECT_TIMEOUT_MS = 10000;
 const DEFAULT_PAINT_CONNECT_TIMEOUT_MS = 60000;
 class ZhsunycoDriver {
     constructor() {
-        this.vendor = 'zhsunyco';
+        this.vendor = "zhsunyco";
     }
     matchesAdvertisement(name, manufacturerId) {
-        return manufacturerId === protocol_1.ZHSUNYCO_MANUFACTURER_ID || (name ?? '').startsWith('WL') || (name ?? '').startsWith('WOESL');
+        return manufacturerId === protocol_1.ZHSUNYCO_MANUFACTURER_ID || (name ?? "").startsWith("WL") || (name ?? "").startsWith("WOESL");
     }
     metadataForPid(pid, hwVersion) {
         const candidates = metadata_1.ZHSUNYCO_PID_METADATA.filter((model) => model.pid === pid);
@@ -63,21 +64,21 @@ class ZhsunycoDriver {
                 const statusChar = await service.getCharacteristic(protocol_1.WOLINK_CHARACTERISTIC_UUIDS.status);
                 const info = (0, protocol_1.decodeAdvertisedInfo)(await configChar.readValue());
                 if (!info) {
-                    throw new Error('zhsunyco device did not return valid config data');
+                    throw new Error("zhsunyco device did not return valid config data");
                 }
                 const metadata = config.modelOverride ? { pid: info.pid, ...config.modelOverride } : this.metadataForPid(info.pid, info.hwVersion);
                 if (!metadata) {
-                    throw new Error(`zhsunyco device reports unrecognised PID 0x${info.pid.toString(16).padStart(4, '0')} - ` +
-                        'pass --width/--height/--voffset/--colours to describe it manually');
+                    throw new Error(`zhsunyco device reports unrecognised PID 0x${info.pid.toString(16).padStart(4, "0")} - ` +
+                        "pass --width/--height/--voffset/--colours to describe it manually");
                 }
                 const statusReceived = new Promise((resolve, reject) => {
-                    statusChar.once('valuechanged', (data) => {
+                    statusChar.once("valuechanged", (data) => {
                         const { errorCode } = (0, protocol_1.decodeStatus)(data);
                         if (errorCode === 0) {
                             resolve();
                         }
                         else {
-                            reject(new Error(`zhsunyco device reported error 0x${errorCode.toString(16).padStart(2, '0')} after refresh`));
+                            reject(new Error(`zhsunyco device reported error 0x${errorCode.toString(16).padStart(2, "0")} after refresh`));
                         }
                     });
                 });
@@ -139,7 +140,7 @@ async function readDeviceDetails(device, address, advertisedInfo) {
             // out of range) should still show up in the scan with whatever the advertisement itself
             // carried, just without battery/PID-by-read. Logged so a blank battery column has a reason
             // instead of looking like the read was simply never attempted.
-            console.error(`zhsunyco [${address}]: battery/config read failed: ${err.message}`);
+            console.error(`${pluginVersion_1.PLUGIN_NAME}: zhsunyco [${address}]: battery/config read failed: ${err.message}`);
             return fallback;
         }
     };
@@ -150,7 +151,7 @@ async function readDeviceDetails(device, address, advertisedInfo) {
     return Promise.race([
         read(),
         (0, bleDiscovery_1.sleep)(SCAN_CONNECT_TIMEOUT_MS * 2).then(() => {
-            console.error(`zhsunyco [${address}]: battery/config read timed out after ${SCAN_CONNECT_TIMEOUT_MS * 2}ms`);
+            console.error(`${pluginVersion_1.PLUGIN_NAME}: zhsunyco [${address}]: battery/config read timed out after ${SCAN_CONNECT_TIMEOUT_MS * 2}ms`);
             return fallback;
         }),
     ]);

package/dist/devices/zhsunyco/metadata.d.ts

@@ -1,4 +1,4 @@
-import { DeviceMetadata } from '../types';
+import { DeviceMetadata } from "../types";
 /**
  * Keyed by PID within the Zhsunyco/Wolink namespace only — this table is not shared
  * with other vendors' PID spaces.