Repository navigation
Releases
v1.3.3
🔐 SSL
- New "Allow self-signed certificates" setting, off by default. A SignalK server with SSL enabled redirects its http port to https, usually with a self-signed certificate, which the plugin previously rejected - so templates using the SignalK REST API (
category=or a resource pinned withprovider=) failed to render and the label showed the fallback warning. Turn the setting on for a server like this.
🐛 Bug fixes
- A render failure that paints the fallback warning on a label is now logged as an error, with its cause, rather than only in debug logging
- When the SignalK API URL can't be reached, the logged error now gives the underlying reason for each address tried, e.g. a self-signed certificate, rather than only suggesting the port or anonymous access; a certificate failure points to the new setting
BLE Manager
- The "Use the SignalK BLE Manager API" setting is now on by default. Servers without BLE Manager (before v2.31.0) fall back to direct BlueZ access, and existing configs that already saved the setting keep their value
- Recent SignalK versions identify Zhsunyco labels by manufacturer, shown as "WOESL" in the BLE Manager device list
Full Changelog: v1.3.2...v1.3.3
v1.3.2
🐛 Bug fixes
- On a SignalK server shutdown or admin UI restart (server v2.35.0+), the plugin now waits at most 5 seconds for a repaint in progress instead of 30, so it stops inside the server's shutdown deadline and the server can close the label's Bluetooth connection cleanly before exiting
📚 Documentation
- Bluetooth docs updated for the BLE Manager fixes in SignalK v2.34.0 and v2.35.0. v2.34.0 is now the practical minimum for BLE Manager, with v2.35.0 recommended. The BLE Manager setting stays off by default, since Zhsunyco labels not yet proven with it.
What's Changed
- Release to npm by staged trusted publishing by @jeyrb in #52
- Use prek and a 7-day npm release cooldown by @jeyrb in #51
- Cooldowns: 2 days for trusted packages, mise cooldown, drop pre-commit.ci by @jeyrb in #53
- Add 'managed by hq' and boat tech directory badges by @jeyrb in #54
Full Changelog: v1.3.1...v1.3.2
v1.3.1
🐛 Bug fixes
- Stopping the plugin mid-paint (saving its config, disabling it, or shutting down the server) now waits up to 30 seconds for that paint to finish, and starts no new paint or retry, so the restarted plugin no longer connects while the old Bluetooth session is still open
📚 Documentation
- Docs site made friendlier to AI coding agents: an llms.txt index plus the whole documentation as Markdown in
llms-full.txtandllms-small.txt, and every page available as Markdown by replacing its trailing/with.md(e.g. getting-started.md)
What's Changed
- Bump svgo from 4.0.2 to 4.1.0 in /site by @dependabot[bot] in #15
- Bump devalue from 5.8.1 to 5.9.2 in /site by @dependabot[bot] in #23
- Bump js-yaml from 4.3.1 to 4.3.2 in /site by @dependabot[bot] in #20
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #32
- Bump actions/upload-pages-artifact from 3 to 5 by @dependabot[bot] in #28
- Bump actions/deploy-pages from 4 to 5 by @dependabot[bot] in #27
- Bump actions/setup-node from 6 to 7 by @dependabot[bot] in #30
- Bump codecov/codecov-action from 5 to 7 by @dependabot[bot] in #29
- Bump actions/configure-pages from 5 to 6 by @dependabot[bot] in #31
- Bump source-map-js from 1.2.1 to 1.2.2 in /site by @dependabot[bot] in #33
- Bump devalue from 5.9.2 to 5.9.4 in /site by @dependabot[bot] in #34
- Bump sharp from 0.35.4 to 0.35.5 in /site by @dependabot[bot] in #35
- ci: pin shared admin workflows to rhizomatics/.github 1.0.0 by @jeyrb in #36
- Bump the npm group with 4 updates by @dependabot[bot] in #37
- Add CLAUDE.md for coding agents by @jeyrb in #38
- Keep personal Claude Code permissions out of the repo by @jeyrb in #39
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #40
- Set engines per SignalK versions policy (node >=22, signalk-server >=2.25.0) by @jeyrb in #41
- Bump the npm_and_yarn group across 1 directory with 2 updates by @dependabot[bot] in #42
- CLAUDE.md: plugin-ci no longer runs Node 20/armv7 by @jeyrb in #43
- Bump undici from 8.11.2 to 8.12.3 in /site in the npm_and_yarn group across 1 directory by @dependabot[bot] in #44
- Bump the npm group with 5 updates by @dependabot[bot] in #45
- BUILD.md: release recipe that never moves version tags by @jeyrb in #47
- Bump zod from 4.6.5 to 4.6.7 in /site in the npm_and_yarn group across 1 directory by @dependabot[bot] in #46
- Replace AGENTS.md symlink so Windows plugin CI passes by @jeyrb in #48
- pre-commit: pin node for nodeenv-managed hooks by @jeyrb in #49
- stop(): wait (bounded) for an in-flight repaint before resolving by @jeyrb in #50
Full Changelog: v1.3.0...v1.3.1
v1.3.0
1.3.0
BLE Manager
First implementation of using new SignalK BLE Manager rather than directly using the bluez services.
- Off by default until longer term stability demonstrated.
- It may be less reliable for some devices that can be reached with direct bluez access - try it and fall back to the direct mode if so.
- Issues with Zhsunyco are detailed in the Bluetooth docs, with a list of the fixes awaited upstream in SignalK. A Gicisky label has worked with it.
- BLE Manager use reduces interference between plugins competing for same BLE devices
- Recommend using SignalK at least release v2.33.0.
Compression
Images are now compressed before sending - no change to what's displayed, but send time is massively reduced for labels with lots of empty space, so less battery is used and sends are less likely to fail.
- On by default for Zhsunyco labels and Gicisky 7.5"/10.2" labels; can be turned off per label, or with
--no-compresson the CLI - Experimental opt-in Wire format
chunkedsends a Gicisky 4.2" BWR compressed too (--compression-format chunkedon the CLI)
Templates
- Simplified use of
labelandeinklabelas a source of template fields, now onlylabelneeded, thougheinklabelwon't break existing templates
Advanced Options
Connect timeout and retries can now be defined per label.
SignalK Base URL now accepts a free-text value
Some labels may need images flipped, so a per-label Mirror option can flip the image horizontally, vertically, or both (rotate 180°, for a label mounted upside down). Also available as --mirror on the CLI paint and render commands.
Different 'chunking' options to help with new label models.
All the advanced options now grouped together to make the config clearer. Note that if you roll back to a previous version you may have to re-enter these values (they are automatically moved to the new section when upgrading).
Dependencies
xmldomupdated to fix security issue with markup injection
1.2.3
- Improved example tide template for 2.9" Gicisky, and added blank and error templates
Full Changelog: v1.2.3...v1.3.0
v1.2.2
- Fully implemented the backoff and retry logic on failed paint, by default after 30s
- Auto reframe now happens in main plugin as well as CLI
- Auto reframe now defaults to
cropfor CLI, can be overidden back tofixed - Handle Gicisky stale cache paint failures by prompting a re-scan when necessary
- Improve background default for
cropreframing
What's Changed
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #10
- Bump @fontsource/roboto-serif from 5.2.9 to 5.3.0 by @dependabot[bot] in #3
- Bump @types/node from 20.19.43 to 26.4.0 by @dependabot[bot] in #4
- Bump postcss from 8.5.19 to 8.5.26 in /site by @dependabot[bot] in #9
- Bump js-yaml from 4.3.0 to 4.3.1 in /site by @dependabot[bot] in #8
New Contributors
- @pre-commit-ci[bot] made their first contribution in #10
Full Changelog: v1.2.1...v1.2.2
v1.2.1
1.2.1
- Additional tide template for 296x128
1.2.0
- Added support for Gicisky labels (also known by other brands), tested with a 2.9" BWRY model
- CLI render command use template height and width as defaults, can still be overridden by arguments to preview particular size of label
- CLI paint commands use label height and width as defaults, overridden by arguments if needed
- CLI paint command now has a
--reframeoption for labels that don't match template size, so can quickly test a label without having perfect template right away
1.1.0
- Label images can now optionally be emailed to an address every time they change, including a table of fields and values used to complete the template, or the prompt if genai based
1.0.0
Full Release
- The
1.0.0reflects that this plugin has been working in real environment for months, and has been refactored for better extensibility
Extension Support
- Custom templates and CLI commands can now be provided by a different plugin
- Initially this is to support
signalk-einklabel-genai-pluginwhich can use a prompt to make an image using a GenAI service like Anthropic or local Ollama
Full Changelog: v0.10.1...v1.2.1
v0.10.1
- Test fixes
- Moved blank templates to
.blankdirectory and suppressed from drop down selection - Added recommendations for
signalk-tidesandsignalk-watch-scheduleplugins
Full Changelog: v0.10.0...v0.10.1
v0.10.0
Watch Schedule Example
- New template to show current and next crew watch, using
signalk-watch-scheduleplugin
CLI / Debugging
fieldscommand now reports where text field definitions can't be interpreted- Epoch style timestamps now automatically handled as if proper date time for format options
Full Changelog: v0.9.1...v0.10.0
v0.9.1
- Fix for upstream EventEmitter leak in
@naugehyde/node-ble
Full Changelog: 0.9.0...v0.9.1
v0.9.0
Tide Clock Example
- Rename
third_quartertolast_quarterfor moon phase icons intemplates/.assets/lunar_phasesto match Derived Data plugin tide.svgrenamed totides\416x240-BWRY.svg. Original maintained but labelled as deprecated- Added a simpler 250x128 version of tide clock for 2.13" labels
Fixes
- 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
- Repaint state used to track which labels to repaint separately tracks the template
nearestColouralgorithm in Zhsunyco driver supports ESLs that only have BWR or BW
Device Selection
- New 'ALL' as device option, and by default disable initial scan, to optimize support for single devices, so can configure and go without waiting for scan
- Scan and explicit device selection only required for boats with multiple ESL devices
Templating
- Now support a directory of templates, where each is named like
416-240-BWRY.svgto support same functions on different devices. - Picks the template within the directory that most closely matches the tide clock height/width/colour-set, if not matched then height/width, and then best h/w ratio for nearest width
template/assetsis nowtemplate/.assets
Full Changelog: v0.8.2...0.9.0