sailkick-boat 0.19.0 → 0.20.1

package/README.md

@@ -257,8 +257,12 @@ worth designing properly rather than guessing at, so for now they are simply sep
 ## Local history (offline Trends + track)
 **One source: a live ring**, sampled from the same BoatState that feeds `/ws/telemetry`
 — no database, works on a Victron GX with nothing else installed. `historyAvailable` is
-forced on so the app shows the Trends panel, and the eight channels match what the cloud
-serves, `stw` included.
+forced on so the app shows the Trends panel, and the **nineteen channels match what the
+cloud serves** — wind (true/apparent, speed/angle/direction), SOG/STW/COG/heading, depth,
+VMG, sea and air temperature, port and starboard revs, and the four active-waypoint
+values. So an instrument cell's history flyout shows the same thing whichever provider is
+answering. A channel with no data is simply absent: a boat with no paddlewheel has no
+`stw`, and the waypoint channels appear only while a destination is active.
 
 There is deliberately **no way to point this at a local InfluxDB**. Until v0.15.0 a read
 token did exactly that, and it was a trap: the app only ever asks for a *relative* window
@@ -482,8 +486,21 @@ Point your chart app / browser at:
 ```bash
 cd ~/.signalk && npm install sailkick-boat   # or a packed tarball
 ```
-Enable + configure under **Server → Plugin Config → "Sailkick boat companion"**.
-Set **Data directory** to a path on the SSD (or leave blank for the plugin data dir).
+The plugin **enables itself on install** and appears in Signal K's **Webapps** menu as
+**Sailkick** — a launcher with two entries, "Open Sailkick" (full app) and "Open on
+phone" (mobile view). Both point at the mirror on this boat, so nothing has to be typed
+by hand. One npm package can only produce one menu item — Signal K dedupes webapps by
+package name — hence one launcher rather than two entries.
+
+Nothing is uploaded by enabling it. Telemetry sync needs an account write token and
+refuses to start without one; AIS upload and the backfill are off by default; and the
+worldwide base-map seed is skipped entirely on an unpaired boat, so a fresh install
+downloads only what you actually look at. **The whole app works with no account** —
+charts, instruments, trends, AIS, routes and polars are all served from the boat. An
+account adds cloud sync, off-boat access and long-term history.
+
+Set **Data directory** to a path on the SSD (or leave blank for the plugin data dir) —
+that is the one setting worth changing straight away.
 
 ### Victron GX / Venus OS (Cerbo, Ekrano)
 Works on Venus OS Large (Signal K enabled). Point **Data directory** at USB/SD storage

package/index.js

@@ -98,6 +98,8 @@ module.exports = function (app) {
   let ais = null
   let aisTargets = null
   let profile = null
+  let proxyPort = null // what the launcher page needs to build its links
+  let pairedSlug = null
   let statusTimer = null
   let accountStatus = null
   let syncWarning = null
@@ -264,7 +266,7 @@ module.exports = function (app) {
       const pOpts = {
         sailkickUrl: upstream.url,
         storeDir: store,
-        proxyPort: p.proxyPort == null ? 8080 : p.proxyPort,
+        proxyPort: (proxyPort = p.proxyPort == null ? 8080 : p.proxyPort),
         localSignalkUrl: p.localSignalkUrl || 'http://127.0.0.1:3000',
         localPaths: (p.localPaths && p.localPaths.length) ? p.localPaths : PROXY_TUNING.localPaths,
         telemetryPath: p.telemetryPath || PROXY_TUNING.telemetryPath,
@@ -457,6 +459,8 @@ module.exports = function (app) {
     ais = null
     aisTargets = null
     profile = null
+    proxyPort = null
+    pairedSlug = null
     proxy = null
     accountStatus = null
     syncWarning = null
@@ -465,6 +469,19 @@ module.exports = function (app) {
   // Mounted by Signal K at /plugins/sailkick-boat. Handlers dispatch to the live
   // proxy module (created in start), so enable/disable works at request time.
   plugin.registerWithRouter = function (router) {
+    // Read by the launcher page (public/index.html), which Signal K serves at
+    // /sailkick-boat/. That page lives outside this process and cannot know which port
+    // the mirror was configured on, so it asks. `paired` drives the hint about cloud
+    // sync; `running` distinguishes "plugin off" from "mirror port disabled".
+    router.get('/info', (req, res) => {
+      res.json({
+        ok: true,
+        running: !!proxy,
+        port: proxyPort,
+        paired: !!pairedSlug,
+        version: (() => { try { return require('./package.json').version } catch { return null } })()
+      })
+    })
     router.get('/p/*', (req, res) => {
       if (proxy) proxy.handleGet(req, res)
       else res.status(503).send('proxy not enabled')

package/lib/history/ring.js

@@ -21,6 +21,23 @@ const fsp = fs.promises
 const path = require('path')
 
 const DEG = Math.PI / 180
+
+// The channel set the Trends panel and the instrument history flyouts expect. It must
+// match the cloud's provider (sailkick server/history/influx-provider.js MAP + the
+// three active-waypoint prefixes), so the same cell shows the same history whether the
+// boat or the cloud is answering.
+//
+// This drifted once already: it was frozen at the eight channels that existed before
+// v0.18.6, while the app grew cells for true wind angle, VMG, temperatures, engine revs
+// and the four waypoint values — and `cog` was sampled into the ring but left out of the
+// output entirely. Eleven of nineteen cells had a live number and an empty flyout.
+// test/history-ring.test.js pins this list against the app's own channel names.
+const CHANNELS = [
+  'tws', 'twd', 'aws', 'awa', 'twa', 'vmg',
+  'sog', 'stw', 'cog', 'heading', 'depth',
+  'seaTemp', 'airTemp', 'rpmPort', 'rpmStbd',
+  'wptBrg', 'wptDist', 'wptVmg', 'wptTtg'
+]
 const wrap360 = (d) => ((d % 360) + 360) % 360
 const MAX_SAMPLES = 50000
 
@@ -51,7 +68,7 @@ function trueWind (s) {
 class RingHistoryProvider {
   constructor ({ source, sampleSec, windowSec, persistFile } = {}) {
     this._source = source
-    this._ring = [] // [{ t, sog, cog, heading, aws, awa, depth, tws, twd, lat, lon }]
+    this._ring = [] // [{ t, ...CHANNELS, lat, lon }]
     const win = windowSec || 3600
     this._windowMs = win * 1000
     this._persistFile = persistFile || null
@@ -80,6 +97,16 @@ class RingHistoryProvider {
       stw: num(s.stwKt),
       aws: num(s.awsKt), awa: num(s.awaDeg), depth: num(s.depthM),
       tws: tw ? tw.tws : null, twd: tw ? tw.twd : null,
+      // Everything below arrived in BoatState with v0.18.6 but was never sampled here,
+      // so these instrument cells had a live value and an empty history flyout.
+      twa: num(s.twaDeg), vmg: num(s.vmgKt),
+      seaTemp: num(s.seaTempC), airTemp: num(s.airTempC),
+      rpmPort: num(s.rpmPort), rpmStbd: num(s.rpmStbd),
+      // Waypoint channels are legitimately null when no destination is active — num()
+      // maps that to null and CHANNELS omits empty ones, so the flyout stays blank
+      // rather than showing a flat line at zero.
+      wptBrg: num(s.wptBrgDeg), wptDist: num(s.wptDistNm),
+      wptVmg: num(s.wptVmgKt), wptTtg: num(s.wptTtgSec),
       lat: num(s.lat), lon: num(s.lon)
     }
     this._ring.push(row)
@@ -97,12 +124,8 @@ class RingHistoryProvider {
 
   getSeries ({ windowSec } = {}) {
     const rows = this._window(windowSec)
-    // Matches the InfluxDB provider's channel set exactly (lib/history/index.js MAP), so
-    // the Trends panel looks the same whichever provider is serving. Empty channels are
-    // omitted, so a boat with no paddlewheel simply has no `stw` key.
-    const chans = ['tws', 'twd', 'aws', 'awa', 'sog', 'stw', 'heading', 'depth']
     const series = {}
-    for (const c of chans) {
+    for (const c of CHANNELS) {
       const pts = rows.filter((r) => r[c] != null).map((r) => [r.t, r[c]])
       if (pts.length) series[c] = pts
     }
@@ -179,4 +202,4 @@ class RingHistoryProvider {
   }
 }
 
-module.exports = { RingHistoryProvider, MAX_SAMPLES }
+module.exports = { RingHistoryProvider, MAX_SAMPLES, CHANNELS }

package/lib/proxy/index.js

@@ -498,12 +498,19 @@ function createProxy (app, options) {
     if (clamped.length) log(`area prefetch: ${clamped.map(([l, v]) => `${l} capped at z${v.top}`).join(', ')} (upstream limit — those tiles do not exist)`)
     if (total > CAP) { area = { capped: true, total, radius, maxZoom }; log(`area prefetch: ~${total} tiles too large — reduce radius/detail`); return null }
     const paths = [...enumerateTiles(bbox, minZoom, perLayer)]
-    area = { done: 0, total: paths.length, running: true, radius, maxZoom, perLayer }
+    // Hold our OWN reference and mutate that, never the `area` slot. A prefetch of tens
+    // of thousands of tiles outlives a plugin disable by minutes, and stop() sets
+    // area = null — so settling handlers that touched `area` threw
+    // "Cannot set properties of null (setting 'running')" on every disable/enable. The
+    // same reference also protects against a restart having installed a NEWER prefetch:
+    // the old run must not report its progress into the new one's counters.
+    const run = { done: 0, total: paths.length, running: true, radius, maxZoom, perLayer }
+    area = run
     log(`area prefetch: ${radius}nm around ${pos.latitude.toFixed(2)},${pos.longitude.toFixed(2)} to z${maxZoom} — ${paths.length} tiles`)
-    area.promise = warmMany(paths, { concurrency: pf.concurrency || 4, onProgress: () => { area.done++ } })
-      .then((r) => { area.running = false; area.result = r; log(`area prefetch done: ${r.cached} cached, ${r.empty} empty, ${r.failed} failed`); return r })
-      .catch((e) => { area.running = false; log('area prefetch error: ' + e.message) })
-    return area.promise
+    run.promise = warmMany(paths, { concurrency: pf.concurrency || 4, onProgress: () => { run.done++ } })
+      .then((r) => { run.running = false; run.result = r; log(`area prefetch done: ${r.cached} cached, ${r.empty} empty, ${r.failed} failed`); return r })
+      .catch((e) => { run.running = false; log('area prefetch error: ' + e.message) })
+    return run.promise
   }
 
   function areaStatus () {

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "sailkick-boat",
-  "version": "0.19.0",
-  "description": "Run the sailkick app on board with no internet: charts, weather, climatology, trends and AIS all served from the boat itself. With a sailkick account it also syncs your metrics to the cloud in real time. Alpha, invite-only — info@sailkick.io",
+  "version": "0.20.1",
+  "description": "Run the sailkick app on board with no internet: charts, weather, climatology, trends and AIS all served from the boat itself. With a sailkick account it also syncs your metrics to the cloud in real time. Alpha, invite-only \u2014 info@sailkick.io",
   "main": "index.js",
   "scripts": {
     "test": "node --test"
   },
   "keywords": [
     "signalk-node-server-plugin",
+    "signalk-webapp",
     "signalk",
     "sailkick",
     "influxdb",
@@ -15,6 +16,7 @@
     "cache",
     "proxy"
   ],
+  "signalk-plugin-enabled-by-default": true,
   "author": "lauchat",
   "license": "MIT",
   "repository": {
@@ -35,6 +37,7 @@
   "files": [
     "index.js",
     "lib/",
+    "public/",
     "README.md",
     "LICENSE"
   ]

package/public/index.html

@@ -0,0 +1,97 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>Sailkick</title>
+<!--
+  Launcher for the Signal K admin menu.
+
+  Signal K mounts <package>/public/ at /<package-name> for any package carrying the
+  `signalk-webapp` keyword, and dedupes the menu by PACKAGE name (interfaces/webapps.js,
+  uniqBy(webapps,'name')) — so one package can only ever produce one entry. Hence one
+  launcher offering both surfaces rather than two menu items.
+
+  The app itself is not served from here: it lives on the plugin's mirror, on a port the
+  owner can change. This page therefore asks the plugin where it is, via the plugin
+  router at /plugins/sailkick-boat/info, and falls back to the default port if that
+  cannot be reached. The host is always taken from the current URL, so this works over
+  whatever address the browser reached Signal K on — LAN IP, .local, or tailnet.
+-->
+<style>
+  :root { color-scheme: light dark; --bg:#f6f7f9; --fg:#12161c; --mut:#5c6672; --card:#fff; --line:#e2e6eb; --accent:#0b6ea9 }
+  @media (prefers-color-scheme: dark) {
+    :root { --bg:#11151a; --fg:#e8edf2; --mut:#96a1ad; --card:#171c23; --line:#252c35; --accent:#4aa8e0 }
+  }
+  * { box-sizing: border-box }
+  body { margin:0; padding:2rem 1rem; background:var(--bg); color:var(--fg);
+         font:16px/1.5 system-ui,-apple-system,"Segoe UI",Roboto,sans-serif }
+  main { max-width:44rem; margin:0 auto }
+  h1 { margin:0 0 .25rem; font-size:1.5rem; letter-spacing:-.01em }
+  .sub { color:var(--mut); margin:0 0 1.5rem }
+  .grid { display:grid; gap:1rem; grid-template-columns:repeat(auto-fit,minmax(15rem,1fr)) }
+  a.card { display:block; padding:1.1rem 1.2rem; background:var(--card); border:1px solid var(--line);
+           border-radius:.7rem; text-decoration:none; color:inherit; transition:border-color .15s, transform .15s }
+  a.card:hover { border-color:var(--accent); transform:translateY(-1px) }
+  a.card strong { display:block; font-size:1.05rem; margin-bottom:.2rem }
+  a.card span { color:var(--mut); font-size:.9rem }
+  .note { margin-top:1.5rem; padding:.85rem 1rem; background:var(--card); border:1px solid var(--line);
+          border-radius:.6rem; color:var(--mut); font-size:.9rem }
+  .note b { color:var(--fg); font-weight:600 }
+  code { font-family:ui-monospace,SFMono-Regular,Menlo,monospace; font-size:.87em }
+  .warn { border-color:#b4791f }
+</style>
+</head>
+<body>
+<main>
+  <h1>Sailkick</h1>
+  <p class="sub">Charts, instruments and AIS, served from this boat.</p>
+
+  <div class="grid">
+    <a class="card" id="desktop" href="#"><strong>Open Sailkick</strong><span>Full app — chart, trends, weather</span></a>
+    <a class="card" id="mobile"  href="#"><strong>Open on phone</strong><span>Mobile view — swipeable instrument decks</span></a>
+  </div>
+
+  <div class="note" id="note">Locating the mirror…</div>
+</main>
+
+<script>
+(function () {
+  var DEFAULT_PORT = 8080;
+  var note = document.getElementById('note');
+
+  function apply (port, info) {
+    var base = location.protocol + '//' + location.hostname + (port ? ':' + port : '');
+    document.getElementById('desktop').href = base + '/';
+    document.getElementById('mobile').href = base + '/mobile.html';
+
+    if (info && info.running === false) {
+      note.className = 'note warn';
+      note.innerHTML = '<b>The mirror is not running.</b> Enable the plugin in ' +
+        'Server → Plugin Config → Sailkick boat companion, then reload this page.';
+      return;
+    }
+    if (port === 0) {
+      note.className = 'note warn';
+      note.innerHTML = '<b>The mirror port is disabled</b> (set to 0 in the plugin config), ' +
+        'so the app cannot be opened from here. Set a port — 8080 is the default.';
+      return;
+    }
+    var paired = info && info.paired;
+    note.innerHTML = 'Serving on <code>' + base + '</code>. Works with no account and no internet — ' +
+      'live data comes from this boat’s own Signal K, and maps are cached locally.' +
+      (paired ? '' : ' <b>Cloud sync is off</b> until you add a sailkick account in the plugin config; ' +
+                     'nothing leaves the boat before then.');
+  }
+
+  fetch('/plugins/sailkick-boat/info', { credentials: 'same-origin' })
+    .then(function (r) { return r.ok ? r.json() : null })
+    .then(function (j) {
+      if (j && typeof j.port === 'number') apply(j.port, j);
+      else apply(DEFAULT_PORT, null);
+    })
+    .catch(function () { apply(DEFAULT_PORT, null); });
+})();
+</script>
+</body>
+</html>