@rhizomatics/signalk-einklabel-plugin 1.0.0 → 1.2.0

package/dist/render/reframe.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reframeBitmap = reframeBitmap;
+/** Nearest-neighbour, not bilinear: the vendor colour quantisers threshold each pixel independently into a small fixed palette (see `nearestColour`/`classifyColour`), so blended edge pixels from interpolation would just be re-thresholded arbitrarily rather than improving the result. */
+function scaleBitmap(bitmap, targetWidth, targetHeight) {
+    const data = new Uint8Array(targetWidth * targetHeight * 4);
+    for (let y = 0; y < targetHeight; y++) {
+        const srcY = Math.min(bitmap.height - 1, Math.floor((y * bitmap.height) / targetHeight));
+        for (let x = 0; x < targetWidth; x++) {
+            const srcX = Math.min(bitmap.width - 1, Math.floor((x * bitmap.width) / targetWidth));
+            const srcOffset = (srcY * bitmap.width + srcX) * 4;
+            const dstOffset = (y * targetWidth + x) * 4;
+            data.set(bitmap.data.subarray(srcOffset, srcOffset + 4), dstOffset);
+        }
+    }
+    return { width: targetWidth, height: targetHeight, data };
+}
+/** Opaque white (matches an untouched label's own background) rather than transparent black, since the vendor colour quantisers treat a fully-transparent pixel the same as an opaque black one. */
+function cropBitmap(bitmap, targetWidth, targetHeight) {
+    const data = new Uint8Array(targetWidth * targetHeight * 4).fill(255);
+    const copyWidth = Math.min(bitmap.width, targetWidth);
+    const copyHeight = Math.min(bitmap.height, targetHeight);
+    for (let y = 0; y < copyHeight; y++) {
+        const srcOffset = y * bitmap.width * 4;
+        const dstOffset = y * targetWidth * 4;
+        data.set(bitmap.data.subarray(srcOffset, srcOffset + copyWidth * 4), dstOffset);
+    }
+    return { width: targetWidth, height: targetHeight, data };
+}
+/** Applies `mode` to fit `bitmap` onto a `targetWidth`x`targetHeight` panel - a no-op whenever the size already matches, regardless of mode. */
+function reframeBitmap(bitmap, targetWidth, targetHeight, mode) {
+    if (mode === "fixed" || (bitmap.width === targetWidth && bitmap.height === targetHeight)) {
+        return bitmap;
+    }
+    return mode === "scale" ? scaleBitmap(bitmap, targetWidth, targetHeight) : cropBitmap(bitmap, targetWidth, targetHeight);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Display SignalK data on eInk Electronic Shelf Labels, includes working examples for tide clock and watch schedule.",
   "keywords": [
     "ble",
@@ -9,13 +9,15 @@
     "esl",
     "instrument",
     "signalk",
+    "zhsunyco",
+    "gicisky",
     "signalk-category-hardware",
     "signalk-category-instruments",
     "signalk-node-server-plugin",
     "tides",
     "watch-schedule"
   ],
-  "homepage": "https://rhizomatics.github.io/signalk-einklabel-plugin/",
+  "homepage": "https://signalk-einklabel.rhizomatics.org.uk/",
   "bugs": {
     "url": "https://github.com/rhizomatics/signalk-einklabel-plugin/issues"
   },
@@ -49,26 +51,26 @@
     "lint": "oxlint"
   },
   "dependencies": {
-    "@fontsource/roboto": "^5.2.10",
-    "@fontsource/roboto-mono": "^5.2.9",
-    "@fontsource/roboto-serif": "^5.2.9",
+    "@fontsource/roboto": "^5.3.0",
+    "@fontsource/roboto-mono": "^5.3.0",
+    "@fontsource/roboto-serif": "^5.3.0",
     "@naugehyde/node-ble": "^1.13.5",
     "@resvg/resvg-wasm": "^2.6.2",
     "@xmldom/xmldom": "^0.9.10",
-    "commander": "^12.1.0",
+    "commander": "^15.0.0",
     "form-data": "^4.0.6",
     "luxon": "^3.7.2",
     "mathjs": "^15.2.0",
     "pngjs": "^7.0.0"
   },
   "devDependencies": {
-    "@signalk/server-api": "^2.28.0",
+    "@signalk/server-api": "^2.31.0",
     "@types/luxon": "^3.7.1",
     "@types/node": "^20.14.0",
     "@types/pngjs": "^6.0.5",
-    "oxfmt": "^0.59.0",
-    "oxlint": "^1.74.0",
-    "oxlint-tsgolint": "^7.0.0",
+    "oxfmt": "^0.66.0",
+    "oxlint": "^1.81.0",
+    "oxlint-tsgolint": "^7.0.2001",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.0"
   },

package/dist/render/llmPrompt.d.ts

@@ -1,86 +0,0 @@
-import { PluginConfig } from "../config";
-import { Colour } from "../devices/types";
-import { Binding } from "./binding";
-import { TemplateContext } from "./types";
-/** Facts about one physical label a prompt's `source=label,path=...` placeholders can reference - see `buildLabelContext`. */
-export interface LabelMeta {
-    manufacturer: string;
-    /** The physical panel's own size label, e.g. `'3.7"'` - `DeviceMetadata.label` verbatim, see `../devices/types.ts`. */
-    label: string;
-    width: number;
-    height: number;
-    colours: Colour[];
-    description?: string;
-    position?: {
-        latitude: number;
-        longitude: number;
-    };
-}
-/**
- * Builds the `context.label` object a prompt/target-guidance fragment addresses via
- * `source=label,path=...` bindings (e.g. `{source=label,path=width}`, or the bare-path shorthand
- * `{width}` is *not* supported here deliberately - see `./binding.ts`'s `parseBinding`, every `{...}`
- * placeholder is a real binding, so a `label` path always needs the explicit `source=label,path=`
- * form to disambiguate it from a `signalk` self path). `colours`/`fonts` are left as arrays (each
- * colour entry pre-annotated with its hex code, e.g. `"black (#000000)"`) rather than joined into a
- * single string, so a prompt author can either use them bare (renders as JSON, e.g. for a model that
- * parses structured hints) or add `format=csv` (see `./formatters.ts`) for a plain comma-separated list.
- */
-export declare function buildLabelContext(meta: LabelMeta): Record<string, unknown>;
-/**
- * Every binding referenced across one or more prompt fragments - every `{...}` placeholder, deduplicated
- * across all of `texts` combined, parsed exactly the way a template's `<desc>` binding is
- * (`parseBinding`, see `./binding.ts`), so a bare path (`{design.length}`, `source=signalk,context=self`
- * shorthand), the full binding grammar (`{source=signalk,path=navigation.position,format=position}`),
- * and a `source=label,path=...` binding all work uniformly. Pass the result to `assembleRawContext`
- * (repaintScheduler.ts) exactly as a template's own bindings are - it fetches the `signalk`/
- * `resources`-sourced ones and silently ignores `label`/`einklabel`-sourced ones, which resolve directly
- * against `context.label`/`context.meta` instead (built by the caller, not fetched).
- *
- * A placeholder that isn't valid binding grammar (e.g. a typo like `{source=taheight}`) is silently
- * skipped here rather than thrown - the same per-field isolation `SvgRenderer` gives a bad `<desc>`
- * binding, so one malformed placeholder doesn't take down the whole prompt. `substitutePlaceholders`
- * hits the identical parse error at substitution time and turns it into "???" for just that field.
- */
-export declare function findPromptBindings(...texts: string[]): Binding[];
-/**
- * Substitutes every `{...}` placeholder in `text` with its resolved binding value against `context`
- * (built by `assembleRawContext` plus `context.label` from `buildLabelContext` - see
- * `findPromptBindings`). Mirrors `renderBinding`'s per-field isolation, but substitutes "???" for
- * anything that resolves to no value at all (missing path, invalid binding grammar) rather than "" -
- * prose with a silently-blank word reads as a fact ("for the sailor of a m vessel"), not as a gap the
- * reader would notice. Two things override that "???": a binding that resolves successfully to a
- * legitimately empty string (e.g. an unset `{source=label,path=description}`) is left as empty, since
- * that's a real answer, not a miss; and a binding with an explicit `default=` (see `./binding.ts`) uses
- * that default instead, since the prompt author has already said what a missing value should read as.
- */
-export declare function substitutePlaceholders(text: string, context: TemplateContext): string;
-/**
- * Strips everything outside the first `<svg`...last `</svg>` span - a chat model asked for "only raw
- * SVG markup" still often wraps it in a markdown code fence or adds a sentence of commentary either
- * side, despite the target-guidance fragment telling it not to.
- */
-export declare function extractSvg(raw: string): string;
-export type LlmSettings = Pick<PluginConfig, "llmProvider" | "llmApiKey" | "llmModel" | "llmBaseUrl"> & {
-    llmTimeoutSeconds?: number;
-};
-/**
- * `ai` and every `@ai-sdk/*` provider package are `optionalDependencies` (see package.json), not plain
- * `dependencies` - most installs (every device using `renderMode: "svg-template"` only) never touch an
- * LLM at all, so they shouldn't have to pull in this whole gateway stack, and an install that fails to
- * fetch one of these (network hiccup, `npm install --omit=optional`, an unsupported platform) must not
- * break BLE painting/templates, which have nothing to do with it. That means every reference to one of
- * these packages has to be a `require()` reached only when a `renderMode: "llm-prompt"` device actually
- * calls `callLlm` - a top-level `import` would be resolved eagerly the moment this module loads (which
- * is every plugin start, via `repaintScheduler.ts`), throwing before any config is even read. Types are
- * still fully checked via `typeof import(...)` below, which - unlike a value `import` - is erased
- * entirely at compile time and leaves no runtime trace for `tsc` to eagerly require.
- */
-export declare function loadOptional<M>(moduleName: string): M;
-/**
- * Calls the configured LLM gateway with `prompt`, returning its raw text response - not yet extracted/
- * validated as SVG, see `extractSvg`. This is the first network call in the codebase that needs its own
- * timeout (`fetchJson` in `../httpJson.ts` has none - every existing call is to the local SignalK
- * server's own REST API).
- */
-export declare function callLlm(settings: LlmSettings, prompt: string): Promise<string>;

package/dist/render/llmPrompt.js

@@ -1,199 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildLabelContext = buildLabelContext;
-exports.findPromptBindings = findPromptBindings;
-exports.substitutePlaceholders = substitutePlaceholders;
-exports.extractSvg = extractSvg;
-exports.loadOptional = loadOptional;
-exports.callLlm = callLlm;
-const binding_1 = require("./binding");
-const formatters_1 = require("./formatters");
-const COLOUR_HEX = { black: "#000000", white: "#FFFFFF", red: "#FF0000", yellow: "#FFFF00" };
-/** The only `font-family` values `SvgRenderer` is guaranteed to render - see `expandGenericFontFamilies` in `./svgRenderer.ts`. */
-const SAFE_FONT_FAMILIES = ["serif", "sans-serif", "monospace"];
-/**
- * Builds the `context.label` object a prompt/target-guidance fragment addresses via
- * `source=label,path=...` bindings (e.g. `{source=label,path=width}`, or the bare-path shorthand
- * `{width}` is *not* supported here deliberately - see `./binding.ts`'s `parseBinding`, every `{...}`
- * placeholder is a real binding, so a `label` path always needs the explicit `source=label,path=`
- * form to disambiguate it from a `signalk` self path). `colours`/`fonts` are left as arrays (each
- * colour entry pre-annotated with its hex code, e.g. `"black (#000000)"`) rather than joined into a
- * single string, so a prompt author can either use them bare (renders as JSON, e.g. for a model that
- * parses structured hints) or add `format=csv` (see `./formatters.ts`) for a plain comma-separated list.
- */
-function buildLabelContext(meta) {
-    return {
-        manufacturer: meta.manufacturer,
-        label: meta.label,
-        width: meta.width,
-        height: meta.height,
-        colours: meta.colours.map((colour) => `${colour} (${COLOUR_HEX[colour]})`),
-        fonts: SAFE_FONT_FAMILIES,
-        description: meta.description ?? "",
-        position: meta.position ? (0, formatters_1.applyFormat)("position", meta.position, {}, 3) : undefined,
-    };
-}
-/**
- * Every binding referenced across one or more prompt fragments - every `{...}` placeholder, deduplicated
- * across all of `texts` combined, parsed exactly the way a template's `<desc>` binding is
- * (`parseBinding`, see `./binding.ts`), so a bare path (`{design.length}`, `source=signalk,context=self`
- * shorthand), the full binding grammar (`{source=signalk,path=navigation.position,format=position}`),
- * and a `source=label,path=...` binding all work uniformly. Pass the result to `assembleRawContext`
- * (repaintScheduler.ts) exactly as a template's own bindings are - it fetches the `signalk`/
- * `resources`-sourced ones and silently ignores `label`/`einklabel`-sourced ones, which resolve directly
- * against `context.label`/`context.meta` instead (built by the caller, not fetched).
- *
- * A placeholder that isn't valid binding grammar (e.g. a typo like `{source=taheight}`) is silently
- * skipped here rather than thrown - the same per-field isolation `SvgRenderer` gives a bad `<desc>`
- * binding, so one malformed placeholder doesn't take down the whole prompt. `substitutePlaceholders`
- * hits the identical parse error at substitution time and turns it into "???" for just that field.
- */
-function findPromptBindings(...texts) {
-    const seen = new Set();
-    const bindings = [];
-    for (const text of texts) {
-        for (const match of text.matchAll(/\{([^{}]+)\}/g)) {
-            const key = match[1].trim();
-            if (seen.has(key))
-                continue;
-            seen.add(key);
-            try {
-                bindings.push((0, binding_1.parseBinding)(key));
-            }
-            catch {
-                // see doc comment above - left for `substitutePlaceholders` to turn into "???"
-            }
-        }
-    }
-    return bindings;
-}
-/**
- * Substitutes every `{...}` placeholder in `text` with its resolved binding value against `context`
- * (built by `assembleRawContext` plus `context.label` from `buildLabelContext` - see
- * `findPromptBindings`). Mirrors `renderBinding`'s per-field isolation, but substitutes "???" for
- * anything that resolves to no value at all (missing path, invalid binding grammar) rather than "" -
- * prose with a silently-blank word reads as a fact ("for the sailor of a m vessel"), not as a gap the
- * reader would notice. Two things override that "???": a binding that resolves successfully to a
- * legitimately empty string (e.g. an unset `{source=label,path=description}`) is left as empty, since
- * that's a real answer, not a miss; and a binding with an explicit `default=` (see `./binding.ts`) uses
- * that default instead, since the prompt author has already said what a missing value should read as.
- */
-function substitutePlaceholders(text, context) {
-    return text.replace(/\{([^{}]+)\}/g, (_match, raw) => {
-        const key = raw.trim();
-        try {
-            const binding = (0, binding_1.parseBinding)(key);
-            const value = (0, binding_1.resolveBinding)(binding, context);
-            if ((value === undefined || value === null) && binding.default === undefined)
-                return "???";
-            return (0, binding_1.renderBinding)(binding, context);
-        }
-        catch {
-            return "???";
-        }
-    });
-}
-/**
- * Strips everything outside the first `<svg`...last `</svg>` span - a chat model asked for "only raw
- * SVG markup" still often wraps it in a markdown code fence or adds a sentence of commentary either
- * side, despite the target-guidance fragment telling it not to.
- */
-function extractSvg(raw) {
-    const start = raw.indexOf("<svg");
-    const end = raw.lastIndexOf("</svg>");
-    if (start === -1 || end === -1 || end < start) {
-        throw new Error('LLM response did not contain a "<svg>...</svg>" document');
-    }
-    return raw.slice(start, end + "</svg>".length);
-}
-/**
- * `ai` and every `@ai-sdk/*` provider package are `optionalDependencies` (see package.json), not plain
- * `dependencies` - most installs (every device using `renderMode: "svg-template"` only) never touch an
- * LLM at all, so they shouldn't have to pull in this whole gateway stack, and an install that fails to
- * fetch one of these (network hiccup, `npm install --omit=optional`, an unsupported platform) must not
- * break BLE painting/templates, which have nothing to do with it. That means every reference to one of
- * these packages has to be a `require()` reached only when a `renderMode: "llm-prompt"` device actually
- * calls `callLlm` - a top-level `import` would be resolved eagerly the moment this module loads (which
- * is every plugin start, via `repaintScheduler.ts`), throwing before any config is even read. Types are
- * still fully checked via `typeof import(...)` below, which - unlike a value `import` - is erased
- * entirely at compile time and leaves no runtime trace for `tsc` to eagerly require.
- */
-function loadOptional(moduleName) {
-    try {
-        // eslint-disable-next-line @typescript-eslint/no-require-imports
-        return require(moduleName);
-    }
-    catch (err) {
-        throw new Error(`LLM provider support needs the optional dependency "${moduleName}", which isn't installed - run "npm install ${moduleName}" (${err.message})`);
-    }
-}
-/** Ollama's own default local listen address - see the `"ollama"` case in `resolveModel` below. */
-const DEFAULT_OLLAMA_BASE_URL = "http://localhost:11434/v1";
-/**
- * Resolves `settings` to a Vercel AI SDK model handle. `"ollama"` and `"local"` both go through the
- * generic `@ai-sdk/openai-compatible` provider (Ollama/LM Studio/vLLM all expose an OpenAI-compatible
- * endpoint, and none of them has - or needs - its own dedicated `@ai-sdk/*` package): `"ollama"`
- * defaults `llmBaseUrl` to Ollama's own standard local address so it works with no further config
- * (override it only if Ollama is running elsewhere, e.g. on the SignalK server's own host reached over
- * the network); `"local"` is for anything else OpenAI-compatible, where there's no sensible universal
- * default, so `llmBaseUrl` is required.
- */
-function resolveModel(settings) {
-    const model = settings.llmModel;
-    if (!model) {
-        throw new Error("no LLM model configured (PluginConfig.llmModel)");
-    }
-    switch (settings.llmProvider ?? "openai") {
-        case "anthropic": {
-            const { createAnthropic } = loadOptional("@ai-sdk/anthropic");
-            return createAnthropic({ apiKey: settings.llmApiKey })(model);
-        }
-        case "google": {
-            const { createGoogleGenerativeAI } = loadOptional("@ai-sdk/google");
-            return createGoogleGenerativeAI({ apiKey: settings.llmApiKey })(model);
-        }
-        case "xai": {
-            const { createXai } = loadOptional("@ai-sdk/xai");
-            return createXai({ apiKey: settings.llmApiKey })(model);
-        }
-        case "ollama": {
-            const { createOpenAICompatible } = loadOptional("@ai-sdk/openai-compatible");
-            return createOpenAICompatible({
-                name: "ollama",
-                baseURL: settings.llmBaseUrl || DEFAULT_OLLAMA_BASE_URL,
-                apiKey: settings.llmApiKey,
-            })(model);
-        }
-        case "local": {
-            if (!settings.llmBaseUrl) {
-                throw new Error('llmBaseUrl is required when llmProvider is "local"');
-            }
-            const { createOpenAICompatible } = loadOptional("@ai-sdk/openai-compatible");
-            return createOpenAICompatible({ name: "local", baseURL: settings.llmBaseUrl, apiKey: settings.llmApiKey })(model);
-        }
-        case "openai":
-        default: {
-            const { createOpenAI } = loadOptional("@ai-sdk/openai");
-            return createOpenAI({ apiKey: settings.llmApiKey })(model);
-        }
-    }
-}
-/**
- * Calls the configured LLM gateway with `prompt`, returning its raw text response - not yet extracted/
- * validated as SVG, see `extractSvg`. This is the first network call in the codebase that needs its own
- * timeout (`fetchJson` in `../httpJson.ts` has none - every existing call is to the local SignalK
- * server's own REST API).
- */
-async function callLlm(settings, prompt) {
-    const model = resolveModel(settings);
-    const { generateText } = loadOptional("ai");
-    const controller = new AbortController();
-    const timer = setTimeout(() => controller.abort(), (settings.llmTimeoutSeconds ?? 30) * 1000);
-    try {
-        const { text } = await generateText({ model, prompt, abortSignal: controller.signal });
-        return text;
-    }
-    finally {
-        clearTimeout(timer);
-    }
-}