@rhizomatics/signalk-einklabel-plugin 1.2.2 → 1.2.3

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.2.3
+
+- Improved example tide template for 2.9" Gicisky, and added blank and error templates
+
 # 1.2.2
 
 - Fully implemented the backoff and retry logic on failed paint, by default after 30s

package/README.md

@@ -8,7 +8,7 @@
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/LICENSE)
 [![boat tech directory](https://boat-tech-directory.rhizomatics.org.uk/images/badge.svg)](https://boat-tech-directory.rhizomatics.org.uk)
 
-A SignalK plugin to display data from SignalK paths, Resource APIs and plugins on Electronic Shelf Labels (ESL) over a Bluetooth Low Energy (BLE) connection using simple SVG templates, or optionally created from a crafted prompt by GenAI if the companion [`@rhizomatics/signalk-einklabel-genai-plugin`](https://github.com/rhizomatics/signalk-einklabel-genai-plugin) is installed.
+A SignalK plugin to display data from SignalK paths, Resource APIs and plugins on Electronic Shelf Labels (ESL) over a Bluetooth Low Energy (BLE) connection using simple SVG templates, or optionally created from a crafted prompt by GenAI if the companion [`@rhizomatics/signalk-einklabel-genai-plugin`](https://github.com/rhizomatics/signalk-einklabel-genai-plugin) is installed. Supports ESLs from two of the major Chinese manufacturers, and requires no firmware or hardware modifications, switch on and go.
 
 ![Companionway Tidal Clock](docs/assets/images/real_tidal_clock.jpg)
 

package/dist/config.js

@@ -414,7 +414,7 @@ function configSchema(app, discovered = []) {
                         reframe: {
                             type: "string",
                             title: "If the render doesn't match the panel size",
-                            description: 'Crop: place at the top-left, truncating anything too big or leaving the rest blank if too small. Scale: stretch to fit exactly (may distort). Fixed: fail the repaint instead of showing an off-size image.',
+                            description: "Crop: place at the top-left, truncating anything too big or leaving the rest blank if too small. Scale: stretch to fit exactly (may distort). Fixed: fail the repaint instead of showing an off-size image.",
                             enum: ["crop", "scale", "fixed"],
                             default: "crop",
                         },

package/dist/email/emailSender.d.ts

@@ -0,0 +1,27 @@
+import { EmailConfig } from "../config";
+import { Bitmap } from "../render/types";
+import { FieldRow } from "../render/fieldsTable";
+/** Either the SVG template's field-by-field table (`buildFieldsTable`), a `TemplateProvider`'s own rendered-content text (`describeContent`), or neither (a provider offered no `describeContent`). */
+export type EmailContentBody = {
+    kind: "table";
+    rows: FieldRow[];
+} | {
+    kind: "text";
+    text: string;
+} | {
+    kind: "none";
+};
+export interface LabelEmailContent {
+    friendlyName: string;
+    description?: string;
+    bitmap: Bitmap;
+    body: EmailContentBody;
+}
+/**
+ * Renders and sends one device's repaint as an email - a PNG attachment (also shown inline via a `cid`
+ * reference), the same field-by-field table `esl-cli fields` shows for a hand-authored SVG template (or
+ * a `TemplateProvider`'s own rendered-content text for something like a GenAI prompt - see `body`), and a
+ * link back to the docs site. Called from `considerRepaint` (`../repaintScheduler.ts`) whenever a
+ * device's `emailTo` is set and its render succeeds.
+ */
+export declare function sendLabelEmail(emailConfig: EmailConfig, to: string, content: LabelEmailContent): Promise<void>;

package/dist/email/emailSender.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendLabelEmail = sendLabelEmail;
+const nodemailer_1 = __importDefault(require("nodemailer"));
+const png_1 = require("../render/png");
+const DOCS_URL = "https://rhizomatics.github.io/signalk-einklabel-plugin/";
+function escapeHtml(text) {
+    return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
+function bodyHtml(body) {
+    if (body.kind === "table") {
+        if (body.rows.length === 0)
+            return "";
+        const rows = body.rows
+            .map((row) => `<tr><td>${escapeHtml(row.id)}</td><td>${escapeHtml(row.spec)}</td><td>${escapeHtml(row.value)}</td></tr>`)
+            .join("");
+        return ('<table border="1" cellpadding="4" cellspacing="0" style="border-collapse:collapse;font-family:monospace;font-size:13px">' +
+            `<thead><tr><th>id</th><th>spec</th><th>value</th></tr></thead><tbody>${rows}</tbody></table>`);
+    }
+    if (body.kind === "text") {
+        return `<pre style="white-space:pre-wrap;font-family:monospace;font-size:13px">${escapeHtml(body.text)}</pre>`;
+    }
+    return "";
+}
+/**
+ * Renders and sends one device's repaint as an email - a PNG attachment (also shown inline via a `cid`
+ * reference), the same field-by-field table `esl-cli fields` shows for a hand-authored SVG template (or
+ * a `TemplateProvider`'s own rendered-content text for something like a GenAI prompt - see `body`), and a
+ * link back to the docs site. Called from `considerRepaint` (`../repaintScheduler.ts`) whenever a
+ * device's `emailTo` is set and its render succeeds.
+ */
+async function sendLabelEmail(emailConfig, to, content) {
+    const transporter = nodemailer_1.default.createTransport({
+        host: emailConfig.smtpHost,
+        port: emailConfig.smtpPort,
+        secure: emailConfig.smtpSecure,
+        auth: emailConfig.smtpUser ? { user: emailConfig.smtpUser, pass: emailConfig.smtpPassword } : undefined,
+    });
+    const png = (0, png_1.bitmapToPng)(content.bitmap);
+    const html = [
+        '<div style="font-family:sans-serif">',
+        `<h2>${escapeHtml(content.friendlyName)}</h2>`,
+        content.description ? `<p>${escapeHtml(content.description)}</p>` : "",
+        `<p><img src="cid:label-image" alt="${escapeHtml(content.friendlyName)}" style="border:1px solid #ccc" /></p>`,
+        bodyHtml(content.body),
+        `<p><a href="${DOCS_URL}">${DOCS_URL}</a></p>`,
+        "</div>",
+    ].join("\n");
+    await transporter.sendMail({
+        from: emailConfig.fromAddress,
+        to,
+        subject: `eInk Label: ${content.friendlyName}`,
+        html,
+        attachments: [
+            {
+                filename: "label.png",
+                content: png,
+                contentType: "image/png",
+                cid: "label-image",
+            },
+        ],
+    });
+}

package/dist/render/fieldsTable.d.ts

@@ -0,0 +1,15 @@
+import { TemplateContext } from "./types";
+export interface FieldRow {
+    id: string;
+    spec: string;
+    value: string;
+}
+/**
+ * Synchronous counterpart to the CLI's `fields` command (`../cli/index.ts`) - same three columns (id,
+ * spec, resolved value), but resolved against a single already-assembled `context` rather than
+ * re-fetching per binding, since a caller like `considerRepaint` (`../repaintScheduler.ts`) already has
+ * the full context its render used. Only meaningful for a hand-authored SVG template - a
+ * `TemplateProvider`-backed template (e.g. GenAI) has no `<desc>` bindings to walk; see
+ * `TemplateProvider.describeContent` (`./templateProviders.ts`) for that case's own text summary instead.
+ */
+export declare function buildFieldsTable(svgSource: string, context: TemplateContext, templatesDir: string, bundledTemplatesDir: string): FieldRow[];

package/dist/render/fieldsTable.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildFieldsTable = buildFieldsTable;
+const path_1 = require("path");
+const xmldom_1 = require("@xmldom/xmldom");
+const assets_1 = require("./assets");
+const binding_1 = require("./binding");
+function resolveFieldValue(tag, desc, context, templatesDir, bundledTemplatesDir) {
+    try {
+        const binding = (0, binding_1.parseBinding)(desc);
+        if (tag !== "image") {
+            return (0, binding_1.renderBinding)(binding, context);
+        }
+        if (!binding.assets) {
+            return 'ERROR: an <image> binding requires an "assets" key';
+        }
+        const key = (0, assets_1.normalizeAssetKey)((0, binding_1.resolveBinding)(binding, context));
+        if (!key)
+            return "(no usable value - image would be omitted)";
+        const assetPath = (0, assets_1.resolveAssetPath)(templatesDir, bundledTemplatesDir, binding.assets, key);
+        return assetPath ? `"${key}" -> ${(0, path_1.basename)(assetPath)}` : `"${key}" -> no matching asset file (image would be omitted)`;
+    }
+    catch (err) {
+        return `ERROR: ${err.message}`;
+    }
+}
+/**
+ * Synchronous counterpart to the CLI's `fields` command (`../cli/index.ts`) - same three columns (id,
+ * spec, resolved value), but resolved against a single already-assembled `context` rather than
+ * re-fetching per binding, since a caller like `considerRepaint` (`../repaintScheduler.ts`) already has
+ * the full context its render used. Only meaningful for a hand-authored SVG template - a
+ * `TemplateProvider`-backed template (e.g. GenAI) has no `<desc>` bindings to walk; see
+ * `TemplateProvider.describeContent` (`./templateProviders.ts`) for that case's own text summary instead.
+ */
+function buildFieldsTable(svgSource, context, templatesDir, bundledTemplatesDir) {
+    const doc = new xmldom_1.DOMParser().parseFromString(svgSource, "image/svg+xml");
+    const rows = [];
+    for (const tag of ["text", "image"]) {
+        const elements = doc.getElementsByTagName(tag);
+        for (let i = 0; i < elements.length; i++) {
+            const element = elements.item(i);
+            if (!element)
+                continue;
+            const id = element.getAttribute("id") ?? `${tag}#${i}`;
+            const desc = element.getElementsByTagName("desc").item(0);
+            if (!desc?.textContent)
+                continue;
+            rows.push({ id, spec: desc.textContent, value: resolveFieldValue(tag, desc.textContent, context, templatesDir, bundledTemplatesDir) });
+        }
+    }
+    return rows;
+}

package/dist/render/llmPrompt.d.ts

@@ -0,0 +1,86 @@
+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

@@ -0,0 +1,199 @@
+"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);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Display SignalK data on eInk Electronic Shelf Labels, includes working examples for tide clock and watch schedule.",
   "keywords": [
     "ble",

package/templates/.blank/296x128-BWRY.svg

@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   width="296"
+   height="128"
+   viewBox="0 0 296 128"
+   version="1.1"
+   id="svg1"
+   sodipodi:docname="296x128-BWRY.svg"
+   inkscape:version="1.3.2 (091e20e, 2023-11-25)"
+   xml:space="preserve"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"><defs
+     id="defs1" /><sodipodi:namedview
+     id="namedview1"
+     pagecolor="#ffffff"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:zoom="1.3906433"
+     inkscape:cx="159.2788"
+     inkscape:cy="101.03238"
+     inkscape:window-width="1488"
+     inkscape:window-height="674"
+     inkscape:window-x="24"
+     inkscape:window-y="33"
+     inkscape:window-maximized="0"
+     inkscape:current-layer="svg1"
+     showgrid="true"
+     showguides="true"><inkscape:grid
+       id="grid1"
+       units="px"
+       originx="0"
+       originy="0"
+       spacingx="1"
+       spacingy="1"
+       empcolor="#0099e5"
+       empopacity="0.30196078"
+       color="#0099e5"
+       opacity="0.14901961"
+       empspacing="5"
+       dotted="false"
+       gridanglex="30"
+       gridanglez="30"
+       visible="true" /></sodipodi:namedview><rect
+     x="1.0169492"
+     y="2.0798673e-08"
+     width="296"
+     height="128"
+     fill="#ffffff"
+     id="rect1"
+     style="stroke-width:0.616026" /><text
+     id="last_repaint"
+     x="245.9742"
+     y="104.33255"
+     font-size="18"
+     font-family="serif"
+     fill="black"
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10.6667px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ffff00;stroke-width:1.19309"
+     transform="scale(0.85412559,1.170788)"><desc
+       id="desc12">source=einklabel,path=repainted,format=local_datetime_short</desc><tspan
+       sodipodi:role="line"
+       id="tspan3"
+       x="245.9742"
+       y="104.33255">27 Jun 26 18:05</tspan></text></svg>

package/templates/.error/296x128-BWRY.svg

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   width="296"
+   height="128"
+   viewBox="0 0 296 128"
+   version="1.1"
+   id="svg4"
+   sodipodi:docname="296x128-BWRY.svg"
+   inkscape:version="1.3.2 (091e20e, 2023-11-25)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <defs
+     id="defs4" />
+  <sodipodi:namedview
+     id="namedview4"
+     pagecolor="#ffffff"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:zoom="0.944"
+     inkscape:cx="124.47034"
+     inkscape:cy="64.088983"
+     inkscape:window-width="1480"
+     inkscape:window-height="578"
+     inkscape:window-x="311"
+     inkscape:window-y="41"
+     inkscape:window-maximized="0"
+     inkscape:current-layer="svg4" />
+  <rect
+     x="-1.059322"
+     y="1.059322"
+     width="296"
+     height="128"
+     fill="#ffffff"
+     id="rect1"
+     style="stroke-width:1.08812" />
+  <polygon
+     points="45,18 12,96 78,96 "
+     fill="#ff0000"
+     stroke="#000000"
+     stroke-width="3"
+     stroke-linejoin="round"
+     id="polygon1" />
+  <rect
+     x="41"
+     y="46"
+     width="8"
+     height="26"
+     fill="#000000"
+     id="rect2" />
+  <circle
+     cx="45"
+     cy="84"
+     r="5"
+     fill="#000000"
+     id="circle2" />
+  <text
+     x="92"
+     y="46"
+     font-size="22px"
+     font-family="sans-serif"
+     font-weight="bold"
+     fill="#000000"
+     id="text2">CONTENT</text>
+  <text
+     x="92"
+     y="72"
+     font-size="22px"
+     font-family="sans-serif"
+     font-weight="bold"
+     fill="#000000"
+     id="text3">UNAVAILABLE</text>
+  <text
+     x="92"
+     y="92"
+     font-size="12px"
+     font-family="sans-serif"
+     fill="#000000"
+     id="text4">Check manually</text>
+  <text
+     id="last_attempt"
+     x="92"
+     y="112"
+     font-size="10px"
+     font-family="monospace"
+     fill="#000000"><desc
+   id="desc4">source=einklabel,path=repainted,format=local_datetime_short</desc>last attempt: --</text>
+</svg>

package/templates/tides/296x128-BWRY.svg

@@ -22,11 +22,11 @@
      inkscape:pagecheckerboard="0"
      inkscape:deskcolor="#d1d1d1"
      inkscape:zoom="1.3906433"
-     inkscape:cx="199.54794"
-     inkscape:cy="131.23423"
+     inkscape:cx="188.04247"
+     inkscape:cy="101.03238"
      inkscape:window-width="1488"
      inkscape:window-height="674"
-     inkscape:window-x="24"
+     inkscape:window-x="102"
      inkscape:window-y="33"
      inkscape:window-maximized="0"
      inkscape:current-layer="svg1"
@@ -49,11 +49,18 @@
        visible="true" /></sodipodi:namedview><rect
      x="1.0169492"
      y="2.0798673e-08"
-     width="249.17073"
+     width="294.47351"
      height="129.97897"
      fill="#ffffff"
      id="rect1"
-     style="stroke-width:0.569552" /><text
+     style="stroke-width:0.619167" /><rect
+     style="fill:#ffff00;stroke:#000000;stroke-width:0.517511"
+     id="rect2"
+     width="295.38821"
+     height="18.45849"
+     x="-8.1818981"
+     y="-129.92928"
+     transform="matrix(1,0,-0.07553602,-0.99714307,0,0)" /><text
      id="station.name"
      x="7.2081757"
      y="19.148237"
@@ -64,18 +71,28 @@
      transform="scale(0.89274881,1.1201359)">Tidal Station Name<desc
    id="desc1">source=resources,resource=tides,provider=tides,path=station.name</desc></text><text
      id="last_repaint"
-     x="221.55899"
-     y="104.94675"
+     x="174.82307"
+     y="131.08972"
      font-size="18"
      font-family="serif"
      fill="black"
-     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10.6667px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ffff00;stroke-width:1.19309"
-     transform="scale(0.85412559,1.170788)"><desc
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.1048px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1.20787;stroke-dasharray:none;stroke-opacity:1"
+     transform="scale(1.0484359,0.95380175)"><desc
        id="desc12">source=einklabel,path=repainted,format=local_datetime_short</desc><tspan
        sodipodi:role="line"
        id="tspan3"
-       x="221.55899"
-       y="104.94675">27 Jun 26 18:05</tspan></text><text
+       x="174.82307"
+       y="131.08972"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.1048px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1.20787;stroke-dasharray:none;stroke-opacity:1">27 Jun 26 18:05</tspan></text><text
+     id="timezone"
+     x="169.78108"
+     y="107.90738"
+     font-size="10.373px"
+     font-family="sans-serif"
+     fill="#ffff00"
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:12px;font-family:Roboto;-inkscape-font-specification:'Roboto, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;direction:rtl;fill:#000000;stroke-width:0.864419"
+     transform="scale(0.86441854,1.156847)">UTC+01:00<desc
+   id="desc11">source=einklabel,path=local_zone</desc></text><text
      id="extremes.0"
      x="7.9661012"
      y="42.022709"
@@ -93,38 +110,38 @@
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ff0000"><desc
    id="desc14">source=resources,resource=tides,provider=tides,path=extremes[1].label</desc>High or Low</text><text
      id="extremes.1.level"
-     x="220.4532"
-     y="70.261024"
+     x="236.04683"
+     y="74.289345"
      font-size="14"
      font-family="monospace"
      fill="red"
-     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:26.6667px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.701"
-     transform="scale(0.75163533,1.3304324)"
-     inkscape:transform-center-y="-140.38618"
-     inkscape:transform-center-x="-0.00038058817"><tspan
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:29.3333px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.88094"
+     transform="scale(0.74369426,1.3446386)"
+     inkscape:transform-center-y="-156.89445"
+     inkscape:transform-center-x="-0.00039560164"><tspan
        sodipodi:role="line"
        id="tspan2-1"
-       x="220.4532"
-       y="70.261024"
-       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:26.6667px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;stroke-width:1.701">1.6m</tspan><desc
+       x="236.04683"
+       y="74.289345"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:29.33333333px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;stroke-width:1.88094">1.6m</tspan><desc
        id="desc5">source=resources,resource=tides,provider=tides,path=extremes[1].level,category=depth</desc></text><text
      id="extremes.1.time"
-     x="137.72458"
-     y="70.627983"
+     x="148.60976"
+     y="72.137405"
      font-size="14"
      font-family="monospace"
      fill="red"
-     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:26.6667px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.48364"
-     transform="scale(0.7345432,1.3613903)">09:36<desc
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:32px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.74366"
+     transform="scale(0.71873644,1.3913306)">09:36<desc
    id="desc8">source=resources,resource=tides,provider=tides,path=extremes[1].time,format=local_time</desc></text><text
      id="extremes.0.time"
-     x="138.1739"
-     y="42.23238"
+     x="148.53975"
+     y="44.011204"
      font-size="14"
      font-family="monospace"
      fill="red"
-     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:26.6667px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.55397"
-     transform="scale(0.74654856,1.3394976)">03:27<desc
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:32px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.79195"
+     transform="scale(0.73254241,1.3651087)">03:27<desc
    id="desc3">source=resources,resource=tides,provider=tides,path=extremes[0].time,format=local_time</desc></text><text
      id="extremes.0.date"
      x="11.198709"
@@ -145,16 +162,30 @@
      transform="scale(0.82428216,1.2131768)"><desc
    id="desc7">source=resources,resource=tides,provider=tides,path=extremes[1].time,format=day_mon</desc>27 Jun</text><text
      id="extremes.0.level"
-     x="217.65784"
-     y="43.220345"
+     x="243.27972"
+     y="44.41362"
      font-size="14"
      font-family="monospace"
      fill="red"
-     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:26.6667px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.71992"
-     transform="scale(0.7703174,1.2981662)"><tspan
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:29.3333px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.91777"
+     transform="scale(0.72743302,1.374697)"><tspan
        sodipodi:role="line"
        id="tspan2"
-       x="217.65784"
-       y="43.220345"
-       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:26.6667px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;stroke-width:1.71992">3.4m</tspan><desc
-       id="desc4">source=resources,resource=tides,provider=tides,path=extremes[0].level,category=depth</desc></text></svg>
+       x="243.27972"
+       y="44.41362"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:29.33333347px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;stroke-width:1.91777">3.4m</tspan><desc
+       id="desc4">source=resources,resource=tides,provider=tides,path=extremes[0].level,category=depth</desc></text><text
+     id="source"
+     x="5.7133317"
+     y="119.17512"
+     font-size="18"
+     font-family="serif"
+     fill="black"
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:13.3333px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ff0000;stroke-width:3.80045"
+     transform="scale(0.95907861,1.0426674)"><desc
+       id="desc21">source=resources,resource=tides,provider=tides,path=station.source.name</desc><tspan
+       sodipodi:role="line"
+       id="tspan20"
+       x="5.7133317"
+       y="119.17512"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:13.3333px;font-family:serif;-inkscape-font-specification:'serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;stroke-width:3.80045">SOURCE</tspan></text></svg>