@rhizomatics/signalk-einklabel-plugin 0.10.0 → 0.10.1

package/CHANGELOG.md

@@ -1,9 +1,17 @@
 # 0.10.1
 
+- Test fixes
+- Moved blank templates to `.blank` directory and suppressed from drop down selection
+- Added recommendations for `signalk-tides` and `signalk-watch-schedule` plugins
+
+# 0.10.0
+
 ## Watch Schedule Example
+
 - New template to show current and next crew watch, using `signalk-watch-schedule` plugin
 
 ## CLI / Debugging
+
 - `fields` command now reports where text field definitions can't be interpreted
 - Epoch style timestamps now automatically handled as if proper date time for format options
 
@@ -21,8 +29,7 @@
 
 ## Fixes
 
-- Fix configuration JSON holding older versions of itself as subentries
-  and data changes
+- Fix configuration JSON holding older versions of itself as subentries and data changes
 - Fix most cases of scanned devices not appearing in device dropdown choice
 
 ## Improvements

package/README.md

@@ -7,10 +7,10 @@
 [![code style: oxfmt](https://img.shields.io/badge/code_style-oxfmt-blue.svg)](https://github.com)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/LICENSE)
 
-    Fully working but limited vendor/product support and requires Linux for device access.
-
 A SignalK plugin to display data from SignalK paths, Resource APIs and plugins on Electronic Shelf Labels (ESL) over a Bluetooth Low Energy (BLE) connection using simple SVG templates.
 
+![Companionway Tidal Clock](docs/assets/images/real_tidal_clock.jpg)
+
 ## 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 (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.
@@ -27,13 +27,13 @@ Most of requirements below are to make SignalK work with Bluetooth Low Energy, w
 
 1. A SignalK server, **running Linux**
 
-- MacOS and Windows aren't supported by the [BLE interface layer](https://www.npmjs.com/package/@naugehyde/node-ble), however can be used for template development and
+- MacOS and Windows aren't supported by the [BLE interface layer](https://www.npmjs.com/package/@naugehyde/node-ble), however they can be used for template development and
   debugging (everything except `scan` and `paint`)
 
 2. A Bluetooth adapter, that can handle BLE (Bluetooth Low Energy).
 
 - Bluetooth adapters for Linux can be tricky, TP-Link UB400 and Asus USB-BT500 are two well-known and available ones
-- Some Raspberry Pi models come with suitable Bluetooth it built-in
+- Some Raspberry Pi models come with suitable Bluetooth built in
 - Don't worry about the very latest Bluetooth versions, 4.0 is minimum for BLE, 5.0 is nice
 - Home Assistant is massively more popular than SignalK, and often also run on Raspberry Pi and similar, so good source of advice
 
@@ -44,14 +44,14 @@ Most of requirements below are to make SignalK work with Bluetooth Low Energy, w
 
 4. One or more supported Electronic Shelf Labels
 
-- The label used for testing this is the [ZhunyCo 3.7" BRWY](https://www.aliexpress.com/item/1005010050104435.html)
+- The label used for testing this is the [Zhsunyco 3.7" BWRY](https://www.aliexpress.com/item/1005010050104435.html)
 
 5. Correct time zone set on server if local time is to be shown on display
 
 - See [FAQ](#faq-timezone)
 - If not set, everything will work, but you may see the wrong zone or not have daylight savings applied
 
-Once you have all of that, it may be worth also installing [signalk-victron-ble](https://github.com/stefanor/signalk-victron-ble),[signalk-ruuvitag-plugin](https://github.com/vokkim/signalk-ruuvitag-plugin) or [bt-sensors-plugin](https://github.com/naugehyde/bt-sensors-plugin-sk) to pull in data from other sensors and equipment.
+Once you have all of that, it may be worth also installing [signalk-victron-ble](https://github.com/stefanor/signalk-victron-ble), [signalk-ruuvitag-plugin](https://github.com/vokkim/signalk-ruuvitag-plugin) or [bt-sensors-plugin](https://github.com/naugehyde/bt-sensors-plugin-sk) to pull in data from other sensors and equipment.
 
 ## Installation
 
@@ -89,7 +89,7 @@ A _tides_ provider plugin for the Resources API installed and enabled, currently
 
 The [tides](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/templates/tides/) templates can be customized to run with any tide provider, a specific one, or switch to other APIs or SignalK data paths.
 
-- In the template it uses a SVG description like `source=resources,resource=tides,provider=tides,path=extremes[0].time,format=local_time` to get the first tide time, ensures its the preferred `signalk-tides` provider and makes it a simple local time rather than a UTC date time.
+- In the template it uses a SVG description like `source=resources,resource=tides,provider=tides,path=extremes[0].time,format=local_time` to get the first tide time, ensures it's 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.
@@ -107,29 +107,29 @@ Template available as 416x240-BWRY for 3.7" ESLs.
 
 ## Setting up a Label
 
-Enable the plugin, and use the large **+** sign to add a label, which open up these fields.
+Enable the plugin, and use the large **+** sign to add a label, which opens up these fields.
 
 ![Label Config](docs/assets/screenshots/label_config.png)
 
 - _Friendly Name_ - Give the label any name (word or phrase) you like, for example 'Tide Clock'
-- _Device_ - Unless you have multiple labels, don't bother with pre-scanning or selecting a specifig device, instead pick **"All discovered devices"** and it will paint any compatible labels it finds. If you want to pick a specific device, you'll need to wait for a device scan to complete.
+- _Device_ - Unless you have multiple labels, don't bother with pre-scanning or selecting a specific device, instead pick **"All discovered devices"** and it will paint any compatible labels it finds. If you want to pick a specific device, you'll need to wait for a device scan to complete.
 - _Template_ - Choose a built in template, or one you've added to the local templates directory
 - _Repaint Trigger_- Do you want this to repaint every few hours (at a chosen minutes past hour), or when a SignalK path changes?
-  - If its a SignalK path, enter it next, for example `environment.tide.state`
-  - If its time based, enter how many hours between repaints, for example 00:00/08:00/16:00 for an 8h schedule, and if you want a specific number of minutes after the hour.
+  - If it's a SignalK path, enter it next, for example `environment.tide.state`
+  - If it's time based, enter how many hours between repaints, for example 00:00/08:00/16:00 for an 8h schedule, and if you want a specific number of minutes after the hour.
 
 There are also two more advanced options, which can usually be ignored.
 
 - _BLE AES key_ - Only needed if the default key doesn't work and you have a better alternative, otherwise ignore
 - _Force Repaint_ - Next time the label is due to be painted, update even if the data or template hasn't changed (this flag will automatically be cleared after this.)
 
-When the plugin starts, it will automatically re-paint the label if its new, or the last timed slot was missed and the data has changed.
+When the plugin starts, it will automatically re-paint the label if it's new, or the last timed slot was missed and the data has changed.
 
 ### Scanning for Devices
 
 Since these are ultra-low power devices, they don't respond instantly to either identify themselves or accept a new image. By default, both scanning and painting have time-outs to wait for a response, which can be altered in the plugin configuration or CLI argument.
 
-One other quirk is that some devices respond with a different name at different times, for example the genric `WOESL` sometimes and model specific `WL17500C74` other times. However, the MAC address, e.g. `66:66:17:50:0D:2B` is constant, and this is what's tracked by the plugin.
+One other quirk is that some devices respond with a different name at different times, for example the generic `WOESL` sometimes and model specific `WL17500C74` other times. However, the MAC address, e.g. `66:66:17:50:0D:2B` is constant, and this is what's tracked by the plugin.
 
 The plugin can optionally re-scan whenever it starts up (off by default), although this isn't essential once a label has been configured. Devices found by any scan are remembered across restarts - see the FAQ below.
 
@@ -257,7 +257,7 @@ See also the commands useful for debugging under [Developing Templates]
 - `render` - transform an SVG template and data into a PNG
 - `paint` - render an SVG template and data to a selected ESL
 
-The width, height, vertical offset and colour palette for the device is taken from the internal register of devices, however can be overridden on the command line. This could be used to help you choose what size of label to buy, or to get an unsupported label working.
+The width, height, vertical offset and colour palette for the device are taken from the internal register of devices, however can be overridden on the command line. This could be used to help you choose what size of label to buy, or to get an unsupported label working.
 
 ( The CLI can also be run from a checked out module, or by opening a terminal shell at `~/.signalk/node_modules/@rhizomatics/signalk-einklabel-plugin`, as `npx esl-cli command --args` )
 
@@ -351,7 +351,7 @@ For example, `npx esl-cli fields -t templates/tide.svg -e examples` will show al
 
 ### I can't see my device as a choice on the drop-down list after scan
 
-SignalK plugins lack ability to self-update after something like a scan, so first time round you may have to close the config and reload it to see this. Subsequently the plugin will remember all scanned devices, and only drop previously seen ones if it goes 24 hours without a positive scan or with failed paint attempts.
+SignalK plugins lack the ability to self-update after something like a scan, so first time round you may have to close the config and reload it to see this. Subsequently the plugin will remember all scanned devices, and only drop previously seen ones if it goes 24 hours without a positive scan or with failed paint attempts.
 
 Easiest way to solve this is to choose 'All Discovered Devices' in the device configuration, and it will paint any compatible devices it finds on future scans.
 
@@ -359,12 +359,12 @@ Easiest way to solve this is to choose 'All Discovered Devices' in the device co
 
 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 it's still missing data.
 
 ### Times are showing incorrectly {#faq-timezone}
 
 If times are in the wrong timezone, or don't have daylight savings applied correctly,
-then check that the server itself (at the Linux level, not SignalK, which doesn't know)is configured for your timezone, assuming of course that you're a coastal sailor. Use `raspi-config` on a Raspberry Pi, or `timedatectl` on a Linux server.
+then check that the server itself (at the Linux level, not SignalK, which doesn't know) is configured for your timezone, assuming of course that you're a coastal sailor. Use `raspi-config` on a Raspberry Pi, or `timedatectl` on a Linux server.
 
 If you're a global cruiser, then use something like [signalk-set-gps-timezone](https://github.com/hoeken/signalk-set-gps-timezone) to set the value in the operating system.
 
@@ -374,7 +374,7 @@ 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_.
+If you have an SVG viewer extension, this will 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_.
 
 ### Description is set in InkScape but doesn't render
 
@@ -383,7 +383,7 @@ Check if the text boxes are normal text or flowed text, and correct to normal te
 ## 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.
-- [zhsynyco-esl](https://github.com/roxburghm/zhsunyco-esl) - Python interface
+- [zhsunyco-esl](https://github.com/roxburghm/zhsunyco-esl) - Python interface
 - [WoLink](https://github.com/NickWaterton/Wolink) - Python interface and protocol analysis
 - [e-ink dashboard for Signal K](https://github.com/meri-imperiumi/dashboard) - Waveshare display based multi instrument display.
 - [eInk Dashboard Modern SK](https://github.com/VladimirKalachikhin/e-inkDashboardModernSK) - SignalK dashboard for non-ESL eInk display.

package/dist/config.js

@@ -200,7 +200,13 @@ function listTemplateVariants(dir) {
         .map(parseTemplateVariant)
         .filter((variant) => variant !== undefined);
 }
-/** A directory only counts as a template-family option if it actually has at least one parseable variant file in it - otherwise it's something else entirely, e.g. `.assets`. */
+/**
+ * A directory only counts as a template-family option if it actually has at least one parseable
+ * variant file in it - otherwise it's something else entirely, e.g. `.assets`. Dot-prefixed
+ * directories (e.g. `.assets`, `.blank`) are always excluded, even if they happen to contain
+ * parseable variant files, since they're reserved for non-template-option use (asset bundles,
+ * work-in-progress templates not ready to appear in the dropdown, etc).
+ */
 function listTemplateFamilies(dir) {
     let entries;
     try {
@@ -210,7 +216,7 @@ function listTemplateFamilies(dir) {
         return [];
     }
     return entries
-        .filter((entry) => entry.isDirectory() && listTemplateVariants((0, path_1.join)(dir, entry.name)).length > 0)
+        .filter((entry) => entry.isDirectory() && !entry.name.startsWith(".") && listTemplateVariants((0, path_1.join)(dir, entry.name)).length > 0)
         .map((entry) => entry.name);
 }
 /** Local templates (files or template-family directories) take priority over a same-named bundled one; both show up as options. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "description": "Display SignalK data on eInk Electronic Shelf Labels",
   "keywords": [
     "ble",
@@ -8,12 +8,12 @@
     "eink",
     "esl",
     "instrument",
-    "watch-schedule",
     "signalk",
     "signalk-category-hardware",
     "signalk-category-instruments",
     "signalk-node-server-plugin",
-    "tides"
+    "tides",
+    "watch-schedule"
   ],
   "homepage": "https://github.com/rhizomatics/signalk-einklabel-plugin#readme",
   "bugs": {
@@ -83,6 +83,10 @@
       "docs/assets/screenshots/example_watch_schedule.png",
       "docs/assets/screenshots/plugin_config.png",
       "docs/assets/screenshots/label_config.png"
+    ],
+    "recommends": [
+      "signalk-watch-schedule",
+      "signalk-tides"
     ]
   }
 }

package/templates/watch/416x240-BWRY.svg

@@ -171,7 +171,7 @@
    y="205.40628"
    style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:26.6667px;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;fill:#1a1a1a;stroke:none;stroke-width:0.612283"><desc
    id="desc3">path=watch.next.endTime,format=local_time</desc>20:00</text>
-   
+
      <rect
    style="fill:#ff0000;stroke:none;stroke-width:2.621;stroke-dasharray:none;stroke-opacity:1"
    id="rect15"