@rhizomatics/signalk-einklabel-plugin 0.6.0 → 0.6.1

package/CHANGELOG.md

@@ -1,7 +1,13 @@
+# 0.6.1
+- Corrected tide lunar phase path from `environment.moonPhase.name` to `environment.moon.phaseName`
 # 0.6.0
-- Added ability to select images for inclusion in SVG templated based on SignalK value
+- Added ability to select images for inclusion in SVG templates based on SignalK path value
+  - Pass a directory of assets, and it will pick the SVG file matching the SignalK value
+  - Matching will cope with "Waning Gibbous" -> `waning_gibbous.svg`
+  - If no match, image will be blank
 - New image selection used to add lunar phase to tide clock example
-  -  Requires a source for `environment.moonPhase.name`, for example the `dervived-data` plugin
+  -  Requires a source for `environment.moon.phaseName`, for example the `dervived-data` plugin
+- New `resources` directory for composable SVG assets
 # 0.5.1
 - Work around `resvg-wasm` font limitations by overriding generic font family with matching font name prior to rendering
 # 0.5.0

package/README.md

@@ -1,18 +1,23 @@
 # eInk Labels for SignalK
 
-** BETA - basic functionality, limited vendor/product support **
+** Fully working but limited vendor/product support **
 
-A SignalK plugin to display data from SignalK paths, APIs and plugins on Electronic Shelf Labels over a Bluetooth Low Energy (BLE) connection using simple SVG templates.
+A SignalK plugin to display data from SignalK paths, APIs and plugins on Electronic Shelf Labels (ESL) over a Bluetooth Low Energy (BLE) connection using simple SVG templates.
 
-Electronic Shelf Labels (ESLs) 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.
+## What is an ESL?
 
-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.
+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.
+
+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.
 
-Unlike some eInk projects, this plugin doesn't require any physical modification to the labels, or loading any new firmware. It can send an image to a supported shelf label fresh out of the box.
 
 ## Pre-requisites
 
-Most of this is about making SignalK work with Bluetooth Low Energy, which is good thing to have anyway, since vendors like Victron, Switchbot, Ruuvi and others have BLE enabled hardware that's useful to have on a boat. [Direct BLE support](https://github.com/SignalK/signalk-server/issues/2411) in SignalK is being planned in 2026.
+Unlike some eInk projects, this plugin doesn't require any physical modification to the labels, or loading any new firmware. It can send an image to a supported shelf label fresh out of the box.
+
+Most of these requirements are about making SignalK work with Bluetooth Low Energy, which is good thing to have anyway, since vendors like Victron, Switchbot, Ruuvi and others have BLE enabled hardware that's useful to have on a boat. [Direct BLE support](https://github.com/SignalK/signalk-server/issues/2411) in SignalK is being planned in 2026.
 
 1. A SignalK server, preferably running Linux (MacOS does weird things with bluetooth)
 2. A Bluetooth adapter, that can handle BLE (Bluetooth Low Energy), which is Bluetooth v4.0 or higher
@@ -53,7 +58,7 @@ npm install @rhizomatics/signalk-einklabel-plugin
 
 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.
 
-To show the lunar phase, the `environment.moonPhase.name` path is required, which can
+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.
 
 ## Templating
@@ -109,7 +114,7 @@ These can all be combined as in `source=resources,resource=tides,path=extremes[2
 The same `<desc>` mechanism works on an `<image>` element instead of a `<text>` element, for a value that's better shown as a picture than as text - a moon phase icon, a wind direction arrow, a weather condition glyph, and so on. Rather than substituting text, the resolved value picks one of a directory of `.svg` files to embed, by an extra required `assets=` key naming that directory (resolved relative to the template file itself, so a bundled template and a user override both work the same way). For example, the tide clock's moon phase icon uses:
 
 ```
-path=environment.moonPhase.name,assets=../resources/svg/lunar_phases
+path=environment.moon.phaseName,assets=../resources/svg/lunar_phases
 ```
 
 The resolved value (e.g. `"Waning Gibbous"`, as published by the [derived-data](https://www.npmjs.com/package/signalk-derived-data) plugin) is normalized to match a filename - lower-cased, punctuation and spaces collapsed to underscores - so `"Waning Gibbous"` picks `waning_gibbous.svg` out of that directory. If the underlying path has no value at all (e.g. the `derived-data` plugin isn't installed), or the value doesn't normalize to any file in the directory, the `<image>` element is simply omitted from that render - no broken image, no placeholder, nothing shown.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "0.6.0",
-  "description": "SignalK plugin that renders selected SignalK data to eInk Electronic Shelf Labels",
+  "version": "0.6.1",
+  "description": "Display SignalK data on eInk Electronic Shelf Labels",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
@@ -23,7 +23,7 @@
     "prepublishOnly": "npm run build"
   },
   "signalk": {
-    "displayName": "eInk Label Instruments",
+    "displayName": "eInk Label Displays",
     "appIcon": "docs/assets/icons/icon_tmp.png",
     "screenshots": [
       "docs/assets/screenshots/example_tidal_clock.png"
@@ -38,7 +38,8 @@
     "esl",
     "display",
     "instrument",
-    "ble"
+    "ble",
+    "tides"
   ],
   "engines": {
     "node": ">=18"

package/templates/tide.svg

@@ -269,4 +269,4 @@
      id="moon_phase"
      x="340.3974"
      y="90.153488"><desc
-       id="desc22">path=environment.moonPhase.name,assets=../resources/svg/lunar_phases</desc></image></svg>
+       id="desc22">path=environment.moon.phaseName,assets=../resources/svg/lunar_phases</desc></image></svg>