@rhizomatics/signalk-einklabel-plugin 0.8.1 → 0.8.2

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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`.

package/README.md

@@ -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.

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/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,
@@ -85,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;
@@ -130,13 +135,26 @@ async function assembleRawContext(app, apiUrl, bindings) {
         resourceBindings.set((0, binding_1.resourceContextKey)(binding), binding);
     }
     for (const [key, binding] of resourceBindings) {
-        // `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. An explicit `provider=` pins which registered provider plugin
-        // answers the request (SignalK's `listResources(resType, params, providerId)`) rather than
-        // leaving it to whichever provider the server considers the default for that resource type.
-        resources[key] = await app.resourcesApi.listResources(binding.resource, {}, binding.provider);
+        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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "0.8.1",
+  "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"