@rhizomatics/signalk-einklabel-plugin 0.6.3 → 0.7.0

package/dist/render/svgRenderer.js

@@ -2,15 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SvgRenderer = void 0;
 const promises_1 = require("fs/promises");
+const path_1 = require("path");
 const xmldom_1 = require("@xmldom/xmldom");
 const resvg_wasm_1 = require("@resvg/resvg-wasm");
 const binding_1 = require("./binding");
 const assets_1 = require("./assets");
 const fonts_1 = require("./fonts");
+const pluginVersion_1 = require("../pluginVersion");
+const config_1 = require("../config");
 let wasmReady;
 function ensureWasmInitialized() {
     if (!wasmReady) {
-        wasmReady = (0, promises_1.readFile)(require.resolve('@resvg/resvg-wasm/index_bg.wasm')).then((buffer) => (0, resvg_wasm_1.initWasm)(buffer));
+        wasmReady = (0, promises_1.readFile)(require.resolve("@resvg/resvg-wasm/index_bg.wasm")).then((buffer) => (0, resvg_wasm_1.initWasm)(buffer));
     }
     return wasmReady;
 }
@@ -53,12 +56,13 @@ function expandGenericFontFamilies(svgSource) {
  * whole tree and rendered blank.
  *
  * Non-textual inclusion: an `<image>` element with a `<desc>` child works the same way, except the
- * resolved value picks one of a directory of `.svg` files (an `assets=` key, required, names that
- * directory - see `./assets.ts`) rather than substituting text, and the element is dropped entirely
- * (rather than showing an error placeholder) whenever the value is unavailable or doesn't map to a
- * file - e.g. a device without the `derived-data` plugin installed simply shows no moon-phase icon.
- * The matched file's contents are inlined as a `data:image/svg+xml;base64,...` URI so no filesystem
- * access happens at resvg-wasm's render step.
+ * resolved value picks one of a directory of `.svg` files (an `assets=` key, required, names an
+ * `assets/<name>` directory looked up under `templatesDir` first and `BUNDLED_TEMPLATES_DIR` otherwise
+ * - see `resolveAssetPath` in `./assets.ts`) rather than substituting text, and the element is dropped
+ * entirely (rather than showing an error placeholder) whenever the value is unavailable or doesn't map
+ * to a file - e.g. a device without the `derived-data` plugin installed simply shows no moon-phase
+ * icon. The matched file's contents are inlined as a `data:image/svg+xml;base64,...` URI so no
+ * filesystem access happens at resvg-wasm's render step.
  *
  * resvg-wasm cannot see the host's installed fonts (`loadSystemFonts`/`fontFiles`
  * are silently no-ops under plain Node) - it only renders text if given font
@@ -71,7 +75,7 @@ class SvgRenderer {
     constructor(fontPaths = fonts_1.DEFAULT_FONT_PATHS) {
         this.fontPaths = fontPaths;
         if (fontPaths.length === 0) {
-            throw new Error('SvgRenderer requires at least one font path - resvg-wasm cannot use host system fonts');
+            throw new Error("SvgRenderer requires at least one font path - resvg-wasm cannot use host system fonts");
         }
     }
     loadFontBuffers() {
@@ -80,73 +84,75 @@ class SvgRenderer {
         }
         return this.fontBuffers;
     }
-    async render(svgTemplatePath, context, width, height) {
+    async render(svgTemplatePath, context, width, height, templatesDir = (0, path_1.dirname)(svgTemplatePath), bundledTemplatesDir = config_1.BUNDLED_TEMPLATES_DIR) {
         const [, fontBuffers] = await Promise.all([ensureWasmInitialized(), this.loadFontBuffers()]);
-        const svgSource = expandGenericFontFamilies(await (0, promises_1.readFile)(svgTemplatePath, 'utf-8'));
-        const doc = new xmldom_1.DOMParser().parseFromString(svgSource, 'image/svg+xml');
-        const elements = doc.getElementsByTagName('text');
+        const svgSource = expandGenericFontFamilies(await (0, promises_1.readFile)(svgTemplatePath, "utf-8"));
+        const doc = new xmldom_1.DOMParser().parseFromString(svgSource, "image/svg+xml");
+        const elements = doc.getElementsByTagName("text");
         for (let i = 0; i < elements.length; i++) {
             const element = elements.item(i);
             if (!element)
                 continue;
-            const descElement = element.getElementsByTagName('desc').item(0);
+            const descElement = element.getElementsByTagName("desc").item(0);
             if (!descElement)
                 continue;
             // Scoped to this one element - a single bad/unavailable binding (e.g. a resource that hasn't
             // loaded yet) must not blank out every other field on the label, nor abort the whole repaint.
             try {
-                const binding = (0, binding_1.parseBinding)(descElement.textContent ?? '');
+                const binding = (0, binding_1.parseBinding)(descElement.textContent ?? "");
                 element.textContent = (0, binding_1.renderBinding)(binding, context);
             }
             catch (err) {
-                console.error(`field "${descElement.textContent}" failed to render: ${err.message}`);
-                element.textContent = 'ERROR';
+                console.error(`${pluginVersion_1.PLUGIN_NAME}: field "${descElement.textContent}" failed to render: ${err.message}`);
+                element.textContent = "ERROR";
             }
         }
         // Collected up front, rather than iterated live like the `<text>` loop above - some of these get
         // removed outright (see below), and removing from a live NodeList while iterating it by index would
         // skip whatever shifts into the removed slot.
         const imageElements = [];
-        const rawImageElements = doc.getElementsByTagName('image');
+        const rawImageElements = doc.getElementsByTagName("image");
         for (let i = 0; i < rawImageElements.length; i++) {
             const element = rawImageElements.item(i);
             if (element)
                 imageElements.push(element);
         }
         for (const element of imageElements) {
-            const descElement = element.getElementsByTagName('desc').item(0);
+            const descElement = element.getElementsByTagName("desc").item(0);
             if (!descElement)
                 continue;
             // Same one-field-at-a-time isolation as the `<text>` loop - and the same "no value" outcome
             // (here, dropping the element rather than blanking to 'ERROR' text) for a value that isn't
             // available at all as for one that doesn't map to any asset file, per the binding's contract.
             try {
-                const binding = (0, binding_1.parseBinding)(descElement.textContent ?? '');
+                const binding = (0, binding_1.parseBinding)(descElement.textContent ?? "");
                 if (!binding.assets) {
                     throw new Error('an <image> binding requires an "assets" key naming the directory to pick a file from');
                 }
                 const key = (0, assets_1.normalizeAssetKey)((0, binding_1.resolveBinding)(binding, context));
-                const assetPath = key && (0, assets_1.resolveAssetPath)(svgTemplatePath, binding.assets, key);
+                const assetPath = key && (0, assets_1.resolveAssetPath)(templatesDir, bundledTemplatesDir, binding.assets, key);
                 if (!assetPath) {
+                    const dirProblem = (0, assets_1.describeAssetsDirProblem)(templatesDir, bundledTemplatesDir, binding.assets);
                     console.error(key
-                        ? `image "${descElement.textContent}" has no asset file for value "${key}" in "${binding.assets}"`
-                        : `image "${descElement.textContent}" resolved to no usable value to pick an asset file with`);
+                        ? `${pluginVersion_1.PLUGIN_NAME}: image "${descElement.textContent}" has no asset file for value "${key}" in "${binding.assets}"`
+                        : `${pluginVersion_1.PLUGIN_NAME}: image "${descElement.textContent}" resolved to no usable value to pick an asset file with`);
+                    console.error(`${pluginVersion_1.PLUGIN_NAME}: ${dirProblem ?? `assets directory for "${binding.assets}" checked out fine - the miss is just this value's`}`);
                     element.parentNode?.removeChild(element);
                     continue;
                 }
-                const assetSource = await (0, promises_1.readFile)(assetPath, 'utf-8');
-                const dataUri = `data:image/svg+xml;base64,${Buffer.from(assetSource).toString('base64')}`;
-                const hrefAttr = element.getAttribute('href') !== null ? 'href' : 'xlink:href';
+                const assetSource = await (0, promises_1.readFile)(assetPath, "utf-8");
+                const dataUri = `data:image/svg+xml;base64,${Buffer.from(assetSource).toString("base64")}`;
+                const hrefAttr = element.getAttribute("href") !== null ? "href" : "xlink:href";
                 element.setAttribute(hrefAttr, dataUri);
             }
             catch (err) {
-                console.error(`image "${descElement.textContent}" failed to render: ${err.message}`);
+                console.error(`${pluginVersion_1.PLUGIN_NAME}: image "${descElement.textContent}" failed to render: ${err.message}`);
                 element.parentNode?.removeChild(element);
             }
         }
         const svgOutput = new xmldom_1.XMLSerializer().serializeToString(doc);
         const resvg = new resvg_wasm_1.Resvg(svgOutput, {
-            fitTo: { mode: 'width', value: width },
+            fitTo: { mode: "width", value: width },
             font: { fontBuffers },
         });
         const rendered = resvg.render();

package/dist/render/types.d.ts

@@ -22,5 +22,5 @@ export interface Bitmap {
  */
 export type TemplateContext = Record<string, unknown>;
 export interface Renderer {
-    render(svgTemplatePath: string, context: TemplateContext, width: number, height: number): Promise<Bitmap>;
+    render(svgTemplatePath: string, context: TemplateContext, width: number, height: number, templatesDir?: string, bundledTemplatesDir?: string): Promise<Bitmap>;
 }

package/dist/repaintScheduler.d.ts

@@ -1,5 +1,5 @@
-import { ServerAPI } from '@signalk/server-api';
-import { PluginConfig } from './config';
+import { ServerAPI } from "@signalk/server-api";
+import { PluginConfig } from "./config";
 export interface RepaintScheduler {
     stop(): void;
 }

package/dist/repaintScheduler.js

@@ -17,11 +17,11 @@ const pluginVersion_1 = require("./pluginVersion");
 const INTERVAL_POLL_MS = 60000;
 const SUBSCRIPTION_DEBOUNCE_MS = 2000;
 function statePath(app) {
-    return (0, path_1.join)(app.getDataDirPath(), 'repaint-state.json');
+    return (0, path_1.join)(app.getDataDirPath(), "repaint-state.json");
 }
 function loadState(app) {
     try {
-        return JSON.parse((0, fs_1.readFileSync)(statePath(app), 'utf-8'));
+        return JSON.parse((0, fs_1.readFileSync)(statePath(app), "utf-8"));
     }
     catch {
         return {};
@@ -33,24 +33,24 @@ function saveState(app, state) {
 /** Deterministic JSON serialisation (sorted keys) so re-ordered object keys don't change the hash. */
 function stableStringify(value) {
     if (Array.isArray(value)) {
-        return `[${value.map(stableStringify).join(',')}]`;
+        return `[${value.map(stableStringify).join(",")}]`;
     }
-    if (value !== null && typeof value === 'object') {
+    if (value !== null && typeof value === "object") {
         const entries = Object.entries(value).sort(([a], [b]) => a.localeCompare(b));
-        return `{${entries.map(([k, v]) => `${JSON.stringify(k)}:${stableStringify(v)}`).join(',')}}`;
+        return `{${entries.map(([k, v]) => `${JSON.stringify(k)}:${stableStringify(v)}`).join(",")}}`;
     }
     return JSON.stringify(value);
 }
 function hashContext(context) {
-    return (0, crypto_1.createHash)('sha1').update(stableStringify(context)).digest('hex');
+    return (0, crypto_1.createHash)("sha1").update(stableStringify(context)).digest("hex");
 }
 /** Merges `value` into `target` at the nested location described by a dotted SignalK path. */
 function setAtPath(target, path, value) {
-    const segments = path.split('.');
+    const segments = path.split(".");
     let node = target;
     for (const segment of segments.slice(0, -1)) {
         const next = node[segment];
-        node[segment] = typeof next === 'object' && next !== null ? next : {};
+        node[segment] = typeof next === "object" && next !== null ? next : {};
         node = node[segment];
     }
     node[segments[segments.length - 1]] = value;
@@ -71,19 +71,19 @@ async function assembleRawContext(app, apiUrl, bindings) {
     const signalk = {};
     const seenSignalk = new Set();
     for (const binding of bindings) {
-        if (binding.source !== 'signalk')
+        if (binding.source !== "signalk")
             continue;
         const key = `${binding.context} ${binding.path}`;
         if (seenSignalk.has(key))
             continue;
         seenSignalk.add(key);
-        const value = binding.context === 'self' ? app.getSelfPath(binding.path) : app.getPath(`${binding.context}.${binding.path}`);
+        const value = binding.context === "self" ? app.getSelfPath(binding.path) : app.getPath(`${binding.context}.${binding.path}`);
         const namespace = (signalk[_a = binding.context] ?? (signalk[_a] = {}));
         setAtPath(namespace, binding.path, value);
     }
     signalk.self ?? (signalk.self = {});
     const pathMeta = {};
-    const signalkContexts = new Set(bindings.filter((binding) => binding.source === 'signalk').map((binding) => binding.context));
+    const signalkContexts = new Set(bindings.filter((binding) => binding.source === "signalk").map((binding) => binding.context));
     if (apiUrl) {
         for (const ctx of signalkContexts) {
             try {
@@ -95,7 +95,7 @@ async function assembleRawContext(app, apiUrl, bindings) {
         }
     }
     const resources = {};
-    const resourceNames = new Set(bindings.filter((binding) => binding.source === 'resources').map((binding) => binding.resource));
+    const resourceNames = new Set(bindings.filter((binding) => binding.source === "resources").map((binding) => binding.resource));
     for (const name of resourceNames) {
         // `listResources`'s type only allows the standard SignalKResourceType union, but the underlying
         // Resources API (and a custom provider like signalk-tides, registered under the non-standard
@@ -105,7 +105,7 @@ async function assembleRawContext(app, apiUrl, bindings) {
     }
     const categoryNames = new Set(bindings.filter((binding) => binding.category).map((binding) => binding.category));
     if (categoryNames.size > 0 && !apiUrl) {
-        throw new Error(`binding references categor${categoryNames.size > 1 ? 'ies' : 'y'} "${[...categoryNames].join(', ')}" but no SignalK API base URL is configured`);
+        throw new Error(`binding references categor${categoryNames.size > 1 ? "ies" : "y"} "${[...categoryNames].join(", ")}" but no SignalK API base URL is configured`);
     }
     const categories = apiUrl ? await (0, unitCategories_1.fetchCategoryDisplayUnits)(apiUrl, categoryNames) : {};
     return { signalk, resources, pathMeta, categories };
@@ -126,8 +126,9 @@ async function considerRepaint(app, config, device, state, getApiUrl) {
         app.debug(`"${device.friendlyName}": no driver/metadata for device "${device.device}", skipping`);
         return;
     }
-    const templatePath = (0, config_1.resolveTemplatePath)((0, config_1.resolveTemplatesDir)(config.templatesDir), device.templateName);
-    const bindings = (0, binding_1.findBindings)((0, fs_1.readFileSync)(templatePath, 'utf-8'));
+    const templatesDir = (0, config_1.resolveTemplatesDir)(config.templatesDir);
+    const templatePath = (0, config_1.resolveTemplatePath)(templatesDir, device.templateName);
+    const bindings = (0, binding_1.findBindings)((0, fs_1.readFileSync)(templatePath, "utf-8"));
     const apiUrl = await getApiUrl().catch((err) => {
         app.debug(`"${device.friendlyName}": ${err.message}`);
         return undefined;
@@ -147,27 +148,30 @@ async function considerRepaint(app, config, device, state, getApiUrl) {
         },
     };
     const renderer = new svgRenderer_1.SvgRenderer();
-    const bitmap = await renderer.render(templatePath, renderContext, metadata.width, metadata.height - metadata.voffset);
+    const bitmap = await renderer.render(templatePath, renderContext, metadata.width, metadata.height - metadata.voffset, templatesDir, config_1.BUNDLED_TEMPLATES_DIR);
     const connectTimeoutMs = config.paintConnectTimeoutSeconds * 1000;
+    let paintDurationMs = 0;
     await (0, bleDiscovery_1.withRetries)(config.paintRetries, async (attempt) => {
         if (attempt > 1) {
-            app.debug(`"${device.friendlyName}": paint attempt ${attempt}/${config.paintRetries}`);
+            app.debug(`"${device.friendlyName}": attempting paint ${attempt}/${config.paintRetries}`);
         }
+        const startedAt = Date.now();
         await driver.paint(bitmap, { address: model.address, aesKey: device.aesKey, connectTimeoutMs });
+        paintDurationMs = Date.now() - startedAt;
     });
     state[device.friendlyName] = { hash };
     saveState(app, state);
     if (device.forceRepaint) {
         clearForceRepaint(app, device.friendlyName);
     }
-    app.debug(`"${device.friendlyName}": repainted`);
+    app.debug(`"${device.friendlyName}": repainted (paint took ${paintDurationMs}ms)`);
 }
 function startRepaintScheduler(app, config) {
     const state = loadState(app);
     const unsubscribes = [];
     const getApiUrl = (0, resolveApiUrl_1.createApiUrlResolver)(config.signalkApiUrl);
     const repaint = (device) => considerRepaint(app, config, device, state, getApiUrl).catch((err) => app.debug(`"${device.friendlyName}": repaint failed: ${err.message}`));
-    const intervalDevices = config.devices.filter((device) => device.repaintTrigger === 'interval');
+    const intervalDevices = config.devices.filter((device) => device.repaintTrigger === "interval");
     if (intervalDevices.length > 0) {
         const timer = setInterval(() => {
             const now = new Date();
@@ -175,14 +179,14 @@ function startRepaintScheduler(app, config) {
                 const hours = device.intervalHours ?? 1;
                 const minute = device.intervalMinute ?? 0;
                 if (now.getHours() % hours === 0 && now.getMinutes() === minute) {
-                    repaint(device);
+                    void repaint(device);
                 }
             }
         }, INTERVAL_POLL_MS);
         unsubscribes.push(() => clearInterval(timer));
     }
     for (const device of config.devices) {
-        if (device.repaintTrigger === 'subscription' && device.triggerPath) {
+        if (device.repaintTrigger === "subscription" && device.triggerPath) {
             const stream = app.streambundle.getSelfStream(device.triggerPath).debounce(SUBSCRIPTION_DEBOUNCE_MS);
             const unsub = stream.onValue(() => repaint(device));
             unsubscribes.push(unsub);
@@ -191,7 +195,7 @@ function startRepaintScheduler(app, config) {
     // Check every device once at startup - harmless given hash dedup, and covers newly-added
     // devices or a forceRepaint left set from before a restart.
     for (const device of config.devices) {
-        repaint(device);
+        void repaint(device);
     }
     return {
         stop() {

package/dist/resolveApiUrl.js

@@ -18,9 +18,9 @@ const httpJson_1 = require("./httpJson");
  * entirely by install method: a bare `npm install` defaults to 3000; container/systemd installs
  * commonly default to 80, or 443 if TLS-terminated locally.
  */
-exports.SIGNALK_API_URL_OPTIONS = ['http://localhost:3000', 'http://localhost', 'https://localhost'];
+exports.SIGNALK_API_URL_OPTIONS = ["http://localhost:3000", "http://localhost", "https://localhost"];
 /** Cheap, always-required (for `category=` resolution) and read-only, so safe to use as a connectivity+access probe. */
-const PROBE_PATH = '/signalk/v1/unitpreferences/categories';
+const PROBE_PATH = "/signalk/v1/unitpreferences/categories";
 async function probe(url) {
     try {
         await (0, httpJson_1.fetchJson)(`${url}${PROBE_PATH}`);
@@ -44,7 +44,7 @@ async function resolveSignalkApiUrl(configuredUrl) {
     }
     throw new Error(configuredUrl
         ? `configured SignalK API base URL "${configuredUrl}" did not respond to ${PROBE_PATH} - check the port, and that anonymous read access is enabled`
-        : `could not reach this server's API on any of ${exports.SIGNALK_API_URL_OPTIONS.join(', ')} - it may be on a different port, or anonymous read access may not be enabled`);
+        : `could not reach this server's API on any of ${exports.SIGNALK_API_URL_OPTIONS.join(", ")} - it may be on a different port, or anonymous read access may not be enabled`);
 }
 /**
  * Memoizes a successful resolution only - a failure (server not ready yet, anonymous access

package/dist/unitCategories.d.ts

@@ -1,4 +1,4 @@
-import { DisplayUnits } from './render/formatters';
+import { DisplayUnits } from "./render/formatters";
 /**
  * Resolves `category=` bindings (e.g. `category=depth` on a `source=resources` value with no per-path
  * metadata of its own to auto-convert from) against this server's unit-preferences setup.

package/dist/unitCategories.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchCategoryDisplayUnits = fetchCategoryDisplayUnits;
 const httpJson_1 = require("./httpJson");
-const CATEGORIES_PATH = '/signalk/v1/unitpreferences/categories';
-const ACTIVE_PRESET_PATH = '/signalk/v1/unitpreferences/active';
-const DEFINITIONS_PATH = '/signalk/v1/unitpreferences/definitions';
+const CATEGORIES_PATH = "/signalk/v1/unitpreferences/categories";
+const ACTIVE_PRESET_PATH = "/signalk/v1/unitpreferences/active";
+const DEFINITIONS_PATH = "/signalk/v1/unitpreferences/definitions";
 /**
  * Resolves `category=` bindings (e.g. `category=depth` on a `source=resources` value with no per-path
  * metadata of its own to auto-convert from) against this server's unit-preferences setup.

package/package.json

@@ -1,51 +1,51 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "description": "Display SignalK data on eInk Electronic Shelf Labels",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "keywords": [
+    "ble",
+    "display",
+    "eink",
+    "esl",
+    "instrument",
+    "signalk",
+    "signalk-category-hardware",
+    "signalk-category-instruments",
+    "signalk-node-server-plugin",
+    "tides"
+  ],
+  "homepage": "https://github.com/rhizomatics/signalk-einklabel-plugin#readme",
+  "bugs": {
+    "url": "https://github.com/rhizomatics/signalk-einklabel-plugin/issues"
+  },
+  "license": "APACHE-2.0",
+  "author": "jey burrows",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rhizomatics/signalk-einklabel-plugin.git"
+  },
   "bin": {
     "esl-cli": "dist/cli/index.js"
   },
   "files": [
     "dist",
     "templates",
-    "resources",
     "docs",
     "CHANGELOG.md",
     "README.md"
   ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
     "watch": "tsc --watch",
     "cli": "ts-node src/cli/index.ts",
     "test": "node scripts/run-tests.js",
     "coverage": "node scripts/run-tests.js --coverage",
-    "prettier:check": "prettier --check .",
-    "prettier:write": "prettier --write .",
-    "prepublishOnly": "npm run build"
-  },
-  "signalk": {
-    "displayName": "eInk Label Displays",
-    "appIcon": "docs/assets/icons/icon_tmp.png",
-    "screenshots": [
-      "docs/assets/screenshots/example_tidal_clock.png"
-    ]
-  },
-  "keywords": [
-    "signalk-node-server-plugin",
-    "signalk-category-instruments",
-    "signalk-category-hardware",
-    "signalk",
-    "eink",
-    "esl",
-    "display",
-    "instrument",
-    "ble",
-    "tides"
-  ],
-  "engines": {
-    "node": ">=18"
+    "prepublishOnly": "npm run build",
+    "fmt": "oxfmt",
+    "fmt:check": "oxfmt --check",
+    "lint": "oxlint"
   },
   "dependencies": {
     "@fontsource/roboto": "^5.2.10",
@@ -65,18 +65,21 @@
     "@types/luxon": "^3.7.1",
     "@types/node": "^20.14.0",
     "@types/pngjs": "^6.0.5",
-    "prettier": "^3.8.5",
+    "oxfmt": "^0.56.0",
+    "oxlint": "^1.71.0",
+    "oxlint-tsgolint": "^0.23.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.0"
   },
-  "license": "APACHE-2.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/rhizomatics/signalk-einklabel-plugin.git"
-  },
-  "author": "jey burrows",
-  "bugs": {
-    "url": "https://github.com/rhizomatics/signalk-einklabel-plugin/issues"
+  "engines": {
+    "node": ">=18"
   },
-  "homepage": "https://github.com/rhizomatics/signalk-einklabel-plugin#readme"
+  "signalk": {
+    "displayName": "eInk Label Displays",
+    "appIcon": "docs/assets/icons/icon_tmp.png",
+    "screenshots": [
+      "docs/assets/screenshots/example_tidal_clock.png",
+      "docs/assets/screenshots/plugin_config.png"
+    ]
+  }
 }

package/templates/assets/lunar_phases/README.md

@@ -0,0 +1,18 @@
+# Lunar Phases
+
+## Source
+
+https://commons.wikimedia.org/wiki/Category:SVG_lunar_phases_icons
+
+## Usage
+
+Embed any of these in a template as a placeholder and set the `description`
+property to `path=environment.moon.phaseName,assets=lunar_phases`
+
+The image will be replaced at rendering time by the one matching the phase name.
+This will automatically adapt from `Waxing Gibbous` to `waxing_gibbous.svg`
+
+## Replacing
+
+Define your own template directory in the plugin configuration, and add an `assets/lunar_phases` directory path beneath it. You will need a complete set of phases in
+the new directory, its not possible to override only one of them.

package/templates/tide.svg

@@ -23,8 +23,8 @@
      inkscape:pagecheckerboard="0"
      inkscape:deskcolor="#d1d1d1"
      inkscape:zoom="1.3906433"
-     inkscape:cx="144.89697"
-     inkscape:cy="197.39066"
+     inkscape:cx="180.85155"
+     inkscape:cy="134.11059"
      inkscape:window-width="1488"
      inkscape:window-height="674"
      inkscape:window-x="24"
@@ -182,16 +182,16 @@
        style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:37.3333px;font-family:monospace;-inkscape-font-specification:'\'Roboto Mono, Bold\', monospace';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;stroke-width:1.78893">3.3m</tspan><desc
        id="desc6">source=resources,resource=tides,path=extremes[2].level,category=depth</desc></text><text
      id="extremes.2.time"
-     x="194.47879"
+     x="203.77321"
      y="146.1584"
      font-size="14"
      font-family="monospace"
      fill="red"
-     style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:37.3333px;font-family:monospace;-inkscape-font-specification:'Roboto Mono, Bold',monospace;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.51352"
+     style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:37.3333px;font-family:monospace;-inkscape-font-specification:'\'Roboto Mono, Bold\', monospace';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.51352"
      transform="scale(0.70226239,1.4239692)">15:53<desc
    id="desc10">source=resources,resource=tides,path=extremes[2].time,format=local_time</desc></text><text
      id="extremes.1.level"
-     x="328.79895"
+     x="334.30084"
      y="109.17664"
      font-size="14"
      font-family="monospace"
@@ -202,17 +202,17 @@
      inkscape:transform-center-x="-0.00038058817"><tspan
        sodipodi:role="line"
        id="tspan2-1"
-       x="328.79895"
+       x="334.30084"
        y="109.17664"
        style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:37.3333px;font-family:monospace;-inkscape-font-specification:'\'Roboto Mono, Bold\', monospace';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
        id="desc5">source=resources,resource=tides,path=extremes[1].level,category=depth</desc></text><text
      id="extremes.1.time"
-     x="187.55594"
+     x="188.63072"
      y="108.65867"
      font-size="14"
      font-family="monospace"
      fill="red"
-     style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:37.3333px;font-family:monospace;-inkscape-font-specification:'Roboto Mono, Bold',monospace;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;stroke-width:1.48364"
+     style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:37.3333px;font-family:monospace;-inkscape-font-specification:'\'Roboto Mono, Bold\', monospace';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
    id="desc8">source=resources,resource=tides,path=extremes[1].time,format=local_time</desc></text><text
      id="extremes.0.time"
@@ -252,7 +252,7 @@
      transform="scale(0.74623156,1.3400666)"><desc
    id="desc9">source=resources,resource=tides,path=extremes[2].time,format=day_mon</desc>27 Jun</text><text
      id="extremes.0.level"
-     x="322.34219"
+     x="324.0769"
      y="64.82357"
      font-size="14"
      font-family="monospace"
@@ -261,7 +261,7 @@
      transform="scale(0.7703174,1.2981662)"><tspan
        sodipodi:role="line"
        id="tspan2"
-       x="322.34219"
+       x="324.0769"
        y="64.82357"
        style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:37.3333px;font-family:monospace;-inkscape-font-specification:'\'Roboto Mono, Bold\', monospace';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,path=extremes[0].level,category=depth</desc></text><text
@@ -282,4 +282,4 @@
      id="moon_phase"
      x="340.3974"
      y="90.153488"><desc
-       id="desc22">path=environment.moon.phaseName,assets=../resources/svg/lunar_phases</desc></image></svg>
+       id="desc22">path=environment.moon.phaseName,assets=lunar_phases</desc></image></svg>