sailkick-boat 0.20.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

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sailkick-boat",
-  "version": "0.20.0",
+  "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": {