@rhizomatics/signalk-einklabel-plugin 0.4.1 → 0.4.2

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.4.2
+- Fix High/Low display for tide clock template
+- Fix last repaint time for display being hour out
+- Change default name of template directory to 'einklabel/templates'
 # 0.4.1
 - Packaging fixes
 # 0.4.0

package/README.md

@@ -30,7 +30,7 @@ In the `description` of the SVG text box, use a comma separated set of key value
 
 For example, `path=environment.forecast.description` uses the default data source (the `self` vessel context) and the named SignalK path. A bare path with no key/value pairs at all, e.g. just `environment.forecast.description`, is shorthand for the same thing. Overriding the default context can be done with `path=environment.forecast.description,context=vessels.urn:mrn:imo:mmsi:232345678` - the `context` value must match a real SignalK context exactly as it appears in the Data Browser.
 
-#### SignalK REST APIs
+#### 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.
 
@@ -51,6 +51,8 @@ A `format` can be specified to make the value easier to understand. The supporte
 
 SignalK's unit preferences are used to automatically convert a `signalk`-sourced numeric value to its preferred display unit, and append a unit symbol like `kt` or `m`, unless `format=raw` is specified to switch that off. However, when using plugin or API data there may be no path metadata to convert from (for example `signalk-tides` publishes tide data to the Resources API, and `level` is a raw metre value with no SignalK path of its own) - in these cases an explicit `category` can be given instead, and the unit preferences will be applied the same way, for example `category=depth` for the tides level figure.
 
+Note that for dates and times, the server timezone must be set correctly, for example `Europe/London` rather than the default `Etc/UTC`. This can be done on Linux using `timedatectl` or `raspi-config` if using a Raspberry Pi with Raspian.
+
 Common categories:
 
 * `depth` - Use the SignalK preferred depth unit, make the conversion if needed, and tack on the unit name as a suffix

package/dist/config.js

@@ -13,7 +13,7 @@ const resolveApiUrl_1 = require("./resolveApiUrl");
 /** The package's own bundled `templates/` directory (ships alongside `dist/`, see package.json's `files`) - templates here are always available, but a same-named template in the user's `templatesDir` takes priority. */
 const BUNDLED_TEMPLATES_DIR = (0, path_1.join)(__dirname, '..', 'templates');
 const SIGNALK_HOME_DIR = (0, path_1.join)((0, os_1.homedir)(), '.signalk');
-const DEFAULT_TEMPLATES_DIR = (0, path_1.join)(SIGNALK_HOME_DIR, 'esl', 'templates');
+const DEFAULT_TEMPLATES_DIR = (0, path_1.join)(SIGNALK_HOME_DIR, 'einklabel', 'templates');
 function defaultConfig() {
     return {
         templatesDir: '',

package/dist/render/formatters.js

@@ -14,13 +14,17 @@ function formatDisplayUnits(value, displayUnits, round) {
 /**
  * The local vessel's timezone (`signalk.self.environment.time.timezoneRegion`), regardless of which
  * vessel's value is being formatted - the display's own clock/locale is what matters, not the data
- * source's. Falls back to UTC when unset.
+ * source's. Most installs never publish that path (it needs a GPS/position-derived timezone plugin),
+ * so this falls back to the host machine's own configured zone - the same thing the SignalK Data
+ * Browser ends up showing, since it's just the browser's local `Intl` zone rather than anything the
+ * server itself publishes. For the live plugin that's the device's own OS timezone (set once via
+ * `raspi-config`/`timedatectl` et al, not GPS-derived); for the CLI it's the developer machine's.
  */
 function selfTimezone(context) {
     const signalk = context.signalk;
     const self = signalk?.self;
     const environment = self?.environment;
-    return environment?.time?.timezoneRegion || 'utc';
+    return environment?.time?.timezoneRegion || Intl.DateTimeFormat().resolvedOptions().timeZone;
 }
 /**
  * Shows the explicit IANA zone name rather than an abbreviation (e.g. "BST") - UK tide tables are

package/dist/render/svgRenderer.js

@@ -62,8 +62,16 @@ class SvgRenderer {
             const descElement = element.getElementsByTagName('desc').item(0);
             if (!descElement)
                 continue;
-            const binding = (0, binding_1.parseBinding)(descElement.textContent ?? '');
-            element.textContent = (0, binding_1.renderBinding)(binding, context);
+            // 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 ?? '');
+                element.textContent = (0, binding_1.renderBinding)(binding, context);
+            }
+            catch (err) {
+                console.error(`field "${descElement.textContent}" failed to render: ${err.message}`);
+                element.textContent = 'ERROR';
+            }
         }
         const svgOutput = new xmldom_1.XMLSerializer().serializeToString(doc);
         const resvg = new resvg_wasm_1.Resvg(svgOutput, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "SignalK plugin that renders selected SignalK data to eInk Electronic Shelf Labels",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/templates/tide.svg

@@ -63,15 +63,15 @@
      font-size="18"
      font-family="serif"
      fill="black"
-     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:12px;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#999999;stroke-width:2.39571"
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:12px;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ffffff;stroke-width:2.39571"
      transform="scale(0.83037506,1.2042751)"><tspan
        sodipodi:role="line"
        id="tspan1"
        x="325.49939"
        y="195.87753"
-       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:12px;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;stroke-width:2.39571;fill:#999999">signalk-einklabel-plugin</tspan></text>
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:11.99999995px;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;stroke-width:2.39571;fill:#ffffff">signalk-einklabel-plugin</tspan></text>
   <text
-     id="station.name-8-2"
+     id="last_repaint"
      x="4.3477793"
      y="201.9895"
      font-size="18"
@@ -81,10 +81,7 @@
      transform="scale(0.85412558,1.170788)"><desc
        id="desc12">source=einklabel,path=repainted,format=local_datetime_short</desc><tspan
        sodipodi:role="line"
-       id="tspan3"
-       x="4.3477793"
-       y="201.9895"
-       style="stroke-width:1.19309;-inkscape-font-specification:'Sans, Normal';font-family:Sans;font-weight:normal;font-style:normal;font-stretch:normal;font-variant:normal;font-size:13.33333347px;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal">Last updated 27 Jun 26 18:05</tspan></text>
+       id="tspan3">27 Jun 26 18:05</tspan></text>
   <text
      id="extremes.0"
      x="7.9661016"
@@ -92,7 +89,8 @@
      font-size="14"
      font-family="monospace"
      fill="black"
-     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:18.6667px;font-family:monospace;-inkscape-font-specification:'monospace, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ff0000">High Water</text>
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:18.6667px;font-family:monospace;-inkscape-font-specification:'monospace, Normal';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 Water</text>
   <text
      id="extremes.1"
      x="13.35283"
@@ -100,7 +98,8 @@
      font-size="14"
      font-family="monospace"
      fill="black"
-     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:18.6667px;font-family:monospace;-inkscape-font-specification:'monospace, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ff0000">Low Water</text>
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:18.6667px;font-family:monospace;-inkscape-font-specification:'monospace, Normal';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>Low Water</text>
   <text
      id="extremes.2"
      x="7.9661016"
@@ -108,7 +107,8 @@
      font-size="14"
      font-family="monospace"
      fill="red"
-     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:18.6667px;font-family:monospace;-inkscape-font-specification:'monospace, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#ff0000">High Water</text>
+     style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:18.6667px;font-family:monospace;-inkscape-font-specification:'monospace, Normal';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 Water</text>
   <text
      id="environment.time.timezoneRegion"
      x="338.47461"