@rhizomatics/signalk-einklabel-plugin 1.3.0-beta7 → 1.3.0-beta9
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 +19 -1
- package/README.md +34 -1
- package/dist/cli/index.d.ts +4 -1
- package/dist/cli/index.js +25 -1
- package/dist/config.d.ts +12 -0
- package/dist/config.js +25 -0
- package/dist/devices/bleBackend.js +16 -1
- package/dist/devices/gicisky/compression.d.ts +22 -9
- package/dist/devices/gicisky/compression.js +128 -13
- package/dist/devices/gicisky/encode.d.ts +1 -1
- package/dist/devices/gicisky/encode.js +2 -2
- package/dist/devices/gicisky/index.js +4 -3
- package/dist/devices/gicisky/layout.d.ts +13 -1
- package/dist/devices/gicisky/layout.js +21 -0
- package/dist/devices/types.d.ts +15 -0
- package/dist/devices/types.js +2 -0
- package/dist/devices/zhsunyco/compression.d.ts +1 -0
- package/dist/devices/zhsunyco/compression.js +30 -0
- package/dist/devices/zhsunyco/index.js +10 -4
- package/dist/devices/zhsunyco/protocol.d.ts +2 -0
- package/dist/devices/zhsunyco/protocol.js +2 -0
- package/dist/email/emailSender.d.ts +27 -0
- package/dist/email/emailSender.js +66 -0
- 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/render/mirror.d.ts +11 -0
- package/dist/render/mirror.js +24 -0
- package/dist/repaintScheduler.js +3 -0
- package/package.json +2 -2
package/dist/devices/types.d.ts
CHANGED
|
@@ -1,8 +1,17 @@
|
|
|
1
1
|
import { Bitmap } from "../render/types";
|
|
2
2
|
import { ReframeMode } from "../render/reframe";
|
|
3
|
+
import { MirrorMode } from "../render/mirror";
|
|
3
4
|
import { BleBackend } from "./bleBackend";
|
|
4
5
|
import { GattConnection } from "./gattConnection";
|
|
5
6
|
export type Colour = "black" | "white" | "red" | "yellow";
|
|
7
|
+
/**
|
|
8
|
+
* Which wire format to send in - `"auto"` uses whatever the driver's model table says;
|
|
9
|
+
* `"chunked"` opts a gicisky panel with separate BW/red planes (e.g. the 4.2" BWR, normally sent
|
|
10
|
+
* plain) into the QuickLZ-compressed chunk framing the 7.5"/10.2" use - see `withCompressionFormat`
|
|
11
|
+
* in `gicisky/layout.ts`. Ignored by other vendors.
|
|
12
|
+
*/
|
|
13
|
+
export type CompressionFormat = "auto" | "chunked";
|
|
14
|
+
export declare const COMPRESSION_FORMATS: CompressionFormat[];
|
|
6
15
|
/**
|
|
7
16
|
* Static facts about one device model, keyed by (vendor, pid) by the registry —
|
|
8
17
|
* PID alone is not assumed unique across vendors.
|
|
@@ -68,6 +77,12 @@ export interface VendorDeviceConfig {
|
|
|
68
77
|
connectTimeoutMs?: number;
|
|
69
78
|
/** How to fit the bitmap onto the panel when its size doesn't already match - see `ReframeMode`. Defaults to `"crop"` - a live label showing *something*, even off-size, beats a repaint that just fails outright; pass `"fixed"` explicitly to get the old reject-the-mismatch behaviour back. */
|
|
70
79
|
reframe?: ReframeMode;
|
|
80
|
+
/** Flips the image after reframing, before encoding - see `MirrorMode`. Defaults to `"none"`. */
|
|
81
|
+
mirror?: MirrorMode;
|
|
82
|
+
/** Compress the upload where the vendor protocol supports it (zhsunyco; gicisky's chunked 7.5"/10.2" panels); ignored otherwise. Defaults to `true`. */
|
|
83
|
+
compress?: boolean;
|
|
84
|
+
/** Overrides the model's own wire format - see `CompressionFormat`. Defaults to `"auto"`. */
|
|
85
|
+
compressionFormat?: CompressionFormat;
|
|
71
86
|
/**
|
|
72
87
|
* How `paint()` reaches the device's BLE hardware - omitted (always true for the CLI, which has no
|
|
73
88
|
* `ServerAPI`/`app.bleApi` to source one from) means direct BlueZ access via a fresh
|
package/dist/devices/types.js
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function compressWolinkBlocks(data: Buffer): Buffer;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.compressWolinkBlocks = compressWolinkBlocks;
|
|
4
|
+
const zlib_1 = require("zlib");
|
|
5
|
+
/**
|
|
6
|
+
* Wolink block-deflate payload format, ported from the `zhsunyco_esl` package bundled with the
|
|
7
|
+
* Home Assistant Wolink ESL integration (`zhsunyco_esl/protocol.py`):
|
|
8
|
+
*
|
|
9
|
+
* A5 A6 <blockCount u8> 02, then per block: <1-based index u8> <compressedLength u16le> <raw deflate>
|
|
10
|
+
*
|
|
11
|
+
* Each block holds up to 8 KB of the uncompressed 2bpp buffer. Sent in place of the raw buffer,
|
|
12
|
+
* followed by `COMMAND.refreshCompressed` carrying the compressed length.
|
|
13
|
+
*/
|
|
14
|
+
const WOLINK_BLOCK_SIZE = 8192;
|
|
15
|
+
const WOLINK_BLOCK_FORMAT = 0x02;
|
|
16
|
+
function compressWolinkBlocks(data) {
|
|
17
|
+
const blockCount = Math.ceil(data.length / WOLINK_BLOCK_SIZE);
|
|
18
|
+
if (blockCount > 0xff) {
|
|
19
|
+
throw new Error(`zhsunyco compression: ${data.length} bytes needs ${blockCount} blocks, format allows at most 255`);
|
|
20
|
+
}
|
|
21
|
+
const parts = [Buffer.from([0xa5, 0xa6, blockCount, WOLINK_BLOCK_FORMAT])];
|
|
22
|
+
for (let i = 0; i < blockCount; i++) {
|
|
23
|
+
const deflated = (0, zlib_1.deflateRawSync)(data.subarray(i * WOLINK_BLOCK_SIZE, (i + 1) * WOLINK_BLOCK_SIZE), { level: 9 });
|
|
24
|
+
const header = Buffer.alloc(3);
|
|
25
|
+
header[0] = i + 1;
|
|
26
|
+
header.writeUInt16LE(deflated.length, 1);
|
|
27
|
+
parts.push(header, deflated);
|
|
28
|
+
}
|
|
29
|
+
return Buffer.concat(parts);
|
|
30
|
+
}
|
|
@@ -7,6 +7,8 @@ const pluginVersion_1 = require("../../pluginVersion");
|
|
|
7
7
|
const metadata_1 = require("./metadata");
|
|
8
8
|
const encode_1 = require("./encode");
|
|
9
9
|
const reframe_1 = require("../../render/reframe");
|
|
10
|
+
const mirror_1 = require("../../render/mirror");
|
|
11
|
+
const compression_1 = require("./compression");
|
|
10
12
|
const protocol_1 = require("./protocol");
|
|
11
13
|
/** node-ble has no MTU API; this matches the reference driver's mtu(247)-9 default. */
|
|
12
14
|
const UPLOAD_CHUNK_SIZE = 238;
|
|
@@ -77,14 +79,18 @@ class ZhsunycoDriver {
|
|
|
77
79
|
const challenge = await conn.read(protocol_1.WOLINK_SERVICE_UUID, protocol_1.WOLINK_CHARACTERISTIC_UUIDS.authenticate);
|
|
78
80
|
await conn.write(protocol_1.WOLINK_SERVICE_UUID, protocol_1.WOLINK_CHARACTERISTIC_UUIDS.authenticate, (0, protocol_1.authResponse)(challenge, aesKey), false);
|
|
79
81
|
await (0, bleDiscovery_1.sleep)(AUTH_SETTLE_DELAY_MS);
|
|
80
|
-
const framed = (0, reframe_1.reframeBitmap)(bitmap, metadata.width, metadata.height - metadata.voffset, config.reframe ?? "crop");
|
|
82
|
+
const framed = (0, mirror_1.mirrorBitmap)((0, reframe_1.reframeBitmap)(bitmap, metadata.width, metadata.height - metadata.voffset, config.reframe ?? "crop"), config.mirror ?? "none");
|
|
81
83
|
const pixelData = (0, encode_1.encodeBitmap)(framed, metadata);
|
|
82
|
-
|
|
83
|
-
|
|
84
|
+
const compress = config.compress ?? true;
|
|
85
|
+
// Upload offsets and the refresh length both count bytes of whatever's actually sent - the
|
|
86
|
+
// compressed payload when compressing, not the raw buffer it inflates back to.
|
|
87
|
+
const payload = compress ? (0, compression_1.compressWolinkBlocks)(pixelData) : pixelData;
|
|
88
|
+
for (let offset = 0; offset < payload.length; offset += UPLOAD_CHUNK_SIZE) {
|
|
89
|
+
const chunk = payload.subarray(offset, offset + UPLOAD_CHUNK_SIZE);
|
|
84
90
|
await conn.write(protocol_1.WOLINK_SERVICE_UUID, protocol_1.WOLINK_CHARACTERISTIC_UUIDS.data, Buffer.concat([(0, protocol_1.commandHeader)(protocol_1.COMMAND.uploadBlock, offset), chunk]), true);
|
|
85
91
|
await (0, bleDiscovery_1.sleep)(CHUNK_WRITE_DELAY_MS);
|
|
86
92
|
}
|
|
87
|
-
await conn.write(protocol_1.WOLINK_SERVICE_UUID, protocol_1.WOLINK_CHARACTERISTIC_UUIDS.data, (0, protocol_1.commandHeader)(protocol_1.COMMAND.refreshUncompressed,
|
|
93
|
+
await conn.write(protocol_1.WOLINK_SERVICE_UUID, protocol_1.WOLINK_CHARACTERISTIC_UUIDS.data, (0, protocol_1.commandHeader)(compress ? protocol_1.COMMAND.refreshCompressed : protocol_1.COMMAND.refreshUncompressed, payload.length), true);
|
|
88
94
|
// `Promise.race` can't cancel its loser, so once `statusReceived` settles (the common case)
|
|
89
95
|
// this timer would otherwise sit alive for the rest of its 60s regardless - see the identical
|
|
90
96
|
// reasoning on `readDeviceDetails`'s own race, below.
|
|
@@ -15,6 +15,8 @@ export declare const WOLINK_CHARACTERISTIC_UUIDS: {
|
|
|
15
15
|
export declare const COMMAND: {
|
|
16
16
|
readonly uploadBlock: 42240;
|
|
17
17
|
readonly refreshUncompressed: 42241;
|
|
18
|
+
/** Refresh after uploading a `compressWolinkBlocks` payload rather than the raw buffer. */
|
|
19
|
+
readonly refreshCompressed: 42242;
|
|
18
20
|
};
|
|
19
21
|
export interface AdvertisedDeviceInfo {
|
|
20
22
|
pid: number;
|
|
@@ -25,6 +25,8 @@ exports.WOLINK_CHARACTERISTIC_UUIDS = {
|
|
|
25
25
|
exports.COMMAND = {
|
|
26
26
|
uploadBlock: 0xa500,
|
|
27
27
|
refreshUncompressed: 0xa501,
|
|
28
|
+
/** Refresh after uploading a `compressWolinkBlocks` payload rather than the raw buffer. */
|
|
29
|
+
refreshCompressed: 0xa502,
|
|
28
30
|
};
|
|
29
31
|
/** Decodes the 8-byte header shared by the advertising mirror and config characteristic. */
|
|
30
32
|
function decodeAdvertisedInfo(data) {
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { EmailConfig } from "../config";
|
|
2
|
+
import { Bitmap } from "../render/types";
|
|
3
|
+
import { FieldRow } from "../render/fieldsTable";
|
|
4
|
+
/** 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`). */
|
|
5
|
+
export type EmailContentBody = {
|
|
6
|
+
kind: "table";
|
|
7
|
+
rows: FieldRow[];
|
|
8
|
+
} | {
|
|
9
|
+
kind: "text";
|
|
10
|
+
text: string;
|
|
11
|
+
} | {
|
|
12
|
+
kind: "none";
|
|
13
|
+
};
|
|
14
|
+
export interface LabelEmailContent {
|
|
15
|
+
friendlyName: string;
|
|
16
|
+
description?: string;
|
|
17
|
+
bitmap: Bitmap;
|
|
18
|
+
body: EmailContentBody;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Renders and sends one device's repaint as an email - a PNG attachment (also shown inline via a `cid`
|
|
22
|
+
* reference), the same field-by-field table `esl-cli fields` shows for a hand-authored SVG template (or
|
|
23
|
+
* a `TemplateProvider`'s own rendered-content text for something like a GenAI prompt - see `body`), and a
|
|
24
|
+
* link back to the docs site. Called from `considerRepaint` (`../repaintScheduler.ts`) whenever a
|
|
25
|
+
* device's `emailTo` is set and its render succeeds.
|
|
26
|
+
*/
|
|
27
|
+
export declare function sendLabelEmail(emailConfig: EmailConfig, to: string, content: LabelEmailContent): Promise<void>;
|
|
@@ -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
|
+
}
|
|
@@ -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
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Bitmap } from "./types";
|
|
2
|
+
/**
|
|
3
|
+
* Flips the rendered image before it's encoded for the panel - for hardware whose RAM layout is
|
|
4
|
+
* mirrored relative to what a driver's encoder assumes (the Wolink HA integration found the 2.9"
|
|
5
|
+
* and 3.5" panels differ from the 3.7" this plugin's zhsunyco encoder was confirmed against), or a
|
|
6
|
+
* label that's simply mounted upside down (`"both"` is a 180° rotation).
|
|
7
|
+
*/
|
|
8
|
+
export type MirrorMode = "none" | "horizontal" | "vertical" | "both";
|
|
9
|
+
export declare const MIRROR_MODES: MirrorMode[];
|
|
10
|
+
/** Returns `bitmap` unchanged for `"none"`, otherwise a flipped copy. */
|
|
11
|
+
export declare function mirrorBitmap(bitmap: Bitmap, mode: MirrorMode): Bitmap;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.MIRROR_MODES = void 0;
|
|
4
|
+
exports.mirrorBitmap = mirrorBitmap;
|
|
5
|
+
exports.MIRROR_MODES = ["none", "horizontal", "vertical", "both"];
|
|
6
|
+
/** Returns `bitmap` unchanged for `"none"`, otherwise a flipped copy. */
|
|
7
|
+
function mirrorBitmap(bitmap, mode) {
|
|
8
|
+
if (mode === "none") {
|
|
9
|
+
return bitmap;
|
|
10
|
+
}
|
|
11
|
+
const { width, height } = bitmap;
|
|
12
|
+
const flipX = mode === "horizontal" || mode === "both";
|
|
13
|
+
const flipY = mode === "vertical" || mode === "both";
|
|
14
|
+
const data = new Uint8Array(bitmap.data.length);
|
|
15
|
+
for (let y = 0; y < height; y++) {
|
|
16
|
+
const srcY = flipY ? height - 1 - y : y;
|
|
17
|
+
for (let x = 0; x < width; x++) {
|
|
18
|
+
const srcX = flipX ? width - 1 - x : x;
|
|
19
|
+
const srcOffset = (srcY * width + srcX) * 4;
|
|
20
|
+
data.set(bitmap.data.subarray(srcOffset, srcOffset + 4), (y * width + x) * 4);
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
return { width, height, data };
|
|
24
|
+
}
|
package/dist/repaintScheduler.js
CHANGED
|
@@ -358,6 +358,9 @@ async function considerRepaint(app, config, device, target, state, getApiUrl) {
|
|
|
358
358
|
aesKey: device.aesKey,
|
|
359
359
|
connectTimeoutMs,
|
|
360
360
|
reframe: device.reframe,
|
|
361
|
+
mirror: device.mirror,
|
|
362
|
+
compress: device.compress,
|
|
363
|
+
compressionFormat: device.compressionFormat,
|
|
361
364
|
gattBackend,
|
|
362
365
|
});
|
|
363
366
|
paintDurationMs = Date.now() - startedAt;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rhizomatics/signalk-einklabel-plugin",
|
|
3
|
-
"version": "1.3.0-
|
|
3
|
+
"version": "1.3.0-beta9",
|
|
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",
|
|
@@ -75,7 +75,7 @@
|
|
|
75
75
|
"typescript": "^5.5.0"
|
|
76
76
|
},
|
|
77
77
|
"engines": {
|
|
78
|
-
"node": ">=
|
|
78
|
+
"node": ">=22"
|
|
79
79
|
},
|
|
80
80
|
"signalk": {
|
|
81
81
|
"displayName": "eInk Label Displays",
|