@rhizomatics/signalk-einklabel-plugin 0.6.2 → 0.6.3

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.6.3
+
+- Improve logging if an image cannot be found in an `assets` directory to match a SignalK path value
+- Expose `plugin_version` as a path for the `einklabel` source
+
 # 0.6.2
 
 - Auto default SignalK URL if `-u` or `-e` not passed as CLI arguments

package/README.md

@@ -95,6 +95,7 @@ The source can be overridden to use the SignalK server's Resources API instead.
 
 - `path=repainted` - the timestamp of the current repaint - for example `source=einklabel,path=repainted,format=local_datetime_short` to show when the label was last updated.
 - `path=local_zone` - a short zone name (e.g. `BST`) for the same timezone used for `local_time`/`day_mon`/`local_datetime_short` (see above) - a fallback for `environment.time.timezoneRegion,format=utc_offset` on installs that never publish that path, since it needs no SignalK metadata of its own. Falls back to a plain UTC offset like `GMT+1` where the host's locale has no real abbreviation for the zone.
+- `path=plugin_version` - expose the version of the eInk Label plugin itself.
 
 #### Customizing Output
 

package/dist/cli/liveContext.js

@@ -11,6 +11,7 @@ const formatters_1 = require("../render/formatters");
 const httpJson_1 = require("../httpJson");
 const unitCategories_1 = require("../unitCategories");
 const pathMeta_1 = require("../pathMeta");
+const pluginVersion_1 = require("../pluginVersion");
 const log_1 = require("./log");
 const RESOURCES_API_PATH = '/signalk/v2/api/resources';
 /** `context=self` -> `vessels/self`, `context=vessels.urn:mrn:imo:mmsi:1` -> `vessels/urn:mrn:imo:mmsi:1` - matches the REST path for that context's full-data-model subtree. */
@@ -78,7 +79,11 @@ async function assembleLiveContext(signalkUrl, bindings) {
     const categories = await (0, unitCategories_1.fetchCategoryDisplayUnits)(signalkUrl, categoryNames);
     // Matches `considerRepaint` in repaintScheduler.ts - the CLI has no real device repaint to time, so
     // a `source=einklabel,path=repainted` binding just resolves to "now", same as a live render would.
-    const meta = { repainted: new Date().toISOString(), local_zone: (0, formatters_1.resolveLocalZoneAbbreviation)({ signalk }) };
+    const meta = {
+        repainted: new Date().toISOString(),
+        local_zone: (0, formatters_1.resolveLocalZoneAbbreviation)({ signalk }),
+        plugin_version: pluginVersion_1.PLUGIN_VERSION,
+    };
     return { signalk, resources, pathMeta, categories, meta };
 }
 async function readJsonFile(filePath) {
@@ -147,6 +152,10 @@ async function assembleExampleContext(examplesDir, bindings) {
             }
         }
     }
-    const meta = { repainted: new Date().toISOString(), local_zone: (0, formatters_1.resolveLocalZoneAbbreviation)({ signalk }) };
+    const meta = {
+        repainted: new Date().toISOString(),
+        local_zone: (0, formatters_1.resolveLocalZoneAbbreviation)({ signalk }),
+        plugin_version: pluginVersion_1.PLUGIN_VERSION,
+    };
     return { signalk, resources, pathMeta: {}, categories, meta };
 }

package/dist/plugin.js

@@ -29,7 +29,8 @@ async function runStartupScan(app, discovered, durationSeconds) {
                 }
                 discovered.push(found);
                 const pid = found.pid !== undefined ? `0x${found.pid.toString(16).padStart(4, '0')}` : 'unknown';
-                app.debug(`discovered ${driver.vendor} device "${found.name ?? ''}" [${found.address}] pid=${pid}`);
+                const hwid = found.hwVersion ?? 'unknown';
+                app.debug(`discovered ${driver.vendor} device "${found.name ?? ''}" [${found.address}] pid=${pid} hwid=${hwid}`);
             });
         });
     }

package/dist/pluginVersion.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The installed plugin's own version, read from `package.json` once at module load - exposed to
+ * templates as `source=einklabel,path=plugin_version` (see `meta` in repaintScheduler.ts and
+ * `cli/liveContext.ts`), e.g. to show a build/version marker on a label for support purposes.
+ */
+export declare const PLUGIN_VERSION: string;

package/dist/pluginVersion.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLUGIN_VERSION = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+/**
+ * The installed plugin's own version, read from `package.json` once at module load - exposed to
+ * templates as `source=einklabel,path=plugin_version` (see `meta` in repaintScheduler.ts and
+ * `cli/liveContext.ts`), e.g. to show a build/version marker on a label for support purposes.
+ */
+exports.PLUGIN_VERSION = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(__dirname, '..', 'package.json'), 'utf-8')).version;

package/dist/render/svgRenderer.js

@@ -128,6 +128,9 @@ class SvgRenderer {
                 const key = (0, assets_1.normalizeAssetKey)((0, binding_1.resolveBinding)(binding, context));
                 const assetPath = key && (0, assets_1.resolveAssetPath)(svgTemplatePath, binding.assets, key);
                 if (!assetPath) {
+                    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`);
                     element.parentNode?.removeChild(element);
                     continue;
                 }

package/dist/repaintScheduler.js

@@ -13,6 +13,7 @@ const formatters_1 = require("./render/formatters");
 const unitCategories_1 = require("./unitCategories");
 const pathMeta_1 = require("./pathMeta");
 const resolveApiUrl_1 = require("./resolveApiUrl");
+const pluginVersion_1 = require("./pluginVersion");
 const INTERVAL_POLL_MS = 60000;
 const SUBSCRIPTION_DEBOUNCE_MS = 2000;
 function statePath(app) {
@@ -139,7 +140,11 @@ async function considerRepaint(app, config, device, state, getApiUrl) {
     }
     const renderContext = {
         ...rawContext,
-        meta: { repainted: new Date().toISOString(), local_zone: (0, formatters_1.resolveLocalZoneAbbreviation)(rawContext) },
+        meta: {
+            repainted: new Date().toISOString(),
+            local_zone: (0, formatters_1.resolveLocalZoneAbbreviation)(rawContext),
+            plugin_version: pluginVersion_1.PLUGIN_VERSION,
+        },
     };
     const renderer = new svgRenderer_1.SvgRenderer();
     const bitmap = await renderer.render(templatePath, renderContext, metadata.width, metadata.height - metadata.voffset);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "Display SignalK data on eInk Electronic Shelf Labels",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/templates/tide.svg

@@ -23,8 +23,8 @@
      inkscape:pagecheckerboard="0"
      inkscape:deskcolor="#d1d1d1"
      inkscape:zoom="1.3906433"
-     inkscape:cx="249.88435"
-     inkscape:cy="101.03238"
+     inkscape:cx="144.89697"
+     inkscape:cy="197.39066"
      inkscape:window-width="1488"
      inkscape:window-height="674"
      inkscape:window-x="24"
@@ -71,19 +71,19 @@
      transform="scale(0.89274878,1.1201359)">Tidal Station Name<desc
    id="desc1">source=resources,resource=tides,path=station.name</desc></text><text
      id="source"
-     x="347.95166"
+     x="367.44577"
      y="226.1548"
      font-size="18"
      font-family="serif"
      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.95907863,1.0426674)"><desc
+     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
        sodipodi:role="line"
        id="tspan20"
-       x="347.95166"
+       x="367.44577"
        y="226.1548"
-       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:13.3332995px;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;stroke-width:3.80045">SOURCE</tspan></text><text
+       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;stroke-width:3.80045">SOURCE</tspan></text><text
      id="last_repaint"
      x="4.3477793"
      y="201.9895"
@@ -119,8 +119,8 @@
      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="environment.time.timezoneRegion"
-     x="239.09819"
+     id="timezone"
+     x="330.60489"
      y="204.67754"
      font-size="10.373px"
      font-family="sans-serif"
@@ -128,7 +128,20 @@
      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, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;direction:rtl;fill:#000000;stroke-width:0.864419"
      transform="scale(0.86441854,1.156847)">UTC+01:00<desc
    id="desc11">source=einklabel,path=local_zone</desc></text><text
-     id="lat"
+     id="plugin_version"
+     x="194.07487"
+     y="204.51942"
+     font-size="10.373px"
+     font-family="sans-serif"
+     fill="#ffff00"
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:13.3333px;font-family:Roboto;-inkscape-font-specification:'Roboto, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;direction:rtl;fill:#000000;stroke-width:0.864419"
+     transform="scale(0.86441854,1.156847)"><desc
+       id="desc16">source=einklabel,path=plugin_version</desc><tspan
+       sodipodi:role="line"
+       id="tspan1"
+       x="194.07487"
+       y="204.51942">v0.0.1</tspan></text><text
+     id="min_tide"
      x="282.65424"
      y="24.967674"
      font-size="12px"
@@ -140,7 +153,7 @@
        id="tspan17"
        x="282.65424"
        y="24.967674">0.0m</tspan></text><text
-     id="hat"
+     id="max_tide"
      x="360.77148"
      y="24.967674"
      font-size="12px"
@@ -211,7 +224,7 @@
      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="extremes.0.time-8"
+     id="extremes.0.date"
      x="10.326324"
      y="74.630478"
      font-size="14"
@@ -220,7 +233,7 @@
      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="extremes.0.time-8-5"
+     id="extremes.1.date"
      x="9.9649849"
      y="123.34451"
      font-size="14"
@@ -229,7 +242,7 @@
      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="extremes.0.time-8-9"
+     id="extremes.2.date"
      x="12.934491"
      y="156.77794"
      font-size="14"