speedandcurrent 2.1.1 → 2.2.1

package/package.json

@@ -1,49 +1,50 @@
-{
-  "name": "speedandcurrent",
-  "version": "2.1.1",
-  "description": "A plugin that automatically corrects boat speed and calculates current and leeway using sensor fusion.",
-  "main": "index.js",
-  "scripts": {
-    "test": "node --test test/plugin.test.js"
-  },
-  "author": "aswin.bouwmeester@gmail.com",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Asw1n/speedandcurrent.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Asw1n/speedandcurrent/issues"
-  },
-  "homepage": "https://github.com/Asw1n/speedandcurrent#readme",
-  "engines": {
-    "node": ">=22.0.0",
-    "signalk-server": ">=2.28.0"
-  },
-  "keywords": [
-    "signalk-webapp",
-    "signalk-node-server-plugin",
-    "signalk-category-utility",
-    "signalk-category-instruments"
-  ],
-  "signalk-plugin-enabled-by-default": false,
-  "signalk": {
-    "appIcon": "./icon.png",
-    "displayName": "Speed and current",
-    "screenshots": [
-      "./docs/correctionTable.png",
-      "./docs/STW_estimation.png",
-      "./docs/learning.png"
-    ]
-  },
-  "dependencies": {
-    "kalman-filter": "^2.3.0",
-    "signalkutilities": "^3.0.0"
-  },
-  "files": [
-    "index.js",
-    "correctionTable.js",
-    "public/",
-    "docs/"
-  ]
-}
+{
+  "name": "speedandcurrent",
+  "version": "2.2.1",
+  "description": "A plugin that automatically corrects boat speed and calculates current and leeway using sensor fusion.",
+  "main": "index.js",
+  "scripts": {
+    "test": "node --test test/plugin.test.js"
+  },
+  "author": "aswin.bouwmeester@gmail.com",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Asw1n/speedandcurrent.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Asw1n/speedandcurrent/issues"
+  },
+  "homepage": "https://github.com/Asw1n/speedandcurrent#readme",
+  "engines": {
+    "node": ">=22.0.0",
+    "signalk-server": ">=2.28.0"
+  },
+  "keywords": [
+    "signalk-webapp",
+    "signalk-node-server-plugin",
+    "signalk-category-utility",
+    "signalk-category-instruments"
+  ],
+  "signalk-plugin-enabled-by-default": false,
+  "signalk": {
+    "appIcon": "./icon.png",
+    "displayName": "Speed and current",
+    "screenshots": [
+      "./docs/correctionTable.png",
+      "./docs/STW_estimation.png",
+      "./docs/learning.png"
+    ]
+  },
+  "dependencies": {
+    "kalman-filter": "^2.3.0",
+    "signalkutilities": "^3.1.0"
+  },
+  "files": [
+    "icon.png",
+    "index.js",
+    "correctionTable.js",
+    "public/",
+    "docs/"
+  ]
+}

package/public/TableRenderer.js

@@ -1,144 +1,144 @@
-// TableRenderer — purpose-built renderer for the correction table.
-// Rows = speed bins (knots), columns = heel bins (degrees).
-// Each learned cell shows factor deviation (±%) and leeway (°).
-// Background encodes factor: green = paddlewheel reads slow, orange = reads fast.
-// Active cell (last updated) gets a bold border; interpolation neighbours get a faint tint.
-
-const RAD_TO_DEG = 180 / Math.PI;
-const MPS_TO_KNOTS = 1.943844;
-
-const DEFAULT_SPEED_SYMBOL = 'kn';
-const DEFAULT_HEEL_SYMBOL  = '°';
-function fmtSpeed(mps)  { return (mps * MPS_TO_KNOTS).toFixed(1); }
-function fmtHeel(rad)   { return (rad * RAD_TO_DEG).toFixed(0); }
-function fmtFactor(f)   { const p = (f - 1) * 100; return (p >= 0 ? '+' : '') + p.toFixed(1) + '%'; }
-function fmtLeeway(rad) { const d = rad * RAD_TO_DEG; return (d >= 0 ? '+' : '') + d.toFixed(0) + '°'; }
-
-class TableRenderer {
-
-  // opts.fmtSpeed / opts.fmtHeel: optional unit-aware formatter functions.
-  // Fall back to the module-level fmtSpeed / fmtHeel when not provided.
-  render(data, opts = {}) {
-    const { id, row, col, table, displayAttributes } = data;
-    const label = displayAttributes?.label ?? '';
-    const maxDev = this._computeMaxDev(table);
-    const fmtSpeedFn  = opts.fmtSpeed    || fmtSpeed;
-    const fmtHeelFn   = opts.fmtHeel     || fmtHeel;
-    const speedSymbol = opts.speedSymbol || DEFAULT_SPEED_SYMBOL;
-    const heelSymbol  = opts.heelSymbol  || DEFAULT_HEEL_SYMBOL;
-    const cornerText  = `${speedSymbol} / ${heelSymbol}`;
-
-    const el = document.createElement('table');
-    el.id = id;
-    el.classList.add('Table2D');
-    el.appendChild(this._headerRow(col, cornerText, fmtHeelFn));
-
-    let rIndex = 0;
-    for (let r = row.min; r <= row.max + 0.01; r += row.step) {
-      el.appendChild(this._dataRow(r, rIndex, col, table, maxDev, fmtSpeedFn));
-      rIndex++;
-    }
-    return el;
-  }
-
-  _headerRow(col, cornerText, fmtHeelFn) {
-    const tr = document.createElement('tr');
-    const th0 = document.createElement('th');
-    th0.textContent = cornerText;
-    th0.classList.add('TableRowHeader', 'TableCorner');
-    tr.appendChild(th0);
-    for (let c = col.min; c <= col.max + 0.01; c += col.step) {
-      const th = document.createElement('th');
-      th.textContent = fmtHeelFn(c);
-      th.classList.add('TablecolumnHeader');
-      tr.appendChild(th);
-    }
-    return tr;
-  }
-
-  _dataRow(r, rIndex, col, table, maxDev, fmtSpeedFn) {
-    const tr = document.createElement('tr');
-    const th = document.createElement('th');
-    th.textContent = fmtSpeedFn(r);
-    th.classList.add('TableRowHeader');
-    tr.appendChild(th);
-    let cIndex = 0;
-    for (let c = col.min; c <= col.max + 0.01; c += col.step) {
-      tr.appendChild(this._cellElement(table[rIndex][cIndex], maxDev));
-      cIndex++;
-    }
-    return tr;
-  }
-
-  _cellElement(cell, maxDev) {
-    const td = document.createElement('td');
-    td.classList.add('TableCell');
-
-    if (!cell || cell.N === 0) {
-      td.classList.add('cell--empty');
-      return td;
-    }
-
-    const factor = Number.isFinite(cell.factor) ? cell.factor : null;
-    const leeway = Number.isFinite(cell.leeway) ? cell.leeway : null;
-
-    if (factor !== null) {
-      const d = document.createElement('div');
-      d.className = 'cell-factor';
-      d.textContent = fmtFactor(factor);
-      td.appendChild(d);
-      const color = this._factorColor(factor, maxDev);
-      if (leeway !== null) {
-        const angleDeg = 90 + leeway * RAD_TO_DEG * 1;
-        td.style.background = `repeating-linear-gradient(
-          ${angleDeg}deg,
-          ${color} 0px, ${color} 9px,
-          #f0f0f0 9px, #f0f0f0 10px
-        )`;
-      } else {
-        td.style.backgroundColor = color;
-      }
-    }
-    if (leeway !== null) {
-      const d = document.createElement('div');
-      d.className = 'cell-leeway';
-      d.textContent = fmtLeeway(leeway);
-      td.appendChild(d);
-    }
-
-    const attrs = cell.displayAttributes;
-    if (attrs?.selected)          td.classList.add('cell--active');
-    else if (attrs?.normWeight > 0) td.classList.add('cell--neighbour');
-
-    return td;
-  }
-
-  // Find the largest absolute factor deviation from 1 to normalise the color scale.
-  _computeMaxDev(table) {
-    let maxDev = 0;
-    for (const row of table) {
-      for (const cell of row) {
-        if (!cell || cell.N === 0 || !Number.isFinite(cell.factor)) continue;
-        const dev = Math.abs(cell.factor - 1);
-        if (dev > maxDev) maxDev = dev;
-      }
-    }
-    return maxDev || 0.05; // avoid a fully white table when all factors are near 1
-  }
-
-  // factor < 1: paddlewheel reads fast → white→orange
-  // factor > 1: paddlewheel reads slow → white→green
-  _factorColor(factor, maxDev) {
-    if (!Number.isFinite(factor)) return '';
-    const dev = factor - 1;
-    if (Math.abs(dev) < 1e-6) return '';
-    const a = Math.min(1, Math.abs(dev) / maxDev);
-    if (dev < 0) {
-      return `rgb(255,${Math.round(255 - 90 * a)},${Math.round(255 * (1 - a))})`; // white→orange
-    } else {
-      return `rgb(${Math.round(255 * (1 - a))},${Math.round(255 - 95 * a)},${Math.round(255 - 175 * a)})`; // white→green
-    }
-  }
-}
-
+// TableRenderer — purpose-built renderer for the correction table.
+// Rows = speed bins (knots), columns = heel bins (degrees).
+// Each learned cell shows factor deviation (±%) and leeway (°).
+// Background encodes factor: green = paddlewheel reads slow, orange = reads fast.
+// Active cell (last updated) gets a bold border; interpolation neighbours get a faint tint.
+
+const RAD_TO_DEG = 180 / Math.PI;
+const MPS_TO_KNOTS = 1.943844;
+
+const DEFAULT_SPEED_SYMBOL = 'kn';
+const DEFAULT_HEEL_SYMBOL  = '°';
+function fmtSpeed(mps)  { return (mps * MPS_TO_KNOTS).toFixed(1); }
+function fmtHeel(rad)   { return (rad * RAD_TO_DEG).toFixed(0); }
+function fmtFactor(f)   { const p = (f - 1) * 100; return (p >= 0 ? '+' : '') + p.toFixed(1) + '%'; }
+function fmtLeeway(rad) { const d = rad * RAD_TO_DEG; return (d >= 0 ? '+' : '') + d.toFixed(0) + '°'; }
+
+class TableRenderer {
+
+  // opts.fmtSpeed / opts.fmtHeel: optional unit-aware formatter functions.
+  // Fall back to the module-level fmtSpeed / fmtHeel when not provided.
+  render(data, opts = {}) {
+    const { id, row, col, table, displayAttributes } = data;
+    const label = displayAttributes?.label ?? '';
+    const maxDev = this._computeMaxDev(table);
+    const fmtSpeedFn  = opts.fmtSpeed    || fmtSpeed;
+    const fmtHeelFn   = opts.fmtHeel     || fmtHeel;
+    const speedSymbol = opts.speedSymbol || DEFAULT_SPEED_SYMBOL;
+    const heelSymbol  = opts.heelSymbol  || DEFAULT_HEEL_SYMBOL;
+    const cornerText  = `${speedSymbol} / ${heelSymbol}`;
+
+    const el = document.createElement('table');
+    el.id = id;
+    el.classList.add('Table2D');
+    el.appendChild(this._headerRow(col, cornerText, fmtHeelFn));
+
+    let rIndex = 0;
+    for (let r = row.min; r <= row.max + 0.01; r += row.step) {
+      el.appendChild(this._dataRow(r, rIndex, col, table, maxDev, fmtSpeedFn));
+      rIndex++;
+    }
+    return el;
+  }
+
+  _headerRow(col, cornerText, fmtHeelFn) {
+    const tr = document.createElement('tr');
+    const th0 = document.createElement('th');
+    th0.textContent = cornerText;
+    th0.classList.add('TableRowHeader', 'TableCorner');
+    tr.appendChild(th0);
+    for (let c = col.min; c <= col.max + 0.01; c += col.step) {
+      const th = document.createElement('th');
+      th.textContent = fmtHeelFn(c);
+      th.classList.add('TablecolumnHeader');
+      tr.appendChild(th);
+    }
+    return tr;
+  }
+
+  _dataRow(r, rIndex, col, table, maxDev, fmtSpeedFn) {
+    const tr = document.createElement('tr');
+    const th = document.createElement('th');
+    th.textContent = fmtSpeedFn(r);
+    th.classList.add('TableRowHeader');
+    tr.appendChild(th);
+    let cIndex = 0;
+    for (let c = col.min; c <= col.max + 0.01; c += col.step) {
+      tr.appendChild(this._cellElement(table[rIndex][cIndex], maxDev));
+      cIndex++;
+    }
+    return tr;
+  }
+
+  _cellElement(cell, maxDev) {
+    const td = document.createElement('td');
+    td.classList.add('TableCell');
+
+    if (!cell || cell.N === 0) {
+      td.classList.add('cell--empty');
+      return td;
+    }
+
+    const factor = Number.isFinite(cell.factor) ? cell.factor : null;
+    const leeway = Number.isFinite(cell.leeway) ? cell.leeway : null;
+
+    if (factor !== null) {
+      const d = document.createElement('div');
+      d.className = 'cell-factor';
+      d.textContent = fmtFactor(factor);
+      td.appendChild(d);
+      const color = this._factorColor(factor, maxDev);
+      if (leeway !== null) {
+        const angleDeg = 90 + leeway * RAD_TO_DEG * 1;
+        td.style.background = `repeating-linear-gradient(
+          ${angleDeg}deg,
+          ${color} 0px, ${color} 9px,
+          #f0f0f0 9px, #f0f0f0 10px
+        )`;
+      } else {
+        td.style.backgroundColor = color;
+      }
+    }
+    if (leeway !== null) {
+      const d = document.createElement('div');
+      d.className = 'cell-leeway';
+      d.textContent = fmtLeeway(leeway);
+      td.appendChild(d);
+    }
+
+    const attrs = cell.displayAttributes;
+    if (attrs?.selected)          td.classList.add('cell--active');
+    else if (attrs?.normWeight > 0) td.classList.add('cell--neighbour');
+
+    return td;
+  }
+
+  // Find the largest absolute factor deviation from 1 to normalise the color scale.
+  _computeMaxDev(table) {
+    let maxDev = 0;
+    for (const row of table) {
+      for (const cell of row) {
+        if (!cell || cell.N === 0 || !Number.isFinite(cell.factor)) continue;
+        const dev = Math.abs(cell.factor - 1);
+        if (dev > maxDev) maxDev = dev;
+      }
+    }
+    return maxDev || 0.05; // avoid a fully white table when all factors are near 1
+  }
+
+  // factor < 1: paddlewheel reads fast → white→orange
+  // factor > 1: paddlewheel reads slow → white→green
+  _factorColor(factor, maxDev) {
+    if (!Number.isFinite(factor)) return '';
+    const dev = factor - 1;
+    if (Math.abs(dev) < 1e-6) return '';
+    const a = Math.min(1, Math.abs(dev) / maxDev);
+    if (dev < 0) {
+      return `rgb(255,${Math.round(255 - 90 * a)},${Math.round(255 * (1 - a))})`; // white→orange
+    } else {
+      return `rgb(${Math.round(255 * (1 - a))},${Math.round(255 - 95 * a)},${Math.round(255 - 175 * a)})`; // white→green
+    }
+  }
+}
+
 export default TableRenderer;