@rhizomatics/signalk-einklabel-plugin 1.3.0-beta12 → 1.3.0-beta13

package/docs/examples/tide-clock.md

@@ -0,0 +1,93 @@
+# Tide Clock
+
+![Tide Clock](../assets/screenshots/example_tidal_clock.png)
+
+Template available as 416x240-BWRY for 3.7" ESLs and a simpler template, sized 250x128, also BWRY, for the cheapest 2.13" labels.
+
+This mini tide clock is a 2.9" Gicisky device, less than £10 inc delivery in summer 2026.
+
+![2.9" Tide Clock](../assets/images/mini_tidal_clock.png)
+
+## Pre-requisites
+
+A _tides_ provider plugin for the Resources API installed and enabled, currently one of:
+
+- [signalk-tides](https://github.com/openwatersio/signalk-tides) - uses [neaps](https://github.com/openwatersio/neaps) library for international off-line coverage
+- [signalk-mareas-ihm](https://github.com/Aitonos/signalk-mareas-ihm) - interfaces with official Spanish IHM tidal predictions, or falls back to Open Meteo and _signalk-tides_
+
+For versions with the moon phases:
+
+- [signalk-derived-data](https://github.com/SignalK/signalk-derived-data) - unlike other plugins, this publishes lunar and solar facts as SignalK paths
+
+The moon phase is optional - without it, the moon icon is simply left blank and the rest of the tide clock still shows.
+
+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 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.
+
+> [!TIP]
+> If testing this without a boat, you'll need another plugin to provide `navigation.position` and `navigation.datetime` to make the moon and tide calcuations work. [signalk-datetime](https://github.com/tmcolby/signalk-datetime) can be configured for the datetime, and [signalk-sailboat-simulator](https://github.com/macjl/signalk-sailboat-simulator) for the postion; other ways may work too.
+
+## Template Reference
+
+The `tides` template family picks the best size for each label automatically - see [Template Families](../templates.md#template-families-multiple-panel-sizescolours).
+
+<!-- BEGIN GENERATED: template-reference tides -->
+<!-- Generated from the bundled templates by `npm run docs:templates` - do not edit by hand. -->
+
+**Template:** `tides`
+
+| File                                                                                                                           | Size (px) | Aspect ratio | Colours                   | Fits these labels exactly                                                |
+| ------------------------------------------------------------------------------------------------------------------------------ | --------- | ------------ | ------------------------- | ------------------------------------------------------------------------ |
+| [`tides/416x240-BWRY.svg`](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/templates/tides/416x240-BWRY.svg) | 416 × 240 | 1.73 : 1     | black, white, red, yellow | Zhsunyco 3.7" BWRY                                                       |
+| [`tides/296x128-BWRY.svg`](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/templates/tides/296x128-BWRY.svg) | 296 × 128 | 2.31 : 1     | black, white, red, yellow | Zhsunyco 2.9" BWRY, Gicisky 2.9" BW, Gicisky 2.9" BWR, Gicisky 2.9" BWRY |
+| [`tides/250x128-BWRY.svg`](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/templates/tides/250x128-BWRY.svg) | 250 × 128 | 1.95 : 1     | black, white, red, yellow | Zhsunyco 2.13" BWRY, Gicisky 2.1" BWR                                    |
+
+**Data used**
+
+| Source                              | Path                         | Options                               | Used in                    |
+| ----------------------------------- | ---------------------------- | ------------------------------------- | -------------------------- |
+| `tides` resource (provider `tides`) | `extremes[n].label`          | -                                     | all                        |
+| `tides` resource (provider `tides`) | `extremes[n].level`          | category `depth`                      | all                        |
+| `tides` resource (provider `tides`) | `extremes[n].time`           | format `local_time`, format `day_mon` | all                        |
+| `tides` resource (provider `tides`) | `station.datums.HAT`         | category `depth`, round 1             | 416x240-BWRY               |
+| `tides` resource (provider `tides`) | `station.datums.LAT`         | category `depth`, round 1             | 416x240-BWRY               |
+| `tides` resource (provider `tides`) | `station.name`               | -                                     | all                        |
+| `tides` resource (provider `tides`) | `station.source.name`        | -                                     | 416x240-BWRY, 296x128-BWRY |
+| Plugin                              | `local_zone`                 | -                                     | 416x240-BWRY, 296x128-BWRY |
+| Plugin                              | `plugin_version`             | -                                     | 416x240-BWRY               |
+| Plugin                              | `repainted`                  | format `local_datetime_short`         | all                        |
+| Signal K path                       | `environment.moon.phaseName` | image from `lunar_phases`             | 416x240-BWRY               |
+
+<!-- END GENERATED -->
+
+The original single-file version is also still available as `tide.svg`:
+
+<!-- BEGIN GENERATED: template-reference tide.svg -->
+<!-- Generated from the bundled templates by `npm run docs:templates` - do not edit by hand. -->
+
+**Template:** `tide.svg`
+
+| File                                                                                               | Size (px) | Aspect ratio | Colours | Fits these labels exactly |
+| -------------------------------------------------------------------------------------------------- | --------- | ------------ | ------- | ------------------------- |
+| [`tide.svg`](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/templates/tide.svg) | 416 × 240 | 1.73 : 1     | -       | Zhsunyco 3.7" BWRY        |
+
+**Data used**
+
+| Source                              | Path                         | Options                               |
+| ----------------------------------- | ---------------------------- | ------------------------------------- |
+| `tides` resource (provider `tides`) | `extremes[n].label`          | -                                     |
+| `tides` resource (provider `tides`) | `extremes[n].level`          | category `depth`                      |
+| `tides` resource (provider `tides`) | `extremes[n].time`           | format `local_time`, format `day_mon` |
+| `tides` resource (provider `tides`) | `station.datums.HAT`         | category `depth`, round 1             |
+| `tides` resource (provider `tides`) | `station.datums.LAT`         | category `depth`, round 1             |
+| `tides` resource (provider `tides`) | `station.name`               | -                                     |
+| `tides` resource (provider `tides`) | `station.source.name`        | -                                     |
+| Plugin                              | `local_zone`                 | -                                     |
+| Plugin                              | `plugin_version`             | -                                     |
+| Plugin                              | `repainted`                  | format `local_datetime_short`         |
+| Signal K path                       | `environment.moon.phaseName` | image from `lunar_phases`             |
+
+<!-- END GENERATED -->

package/docs/examples/watch-schedule.md

@@ -0,0 +1,37 @@
+# Watch Schedule
+
+![Watch Schedule](../assets/screenshots/example_watch_schedule.png)
+
+Template available as 416x240-BWRY for 3.7" ESLs.
+
+## Pre-requisites
+
+- Source of `watch.current` and `watch.next` values
+  - `signalk-watch-schedule` plugin
+
+## Template Reference
+
+<!-- BEGIN GENERATED: template-reference watch -->
+<!-- Generated from the bundled templates by `npm run docs:templates` - do not edit by hand. -->
+
+**Template:** `watch`
+
+| File                                                                                                                           | Size (px) | Aspect ratio | Colours                   | Fits these labels exactly |
+| ------------------------------------------------------------------------------------------------------------------------------ | --------- | ------------ | ------------------------- | ------------------------- |
+| [`watch/416x240-BWRY.svg`](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/templates/watch/416x240-BWRY.svg) | 416 × 240 | 1.73 : 1     | black, white, red, yellow | Zhsunyco 3.7" BWRY        |
+
+**Data used**
+
+| Source        | Path                      | Options                       |
+| ------------- | ------------------------- | ----------------------------- |
+| Plugin        | `plugin_version`          | -                             |
+| Plugin        | `repainted`               | format `local_datetime_short` |
+| Signal K path | `watch.current.endTime`   | format `local_time`           |
+| Signal K path | `watch.current.startTime` | format `local_time`           |
+| Signal K path | `watch.current.teamName`  | -                             |
+| Signal K path | `watch.next.endTime`      | format `local_time`           |
+| Signal K path | `watch.next.startTime`    | format `local_time`           |
+| Signal K path | `watch.next.teamName`     | -                             |
+| Signal K path | `watch.system.name`       | -                             |
+
+<!-- END GENERATED -->

package/docs/extending.md

@@ -0,0 +1,33 @@
+# Extending
+
+## Architecture
+
+The primary things managed and provided by the plugin are:
+
+- ESL Vendor
+  - Sub-package per vendor
+- ESL Device
+  - Metadata in the vendor package, using a `pid` or sometimes `pid` combined with `hwid` in the BLE results to pinpoint a model
+- SVG Template
+- SignalK API base URL
+  - Used for automatic unit conversion on `signalk`-sourced numeric values and for resolving an explicit `category=` binding - neither has an in-process equivalent, both go via this server's own REST API
+  - Optional: left blank, the plugin probes the probable values in likelihood order at startup - `http://localhost:3000`, `http://localhost`, `https://localhost`. Set it explicitly to skip probing
+  - Either way, errors clearly if nothing responds (wrong port) or the probe is rejected (anonymous read access not enabled) - these endpoints must allow anonymous read access, since the plugin has no login flow
+
+## Hardware
+
+Additional vendors and devices can be added by a separate npm package that implements the `VendorDriver` interface and registers itself - there's no scanning of installed packages, registration is always an explicit call by the extension's own code.
+
+- `import esl from '@rhizomatics/signalk-einklabel-plugin'; esl.registerVendorDriver(myDriver)`
+- In the SignalK runtime, call this from the extension's own plugin `start()`. In the CLI, load the extension with `esl-cli --require <module> <command>`.
+- Declare this package as a regular npm `dependency` in the extension package - **not** a `peerDependency`, per SignalK's own guidance that npm's peer-dependency resolution interacts poorly with the server's plugin install layout - and declare the SignalK-level relationship via `"signalk": { "requires": ["@rhizomatics/signalk-einklabel-plugin"] }` in the extension's own `package.json` instead, so the App Store can install/report it.
+
+## Template Providers
+
+An alternative way to produce a device's content, alongside hand-authored SVG templates, can be added the same way - `esl.registerTemplateProvider({ suffix, listTemplates, render })`, from a separate package's own plugin `start()` (or `esl-cli --require <module>`). This is what [`@rhizomatics/signalk-einklabel-genai-plugin`](templates.md#genai-rendering) is: `listTemplates()` returns the entries it currently offers (already including its own `suffix`, e.g. `"forecast (GenAI)"`) for the "Template" dropdown, and `render(request)` - given the same signalk/resources/label context any SVG template's bindings get - returns a `Bitmap`, exactly as `SvgRenderer.render()` would. Rejecting from `render()` routes the repaint through this plugin's own generic fallback-warning template, the same as a broken hand-authored template failing to render.
+
+`esl.SvgRenderer`, `esl.buildLabel`, `esl.findBindingsInText`, and `esl.substituteBindingsInText` are also exported for a `TemplateProvider` extension to reuse - e.g. to resolve its own `{...}`-style placeholders against the request's context, or to rasterize whatever SVG it produces into the `Bitmap` its `render()` must return.
+
+## CLI Commands
+
+`esl-cli` can also be extended with new subcommands by a `-r/--require`'d package, which is how [`@rhizomatics/signalk-einklabel-genai-plugin`](templates.md#genai-rendering) adds its own `prompt`/`generate` commands for testing prompts without a device. See [Command Line Interface](cli.md) for the built-in commands.

package/docs/faq.md

@@ -0,0 +1,40 @@
+# Frequently Asked Questions
+
+## I can't see my device as a choice on the drop-down list after scan
+
+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.
+
+## Sometimes values are missing on the display
+
+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 it's still missing data.
+
+## Times are showing incorrectly
+
+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.
+
+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.
+
+## The ESL signal is too weak from my SignalK server
+
+See [Weak Signal](bluetooth.md#weak-signal).
+
+## Can't edit the text contents of SVG template in VSCode
+
+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
+
+Check if the text boxes are normal text or flowed text, and correct to normal text.
+
+## My label just shows "CONTENT UNAVAILABLE"
+
+That's the bundled fallback warning, not necessarily an error in this plugin - it means the most recent repaint failed, whatever produced the content (a broken hand-authored template, or a `TemplateProvider` extension like [`@rhizomatics/signalk-einklabel-genai-plugin`](templates.md#genai-rendering) - e.g. its LLM call failing on no network/API access, an invalid API key, or a response that wasn't a renderable SVG, after using up its configured retries). Check the SignalK server logs (debug logging on for this plugin) for the specific error, and if it's a GenAI device, check that plugin's own provider/API key/model settings. This plugin deliberately never leaves old content on screen when a repaint fails - it retries automatically at the next scheduled interval.
+
+## Bluetooth problems
+
+Choosing an adapter, adapters that stop responding, and Bluetooth starting after SignalK are covered on the [Bluetooth](bluetooth.md) page.

package/docs/getting-started.md

@@ -0,0 +1,111 @@
+# Getting Started
+
+## Pre-requisites
+
+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 requirements below are to make 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.
+
+This plugin can reach BLE hardware two ways - pick whichever fits your setup:
+
+- **Direct BlueZ access** (default) - the plugin talks to BlueZ over D-Bus itself. Requirements 1-3 below apply.
+- **SignalK BLE Manager API** (opt-in) - SignalK server >= 2.32.0 ships a [BLE Provider/Consumer API](https://github.com/SignalK/signalk-server/issues/2411) (admin UI: "BLE Manager") that arbitrates adapter access across every BLE-consuming plugin instead of each one grabbing `hci0` for itself, and can source BLE over a remote gateway instead of local hardware at all. Enable the "Use the SignalK BLE Manager API" setting in this plugin's config once it's available (it only appears once the running server has it) - requirements 1-3 below then become the SignalK server's problem, under its own Bluetooth admin settings, not this plugin's.
+
+1. A SignalK server, **running Linux** (direct BlueZ mode only - BLE Manager mode with a remote gateway provider has no such requirement)
+
+- MacOS and Windows aren't supported by the [BLE interface layer](https://www.npmjs.com/package/@naugehyde/node-ble) in direct BlueZ mode, 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) - direct BlueZ mode only; in BLE Manager mode this is whatever the server's own Bluetooth settings provide.
+
+- Bluetooth adapters for Linux can be tricky - see [Choosing a Bluetooth Adapter](bluetooth.md#choosing-a-bluetooth-adapter) for advice
+
+3. `bluez` package installed in Linux - direct BlueZ mode only
+
+- No need to do this if you have a Raspberry Pi with recent Raspian version, since bluez comes built in.
+- If you're not running a Raspberry Pi, then ensure that the `dbus` package is installed
+
+4. One or more supported Electronic Shelf Labels
+
+- The labels used for testing this are the [Zhsunyco 3.7" BWRY](https://www.aliexpress.com/item/1005010050104435.html) and a [Gicisky 2.9" BWRY](https://www.aliexpress.com/item/1005012933325056.html) - see [Supported Labels](#supported-labels)
+
+5. Correct time zone set on server if local time is to be shown on display
+
+- See [Times are showing incorrectly](faq.md#times-are-showing-incorrectly)
+- 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.
+
+## Installation
+
+Look for **eInk Label Displays** in the **SignalK AppStore** on your
+server ( under _Apps & Plugins_ on the latest version).
+
+### Using Outside of SignalK
+
+The plugin can also be installed as a stand-alone module, which can be useful for designing templates away from the boat, and makes available the `esl-cli` command line tool for scanning devices and debugging templates - see [Command Line Interface](cli.md).
+
+```bash
+npm install @rhizomatics/signalk-einklabel-plugin
+```
+
+## Configuration
+
+Use the standard configuration option in the SignalK menu for the plugin.
+
+![Plugin Configuration](assets/screenshots/plugin_config.png)
+
+## Setting up a Label
+
+Enable the plugin, and use the large **+** sign to add a label, which opens up these fields.
+
+![Label Config](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 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 (see [Examples](examples/README.md)), one you've added to the local templates directory, or - if a companion plugin like [`@rhizomatics/signalk-einklabel-genai-plugin`](templates.md#genai-rendering) is installed - one of its own contributed entries (shown with a suffix, e.g. "forecast (GenAI)")
+- _Location/description_ - Optional free-text notes on where this label is physically mounted/viewed from, e.g. "chart table, viewed from ~1m in poor light" - available to any template as `source=label,path=description` (see [Label Details](templates.md#label-details))
+- _Repaint Trigger_- Do you want this to repaint every few hours (at a chosen minutes past hour), or when a SignalK path changes?
+  - 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.
+
+The rest are grouped under _Advanced settings_, and can usually be ignored.
+
+- _If the render doesn't match the panel size_ - see [Reframing](templates.md#reframing)
+- _Compress upload_, _Mirror_ and _Wire format_ - see [Other Image Options](templates.md#other-image-options)
+- _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.)
+- _BLE AES key_ - Only needed if the default key doesn't work and you have a better alternative, otherwise ignore
+- _Paint connect timeout_ and _Paint retries_ for this device - leave blank to use the plugin-wide settings, or set them for a label that's slower to respond or further away than the others
+
+Configs saved by earlier versions are moved into this layout automatically when the plugin starts.
+
+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 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 [Troubleshooting](faq.md#i-cant-see-my-device-as-a-choice-on-the-drop-down-list-after-scan).
+
+## Supported Labels
+
+### Zhsunyco
+
+Also known as 'Suny' and 'WOLink'.
+
+- [BLE ESLs](https://www.zhsunyco.com/digital-display-solution-for-small-retail-business/ble-esl-solution/)
+  - The range of labels available on retail sites like AliExpress may be larger than on their corporate site
+  - In mid 2026, a 4 colour (BWRY) 3.7" label retailed for about $35, with quantity discounts for bulk sets
+  - Cheapest units are 2 colour 1.54", and they go up to 7.5"
+
+Python code for a variety of their labels at https://github.com/roxburghm/zhsunyco-esl and https://github.com/NickWaterton/Wolink
+
+### Gicisky
+
+Known by other names, e.g. 'Picksmart', and with white label brands
+
+- BLE ESLs
+  - Official store is on [AliExpress](https://www.aliexpress.com/store/911771479/pages/all-items.html?productGroupId=40000001654819&spm=a2g0o.store_pc_home.pcShopHead_6000727597996.1_1)
+  - Cheapest labels under £10 GBP / $13 USD

package/docs/templates.md

@@ -0,0 +1,142 @@
+# Templates
+
+Templates are simply SVG files, to which expressions can be added to use SignalK data, with options to make it easier to read, like rounding or simplifying dates and times. The template can have sample data in the placeholder, so is easy to layout and visualize.
+
+The bundled templates, with the sizes and data each one uses, are listed under [Examples](examples/README.md).
+
+## Template Families (multiple panel sizes/colours)
+
+A "Template" selection can either be one specific `.svg` file, or a _directory_ holding several versions of the same template for different panel sizes/colour-sets, e.g. `templates/tides/416x240-BWRY.svg` and `templates/tides/250x128-BWRY.svg` both implement the tide clock, just at different sizes.
+
+Each template is named `<width>x<height>-<colours>.svg`, where `<colours>` is one letter per supported colour: `B`(lack)/`W`(hite)/`R`(ed)/`Y`(ellow) - e.g. `BWRY` for a 4-colour panel, `BWR` for a 3-colour one.
+
+Selecting the directory (e.g. `tides`) instead of one file lets one `DeviceConfig` entry - especially a `device: "All discovered devices"` entry covering several different physical panels - automatically pick the best-fitting file for each device's actual size/colours, trying in order:
+
+1. An exact width/height/colour-set match.
+2. Failing that, width/height alone (any colour-set).
+3. Failing that too, the nearest width, tie-broken by whichever file's own height/width ratio is closest to the device's.
+
+## Reframing
+
+There's some wiggle room with the `reframe` options to use a template that's a bit too small, or too large, for the label, although best results come from a template that's precisely matching the pixel height and width of the label. Next best is template that has the same aspect ratio, so it can be cleanly scaled. `crop` is the 2nd least worst, though if its only a handful of pixels its often not worth worring about a separate template and `crop` is just fine. `scale` is likely to look worst, since it will force an image in regardless of aspect ratio.
+
+## Other Image Options
+
+Each label has a few more settings for how the image is sent, under _Advanced settings_. The CLI `paint` command has matching options (see [Command Line Interface](cli.md)), so you can try them on a label before changing the plugin config.
+
+- _Compress upload_ - on by default. Sends much less data over Bluetooth, so painting is quicker, uses less of the label's battery and is less likely to time out. Works for Zhsunyco labels and Gicisky 7.5"/10.2" labels, and is ignored for others. Turn it off if a label stops updating.
+- _Wire format (Gicisky, experimental)_ - `auto` by default. `chunked` sends a Gicisky 4.2" BWR label compressed, the same way as the 7.5"/10.2". The vendor's own app has been seen doing this, but it hasn't been tested on current firmware. Set it back to `auto` if the label stops updating.
+- _Mirror_ - `none` by default. `horizontal` or `vertical` fixes a label model whose image comes out mirrored. `both` rotates the image 180°, for a label that has to be mounted upside down.
+
+## Template Source Specification
+
+In the `description` of the SVG text box, use a comma separated set of key value pairs to define the data source and formatting.
+
+### SignalK Paths
+
+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
+
+The source can be overridden to use the SignalK server's Resources API instead. Change `source` to `resources` and specify which resource with `resource`. If there are multiple providers for the same resource, and they're not equally useful, then either set a default provider in SignalK, or use the `provider` tag to set the name.
+
+For example, `source=resources,resource=tides,provider=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. `provider` is optional, the default provider will be used if not specified.
+
+### Plugin Derived Data
+
+`source=einklabel` reads data injected by the plugin itself, rather than from SignalK. Available paths:
+
+- `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.
+
+### Label Details
+
+`source=label` reads facts about the label being painted, so one template can adapt to different labels. Available paths:
+
+- `path=description` - the label's _Location/description_ setting, e.g. `source=label,path=description`
+- `path=manufacturer` - the label's maker, e.g. `Zhsunyco`
+- `path=label` - the model's panel size, e.g. `3.7"`
+- `path=width` and `path=height` - the panel size in pixels
+- `path=colours` - the colours the panel can show, e.g. `black (#000000)`; add `format=csv` for a plain comma-separated list
+- `path=fonts` - the font families that are always available: `serif`, `sans-serif` and `monospace`
+- `path=position` - the vessel's position, rounded to about 1km
+
+These also work in the fallback warning shown when a template fails to render. Changing a label's description repaints it.
+
+### Customizing Output
+
+A `format` can be specified to make the value easier to understand. The supported formats are:
+
+- `local_time` - reduce a time stamp to just the time (H:M:S), omitting the date, and applying daylight savings if appropriate
+- `day_mon` - reduce a time stamp to day and month, e.g. `27 Jun`, applying daylight savings if appropriate
+- `local_datetime_short` - format a time stamp as day, abbreviated month, 2-digit year and 24h time, e.g. `21 Jun 26 18:05`, applying daylight savings if appropriate
+- `utc_offset` - Show a timezone in `UTC+01:00` style format
+- `position` - Format a `{ latitude, longitude }` value as decimal degrees with hemisphere letters, e.g. `56.6250°N 6.0700°W`
+- `raw` - Don't apply automatic SignalK unit conversion and symbol display (see below)
+
+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` - see [Times are showing incorrectly](faq.md#times-are-showing-incorrectly).
+
+#### Common categories
+
+- `depth` - Use the SignalK preferred depth unit, make the conversion if needed, and tack on the unit name as a suffix
+- `speed` - Use the SignalK preferred speed unit, make the conversion if needed, and tack on the unit name as a suffix
+- `temperature` - Use the SignalK preferred temperature unit, make the conversion if needed, and tack on the unit name as a suffix
+
+Additionally, `round=n` can be used to round to limited decimal places.
+
+`default=<value>` substitutes `<value>` whenever the resolved value is missing (e.g. an unpublished path), instead of falling through to an empty string - useful anywhere a blank would be misread as a real answer. `default=` with nothing after the `=` still counts as set, deliberately defaulting to an empty string rather than leaving the fallback behaviour unchanged.
+
+These can all be combined as in `source=resources,resource=tides,provider=tides,path=extremes[2].level,category=depth,round=2`
+
+## Non-Textual Fields (Images)
+
+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 - an `.assets/<name>` sub-directory looked up in your configured `templates` directory first, and the bundled `templates` directory otherwise. For example, the tide clock's moon phase icon uses:
+
+```
+path=environment.moon.phaseName,assets=lunar_phases
+```
+
+which resolves against `templates/.assets/lunar_phases/` (bundled, or your own configured `templates` directory's `.assets/lunar_phases/` if you have one). 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 omitted from that render - no broken image, no placeholder, nothing shown - and a line is logged to the console so a missing/unmatched value isn't silently invisible.
+
+If you don't like the bundled moon phase icons, save your own `<value>.svg` files in the `.assets/lunar_phases` sub-directory of your configured `templates` directory - the whole directory is used in place of the bundled one, so add all 8 phases you want to keep, not just the ones you're changing. These moon phases can be re-used in any other label.
+
+This is a general mechanism, not specific to moon phases - any `source`/`context`/`path`/`format` combination valid for a `<text>` binding works here too (a `source=resources` value, an explicit `category=`, etc.), the only difference is the required `assets=` directory and the "no match -> no image" behaviour instead of substituted text. To add your own, put a directory of `<value>.svg` files under an `.assets/<name>` sub-directory of your `templates` directory, add an `<image>` element in your SVG editor at the size/position you want, and give it a `<desc>` the same way you would a text field - overriding just the template, just its assets, or both together, all work independently.
+
+## Fonts
+
+Three font types are loaded by default, use the generic font family, or exact font name, in the SVG editor and choose size and weight (bold, semi-bold etc). Some labels will make a decent attempt to gray scale. Use the simple pure red, yellow, white, black to match the label's limited colour choice (some labels only offer black and white, or black/white/red). If a font can't be matched it will default to (sans-serif) Roboto.
+
+- `serif` - `Roboto Serif`
+- `sans-serif` - `Roboto`
+- `monospace` - `Roboto Mono`
+
+## Designing Templates
+
+Templates can be added to the configurable directory. [Inkscape](https://inkscape.org) free, open source, and recommended for editing templates, or your own favourite editor, or by hand in a text editor for hard core (or just tidying up the template side).
+
+![Example Field Definition](assets/screenshots/inkscape_desc.png)
+
+The object ID and label aren't used by the plugin, only the description is used to define fields. You can also add in ordinary text fields without field definitions, as labels, logos, help text etc.
+
+Placeholder text isn't necessary, and is ignored by the plugin, but makes it much easier to visualize the result.
+
+Inkscape adds its own metadata to images, which can be stripped off by exporting a simple SVG, although can be left in place with no harm; main reason to simplify the SVG is manual changes in a text editor.
+
+Due to a limitation in the `resvg-wasm` library used to turn SVGs into images, the `font-family` is limited to `serif`,`sans-serif`,`monospace` or the exact name of one of the installed fonts - `Roboto` (sans serif), `Roboto Serif` or `Roboto Mono`.
+
+Inkscape has its own fonts, which won't match what's available in the SignalK plugin, so for more precise design, install [Roboto from Google](https://fonts.google.com/specimen/Roboto) via the web page, `brew` on MacOS or similar.
+
+To try a template out without a label, or even without a SignalK server, use the CLI's `render` and `fields` commands - see [Debugging Templates](cli.md#debugging-templates).
+
+## GenAI Rendering
+
+As an alternative to hand-designed SVG templates, a device's content can be generated by an LLM instead - this is provided entirely by a separate companion plugin, [`@rhizomatics/signalk-einklabel-genai-plugin`](https://github.com/rhizomatics/signalk-einklabel-genai-plugin), not by this core plugin. The base plugin (BLE painting, SVG templates) has nothing to do with any LLM SDK or API key, so installing it never pulls in GenAI dependencies unless you also explicitly install and enable the companion plugin - the split is deliberate, for anyone on a small/constrained install or who'd simply rather not have any GenAI code in their install at all.
+
+Once the companion plugin is installed and enabled, its own config screen handles provider/model/API-key selection (OpenAI, Anthropic, Google, xAI, DeepSeek, Moonshot AI, Ollama, or any other OpenAI-compatible endpoint), and its prompts show up as ordinary entries in this plugin's "Template" dropdown, suffixed (e.g. "forecast (GenAI)") - pick one exactly like you'd pick a `.svg` file. Under the hood it's a `TemplateProvider` (see [Template Providers](extending.md#template-providers)) - the same extension mechanism a new vendor's hardware driver uses - so from this plugin's point of view it's just another way `templateName` gets resolved to an image.
+
+If the LLM call fails (network/API error, exhausted retries) or its response isn't renderable, this core plugin pushes its own bundled warning template instead of leaving the previous, possibly now-wrong, content on screen - so a stale weather prompt never quietly shows yesterday's forecast through today's storm. This is a generic safety net, not GenAI-specific: the exact same fallback covers a broken hand-authored template failing to render at all. The next scheduled repaint retries automatically. Since each repaint may call a (usually paid) LLM API, a GenAI-backed device should use Repaint Trigger `interval`, not `subscription`.
+
+See the companion plugin's own README for installing it, writing prompts, and its `esl-cli prompt`/`generate` commands for testing prompts without a device.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "1.3.0-beta12",
+  "version": "1.3.0-beta13",
   "description": "Display SignalK data on eInk Electronic Shelf Labels, includes working examples for tide clock and watch schedule.",
   "keywords": [
     "ble",
@@ -49,6 +49,8 @@
     "build": "tsc",
     "watch": "tsc --watch",
     "cli": "ts-node src/cli/index.ts",
+    "docs:dev": "npm --prefix site run dev",
+    "docs:templates": "ts-node src/docs/templateReference.ts && oxfmt docs/examples",
     "test": "node scripts/run-tests.js",
     "coverage": "node scripts/run-tests.js --coverage",
     "prepublishOnly": "npm run build",
@@ -95,7 +97,8 @@
     "recommends": [
       "@rhizomatics/signalk-einklabel-genai-plugin",
       "signalk-watch-schedule",
-      "signalk-tides"
+      "signalk-tides",
+      "signalk-derived-data"
     ]
   }
 }