@rhizomatics/signalk-einklabel-plugin 1.3.0-beta1 → 1.3.0-beta11

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

@@ -15,6 +15,8 @@ export declare const WOLINK_CHARACTERISTIC_UUIDS: {
 export declare const COMMAND: {
     readonly uploadBlock: 42240;
     readonly refreshUncompressed: 42241;
+    /** Refresh after uploading a `compressWolinkBlocks` payload rather than the raw buffer. */
+    readonly refreshCompressed: 42242;
 };
 export interface AdvertisedDeviceInfo {
     pid: number;

package/dist/devices/zhsunyco/protocol.js

@@ -25,6 +25,8 @@ exports.WOLINK_CHARACTERISTIC_UUIDS = {
 exports.COMMAND = {
     uploadBlock: 0xa500,
     refreshUncompressed: 0xa501,
+    /** Refresh after uploading a `compressWolinkBlocks` payload rather than the raw buffer. */
+    refreshCompressed: 0xa502,
 };
 /** Decodes the 8-byte header shared by the advertising mirror and config characteristic. */
 function decodeAdvertisedInfo(data) {

package/dist/plugin.js

@@ -9,6 +9,7 @@ const discoveryCoordinator_1 = require("./devices/discoveryCoordinator");
 const bleDiscovery_1 = require("./devices/bleDiscovery");
 const discoveredDevicesStore_1 = require("./devices/discoveredDevicesStore");
 const repaintScheduler_1 = require("./repaintScheduler");
+const pluginVersion_1 = require("./pluginVersion");
 /** Mirrors signalk-bluetti-plugin's convention: scan briefly, report finds via plugin status for the user to copy-paste. */
 async function runStartupScan(app, durationSeconds, useBleApi) {
     const alreadyRunning = (0, discoveryCoordinator_1.scanInProgressSince)();
@@ -41,6 +42,7 @@ function createPlugin(app) {
     // enough to have added it - checked at runtime rather than trusted from the type.
     const bleApiAvailable = !!app.bleApi;
     let scheduler;
+    let stopDiscoveryListener;
     let stopped = false;
     const plugin = {
         id: "signalk-einklabel-plugin",
@@ -54,10 +56,10 @@ function createPlugin(app) {
         start(config) {
             const pluginConfig = {
                 ...(0, config_1.defaultConfig)(),
-                ...config,
+                ...(0, config_1.migrateConfig)(config).config,
             };
             app.debug(`starting with ${pluginConfig.devices.length} configured device(s)`);
-            (0, config_1.healNestedConfig)(app);
+            (0, config_1.healStoredConfig)(app);
             stopped = false;
             const useBleApi = pluginConfig.useBleApi && bleApiAvailable;
             if (pluginConfig.useBleApi && !bleApiAvailable) {
@@ -73,6 +75,11 @@ function createPlugin(app) {
                 scheduler = (0, repaintScheduler_1.startRepaintScheduler)(app, pluginConfig);
             };
             if (useBleApi) {
+                // BLE Manager already runs its own continuous scan server-side (that's what populates its own
+                // admin UI device list) - unlike direct BlueZ access below, discovery here doesn't need a
+                // bounded scan window at all, so this listens for as long as the plugin runs rather than only
+                // during `scanOnStart`/an on-demand `ALL_DEVICES` scan. See its own doc comment.
+                stopDiscoveryListener = (0, discoveryCoordinator_1.startBleApiDiscoveryListener)(app, pluginVersion_1.PLUGIN_NAME);
                 // The server/provider governs its own local-adapter readiness once BLE Manager mode owns
                 // `hci0` (or has none at all, behind a remote gateway) - waiting on a *local* BlueZ adapter
                 // here would be waiting on something this mode may never even need.
@@ -90,6 +97,8 @@ function createPlugin(app) {
             stopped = true;
             scheduler?.stop();
             scheduler = undefined;
+            stopDiscoveryListener?.();
+            stopDiscoveryListener = undefined;
             app.debug("stopped");
         },
     };

package/dist/render/mirror.d.ts

@@ -0,0 +1,11 @@
+import { Bitmap } from "./types";
+/**
+ * Flips the rendered image before it's encoded for the panel - for hardware whose RAM layout is
+ * mirrored relative to what a driver's encoder assumes (the Wolink HA integration found the 2.9"
+ * and 3.5" panels differ from the 3.7" this plugin's zhsunyco encoder was confirmed against), or a
+ * label that's simply mounted upside down (`"both"` is a 180° rotation).
+ */
+export type MirrorMode = "none" | "horizontal" | "vertical" | "both";
+export declare const MIRROR_MODES: MirrorMode[];
+/** Returns `bitmap` unchanged for `"none"`, otherwise a flipped copy. */
+export declare function mirrorBitmap(bitmap: Bitmap, mode: MirrorMode): Bitmap;

package/dist/render/mirror.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MIRROR_MODES = void 0;
+exports.mirrorBitmap = mirrorBitmap;
+exports.MIRROR_MODES = ["none", "horizontal", "vertical", "both"];
+/** Returns `bitmap` unchanged for `"none"`, otherwise a flipped copy. */
+function mirrorBitmap(bitmap, mode) {
+    if (mode === "none") {
+        return bitmap;
+    }
+    const { width, height } = bitmap;
+    const flipX = mode === "horizontal" || mode === "both";
+    const flipY = mode === "vertical" || mode === "both";
+    const data = new Uint8Array(bitmap.data.length);
+    for (let y = 0; y < height; y++) {
+        const srcY = flipY ? height - 1 - y : y;
+        for (let x = 0; x < width; x++) {
+            const srcX = flipX ? width - 1 - x : x;
+            const srcOffset = (srcY * width + srcX) * 4;
+            data.set(bitmap.data.subarray(srcOffset, srcOffset + 4), (y * width + x) * 4);
+        }
+    }
+    return { width, height, data };
+}

package/dist/repaintScheduler.js

@@ -23,6 +23,8 @@ const pluginVersion_1 = require("./pluginVersion");
 const httpJson_1 = require("./httpJson");
 const INTERVAL_POLL_MS = 60000;
 const SUBSCRIPTION_DEBOUNCE_MS = 2000;
+/** Pause between paint attempts - see `withRetries`' `delayMs`. */
+const PAINT_RETRY_DELAY_MS = 5000;
 const RESOURCES_API_PATH = "/signalk/v2/api/resources";
 /**
  * The most recent wall-clock instant at or before `now` that an `interval`-triggered device's own
@@ -173,7 +175,7 @@ async function assembleRawContext(app, apiUrl, bindings) {
 }
 function clearForceRepaint(app, friendlyName) {
     const current = (0, config_1.readCurrentConfig)(app);
-    const devices = (current.devices ?? []).map((device) => device.friendlyName === friendlyName ? { ...device, forceRepaint: false } : device);
+    const devices = (current.devices ?? []).map((device) => device.friendlyName === friendlyName ? { ...device, advanced: { ...device.advanced, forceRepaint: false } } : device);
     app.savePluginOptions({ ...current, devices }, (err) => {
         if (err)
             app.debug(`failed to clear forceRepaint for "${friendlyName}": ${err.message}`);
@@ -307,7 +309,7 @@ async function considerRepaint(app, config, device, target, state, getApiUrl) {
         // scheduled tick" (e.g. a regenerated forecast) is the whole point of one - which is exactly why a
         // provider-backed device should use `repaintTrigger: "interval"`, not `subscription`, for
         // cost/battery reasons (each repaint may be a paid API call on the provider's side).
-        if (!provider && !templateChanged && !dataChanged && !device.forceRepaint) {
+        if (!provider && !templateChanged && !dataChanged && !device.advanced?.forceRepaint) {
             app.debug(`${label}: data unchanged, skipping repaint`);
             return;
         }
@@ -325,7 +327,7 @@ async function considerRepaint(app, config, device, target, state, getApiUrl) {
             ? await provider.render({ templateName: device.templateName, context: renderContext, width, height, colours: metadata.colours })
             : await renderer.render(templatePath, renderContext, width, height, templatesDir, config_1.BUNDLED_TEMPLATES_DIR);
         succeeded = true;
-        repaintReason = device.forceRepaint
+        repaintReason = device.advanced?.forceRepaint
             ? "forced"
             : provider
                 ? "provider-rendered"
@@ -344,16 +346,29 @@ async function considerRepaint(app, config, device, target, state, getApiUrl) {
         });
         bitmap = await renderer.render(fallbackPath, { meta: { repainted: new Date().toISOString(), plugin_version: pluginVersion_1.PLUGIN_VERSION, description: device.description ?? "" } }, width, height, templatesDir, config_1.BUNDLED_TEMPLATES_DIR);
     }
-    const connectTimeoutMs = config.paintConnectTimeoutSeconds * 1000;
-    await (0, bleDiscovery_1.withRetries)(config.paintRetries, async (attempt) => {
-        if (attempt > 1) {
-            app.debug(`${label}: attempting paint ${attempt}/${config.paintRetries}`);
-        }
+    const connectTimeoutMs = (device.advanced?.paintConnectTimeoutSeconds ?? config.paintConnectTimeoutSeconds) * 1000;
+    const gattBackend = config.useBleApi && app.bleApi ? (0, bleBackend_1.bleApiBackend)(app.bleApi, pluginVersion_1.PLUGIN_NAME) : undefined;
+    const attempts = Math.max(1, device.advanced?.paintRetries ?? config.paintRetries);
+    const paintWithRetries = () => (0, bleDiscovery_1.withRetries)(attempts, async (attempt) => {
+        app.debug(`${label}: attempting paint ${attempt}/${attempts}`);
         const startedAt = Date.now();
-        const gattBackend = config.useBleApi && app.bleApi ? (0, bleBackend_1.bleApiBackend)(app.bleApi, pluginVersion_1.PLUGIN_NAME) : undefined;
-        await driver.paint(bitmap, { address, aesKey: device.aesKey, connectTimeoutMs, reframe: device.reframe, gattBackend });
+        await driver.paint(bitmap, {
+            address,
+            pid: target.pid,
+            aesKey: device.advanced?.aesKey,
+            connectTimeoutMs,
+            reframe: device.reframe,
+            mirror: device.advanced?.mirror,
+            compress: device.advanced?.compress,
+            compressionFormat: device.advanced?.compressionFormat,
+            gattBackend,
+        });
         paintDurationMs = Date.now() - startedAt;
+    }, {
+        delayMs: PAINT_RETRY_DELAY_MS,
+        onError: (err, attempt) => app.debug(`${label}: paint attempt ${attempt}/${attempts} failed: ${err.message}`),
     });
+    await (gattBackend ? (0, bleBackend_1.exclusiveBleManagerAccess)(paintWithRetries) : paintWithRetries());
     (0, discoveredDevicesStore_1.touchDiscoveredDevice)(app, { address, vendor: target.vendor, pid: target.pid, hwVersion: target.hwVersion, metadata });
     // Only a successful render counts as "repainted" for dedup/catch-up purposes - a failure must not be
     // recorded here (see this function's doc comment on why).
@@ -393,7 +408,7 @@ function startRepaintScheduler(app, config) {
         // A single `forceRepaint` flag covers every target under `ALL_DEVICES` too - only clear it once
         // every target has actually succeeded, so a target that failed still gets forced again next time
         // instead of quietly reverting to ordinary hash-based dedup.
-        if (device.forceRepaint && results.every((result) => result.status === "fulfilled")) {
+        if (device.advanced?.forceRepaint && results.every((result) => result.status === "fulfilled")) {
             clearForceRepaint(app, device.friendlyName);
         }
     };
@@ -440,7 +455,7 @@ function startRepaintScheduler(app, config) {
     // still avoids a redundant paint once targets are resolved.
     const startupCheckTimer = setTimeout(() => {
         for (const device of config.devices) {
-            if (device.repaintTrigger === "interval" && !device.forceRepaint && device.device !== config_1.ALL_DEVICES) {
+            if (device.repaintTrigger === "interval" && !device.advanced?.forceRepaint && device.device !== config_1.ALL_DEVICES) {
                 const hours = device.intervalHours ?? 1;
                 const minute = device.intervalMinute ?? 0;
                 const dueSlot = mostRecentScheduledSlot(new Date(), hours, minute);

package/package.json

@@ -1,20 +1,26 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "1.3.0-beta1",
+  "version": "1.3.0-beta11",
   "description": "Display SignalK data on eInk Electronic Shelf Labels, includes working examples for tide clock and watch schedule.",
   "keywords": [
     "ble",
     "display",
+    "e-ink",
+    "e-paper",
     "eink",
+    "epaper",
     "esl",
     "gicisky",
     "instrument",
+    "marine",
+    "shelf-label",
     "signalk",
     "signalk-category-hardware",
     "signalk-category-instruments",
     "signalk-node-server-plugin",
     "tides",
     "watch-schedule",
+    "wolink",
     "zhsunyco"
   ],
   "homepage": "https://signalk-einklabel.rhizomatics.org.uk/",
@@ -56,7 +62,7 @@
     "@fontsource/roboto-serif": "^5.3.0",
     "@naugehyde/node-ble": "^1.13.5",
     "@resvg/resvg-wasm": "^2.6.2",
-    "@xmldom/xmldom": "^0.9.10",
+    "@xmldom/xmldom": "^0.9.12",
     "commander": "^15.0.0",
     "form-data": "^4.0.6",
     "luxon": "^3.7.2",
@@ -65,17 +71,17 @@
   },
   "devDependencies": {
     "@signalk/server-api": "^2.32.0",
-    "@types/luxon": "^3.7.1",
-    "@types/node": "^26.4.0",
+    "@types/luxon": "^3.7.5",
+    "@types/node": "^26.6.0",
     "@types/pngjs": "^6.0.5",
-    "oxfmt": "^0.66.0",
-    "oxlint": "^1.81.0",
+    "oxfmt": "^0.70.0",
+    "oxlint": "^1.85.0",
     "oxlint-tsgolint": "^7.0.2001",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=22"
   },
   "signalk": {
     "displayName": "eInk Label Displays",
@@ -87,9 +93,9 @@
       "docs/assets/screenshots/label_config.png"
     ],
     "recommends": [
+      "@rhizomatics/signalk-einklabel-genai-plugin",
       "signalk-watch-schedule",
-      "signalk-tides",
-      "@rhizomatics/signalk-einklabel-genai-plugin"
+      "signalk-tides"
     ]
   }
 }