@rhizomatics/signalk-einklabel-plugin 0.8.0 → 0.8.2

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.8.2
+
+- Work around a SignalK bug in Server API where `ResourcesApi.listResources()` merges provider values in undetermined order and ignores specified provider.
+
+# 0.8.1
+
+- A preferred `provider` can now be set for `resources`.
+  - The example `tide.svg` sets this to `provider=tides` to ignore other providers, (such as `mareas-ihm`)
+- Devices will repaint at startup even if no schedule slot has been missed prior to startup, if the template itself has subsequently changed
+
 # 0.8.0
 
 - New `settle` time, configurable and defaulting to 120 seconds, to wait after plugin startup before attempting to access paths
@@ -6,7 +16,6 @@
 - Path based subscriptions ignore temporarily missing paths, so displays don't waste their tiny batteries on flapping values
 - Documentation now has a FAQ plus lots of other ESL/eInk hacking links.
 
-
 # 0.7.1
 
 - Fix path value retrieved for Image Fields when running in live plugin

package/README.md

@@ -13,11 +13,11 @@ A SignalK plugin to display data from SignalK paths, APIs and plugins on Electro
 
 ## What is an ESL?
 
-Electronic Shelf Labels are [eInk](https://en.wikipedia.org/wiki/E_Ink) devices that consume very little battery energy, presuming they are not constantly updated - the battery is used only when the display changes, and a periodic BLE check for incoming changes. Perfect for info that changes only once or twice a day, like tidal information.
+Electronic Shelf Labels are [eInk](https://en.wikipedia.org/wiki/E_Ink) devices that consume very little battery energy, presuming they are not constantly updated - the battery is used only when the display changes (which can take 5-10 seconds) and a periodic BLE check for incoming changes. Perfect for info that changes only once or twice a day, like tidal information.
 
 Since they are designed to be used in large quantity in small shops, they are cheap and simple devices. Earlier models required dedicated controllers, or updates over Wifi or NFC, whereas many modern ones are standalone BLE devices that can be updated from a phone or server.
 
-Being battery operated, they can be stuck on anywhere without wiring - the only constraints are bluetooth range, visibility (they need ambient light since the display is more like paper than a traditional lit-up electronic display) and out of the weather since the devices are intended for indoor use.
+Being battery operated, they can be stuck on anywhere without wiring - the only location constraints are bluetooth range, visibility (they need ambient light since the display is more like paper than a traditional lit-up electronic display) and out of the weather since the devices are intended for indoor use.
 
 ## Pre-requisites
 
@@ -72,7 +72,7 @@ npm install @rhizomatics/signalk-einklabel-plugin
 
 ![Tide Clock](docs/assets/screenshots/example_tidal_clock.png)
 
-The tide clock needs the [signalk-tides](https://github.com/openwatersio/signalk-tides) plugin to be installed and publishing tides to the Resources API. The [tide.svg](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/templates/tide.svg) can be customized to run with other APIs or take data only from SignalK data paths.
+The tide clock needs the [signalk-tides](https://github.com/openwatersio/signalk-tides) plugin to be installed and publishing tides to the Resources API. The [tide.svg](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/templates/tide.svg) can be customized to run with other APIs or take data only from SignalK data paths. For example, `source=resources,resource=tides,provider=tides,path=extremes[0].time,format=local_time` gets the first tide time, ensures its the preferred `signalk-tides` provider and makes it a simple local time rather than a UTC date time.
 
 To show the lunar phase, the `environment.moon.phaseName` path is required, which can
 be easily achieved by installing and configuring the `derived-data` plugin.
@@ -117,7 +117,9 @@ For example, `path=environment.forecast.description` uses the default data sourc
 
 #### SignalK REST APIs
 
-The source can be overridden to use the SignalK server's Resources API instead. For example, `source=resources,resource=tides,path=station.name` picks the `tides` resource and pulls the `station.name` path out of the JSON response - this works for any resource type (`tides`, `waypoints`, `routes`, ...), and needs nothing configured: the plugin reaches the Resources API directly. Where a resource is specified, it will be fetched once for that render, and subsequent fields sourced from the same resource use that cached response.
+The source can be overridden to use the SignalK server's Resources API instead. Change `source` to `resources` and specify which resource with `resource`. If there are multiple providers for the same resource, and they're not equally useful, then either set a default provider in SignalK, or use the `provider` tag to set the name.
+
+For example, `source=resources,resource=tides,provider=tides,path=station.name` picks the `tides` resource and pulls the `station.name` path out of the JSON response - this works for any resource type (`tides`, `waypoints`, `routes`, ...), and needs nothing configured: the plugin reaches the Resources API directly. Where a resource is specified, it will be fetched once for that render, and subsequent fields sourced from the same resource use that cached response. `provider` is optional, the default provider will be used if not specified.
 
 #### Plugin Data
 
@@ -150,7 +152,7 @@ Common categories:
 
 Additionally, `round=n` can be used to round to limited decimal places.
 
-These can all be combined as in `source=resources,resource=tides,path=extremes[2].level,category=depth,round=2`
+These can all be combined as in `source=resources,resource=tides,provider=tides,path=extremes[2].level,category=depth,round=2`
 
 ### Non-Textual Fields (Images)
 
@@ -174,7 +176,6 @@ Three font types are loaded by default, use the generic font family, or exact fo
 - `sans-serif` - `Roboto`
 - `monospace` - `Roboto Mono`
 
-
 ## Vendors
 
 ### Zhsunyco
@@ -253,7 +254,6 @@ Inkscape adds its own metadata to images, which can be stripped off by exporting
 
 Due to a limitation in the `resvg-wasm` library used to turn SVGs into images, the `font-family` is limited to `serif`,`sans-serif`,`monospace` or the exact name of one of the installed fonts - `Roboto` (sans serif), `Roboto Serif` or `Roboto Mono`. Inkscape has its own fonts, which won't match what's available in the SignalK plugin, so for more precise design, install [Roboto from Google](https://fonts.google.com/specimen/Roboto) via the web page, `brew` on MacOS or similar.
 
-
 ### Debugging Templates
 
 The `esl-cli` can be used to debug and validate templates quickly:
@@ -272,25 +272,25 @@ npx esl-cli fields -t templates/tide.svg -u http://localhost
 ```
 
 ```
-id                       spec                                                                     value
-station.name             source=resources,resource=tides,path=station.name                        Tobermory
-source.name.             source=resources,resource=tides,path=station.source.name                 TICON-4
-last_repaint             source=einklabel,path=repainted,format=local_datetime_short              30 Jun 26 00:08
-extremes.0               source=resources,resource=tides,path=extremes[0].label                   Low
-extremes.1               source=resources,resource=tides,path=extremes[1].label                   High
-extremes.2               source=resources,resource=tides,path=extremes[2].label                   Low
-timezoneRegion           source=einklabel,path=local_zone                                         BST
-lat                      source=resources,resource=tides,path=station.datums.LAT,category=depth   0.2m
-hat                      source=resources,resource=tides,path=station.datums.HAT,category=depth   5.2m
-extremes.2.level         source=resources,resource=tides,path=extremes[2].level,category=depth    1.1m
-extremes.2.time          source=resources,resource=tides,path=extremes[2].time,format=local_time  13:15
-extremes.1.level         source=resources,resource=tides,path=extremes[1].level,category=depth    3.8m
-extremes.1.time          source=resources,resource=tides,path=extremes[1].time,format=local_time  07:05
-extremes.0.time          source=resources,resource=tides,path=extremes[0].time,format=local_time  01:21
-extremes.0.time-8        source=resources,resource=tides,path=extremes[0].time,format=day_mon     30 Jun
-extremes.0.time-8-5      source=resources,resource=tides,path=extremes[1].time,format=day_mon     30 Jun
-extremes.0.time-8-9      source=resources,resource=tides,path=extremes[2].time,format=day_mon     30 Jun
-extremes.0.level         source=resources,resource=tides,path=extremes[0].level,category=depth    1.3m
+id                   spec                                                                                    value
+station.name         source=resources,resource=tides,provider=tides,path=station.name                        Tobermory
+source.name.         source=resources,resource=tides,provider=tides,path=station.source.name                 TICON-4
+last_repaint         source=einklabel,path=repainted,format=local_datetime_short                             30 Jun 26 00:08
+extremes.0           source=resources,resource=tides,provider=tides,path=extremes[0].label                   Low
+extremes.1           source=resources,resource=tides,provider=tides,path=extremes[1].label                   High
+extremes.2           source=resources,resource=tides,provider=tides,path=extremes[2].label                   Low
+timezoneRegion       source=einklabel,path=local_zone                                                        BST
+lat                  source=resources,resource=tides,provider=tides,path=station.datums.LAT,category=depth   0.2m
+hat                  source=resources,resource=tides,provider=tides,path=station.datums.HAT,category=depth   5.2m
+extremes.2.level     source=resources,resource=tides,provider=tides,path=extremes[2].level,category=depth    1.1m
+extremes.2.time      source=resources,resource=tides,provider=tides,path=extremes[2].time,format=local_time  13:15
+extremes.1.level     source=resources,resource=tides,provider=tides,path=extremes[1].level,category=depth    3.8m
+extremes.1.time      source=resources,resource=tides,provider=tides,path=extremes[1].time,format=local_time  07:05
+extremes.0.time      source=resources,resource=tides,provider=tides,path=extremes[0].time,format=local_time  01:21
+extremes.0.time-8    source=resources,resource=tides,provider=tides,path=extremes[0].time,format=day_mon     30 Jun
+extremes.0.time-8-5  source=resources,resource=tides,provider=tides,path=extremes[1].time,format=day_mon     30 Jun
+extremes.0.time-8-9  source=resources,resource=tides,provider=tides,path=extremes[2].time,format=day_mon     30 Jun
+extremes.0.level     source=resources,resource=tides,provider=tides,path=extremes[0].level,category=depth    1.3m
 ```
 
 ### Offline Working
@@ -309,7 +309,7 @@ For example, `npx esl-cli fields -t templates/tide.svg -e examples` will show al
 
 If the plugin repaints a display at server startup, then the plugin that provides the data may not have started ( or in the case of `derived-data` the plugin that the plugin depends on! ) and unlike Home Assistant, there's no good way of sequencing the start of plugins.
 
-Use the *settle* time, to impose a minimum wait between the eInk Label plugin being initialized, and it attempting to paint any displays, and increase this value if its still missing data.
+Use the _settle_ time, to impose a minimum wait between the eInk Label plugin being initialized, and it attempting to paint any displays, and increase this value if its still missing data.
 
 ### Times are showing incorrectly {#faq-timezone}
 
@@ -322,6 +322,10 @@ If you're a global cruiser, then use something like [signalk-set-gps-timezone](h
 
 Try a BLE proxy device, ESP32 is popular for this.
 
+### Can't edit the text contents of SVG template in VSCode
+
+If you have an SVG viewer extension, this wll show the image rather than allowing editing of text. To solve, right click on the file in VSCode _Explorer_ view and choose to edit with _Text Editor_.
+
 ## Other ESL and General eInk Resources
 
 - [Open ePaper Link](https://openepaperlink.de) - Alternative open source firmware to flash onto eInk shelf labels, with Home Assistant integration.
@@ -329,7 +333,7 @@ Try a BLE proxy device, ESP32 is popular for this.
 - [eInk Dashboard Modern SK](https://github.com/VladimirKalachikhin/e-inkDashboardModernSK) - SignalK dashboard for non-ESL eInk display.
 - [esp32-esl-system](https://github.com/giobauermeister/esp32-esl-system) - Docker and ESP32 based system for updating ESLs.
 - [hass-gicisky](https://github.com/eigger/hass-gicisky) - Home Assistant integration for Gicisky ESLs ( a similar vendor to Zhsunyco). Uses [imagespec](https://github.com/eigger/imagespec) for templating.
-- [ha-panda](https://github.com/moryoav/ha-panda) -  Home Assistant integration for Panda ESLs ( a similar vendor to Zhsunyco).
+- [ha-panda](https://github.com/moryoav/ha-panda) - Home Assistant integration for Panda ESLs ( a similar vendor to Zhsunyco).
 - [Dmitry.gr](https://dmitry.gr/?r=05.Projects&proj=29.%20eInk%20Price%20Tags) - Personal site of an ESL hacker
 - [Aaron Christobel](https://www.youtube.com/@atc1441) - YouTube channel of an ESL hacker.
 - [rbaron.net](https://rbaron.net/blog/2022/07/29/Daisy-chaining-multiple-electronic-shelf-labels) - Blog of an early ESL hacker.

package/dist/cli/liveContext.js

@@ -7,6 +7,7 @@ exports.assembleLiveContext = assembleLiveContext;
 exports.assembleExampleContext = assembleExampleContext;
 const promises_1 = require("fs/promises");
 const path_1 = __importDefault(require("path"));
+const binding_1 = require("../render/binding");
 const formatters_1 = require("../render/formatters");
 const unwrapSignalkTree_1 = require("../render/unwrapSignalkTree");
 const httpJson_1 = require("../httpJson");
@@ -47,11 +48,19 @@ async function assembleLiveContext(signalkUrl, bindings) {
         }
     }
     const resources = {};
-    const resourceNames = new Set(bindings.filter((binding) => binding.source === "resources").map((binding) => binding.resource));
-    for (const name of resourceNames) {
-        const url = `${signalkUrl}${RESOURCES_API_PATH}/${name}`;
+    const resourceBindings = new Map();
+    for (const binding of bindings) {
+        if (binding.source !== "resources")
+            continue;
+        resourceBindings.set((0, binding_1.resourceContextKey)(binding), binding);
+    }
+    for (const [key, binding] of resourceBindings) {
+        // A `provider=` binding pins which registered provider plugin answers the request (matches
+        // `checkForProvider`'s `?provider=` query param in signalk-server's resources REST API) rather
+        // than leaving it to whichever provider the server considers the default for that resource type.
+        const url = `${signalkUrl}${RESOURCES_API_PATH}/${binding.resource}${binding.provider ? `?provider=${encodeURIComponent(binding.provider)}` : ""}`;
         (0, log_1.logDebug)(`GET ${url}`);
-        resources[name] = await (0, httpJson_1.fetchJson)(url);
+        resources[key] = await (0, httpJson_1.fetchJson)(url);
     }
     const categoryNames = new Set(bindings.filter((binding) => binding.category).map((binding) => binding.category));
     const categories = await (0, unitCategories_1.fetchCategoryDisplayUnits)(signalkUrl, categoryNames);
@@ -112,11 +121,18 @@ async function assembleExampleContext(examplesDir, bindings) {
         }
     }
     const resources = {};
-    const resourceNames = new Set(bindings.filter((binding) => binding.source === "resources").map((binding) => binding.resource));
-    for (const name of resourceNames) {
-        const resourcePath = path_1.default.join(examplesDir, "resources", `${name}.json`);
+    const resourceBindings = new Map();
+    for (const binding of bindings) {
+        if (binding.source !== "resources")
+            continue;
+        resourceBindings.set((0, binding_1.resourceContextKey)(binding), binding);
+    }
+    for (const [key, binding] of resourceBindings) {
+        // Example data has no notion of multiple providers for the same resource type - the file is
+        // still named after the bare `resource=` type regardless of any `provider=` a binding pins.
+        const resourcePath = path_1.default.join(examplesDir, "resources", `${binding.resource}.json`);
         (0, log_1.logDebug)(`reading ${resourcePath}`);
-        resources[name] = await readJsonFile(resourcePath);
+        resources[key] = await readJsonFile(resourcePath);
     }
     const categoryNames = new Set(bindings.filter((binding) => binding.category).map((binding) => binding.category));
     let categories = {};

package/dist/config.js

@@ -158,7 +158,7 @@ function configSchema(app, discovered = []) {
                 type: "number",
                 title: "Settle time after plugin start (seconds)",
                 description: "Holds off every repaint (startup check, interval, and subscription alike) until this long after the plugin starts - " +
-                    "the first minute or two of SignalK startup is a chaos of plugin dependency sequencing, so data a template needs " +
+                    "the first minute or two of SignalK startup often has many errors as plugins start before the paths they depend on are ready, so data a template needs " +
                     "(e.g. from the derived-data plugin) may not be published yet.",
                 minimum: 0,
                 default: defaults.settleSeconds,

package/dist/devices/zhsunyco/index.js

@@ -150,7 +150,7 @@ async function readDeviceDetails(device, address, advertisedInfo) {
     // which otherwise stays set forever and silently skips every later scan).
     return Promise.race([
         read(),
-        (0, bleDiscovery_1.sleep)(SCAN_CONNECT_TIMEOUT_MS * 2).then(() => {
+        (0, bleDiscovery_1.sleep)(SCAN_CONNECT_TIMEOUT_MS * 3).then(() => {
             console.error(`${pluginVersion_1.PLUGIN_NAME}: zhsunyco [${address}]: battery/config read timed out after ${SCAN_CONNECT_TIMEOUT_MS * 2}ms`);
             return fallback;
         }),

package/dist/render/assets.d.ts

@@ -21,3 +21,9 @@ export declare function resolveAssetPath(templatesDir: string, bundledTemplatesD
  * directory, is readable) - the miss is then just this value's.
  */
 export declare function describeAssetsDirProblem(templatesDir: string, bundledTemplatesDir: string, assetsName: string): string | undefined;
+/**
+ * Counts the `.svg` files in whichever `assets/<assetsName>` directory `selectAssetsDir` would read
+ * from, for a caller to report alongside a resolved-but-empty-key miss - confirms which directory is in
+ * play and how populated it is, which "the directory exists" alone doesn't convey.
+ */
+export declare function countAssets(templatesDir: string, bundledTemplatesDir: string, assetsName: string): number;

package/dist/render/assets.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeAssetKey = normalizeAssetKey;
 exports.resolveAssetPath = resolveAssetPath;
 exports.describeAssetsDirProblem = describeAssetsDirProblem;
+exports.countAssets = countAssets;
 const fs_1 = require("fs");
 const path_1 = require("path");
 /**
@@ -86,3 +87,16 @@ function describeAssetsDirProblem(templatesDir, bundledTemplatesDir, assetsName)
     const problem = describeDir(selectAssetsDir(templatesDir, bundledTemplatesDir, assetsName));
     return problem && `assets directory ${problem}`;
 }
+/**
+ * Counts the `.svg` files in whichever `assets/<assetsName>` directory `selectAssetsDir` would read
+ * from, for a caller to report alongside a resolved-but-empty-key miss - confirms which directory is in
+ * play and how populated it is, which "the directory exists" alone doesn't convey.
+ */
+function countAssets(templatesDir, bundledTemplatesDir, assetsName) {
+    try {
+        return (0, fs_1.readdirSync)(selectAssetsDir(templatesDir, bundledTemplatesDir, assetsName)).filter((name) => name.endsWith(".svg")).length;
+    }
+    catch {
+        return 0;
+    }
+}

package/dist/render/binding.d.ts

@@ -10,6 +10,15 @@ export interface Binding {
     context: string;
     /** Required when `source === 'resources'` - the Resources API resource type, e.g. `tides`, `waypoints`. */
     resource?: string;
+    /**
+     * Only meaningful when `source === 'resources'` - the plugin id of the Resource Provider to query
+     * (SignalK's `listResources(resType, params, providerId)`), e.g. `signalk-tides`. Optional - when
+     * omitted, the server picks whichever provider is registered for `resource` (its "default"), which is
+     * ambiguous/unpredictable when more than one plugin provides the same resource type (e.g. installing
+     * a second tides plugin can silently make it the one used instead of the one the template was authored
+     * for). Set this to pin a template to one provider regardless of what else is installed.
+     */
+    provider?: string;
     /** For `source === 'einklabel'`, a dotted path into the plugin's own injected `meta` (e.g. `repainted`), rather than into vessel/resource data. */
     path: string;
     /** A named formatter (see `./formatters.ts`), or `'raw'` to suppress automatic unit conversion (see `renderBinding`). */
@@ -37,6 +46,14 @@ export interface Binding {
  * unambiguously signals this shorthand.
  */
 export declare function parseBinding(desc: string): Binding;
+/**
+ * Key under which a `source=resources` binding's data is stored in `context.resources` (see
+ * `assembleRawContext` in repaintScheduler.ts and `cli/liveContext.ts`'s equivalent) - incorporates
+ * `provider` so two bindings naming the same `resource` type but different providers (e.g. pinning one
+ * template's `tides` binding to `provider=signalk-tides` while another is left to the server's default)
+ * don't collide on a single cache entry.
+ */
+export declare function resourceContextKey(binding: Pick<Binding, "resource" | "provider">): string;
 /**
  * Parses every `<text>` and `<image>` element's `<desc>` binding out of raw SVG source - lets a caller
  * discover what data a template needs before fetching anything, with no separate config declaring it

package/dist/render/binding.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseBinding = parseBinding;
+exports.resourceContextKey = resourceContextKey;
 exports.findBindings = findBindings;
 exports.resolveBinding = resolveBinding;
 exports.renderBinding = renderBinding;
 const xmldom_1 = require("@xmldom/xmldom");
 const formatters_1 = require("./formatters");
 const SOURCES = ["signalk", "resources", "einklabel"];
-const KNOWN_KEYS = new Set(["source", "context", "resource", "path", "format", "category", "round", "assets"]);
+const KNOWN_KEYS = new Set(["source", "context", "resource", "provider", "path", "format", "category", "round", "assets"]);
 /**
  * Parses a `<desc>` element's text content into a `Binding`, e.g.
  * `source=resources,resource=tides,path=extremes[0].level,category=depth,round=2` or, using the
@@ -45,6 +46,9 @@ function parseBinding(desc) {
     if (source === "resources" && !fields.resource) {
         throw new Error(`invalid binding "${desc}" - source=resources requires a "resource" key`);
     }
+    if (fields.provider && source !== "resources") {
+        throw new Error(`invalid binding "${desc}" - "provider" is only valid with source=resources`);
+    }
     if (!fields.path) {
         throw new Error(`invalid binding "${desc}" - missing required "path" key`);
     }
@@ -52,6 +56,7 @@ function parseBinding(desc) {
         source,
         context,
         resource: fields.resource,
+        provider: fields.provider,
         path: fields.path,
         format: fields.format,
         category: fields.category,
@@ -59,6 +64,16 @@ function parseBinding(desc) {
         assets: fields.assets,
     };
 }
+/**
+ * Key under which a `source=resources` binding's data is stored in `context.resources` (see
+ * `assembleRawContext` in repaintScheduler.ts and `cli/liveContext.ts`'s equivalent) - incorporates
+ * `provider` so two bindings naming the same `resource` type but different providers (e.g. pinning one
+ * template's `tides` binding to `provider=signalk-tides` while another is left to the server's default)
+ * don't collide on a single cache entry.
+ */
+function resourceContextKey(binding) {
+    return binding.provider ? `${binding.resource}@${binding.provider}` : binding.resource;
+}
 /**
  * Parses every `<text>` and `<image>` element's `<desc>` binding out of raw SVG source - lets a caller
  * discover what data a template needs before fetching anything, with no separate config declaring it
@@ -112,9 +127,10 @@ function resolveBinding(binding, context) {
         return getAtPath(meta, binding.path);
     }
     const resources = context.resources;
-    const resource = resources?.[binding.resource];
+    const resourceKey = resourceContextKey(binding);
+    const resource = resources?.[resourceKey];
     if (resource === undefined) {
-        throw new Error(`binding references resource "${binding.resource}" which is not present in the render context`);
+        throw new Error(`binding references resource "${resourceKey}" which is not present in the render context`);
     }
     return getAtPath(resource, binding.path);
 }

package/dist/render/svgRenderer.js

@@ -136,7 +136,7 @@ class SvgRenderer {
                     console.error(key
                         ? `${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 empty value to select asset`);
-                    console.error(`${pluginVersion_1.PLUGIN_NAME}: ${dirProblem ?? `assets directory for "${binding.assets}" is present`}`);
+                    console.error(`${pluginVersion_1.PLUGIN_NAME}: ${dirProblem ?? `directory "${binding.assets}" found with ${(0, assets_1.countAssets)(templatesDir, bundledTemplatesDir, binding.assets)} assets`}`);
                     element.parentNode?.removeChild(element);
                     continue;
                 }

package/dist/repaintScheduler.js

@@ -16,8 +16,10 @@ const unitCategories_1 = require("./unitCategories");
 const pathMeta_1 = require("./pathMeta");
 const resolveApiUrl_1 = require("./resolveApiUrl");
 const pluginVersion_1 = require("./pluginVersion");
+const httpJson_1 = require("./httpJson");
 const INTERVAL_POLL_MS = 60000;
 const SUBSCRIPTION_DEBOUNCE_MS = 2000;
+const RESOURCES_API_PATH = "/signalk/v2/api/resources";
 /**
  * The most recent wall-clock instant at or before `now` that an `interval`-triggered device's own
  * periodic check (below, in `startRepaintScheduler`) would fire at - every `intervalHours` hours,
@@ -60,8 +62,9 @@ function stableStringify(value) {
     }
     return JSON.stringify(value);
 }
-function hashContext(context) {
-    return (0, crypto_1.createHash)("sha1").update(stableStringify(context)).digest("hex");
+/** Hashes both the live data context and the template's mtime, so editing a template (even with no data change) triggers a repaint. */
+function hashContext(context, templateMtimeMs) {
+    return (0, crypto_1.createHash)("sha1").update(stableStringify(context)).update(String(templateMtimeMs)).digest("hex");
 }
 /** Merges `value` into `target` at the nested location described by a dotted SignalK path. */
 function setAtPath(target, path, value) {
@@ -84,13 +87,16 @@ function setAtPath(target, path, value) {
  * CLI's HTTP-fetched equivalent (`assembleLiveContext` in `cli/liveContext.ts`), so a `path=` binding
  * resolves to the same value either way - without it, `resolveBinding` would hand back the whole
  * wrapper object instead of e.g. a plain string, breaking any binding that expects one (a `<image>`'s
- * `assets=`, a `format=` formatter, etc). `resources`-sourced bindings go through `app.resourcesApi`,
- * in-process too, with no such wrapper. Per-path unit-conversion metadata (`pathMeta`, for automatic
- * conversion - see `renderBinding`) and an explicit `category=` binding's resolved conversion both
- * have no in-process equivalent (confirmed against the signalk-server source - that resolution only
- * happens in its REST layer), so both need `apiUrl` - fetching `pathMeta` is best-effort (a
- * missing/unreachable server just means no automatic conversion), but a `category=` binding is a
- * declared dependency, so a missing `apiUrl` is a hard error there.
+ * `assets=`, a `format=` formatter, etc). `resources`-sourced bindings with no `provider=` pin go
+ * through `app.resourcesApi` in-process too, with no such wrapper - but a `provider=`-pinned binding
+ * goes over HTTP instead (see the resources loop below), since the in-process API doesn't actually
+ * honor `providerId` on signalk-server 2.30.0. Per-path unit-conversion metadata (`pathMeta`, for
+ * automatic conversion - see `renderBinding`) and an explicit `category=` binding's resolved
+ * conversion both have no in-process equivalent (confirmed against the signalk-server source - that
+ * resolution only happens in its REST layer), so both need `apiUrl` - fetching `pathMeta` is
+ * best-effort (a missing/unreachable server just means no automatic conversion), but a `category=`
+ * binding (and now a `provider=`-pinned resource binding) is a declared dependency, so a missing
+ * `apiUrl` is a hard error there.
  */
 async function assembleRawContext(app, apiUrl, bindings) {
     var _a;
@@ -122,13 +128,33 @@ async function assembleRawContext(app, apiUrl, bindings) {
         }
     }
     const resources = {};
-    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
-        // "tides" type) accepts any registered resource type string - this cast matches `getResource`'s
-        // wider, accurate signature.
-        resources[name] = await app.resourcesApi.listResources(name, {});
+    const resourceBindings = new Map();
+    for (const binding of bindings) {
+        if (binding.source !== "resources")
+            continue;
+        resourceBindings.set((0, binding_1.resourceContextKey)(binding), binding);
+    }
+    for (const [key, binding] of resourceBindings) {
+        if (binding.provider) {
+            // `app.resourcesApi.listResources(resType, params, providerId)` validates providerId against the
+            // registered providers but then - confirmed against signalk-server 2.30.0's own source - ignores
+            // it and merges every registered provider's results together (its internal `listFromAll`), so a
+            // second provider for the same resource type can silently clobber the one a binding pinned. The
+            // REST API's own `?provider=` query param doesn't have this bug (it queries only that provider),
+            // so a pinned binding goes over HTTP instead of the in-process API to actually get what it asked for.
+            if (!apiUrl) {
+                throw new Error(`binding pins resource "${binding.resource}" to provider "${binding.provider}" but no SignalK API base URL is configured`);
+            }
+            resources[key] = await (0, httpJson_1.fetchJson)(`${apiUrl}${RESOURCES_API_PATH}/${binding.resource}?provider=${encodeURIComponent(binding.provider)}`);
+        }
+        else {
+            // `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
+            // "tides" type) accepts any registered resource type string - this cast matches `getResource`'s
+            // wider, accurate signature. No `provider=` pin here, so the in-process call's default-provider
+            // behavior (whichever the server picks) is fine - and cheaper than a redundant HTTP round trip.
+            resources[key] = await app.resourcesApi.listResources(binding.resource, {}, undefined);
+        }
     }
     const categoryNames = new Set(bindings.filter((binding) => binding.category).map((binding) => binding.category));
     if (categoryNames.size > 0 && !apiUrl) {
@@ -155,13 +181,14 @@ async function considerRepaint(app, config, device, state, getApiUrl) {
     }
     const templatesDir = (0, config_1.resolveTemplatesDir)(config.templatesDir);
     const templatePath = (0, config_1.resolveTemplatePath)(templatesDir, device.templateName);
+    const templateMtimeMs = (0, fs_1.statSync)(templatePath).mtimeMs;
     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;
     });
     const rawContext = await assembleRawContext(app, apiUrl, bindings);
-    const hash = hashContext(rawContext);
+    const hash = hashContext(rawContext, templateMtimeMs);
     if (state[device.friendlyName]?.hash === hash && !device.forceRepaint) {
         app.debug(`"${device.friendlyName}": data unchanged, skipping repaint`);
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Display SignalK data on eInk Electronic Shelf Labels",
   "keywords": [
     "ble",

package/templates/tide.svg

@@ -12,7 +12,10 @@
    xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
    xmlns:xlink="http://www.w3.org/1999/xlink"
    xmlns="http://www.w3.org/2000/svg"
-   xmlns:svg="http://www.w3.org/2000/svg"><defs
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:dc="http://purl.org/dc/elements/1.1/"><defs
      id="defs1" /><sodipodi:namedview
      id="namedview1"
      pagecolor="#ffffff"
@@ -69,7 +72,7 @@
      fill="yellow"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:32px;font-family:serif;-inkscape-font-specification:'Roboto Serif 20pt';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ffff00;stroke:#000000;stroke-width:1.2278;stroke-opacity:1"
      transform="scale(0.89274878,1.1201359)">Tidal Station Name<desc
-   id="desc1">source=resources,resource=tides,path=station.name</desc></text><text
+   id="desc1">source=resources,resource=tides,provider=tides,path=station.name</desc></text><text
      id="source"
      x="367.44577"
      y="226.1548"
@@ -78,7 +81,7 @@
      fill="black"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:13.3333px;font-family:sans-serif;-inkscape-font-specification:'\'Roboto\', sans-serif';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ff0000;stroke-width:3.80045"
      transform="scale(0.95907862,1.0426674)"><desc
-       id="desc21">source=resources,resource=tides,path=station.source.name</desc><tspan
+       id="desc21">source=resources,resource=tides,provider=tides,path=station.source.name</desc><tspan
        sodipodi:role="line"
        id="tspan20"
        x="367.44577"
@@ -102,7 +105,7 @@
      font-family="monospace"
      fill="black"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:22.6667px;font-family:sans-serif;-inkscape-font-specification:'Roboto, Normal',sans-serif;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ff0000"><desc
-   id="desc13">source=resources,resource=tides,path=extremes[0].label</desc>High or Low</text><text
+   id="desc13">source=resources,resource=tides,provider=tides,path=extremes[0].label</desc>High or Low</text><text
      id="extremes.1"
      x="7.6000967"
      y="117.85719"
@@ -110,7 +113,7 @@
      font-family="monospace"
      fill="black"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:22.6667px;font-family:sans-serif;-inkscape-font-specification:'Roboto, Normal',sans-serif;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ff0000"><desc
-   id="desc14">source=resources,resource=tides,path=extremes[1].label</desc>High or Low</text><text
+   id="desc14">source=resources,resource=tides,provider=tides,path=extremes[1].label</desc>High or Low</text><text
      id="extremes.2"
      x="7.2470098"
      y="176.12112"
@@ -118,7 +121,7 @@
      font-family="monospace"
      fill="red"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:22.6667px;font-family:sans-serif;-inkscape-font-specification:'Roboto, Normal',sans-serif;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ff0000"><desc
-   id="desc15">source=resources,resource=tides,path=extremes[2].label</desc>High or Low</text><text
+   id="desc15">source=resources,resource=tides,provider=tides,path=extremes[2].label</desc>High or Low</text><text
      id="timezone"
      x="330.60489"
      y="204.67754"
@@ -148,7 +151,7 @@
      font-family="sans-serif"
      fill="#ffff00"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:21.3333px;font-family:sans-serif;-inkscape-font-specification:'\'Roboto, Normal\', sans-serif';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#1a1a1a;stroke:#fefe54;stroke-opacity:1"><desc
-       id="desc18">source=resources,resource=tides,path=station.datums.LAT,category=depth,round=1</desc><tspan
+       id="desc18">source=resources,resource=tides,provider=tides,path=station.datums.LAT,category=depth,round=1</desc><tspan
        sodipodi:role="line"
        id="tspan17"
        x="282.65424"
@@ -160,7 +163,7 @@
      font-family="sans-serif"
      fill="#ffff00"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:21.3333px;font-family:sans-serif;-inkscape-font-specification:'\'Roboto, Normal\', sans-serif';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#1a1a1a;stroke:#fefe54;stroke-opacity:1"><desc
-       id="desc19">source=resources,resource=tides,path=station.datums.HAT,category=depth,round=1</desc><tspan
+       id="desc19">source=resources,resource=tides,provider=tides,path=station.datums.HAT,category=depth,round=1</desc><tspan
        sodipodi:role="line"
        id="tspan18"
        x="360.77148"
@@ -180,7 +183,7 @@
        x="322.52386"
        y="158.08005"
        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="desc6">source=resources,resource=tides,provider=tides,path=extremes[2].level,category=depth</desc></text><text
      id="extremes.2.time"
      x="203.77321"
      y="146.1584"
@@ -189,7 +192,7 @@
      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"
      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="desc10">source=resources,resource=tides,provider=tides,path=extremes[2].time,format=local_time</desc></text><text
      id="extremes.1.level"
      x="334.30084"
      y="109.17664"
@@ -205,7 +208,7 @@
        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="desc5">source=resources,resource=tides,provider=tides,path=extremes[1].level,category=depth</desc></text><text
      id="extremes.1.time"
      x="188.63072"
      y="108.65867"
@@ -214,7 +217,7 @@
      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"
      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="desc8">source=resources,resource=tides,provider=tides,path=extremes[1].time,format=local_time</desc></text><text
      id="extremes.0.time"
      x="184.40854"
      y="64.242691"
@@ -223,7 +226,7 @@
      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.55397"
      transform="scale(0.74654856,1.3394976)">03:27<desc
-   id="desc3">source=resources,resource=tides,path=extremes[0].time,format=local_time</desc></text><text
+   id="desc3">source=resources,resource=tides,provider=tides,path=extremes[0].time,format=local_time</desc></text><text
      id="extremes.0.date"
      x="10.326324"
      y="74.630478"
@@ -232,7 +235,7 @@
      fill="red"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:22.6667px;font-family:sans-serif;-inkscape-font-specification:'Roboto, Normal',sans-serif;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#666666;stroke-width:1.32646"
      transform="scale(0.82428216,1.2131768)"><desc
-   id="desc2">source=resources,resource=tides,path=extremes[0].time,format=day_mon</desc>27 Jun</text><text
+   id="desc2">source=resources,resource=tides,provider=tides,path=extremes[0].time,format=day_mon</desc>27 Jun</text><text
      id="extremes.1.date"
      x="9.9649849"
      y="123.34451"
@@ -241,7 +244,7 @@
      fill="red"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:22.6667px;font-family:sans-serif;-inkscape-font-specification:'Roboto, Normal',sans-serif;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#666666;stroke-width:1.32646"
      transform="scale(0.82428216,1.2131768)"><desc
-   id="desc7">source=resources,resource=tides,path=extremes[1].time,format=day_mon</desc>27 Jun</text><text
+   id="desc7">source=resources,resource=tides,provider=tides,path=extremes[1].time,format=day_mon</desc>27 Jun</text><text
      id="extremes.2.date"
      x="12.934491"
      y="156.77794"
@@ -250,7 +253,7 @@
      fill="red"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:22.6667px;font-family:sans-serif;-inkscape-font-specification:'Roboto, Normal',sans-serif;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#666666;stroke-width:1.4652"
      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="desc9">source=resources,resource=tides,provider=tides,path=extremes[2].time,format=day_mon</desc>27 Jun</text><text
      id="extremes.0.level"
      x="324.0769"
      y="64.82357"
@@ -264,7 +267,7 @@
        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
+       id="desc4">source=resources,resource=tides,provider=tides,path=extremes[0].level,category=depth</desc></text><text
      xml:space="preserve"
      style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:21.3333px;font-family:sans-serif;-inkscape-font-specification:'\'Roboto, Normal\', sans-serif';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#1a1a1a;stroke:#fefe54;stroke-width:0.612283;stroke-opacity:1"
      x="337.254"