@meri-imperiumi/signalk-dead-reckoning 0.12.2 → 0.12.3

package/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.12.3] - 2026-10-03
+
+### Fixed
+- **Tier-3 weather current now parses the fields providers actually
+  serve.** `parseWeatherCurrent` read the REST docs' shape
+  (`current.set` rad / `current.drift` m/s), but the Weather API server
+  transforms nothing — both the JS API (`app.weatherApi.getForecasts`)
+  and REST return the registered provider's data as-is — and the
+  providers on this install never emit that shape: the default GRIB
+  provider carries no currents at all, and signalk-weather-router-plus
+  answers `water.surfaceCurrentDirection` (rad, the set, towards) /
+  `water.surfaceCurrentSpeed` (m/s), the shape of `@signalk/server-api`'s
+  TS `WeatherData` interface (which contradicts the docs' TypeBox
+  `WeatherDataModel`). Every poll therefore died with "forecast carries
+  no current data" and DR silently ran on derived/zero current. The
+  parser now accepts both shapes (water.* preferred), verified against
+  the live server; wind-only entries without current coverage are
+  skipped so interpolation brackets between the entries that carry
+  current.
+
 ## [0.12.2] - 2026-09-28
 
 ### Fixed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meri-imperiumi/signalk-dead-reckoning",
-  "version": "0.12.2",
+  "version": "0.12.3",
   "description": "Offline-first dead reckoning and sensor fusion engine for Signal K",
   "main": "plugin/index.js",
   "scripts": {

package/plugin/current.js

@@ -13,11 +13,17 @@
  *     observation outranks model products (sea trial 2026-08-30→09-05:
  *     ~11 nm DR error over 622 nm vs 47 nm for tier 3).
  *  3. **Signal K Weather API** (`/signalk/v2/api/weather/forecasts/point`)
- *     — a provider (e.g. a GRIB another process already downloaded)
- *     serves point forecasts carrying `current: {set (rad), drift (m/s)}`.
- *     The client polls it at the vessel position on a slow interval and
- *     caches the time-interpolated vector; the 1 Hz tick never touches
- *     the network.
+ *     — a weather provider carrying currents (e.g. signalk-weather-router-
+ *     plus: Copernicus SMOC) answers point forecasts; the client polls it
+ *     at the vessel position on a slow interval and caches the
+ *     time-interpolated vector; the 1 Hz tick never touches the network.
+ *     Current fields follow the provider: the REST docs' TypeBox model
+ *     defines top-level `current.set` (rad, towards) / `current.drift`
+ *     (m/s), while `@signalk/server-api`'s TS WeatherData and the real
+ *     providers use `water.surfaceCurrentDirection` /
+ *     `water.surfaceCurrentSpeed`. The server transforms nothing — the
+ *     JS API and REST both return provider data as-is — so the parser
+ *     accepts both shapes.
  *  4. Offline pilot charts (`offline_pilot_currents`) — table exists in
  *     the schema; the lookup hook is reserved.
  *  5. **Zero vector** — pure inertial water track.
@@ -44,8 +50,11 @@ function normalizeDeg360(deg) {
 
 /**
  * Parses a Weather API forecast series into the current vector valid at
- * `nowMs`. Entries carrying `current.set` (rad, direction the current
- * flows *toward*) and `current.drift` (m/s) are interpolated as u/v
+ * `nowMs`. Entries carrying current data — `water.surfaceCurrentDirection`
+ * (rad, the direction the current flows *toward*) and
+ * `water.surfaceCurrentSpeed` (m/s), or the REST docs' top-level
+ * `current.set` / `current.drift` (same units, same semantics) — are
+ * interpolated as u/v
  * components between the entries bracketing `nowMs`; outside the series
  * the nearest endpoint is used (the client's TTL bounds staleness).
  *
@@ -59,8 +68,13 @@ function parseWeatherCurrent(points, nowMs) {
   const entries = [];
   for (const p of points) {
     const t = Date.parse(p?.date ?? "");
-    const set = p?.current?.set;
-    const drift = p?.current?.drift;
+    // Two shapes exist in the wild: the REST docs' TypeBox model (top-
+    // level current.set/drift) and the server-api TS WeatherData interface
+    // plus real providers (water.surfaceCurrent*). The server serves
+    // provider data untransformed on both the JS API and REST, so accept
+    // either; prefer the water.* fields.
+    const set = p?.water?.surfaceCurrentDirection ?? p?.current?.set;
+    const drift = p?.water?.surfaceCurrentSpeed ?? p?.current?.drift;
     if (!Number.isFinite(t)) continue;
     if (!Number.isFinite(set) || !Number.isFinite(drift)) continue;
     entries.push({ t, set, drift });
@@ -184,8 +198,14 @@ function resolveCurrent(input = {}) {
  * `/signalk/...` path. On servers without the Weather API the client
  * stays idle and the §6.2 resolver never sees tier 3.
  *
- * The response is a WeatherDataModel array; `current.set` is radians
- * and `current.drift` m/s (converted here to deg/kn).
+ * The response is a WeatherData array (the Signal K Weather API model).
+ * Currents appear either as `water.surfaceCurrentDirection` (rad, the
+ * set, towards) / `water.surfaceCurrentSpeed` (m/s) — what real
+ * providers like signalk-weather-router-plus serve — or as the REST
+ * docs' `current.set` / `current.drift` (same units); both are
+ * converted here to deg/kn. Entries without current coverage (e.g.
+ * wind-only steps, or points outside the provider's current sources)
+ * simply lack the fields and are skipped.
  */
 class WeatherCurrentClient {
   /**

package/plugin/index.js

@@ -830,7 +830,7 @@ module.exports = (app) => {
           type: "boolean",
           title: "Use Signal K Weather API current (set/drift) for DR",
           description:
-            "Polls the server's weather provider (typically a GRIB another process downloaded) for the point-forecast current at the vessel position and integrates it into the DR solution (SPEC §6.2 tier 3). Falls back to the zero vector when unavailable.",
+            "Polls the server's weather provider (e.g. signalk-weather-router-plus, serving ECMWF wind and Copernicus SMOC currents) for the point-forecast current at the vessel position and integrates it into the DR solution (SPEC §6.2 tier 3). Falls back to the zero vector when unavailable.",
           default: DEFAULT_CONFIG.weatherCurrent.enabled,
         },
         "weatherCurrent.intervalMs": {
@@ -958,8 +958,9 @@ module.exports = (app) => {
           : seedTs;
 
       // §6.2 tier 3: poll the Signal K Weather API for the point-forecast
-      // current at the vessel position (typically a GRIB another process
-      // downloaded). Off the 1 Hz hot path: slow interval, cached read.
+      // current at the vessel position (a current-capable provider such as
+      // signalk-weather-router-plus). Off the 1 Hz hot path: slow interval,
+      // cached read.
       if (config.weatherCurrent.enabled) {
         // In-process Weather API (mirrors signalk-energy-predictor):
         // `app.weatherApi` is the same instance the REST routes wrap,

package/tests/current.test.js

@@ -16,11 +16,11 @@ const {
 
 const NOW = Date.UTC(2026, 6, 15, 12, 0, 0);
 
-/** forecast entry helper: set rad toward, drift m/s */
+/** forecast entry helper: set rad toward, drift m/s (SK Weather API shape) */
 function entry(offsetMin, setRad, driftMs) {
   return {
     date: new Date(NOW + offsetMin * 60000).toISOString(),
-    current: { set: setRad, drift: driftMs },
+    water: { surfaceCurrentDirection: setRad, surfaceCurrentSpeed: driftMs },
   };
 }
 
@@ -76,6 +76,47 @@ test("parseWeatherCurrent: null when no entry carries current data", () => {
   assert.strictEqual(parseWeatherCurrent(null, NOW), null);
 });
 
+test("parseWeatherCurrent: entries without current data are skipped, not fatal", () => {
+  // Real providers emit wind-only entries too (e.g. ECMWF steps outside
+  // SMOC coverage, or points the current sources do not reach). Those
+  // entries must be skipped so interpolation still brackets `nowMs`
+  // between the entries that carry current.
+  const r = parseWeatherCurrent(
+    [
+      {
+        date: new Date(NOW - 60 * 60000).toISOString(),
+        wind: { speedTrue: 5 },
+      },
+      entry(0, 0, 1),
+      entry(60, Math.PI / 2, 1),
+    ],
+    NOW + 30 * 60000,
+  );
+  assert.ok(r);
+  assert.ok(r.setTrue > 0 && r.setTrue < 90, `setTrue ${r?.setTrue}`);
+});
+
+test("parseWeatherCurrent: accepts the REST docs' current.set/drift shape too", () => {
+  // @signalk/server-api ships two conflicting models: the TypeBox
+  // WeatherDataModel behind the REST docs (top-level current.set/drift)
+  // and the TS WeatherData interface (water.surfaceCurrent*). The server
+  // serves provider data untransformed, so both must parse identically.
+  const docShape = (offsetMin, setRad, driftMs) => ({
+    date: new Date(NOW + offsetMin * 60000).toISOString(),
+    current: { set: setRad, drift: driftMs },
+  });
+  const fromWater = parseWeatherCurrent(
+    [entry(-60, 0, 1), entry(60, Math.PI / 2, 1)],
+    NOW,
+  );
+  const fromDoc = parseWeatherCurrent(
+    [docShape(-60, 0, 1), docShape(60, Math.PI / 2, 1)],
+    NOW,
+  );
+  assert.ok(fromDoc);
+  assert.deepStrictEqual(fromDoc, fromWater);
+});
+
 // --------------------------------------------------------------- resolver
 
 test("resolveCurrent: tier 5 zero vector when nothing better exists", () => {

package/tests/plugin.test.js

@@ -3854,12 +3854,18 @@ test("tick integrates the Weather API current into the DR solution (tier 3)", as
   const app = new FakeSignalKApp();
   app.dataPath = dir;
   // In-process Weather API (the same object signalk-energy-predictor
-  // calls): 1 m/s due east → set 90° true, drift ≈ 1.944 kn.
+  // calls): 1 m/s due east → set 90° true, drift ≈ 1.944 kn. The
+  // response uses the Signal K WeatherData shape (currents under
+  // `water`, as spec-conformant providers like
+  // signalk-weather-router-plus serve them).
   app.weatherApi = {
     getForecasts: async () => [
       {
         date: new Date().toISOString(),
-        current: { set: Math.PI / 2, drift: 1 },
+        water: {
+          surfaceCurrentDirection: Math.PI / 2,
+          surfaceCurrentSpeed: 1,
+        },
       },
     ],
   };