@rhizomatics/signalk-einklabel-plugin 1.2.2 → 1.3.0-beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +56 -7
- package/dist/cli/index.js +5 -5
- package/dist/config.d.ts +7 -0
- package/dist/config.js +15 -1
- package/dist/devices/bleBackend.d.ts +21 -0
- package/dist/devices/bleBackend.js +96 -0
- package/dist/devices/bleDiscovery.d.ts +11 -0
- package/dist/devices/bleDiscovery.js +89 -0
- package/dist/devices/discoveryCoordinator.d.ts +7 -6
- package/dist/devices/discoveryCoordinator.js +81 -9
- package/dist/devices/gattConnection.d.ts +9 -0
- package/dist/devices/gattConnection.js +2 -0
- package/dist/devices/gicisky/index.d.ts +7 -2
- package/dist/devices/gicisky/index.js +107 -96
- package/dist/devices/types.d.ts +26 -6
- package/dist/devices/zhsunyco/index.d.ts +8 -2
- package/dist/devices/zhsunyco/index.js +83 -79
- package/dist/email/emailSender.d.ts +27 -0
- package/dist/email/emailSender.js +66 -0
- package/dist/plugin.js +27 -9
- package/dist/render/fieldsTable.d.ts +15 -0
- package/dist/render/fieldsTable.js +52 -0
- package/dist/render/llmPrompt.d.ts +86 -0
- package/dist/render/llmPrompt.js +199 -0
- package/dist/repaintScheduler.js +4 -2
- package/docs/assets/images/mini_tidal_clock.png +0 -0
- package/package.json +2 -2
- package/templates/.blank/296x128-BWRY.svg +69 -0
- package/templates/.error/296x128-BWRY.svg +93 -0
- package/templates/tides/296x128-BWRY.svg +67 -36
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.sendLabelEmail = sendLabelEmail;
|
|
7
|
+
const nodemailer_1 = __importDefault(require("nodemailer"));
|
|
8
|
+
const png_1 = require("../render/png");
|
|
9
|
+
const DOCS_URL = "https://rhizomatics.github.io/signalk-einklabel-plugin/";
|
|
10
|
+
function escapeHtml(text) {
|
|
11
|
+
return text.replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">").replace(/"/g, """);
|
|
12
|
+
}
|
|
13
|
+
function bodyHtml(body) {
|
|
14
|
+
if (body.kind === "table") {
|
|
15
|
+
if (body.rows.length === 0)
|
|
16
|
+
return "";
|
|
17
|
+
const rows = body.rows
|
|
18
|
+
.map((row) => `<tr><td>${escapeHtml(row.id)}</td><td>${escapeHtml(row.spec)}</td><td>${escapeHtml(row.value)}</td></tr>`)
|
|
19
|
+
.join("");
|
|
20
|
+
return ('<table border="1" cellpadding="4" cellspacing="0" style="border-collapse:collapse;font-family:monospace;font-size:13px">' +
|
|
21
|
+
`<thead><tr><th>id</th><th>spec</th><th>value</th></tr></thead><tbody>${rows}</tbody></table>`);
|
|
22
|
+
}
|
|
23
|
+
if (body.kind === "text") {
|
|
24
|
+
return `<pre style="white-space:pre-wrap;font-family:monospace;font-size:13px">${escapeHtml(body.text)}</pre>`;
|
|
25
|
+
}
|
|
26
|
+
return "";
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Renders and sends one device's repaint as an email - a PNG attachment (also shown inline via a `cid`
|
|
30
|
+
* reference), the same field-by-field table `esl-cli fields` shows for a hand-authored SVG template (or
|
|
31
|
+
* a `TemplateProvider`'s own rendered-content text for something like a GenAI prompt - see `body`), and a
|
|
32
|
+
* link back to the docs site. Called from `considerRepaint` (`../repaintScheduler.ts`) whenever a
|
|
33
|
+
* device's `emailTo` is set and its render succeeds.
|
|
34
|
+
*/
|
|
35
|
+
async function sendLabelEmail(emailConfig, to, content) {
|
|
36
|
+
const transporter = nodemailer_1.default.createTransport({
|
|
37
|
+
host: emailConfig.smtpHost,
|
|
38
|
+
port: emailConfig.smtpPort,
|
|
39
|
+
secure: emailConfig.smtpSecure,
|
|
40
|
+
auth: emailConfig.smtpUser ? { user: emailConfig.smtpUser, pass: emailConfig.smtpPassword } : undefined,
|
|
41
|
+
});
|
|
42
|
+
const png = (0, png_1.bitmapToPng)(content.bitmap);
|
|
43
|
+
const html = [
|
|
44
|
+
'<div style="font-family:sans-serif">',
|
|
45
|
+
`<h2>${escapeHtml(content.friendlyName)}</h2>`,
|
|
46
|
+
content.description ? `<p>${escapeHtml(content.description)}</p>` : "",
|
|
47
|
+
`<p><img src="cid:label-image" alt="${escapeHtml(content.friendlyName)}" style="border:1px solid #ccc" /></p>`,
|
|
48
|
+
bodyHtml(content.body),
|
|
49
|
+
`<p><a href="${DOCS_URL}">${DOCS_URL}</a></p>`,
|
|
50
|
+
"</div>",
|
|
51
|
+
].join("\n");
|
|
52
|
+
await transporter.sendMail({
|
|
53
|
+
from: emailConfig.fromAddress,
|
|
54
|
+
to,
|
|
55
|
+
subject: `eInk Label: ${content.friendlyName}`,
|
|
56
|
+
html,
|
|
57
|
+
attachments: [
|
|
58
|
+
{
|
|
59
|
+
filename: "label.png",
|
|
60
|
+
content: png,
|
|
61
|
+
contentType: "image/png",
|
|
62
|
+
cid: "label-image",
|
|
63
|
+
},
|
|
64
|
+
],
|
|
65
|
+
});
|
|
66
|
+
}
|
package/dist/plugin.js
CHANGED
|
@@ -10,7 +10,7 @@ const bleDiscovery_1 = require("./devices/bleDiscovery");
|
|
|
10
10
|
const discoveredDevicesStore_1 = require("./devices/discoveredDevicesStore");
|
|
11
11
|
const repaintScheduler_1 = require("./repaintScheduler");
|
|
12
12
|
/** Mirrors signalk-bluetti-plugin's convention: scan briefly, report finds via plugin status for the user to copy-paste. */
|
|
13
|
-
async function runStartupScan(app, durationSeconds) {
|
|
13
|
+
async function runStartupScan(app, durationSeconds, useBleApi) {
|
|
14
14
|
const alreadyRunning = (0, discoveryCoordinator_1.scanInProgressSince)();
|
|
15
15
|
if (alreadyRunning !== undefined) {
|
|
16
16
|
const elapsedSeconds = ((Date.now() - alreadyRunning) / 1000).toFixed(0);
|
|
@@ -21,7 +21,7 @@ async function runStartupScan(app, durationSeconds) {
|
|
|
21
21
|
app.setPluginStatus(`Scanning for ESL devices for ${durationSeconds}s...`);
|
|
22
22
|
}
|
|
23
23
|
const startedAt = Date.now();
|
|
24
|
-
const { foundThisScan } = await (0, discoveryCoordinator_1.ensureScan)(app, durationSeconds).catch((err) => {
|
|
24
|
+
const { foundThisScan } = await (0, discoveryCoordinator_1.ensureScan)(app, durationSeconds, useBleApi).catch((err) => {
|
|
25
25
|
app.debug(`startup scan failed: ${err.message}`);
|
|
26
26
|
return { foundThisScan: [] };
|
|
27
27
|
});
|
|
@@ -36,6 +36,10 @@ async function runStartupScan(app, durationSeconds) {
|
|
|
36
36
|
function createPlugin(app) {
|
|
37
37
|
(0, registry_1.registerDriver)(new zhsunyco_1.ZhsunycoDriver());
|
|
38
38
|
(0, registry_1.registerDriver)(new gicisky_1.GiciskyDriver());
|
|
39
|
+
// Present on SignalK server >= 2.32.0 (the BLE Provider/Consumer API - "BLE Manager" in the admin
|
|
40
|
+
// UI); `ServerAPI`'s own type says this is always defined, but that's only true on servers new
|
|
41
|
+
// enough to have added it - checked at runtime rather than trusted from the type.
|
|
42
|
+
const bleApiAvailable = !!app.bleApi;
|
|
39
43
|
let scheduler;
|
|
40
44
|
let stopped = false;
|
|
41
45
|
const plugin = {
|
|
@@ -55,18 +59,32 @@ function createPlugin(app) {
|
|
|
55
59
|
app.debug(`starting with ${pluginConfig.devices.length} configured device(s)`);
|
|
56
60
|
(0, config_1.healNestedConfig)(app);
|
|
57
61
|
stopped = false;
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
62
|
+
const useBleApi = pluginConfig.useBleApi && bleApiAvailable;
|
|
63
|
+
if (pluginConfig.useBleApi && !bleApiAvailable) {
|
|
64
|
+
app.debug("useBleApi is enabled but this SignalK server has no BLE Manager API (requires >= 2.32.0) - falling back to direct BlueZ access");
|
|
65
|
+
}
|
|
66
|
+
app.debug(useBleApi ? "using the SignalK BLE Manager API for Bluetooth access" : "using direct BlueZ access for Bluetooth");
|
|
67
|
+
const start = () => {
|
|
63
68
|
if (stopped)
|
|
64
69
|
return;
|
|
65
70
|
if (pluginConfig.scanOnStart) {
|
|
66
|
-
void runStartupScan(app, pluginConfig.scanDurationSeconds);
|
|
71
|
+
void runStartupScan(app, pluginConfig.scanDurationSeconds, useBleApi);
|
|
67
72
|
}
|
|
68
73
|
scheduler = (0, repaintScheduler_1.startRepaintScheduler)(app, pluginConfig);
|
|
69
|
-
}
|
|
74
|
+
};
|
|
75
|
+
if (useBleApi) {
|
|
76
|
+
// The server/provider governs its own local-adapter readiness once BLE Manager mode owns
|
|
77
|
+
// `hci0` (or has none at all, behind a remote gateway) - waiting on a *local* BlueZ adapter
|
|
78
|
+
// here would be waiting on something this mode may never even need.
|
|
79
|
+
start();
|
|
80
|
+
}
|
|
81
|
+
else {
|
|
82
|
+
// Waits (with backoff, indefinitely on Linux) for a BLE adapter before the startup scan or
|
|
83
|
+
// the repaint scheduler touch BLE at all - see `waitForAdapter`'s doc comment on the
|
|
84
|
+
// boot-time race this covers. `stopped` is checked again inside `start()`, not just passed
|
|
85
|
+
// as `cancelled`, since the wait can also resolve `true` on its own right as `stop()` runs.
|
|
86
|
+
void (0, bleDiscovery_1.waitForAdapter)((message) => app.debug(message), () => stopped).then(start);
|
|
87
|
+
}
|
|
70
88
|
},
|
|
71
89
|
stop() {
|
|
72
90
|
stopped = true;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { TemplateContext } from "./types";
|
|
2
|
+
export interface FieldRow {
|
|
3
|
+
id: string;
|
|
4
|
+
spec: string;
|
|
5
|
+
value: string;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Synchronous counterpart to the CLI's `fields` command (`../cli/index.ts`) - same three columns (id,
|
|
9
|
+
* spec, resolved value), but resolved against a single already-assembled `context` rather than
|
|
10
|
+
* re-fetching per binding, since a caller like `considerRepaint` (`../repaintScheduler.ts`) already has
|
|
11
|
+
* the full context its render used. Only meaningful for a hand-authored SVG template - a
|
|
12
|
+
* `TemplateProvider`-backed template (e.g. GenAI) has no `<desc>` bindings to walk; see
|
|
13
|
+
* `TemplateProvider.describeContent` (`./templateProviders.ts`) for that case's own text summary instead.
|
|
14
|
+
*/
|
|
15
|
+
export declare function buildFieldsTable(svgSource: string, context: TemplateContext, templatesDir: string, bundledTemplatesDir: string): FieldRow[];
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.buildFieldsTable = buildFieldsTable;
|
|
4
|
+
const path_1 = require("path");
|
|
5
|
+
const xmldom_1 = require("@xmldom/xmldom");
|
|
6
|
+
const assets_1 = require("./assets");
|
|
7
|
+
const binding_1 = require("./binding");
|
|
8
|
+
function resolveFieldValue(tag, desc, context, templatesDir, bundledTemplatesDir) {
|
|
9
|
+
try {
|
|
10
|
+
const binding = (0, binding_1.parseBinding)(desc);
|
|
11
|
+
if (tag !== "image") {
|
|
12
|
+
return (0, binding_1.renderBinding)(binding, context);
|
|
13
|
+
}
|
|
14
|
+
if (!binding.assets) {
|
|
15
|
+
return 'ERROR: an <image> binding requires an "assets" key';
|
|
16
|
+
}
|
|
17
|
+
const key = (0, assets_1.normalizeAssetKey)((0, binding_1.resolveBinding)(binding, context));
|
|
18
|
+
if (!key)
|
|
19
|
+
return "(no usable value - image would be omitted)";
|
|
20
|
+
const assetPath = (0, assets_1.resolveAssetPath)(templatesDir, bundledTemplatesDir, binding.assets, key);
|
|
21
|
+
return assetPath ? `"${key}" -> ${(0, path_1.basename)(assetPath)}` : `"${key}" -> no matching asset file (image would be omitted)`;
|
|
22
|
+
}
|
|
23
|
+
catch (err) {
|
|
24
|
+
return `ERROR: ${err.message}`;
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Synchronous counterpart to the CLI's `fields` command (`../cli/index.ts`) - same three columns (id,
|
|
29
|
+
* spec, resolved value), but resolved against a single already-assembled `context` rather than
|
|
30
|
+
* re-fetching per binding, since a caller like `considerRepaint` (`../repaintScheduler.ts`) already has
|
|
31
|
+
* the full context its render used. Only meaningful for a hand-authored SVG template - a
|
|
32
|
+
* `TemplateProvider`-backed template (e.g. GenAI) has no `<desc>` bindings to walk; see
|
|
33
|
+
* `TemplateProvider.describeContent` (`./templateProviders.ts`) for that case's own text summary instead.
|
|
34
|
+
*/
|
|
35
|
+
function buildFieldsTable(svgSource, context, templatesDir, bundledTemplatesDir) {
|
|
36
|
+
const doc = new xmldom_1.DOMParser().parseFromString(svgSource, "image/svg+xml");
|
|
37
|
+
const rows = [];
|
|
38
|
+
for (const tag of ["text", "image"]) {
|
|
39
|
+
const elements = doc.getElementsByTagName(tag);
|
|
40
|
+
for (let i = 0; i < elements.length; i++) {
|
|
41
|
+
const element = elements.item(i);
|
|
42
|
+
if (!element)
|
|
43
|
+
continue;
|
|
44
|
+
const id = element.getAttribute("id") ?? `${tag}#${i}`;
|
|
45
|
+
const desc = element.getElementsByTagName("desc").item(0);
|
|
46
|
+
if (!desc?.textContent)
|
|
47
|
+
continue;
|
|
48
|
+
rows.push({ id, spec: desc.textContent, value: resolveFieldValue(tag, desc.textContent, context, templatesDir, bundledTemplatesDir) });
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
return rows;
|
|
52
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { PluginConfig } from "../config";
|
|
2
|
+
import { Colour } from "../devices/types";
|
|
3
|
+
import { Binding } from "./binding";
|
|
4
|
+
import { TemplateContext } from "./types";
|
|
5
|
+
/** Facts about one physical label a prompt's `source=label,path=...` placeholders can reference - see `buildLabelContext`. */
|
|
6
|
+
export interface LabelMeta {
|
|
7
|
+
manufacturer: string;
|
|
8
|
+
/** The physical panel's own size label, e.g. `'3.7"'` - `DeviceMetadata.label` verbatim, see `../devices/types.ts`. */
|
|
9
|
+
label: string;
|
|
10
|
+
width: number;
|
|
11
|
+
height: number;
|
|
12
|
+
colours: Colour[];
|
|
13
|
+
description?: string;
|
|
14
|
+
position?: {
|
|
15
|
+
latitude: number;
|
|
16
|
+
longitude: number;
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Builds the `context.label` object a prompt/target-guidance fragment addresses via
|
|
21
|
+
* `source=label,path=...` bindings (e.g. `{source=label,path=width}`, or the bare-path shorthand
|
|
22
|
+
* `{width}` is *not* supported here deliberately - see `./binding.ts`'s `parseBinding`, every `{...}`
|
|
23
|
+
* placeholder is a real binding, so a `label` path always needs the explicit `source=label,path=`
|
|
24
|
+
* form to disambiguate it from a `signalk` self path). `colours`/`fonts` are left as arrays (each
|
|
25
|
+
* colour entry pre-annotated with its hex code, e.g. `"black (#000000)"`) rather than joined into a
|
|
26
|
+
* single string, so a prompt author can either use them bare (renders as JSON, e.g. for a model that
|
|
27
|
+
* parses structured hints) or add `format=csv` (see `./formatters.ts`) for a plain comma-separated list.
|
|
28
|
+
*/
|
|
29
|
+
export declare function buildLabelContext(meta: LabelMeta): Record<string, unknown>;
|
|
30
|
+
/**
|
|
31
|
+
* Every binding referenced across one or more prompt fragments - every `{...}` placeholder, deduplicated
|
|
32
|
+
* across all of `texts` combined, parsed exactly the way a template's `<desc>` binding is
|
|
33
|
+
* (`parseBinding`, see `./binding.ts`), so a bare path (`{design.length}`, `source=signalk,context=self`
|
|
34
|
+
* shorthand), the full binding grammar (`{source=signalk,path=navigation.position,format=position}`),
|
|
35
|
+
* and a `source=label,path=...` binding all work uniformly. Pass the result to `assembleRawContext`
|
|
36
|
+
* (repaintScheduler.ts) exactly as a template's own bindings are - it fetches the `signalk`/
|
|
37
|
+
* `resources`-sourced ones and silently ignores `label`/`einklabel`-sourced ones, which resolve directly
|
|
38
|
+
* against `context.label`/`context.meta` instead (built by the caller, not fetched).
|
|
39
|
+
*
|
|
40
|
+
* A placeholder that isn't valid binding grammar (e.g. a typo like `{source=taheight}`) is silently
|
|
41
|
+
* skipped here rather than thrown - the same per-field isolation `SvgRenderer` gives a bad `<desc>`
|
|
42
|
+
* binding, so one malformed placeholder doesn't take down the whole prompt. `substitutePlaceholders`
|
|
43
|
+
* hits the identical parse error at substitution time and turns it into "???" for just that field.
|
|
44
|
+
*/
|
|
45
|
+
export declare function findPromptBindings(...texts: string[]): Binding[];
|
|
46
|
+
/**
|
|
47
|
+
* Substitutes every `{...}` placeholder in `text` with its resolved binding value against `context`
|
|
48
|
+
* (built by `assembleRawContext` plus `context.label` from `buildLabelContext` - see
|
|
49
|
+
* `findPromptBindings`). Mirrors `renderBinding`'s per-field isolation, but substitutes "???" for
|
|
50
|
+
* anything that resolves to no value at all (missing path, invalid binding grammar) rather than "" -
|
|
51
|
+
* prose with a silently-blank word reads as a fact ("for the sailor of a m vessel"), not as a gap the
|
|
52
|
+
* reader would notice. Two things override that "???": a binding that resolves successfully to a
|
|
53
|
+
* legitimately empty string (e.g. an unset `{source=label,path=description}`) is left as empty, since
|
|
54
|
+
* that's a real answer, not a miss; and a binding with an explicit `default=` (see `./binding.ts`) uses
|
|
55
|
+
* that default instead, since the prompt author has already said what a missing value should read as.
|
|
56
|
+
*/
|
|
57
|
+
export declare function substitutePlaceholders(text: string, context: TemplateContext): string;
|
|
58
|
+
/**
|
|
59
|
+
* Strips everything outside the first `<svg`...last `</svg>` span - a chat model asked for "only raw
|
|
60
|
+
* SVG markup" still often wraps it in a markdown code fence or adds a sentence of commentary either
|
|
61
|
+
* side, despite the target-guidance fragment telling it not to.
|
|
62
|
+
*/
|
|
63
|
+
export declare function extractSvg(raw: string): string;
|
|
64
|
+
export type LlmSettings = Pick<PluginConfig, "llmProvider" | "llmApiKey" | "llmModel" | "llmBaseUrl"> & {
|
|
65
|
+
llmTimeoutSeconds?: number;
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* `ai` and every `@ai-sdk/*` provider package are `optionalDependencies` (see package.json), not plain
|
|
69
|
+
* `dependencies` - most installs (every device using `renderMode: "svg-template"` only) never touch an
|
|
70
|
+
* LLM at all, so they shouldn't have to pull in this whole gateway stack, and an install that fails to
|
|
71
|
+
* fetch one of these (network hiccup, `npm install --omit=optional`, an unsupported platform) must not
|
|
72
|
+
* break BLE painting/templates, which have nothing to do with it. That means every reference to one of
|
|
73
|
+
* these packages has to be a `require()` reached only when a `renderMode: "llm-prompt"` device actually
|
|
74
|
+
* calls `callLlm` - a top-level `import` would be resolved eagerly the moment this module loads (which
|
|
75
|
+
* is every plugin start, via `repaintScheduler.ts`), throwing before any config is even read. Types are
|
|
76
|
+
* still fully checked via `typeof import(...)` below, which - unlike a value `import` - is erased
|
|
77
|
+
* entirely at compile time and leaves no runtime trace for `tsc` to eagerly require.
|
|
78
|
+
*/
|
|
79
|
+
export declare function loadOptional<M>(moduleName: string): M;
|
|
80
|
+
/**
|
|
81
|
+
* Calls the configured LLM gateway with `prompt`, returning its raw text response - not yet extracted/
|
|
82
|
+
* validated as SVG, see `extractSvg`. This is the first network call in the codebase that needs its own
|
|
83
|
+
* timeout (`fetchJson` in `../httpJson.ts` has none - every existing call is to the local SignalK
|
|
84
|
+
* server's own REST API).
|
|
85
|
+
*/
|
|
86
|
+
export declare function callLlm(settings: LlmSettings, prompt: string): Promise<string>;
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.buildLabelContext = buildLabelContext;
|
|
4
|
+
exports.findPromptBindings = findPromptBindings;
|
|
5
|
+
exports.substitutePlaceholders = substitutePlaceholders;
|
|
6
|
+
exports.extractSvg = extractSvg;
|
|
7
|
+
exports.loadOptional = loadOptional;
|
|
8
|
+
exports.callLlm = callLlm;
|
|
9
|
+
const binding_1 = require("./binding");
|
|
10
|
+
const formatters_1 = require("./formatters");
|
|
11
|
+
const COLOUR_HEX = { black: "#000000", white: "#FFFFFF", red: "#FF0000", yellow: "#FFFF00" };
|
|
12
|
+
/** The only `font-family` values `SvgRenderer` is guaranteed to render - see `expandGenericFontFamilies` in `./svgRenderer.ts`. */
|
|
13
|
+
const SAFE_FONT_FAMILIES = ["serif", "sans-serif", "monospace"];
|
|
14
|
+
/**
|
|
15
|
+
* Builds the `context.label` object a prompt/target-guidance fragment addresses via
|
|
16
|
+
* `source=label,path=...` bindings (e.g. `{source=label,path=width}`, or the bare-path shorthand
|
|
17
|
+
* `{width}` is *not* supported here deliberately - see `./binding.ts`'s `parseBinding`, every `{...}`
|
|
18
|
+
* placeholder is a real binding, so a `label` path always needs the explicit `source=label,path=`
|
|
19
|
+
* form to disambiguate it from a `signalk` self path). `colours`/`fonts` are left as arrays (each
|
|
20
|
+
* colour entry pre-annotated with its hex code, e.g. `"black (#000000)"`) rather than joined into a
|
|
21
|
+
* single string, so a prompt author can either use them bare (renders as JSON, e.g. for a model that
|
|
22
|
+
* parses structured hints) or add `format=csv` (see `./formatters.ts`) for a plain comma-separated list.
|
|
23
|
+
*/
|
|
24
|
+
function buildLabelContext(meta) {
|
|
25
|
+
return {
|
|
26
|
+
manufacturer: meta.manufacturer,
|
|
27
|
+
label: meta.label,
|
|
28
|
+
width: meta.width,
|
|
29
|
+
height: meta.height,
|
|
30
|
+
colours: meta.colours.map((colour) => `${colour} (${COLOUR_HEX[colour]})`),
|
|
31
|
+
fonts: SAFE_FONT_FAMILIES,
|
|
32
|
+
description: meta.description ?? "",
|
|
33
|
+
position: meta.position ? (0, formatters_1.applyFormat)("position", meta.position, {}, 3) : undefined,
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Every binding referenced across one or more prompt fragments - every `{...}` placeholder, deduplicated
|
|
38
|
+
* across all of `texts` combined, parsed exactly the way a template's `<desc>` binding is
|
|
39
|
+
* (`parseBinding`, see `./binding.ts`), so a bare path (`{design.length}`, `source=signalk,context=self`
|
|
40
|
+
* shorthand), the full binding grammar (`{source=signalk,path=navigation.position,format=position}`),
|
|
41
|
+
* and a `source=label,path=...` binding all work uniformly. Pass the result to `assembleRawContext`
|
|
42
|
+
* (repaintScheduler.ts) exactly as a template's own bindings are - it fetches the `signalk`/
|
|
43
|
+
* `resources`-sourced ones and silently ignores `label`/`einklabel`-sourced ones, which resolve directly
|
|
44
|
+
* against `context.label`/`context.meta` instead (built by the caller, not fetched).
|
|
45
|
+
*
|
|
46
|
+
* A placeholder that isn't valid binding grammar (e.g. a typo like `{source=taheight}`) is silently
|
|
47
|
+
* skipped here rather than thrown - the same per-field isolation `SvgRenderer` gives a bad `<desc>`
|
|
48
|
+
* binding, so one malformed placeholder doesn't take down the whole prompt. `substitutePlaceholders`
|
|
49
|
+
* hits the identical parse error at substitution time and turns it into "???" for just that field.
|
|
50
|
+
*/
|
|
51
|
+
function findPromptBindings(...texts) {
|
|
52
|
+
const seen = new Set();
|
|
53
|
+
const bindings = [];
|
|
54
|
+
for (const text of texts) {
|
|
55
|
+
for (const match of text.matchAll(/\{([^{}]+)\}/g)) {
|
|
56
|
+
const key = match[1].trim();
|
|
57
|
+
if (seen.has(key))
|
|
58
|
+
continue;
|
|
59
|
+
seen.add(key);
|
|
60
|
+
try {
|
|
61
|
+
bindings.push((0, binding_1.parseBinding)(key));
|
|
62
|
+
}
|
|
63
|
+
catch {
|
|
64
|
+
// see doc comment above - left for `substitutePlaceholders` to turn into "???"
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
return bindings;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Substitutes every `{...}` placeholder in `text` with its resolved binding value against `context`
|
|
72
|
+
* (built by `assembleRawContext` plus `context.label` from `buildLabelContext` - see
|
|
73
|
+
* `findPromptBindings`). Mirrors `renderBinding`'s per-field isolation, but substitutes "???" for
|
|
74
|
+
* anything that resolves to no value at all (missing path, invalid binding grammar) rather than "" -
|
|
75
|
+
* prose with a silently-blank word reads as a fact ("for the sailor of a m vessel"), not as a gap the
|
|
76
|
+
* reader would notice. Two things override that "???": a binding that resolves successfully to a
|
|
77
|
+
* legitimately empty string (e.g. an unset `{source=label,path=description}`) is left as empty, since
|
|
78
|
+
* that's a real answer, not a miss; and a binding with an explicit `default=` (see `./binding.ts`) uses
|
|
79
|
+
* that default instead, since the prompt author has already said what a missing value should read as.
|
|
80
|
+
*/
|
|
81
|
+
function substitutePlaceholders(text, context) {
|
|
82
|
+
return text.replace(/\{([^{}]+)\}/g, (_match, raw) => {
|
|
83
|
+
const key = raw.trim();
|
|
84
|
+
try {
|
|
85
|
+
const binding = (0, binding_1.parseBinding)(key);
|
|
86
|
+
const value = (0, binding_1.resolveBinding)(binding, context);
|
|
87
|
+
if ((value === undefined || value === null) && binding.default === undefined)
|
|
88
|
+
return "???";
|
|
89
|
+
return (0, binding_1.renderBinding)(binding, context);
|
|
90
|
+
}
|
|
91
|
+
catch {
|
|
92
|
+
return "???";
|
|
93
|
+
}
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Strips everything outside the first `<svg`...last `</svg>` span - a chat model asked for "only raw
|
|
98
|
+
* SVG markup" still often wraps it in a markdown code fence or adds a sentence of commentary either
|
|
99
|
+
* side, despite the target-guidance fragment telling it not to.
|
|
100
|
+
*/
|
|
101
|
+
function extractSvg(raw) {
|
|
102
|
+
const start = raw.indexOf("<svg");
|
|
103
|
+
const end = raw.lastIndexOf("</svg>");
|
|
104
|
+
if (start === -1 || end === -1 || end < start) {
|
|
105
|
+
throw new Error('LLM response did not contain a "<svg>...</svg>" document');
|
|
106
|
+
}
|
|
107
|
+
return raw.slice(start, end + "</svg>".length);
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* `ai` and every `@ai-sdk/*` provider package are `optionalDependencies` (see package.json), not plain
|
|
111
|
+
* `dependencies` - most installs (every device using `renderMode: "svg-template"` only) never touch an
|
|
112
|
+
* LLM at all, so they shouldn't have to pull in this whole gateway stack, and an install that fails to
|
|
113
|
+
* fetch one of these (network hiccup, `npm install --omit=optional`, an unsupported platform) must not
|
|
114
|
+
* break BLE painting/templates, which have nothing to do with it. That means every reference to one of
|
|
115
|
+
* these packages has to be a `require()` reached only when a `renderMode: "llm-prompt"` device actually
|
|
116
|
+
* calls `callLlm` - a top-level `import` would be resolved eagerly the moment this module loads (which
|
|
117
|
+
* is every plugin start, via `repaintScheduler.ts`), throwing before any config is even read. Types are
|
|
118
|
+
* still fully checked via `typeof import(...)` below, which - unlike a value `import` - is erased
|
|
119
|
+
* entirely at compile time and leaves no runtime trace for `tsc` to eagerly require.
|
|
120
|
+
*/
|
|
121
|
+
function loadOptional(moduleName) {
|
|
122
|
+
try {
|
|
123
|
+
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
124
|
+
return require(moduleName);
|
|
125
|
+
}
|
|
126
|
+
catch (err) {
|
|
127
|
+
throw new Error(`LLM provider support needs the optional dependency "${moduleName}", which isn't installed - run "npm install ${moduleName}" (${err.message})`);
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
/** Ollama's own default local listen address - see the `"ollama"` case in `resolveModel` below. */
|
|
131
|
+
const DEFAULT_OLLAMA_BASE_URL = "http://localhost:11434/v1";
|
|
132
|
+
/**
|
|
133
|
+
* Resolves `settings` to a Vercel AI SDK model handle. `"ollama"` and `"local"` both go through the
|
|
134
|
+
* generic `@ai-sdk/openai-compatible` provider (Ollama/LM Studio/vLLM all expose an OpenAI-compatible
|
|
135
|
+
* endpoint, and none of them has - or needs - its own dedicated `@ai-sdk/*` package): `"ollama"`
|
|
136
|
+
* defaults `llmBaseUrl` to Ollama's own standard local address so it works with no further config
|
|
137
|
+
* (override it only if Ollama is running elsewhere, e.g. on the SignalK server's own host reached over
|
|
138
|
+
* the network); `"local"` is for anything else OpenAI-compatible, where there's no sensible universal
|
|
139
|
+
* default, so `llmBaseUrl` is required.
|
|
140
|
+
*/
|
|
141
|
+
function resolveModel(settings) {
|
|
142
|
+
const model = settings.llmModel;
|
|
143
|
+
if (!model) {
|
|
144
|
+
throw new Error("no LLM model configured (PluginConfig.llmModel)");
|
|
145
|
+
}
|
|
146
|
+
switch (settings.llmProvider ?? "openai") {
|
|
147
|
+
case "anthropic": {
|
|
148
|
+
const { createAnthropic } = loadOptional("@ai-sdk/anthropic");
|
|
149
|
+
return createAnthropic({ apiKey: settings.llmApiKey })(model);
|
|
150
|
+
}
|
|
151
|
+
case "google": {
|
|
152
|
+
const { createGoogleGenerativeAI } = loadOptional("@ai-sdk/google");
|
|
153
|
+
return createGoogleGenerativeAI({ apiKey: settings.llmApiKey })(model);
|
|
154
|
+
}
|
|
155
|
+
case "xai": {
|
|
156
|
+
const { createXai } = loadOptional("@ai-sdk/xai");
|
|
157
|
+
return createXai({ apiKey: settings.llmApiKey })(model);
|
|
158
|
+
}
|
|
159
|
+
case "ollama": {
|
|
160
|
+
const { createOpenAICompatible } = loadOptional("@ai-sdk/openai-compatible");
|
|
161
|
+
return createOpenAICompatible({
|
|
162
|
+
name: "ollama",
|
|
163
|
+
baseURL: settings.llmBaseUrl || DEFAULT_OLLAMA_BASE_URL,
|
|
164
|
+
apiKey: settings.llmApiKey,
|
|
165
|
+
})(model);
|
|
166
|
+
}
|
|
167
|
+
case "local": {
|
|
168
|
+
if (!settings.llmBaseUrl) {
|
|
169
|
+
throw new Error('llmBaseUrl is required when llmProvider is "local"');
|
|
170
|
+
}
|
|
171
|
+
const { createOpenAICompatible } = loadOptional("@ai-sdk/openai-compatible");
|
|
172
|
+
return createOpenAICompatible({ name: "local", baseURL: settings.llmBaseUrl, apiKey: settings.llmApiKey })(model);
|
|
173
|
+
}
|
|
174
|
+
case "openai":
|
|
175
|
+
default: {
|
|
176
|
+
const { createOpenAI } = loadOptional("@ai-sdk/openai");
|
|
177
|
+
return createOpenAI({ apiKey: settings.llmApiKey })(model);
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Calls the configured LLM gateway with `prompt`, returning its raw text response - not yet extracted/
|
|
183
|
+
* validated as SVG, see `extractSvg`. This is the first network call in the codebase that needs its own
|
|
184
|
+
* timeout (`fetchJson` in `../httpJson.ts` has none - every existing call is to the local SignalK
|
|
185
|
+
* server's own REST API).
|
|
186
|
+
*/
|
|
187
|
+
async function callLlm(settings, prompt) {
|
|
188
|
+
const model = resolveModel(settings);
|
|
189
|
+
const { generateText } = loadOptional("ai");
|
|
190
|
+
const controller = new AbortController();
|
|
191
|
+
const timer = setTimeout(() => controller.abort(), (settings.llmTimeoutSeconds ?? 30) * 1000);
|
|
192
|
+
try {
|
|
193
|
+
const { text } = await generateText({ model, prompt, abortSignal: controller.signal });
|
|
194
|
+
return text;
|
|
195
|
+
}
|
|
196
|
+
finally {
|
|
197
|
+
clearTimeout(timer);
|
|
198
|
+
}
|
|
199
|
+
}
|
package/dist/repaintScheduler.js
CHANGED
|
@@ -7,6 +7,7 @@ const path_1 = require("path");
|
|
|
7
7
|
const fs_1 = require("fs");
|
|
8
8
|
const config_1 = require("./config");
|
|
9
9
|
const bleDiscovery_1 = require("./devices/bleDiscovery");
|
|
10
|
+
const bleBackend_1 = require("./devices/bleBackend");
|
|
10
11
|
const discoveredDevicesStore_1 = require("./devices/discoveredDevicesStore");
|
|
11
12
|
const discoveryCoordinator_1 = require("./devices/discoveryCoordinator");
|
|
12
13
|
const registry_1 = require("./devices/registry");
|
|
@@ -200,7 +201,7 @@ async function resolveTargets(app, config, device) {
|
|
|
200
201
|
let records = (0, discoveredDevicesStore_1.loadDiscoveredDevices)(app);
|
|
201
202
|
if (Object.keys(records).length === 0) {
|
|
202
203
|
app.debug(`"${device.friendlyName}": device is "${config_1.ALL_DEVICES}" and nothing discovered yet - scanning for ${config.scanDurationSeconds}s`);
|
|
203
|
-
records = (await (0, discoveryCoordinator_1.ensureScan)(app, config.scanDurationSeconds)).merged;
|
|
204
|
+
records = (await (0, discoveryCoordinator_1.ensureScan)(app, config.scanDurationSeconds, config.useBleApi && !!app.bleApi)).merged;
|
|
204
205
|
}
|
|
205
206
|
const targets = [];
|
|
206
207
|
for (const record of Object.values(records)) {
|
|
@@ -349,7 +350,8 @@ async function considerRepaint(app, config, device, target, state, getApiUrl) {
|
|
|
349
350
|
app.debug(`${label}: attempting paint ${attempt}/${config.paintRetries}`);
|
|
350
351
|
}
|
|
351
352
|
const startedAt = Date.now();
|
|
352
|
-
|
|
353
|
+
const gattBackend = config.useBleApi && app.bleApi ? (0, bleBackend_1.bleApiBackend)(app.bleApi, pluginVersion_1.PLUGIN_NAME) : undefined;
|
|
354
|
+
await driver.paint(bitmap, { address, aesKey: device.aesKey, connectTimeoutMs, reframe: device.reframe, gattBackend });
|
|
353
355
|
paintDurationMs = Date.now() - startedAt;
|
|
354
356
|
});
|
|
355
357
|
(0, discoveredDevicesStore_1.touchDiscoveredDevice)(app, { address, vendor: target.vendor, pid: target.pid, hwVersion: target.hwVersion, metadata });
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rhizomatics/signalk-einklabel-plugin",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0-beta1",
|
|
4
4
|
"description": "Display SignalK data on eInk Electronic Shelf Labels, includes working examples for tide clock and watch schedule.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ble",
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
"pngjs": "^7.0.0"
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
|
-
"@signalk/server-api": "^2.
|
|
67
|
+
"@signalk/server-api": "^2.32.0",
|
|
68
68
|
"@types/luxon": "^3.7.1",
|
|
69
69
|
"@types/node": "^26.4.0",
|
|
70
70
|
"@types/pngjs": "^6.0.5",
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
2
|
+
<svg
|
|
3
|
+
width="296"
|
|
4
|
+
height="128"
|
|
5
|
+
viewBox="0 0 296 128"
|
|
6
|
+
version="1.1"
|
|
7
|
+
id="svg1"
|
|
8
|
+
sodipodi:docname="296x128-BWRY.svg"
|
|
9
|
+
inkscape:version="1.3.2 (091e20e, 2023-11-25)"
|
|
10
|
+
xml:space="preserve"
|
|
11
|
+
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
|
12
|
+
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
|
13
|
+
xmlns="http://www.w3.org/2000/svg"
|
|
14
|
+
xmlns:svg="http://www.w3.org/2000/svg"><defs
|
|
15
|
+
id="defs1" /><sodipodi:namedview
|
|
16
|
+
id="namedview1"
|
|
17
|
+
pagecolor="#ffffff"
|
|
18
|
+
bordercolor="#000000"
|
|
19
|
+
borderopacity="0.25"
|
|
20
|
+
inkscape:showpageshadow="2"
|
|
21
|
+
inkscape:pageopacity="0.0"
|
|
22
|
+
inkscape:pagecheckerboard="0"
|
|
23
|
+
inkscape:deskcolor="#d1d1d1"
|
|
24
|
+
inkscape:zoom="1.3906433"
|
|
25
|
+
inkscape:cx="159.2788"
|
|
26
|
+
inkscape:cy="101.03238"
|
|
27
|
+
inkscape:window-width="1488"
|
|
28
|
+
inkscape:window-height="674"
|
|
29
|
+
inkscape:window-x="24"
|
|
30
|
+
inkscape:window-y="33"
|
|
31
|
+
inkscape:window-maximized="0"
|
|
32
|
+
inkscape:current-layer="svg1"
|
|
33
|
+
showgrid="true"
|
|
34
|
+
showguides="true"><inkscape:grid
|
|
35
|
+
id="grid1"
|
|
36
|
+
units="px"
|
|
37
|
+
originx="0"
|
|
38
|
+
originy="0"
|
|
39
|
+
spacingx="1"
|
|
40
|
+
spacingy="1"
|
|
41
|
+
empcolor="#0099e5"
|
|
42
|
+
empopacity="0.30196078"
|
|
43
|
+
color="#0099e5"
|
|
44
|
+
opacity="0.14901961"
|
|
45
|
+
empspacing="5"
|
|
46
|
+
dotted="false"
|
|
47
|
+
gridanglex="30"
|
|
48
|
+
gridanglez="30"
|
|
49
|
+
visible="true" /></sodipodi:namedview><rect
|
|
50
|
+
x="1.0169492"
|
|
51
|
+
y="2.0798673e-08"
|
|
52
|
+
width="296"
|
|
53
|
+
height="128"
|
|
54
|
+
fill="#ffffff"
|
|
55
|
+
id="rect1"
|
|
56
|
+
style="stroke-width:0.616026" /><text
|
|
57
|
+
id="last_repaint"
|
|
58
|
+
x="245.9742"
|
|
59
|
+
y="104.33255"
|
|
60
|
+
font-size="18"
|
|
61
|
+
font-family="serif"
|
|
62
|
+
fill="black"
|
|
63
|
+
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"
|
|
64
|
+
transform="scale(0.85412559,1.170788)"><desc
|
|
65
|
+
id="desc12">source=einklabel,path=repainted,format=local_datetime_short</desc><tspan
|
|
66
|
+
sodipodi:role="line"
|
|
67
|
+
id="tspan3"
|
|
68
|
+
x="245.9742"
|
|
69
|
+
y="104.33255">27 Jun 26 18:05</tspan></text></svg>
|