signalk-polar-performance-plugin 1.2.1 → 1.3.2

package/CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Fixed
+- Signal K admin styling now loads from standalone CSS records in current Vite manifests while retaining support for entry-associated CSS and older server fallbacks.
+- `/live` and `/status` endpoints now return `null` for `tws`/`twa` (and downstream fields) when the wind smoother has no data or is stale, instead of `0`. The guard was checking for the presence of the smoother object rather than its `ready` state.
+- `computeAndSend`: when the polar table lookup fails (boat outside polar range — in irons or above max TWS), the `performance.polarSpeed`, `performance.polarSpeedRatio`, and `performance.targetSpeed` SK paths are now written with `null` instead of `0`. Writing `0` was misleading because it is a valid-looking value rather than an explicit "no data" signal.
+- Live input subscriptions are now re-established after prolonged silence for all subscribed inputs, not just true wind. Boat speed and optional true heading use the same recovery path, and the plugin now reports their lifecycle state through the webapp/status endpoints.
+
+### Changed
+- Idle input recovery is now always enabled; the temporary `detectStaleData` setting has been removed from the runtime settings UI.
+
 ## [1.2.1] - 2026-07-25
 
 ### Fixed

package/README.md

@@ -2,6 +2,8 @@
 
 Polar Performance reads your boat's true wind speed, true wind angle, and boat speed from Signal K, looks up the corresponding target values from your polar diagram, and publishes performance metrics — beat angle, run angle, VMG, polar speed ratio, and others — back to the Signal K bus in real time. An integrated webapp lets you inspect the live values, manage polars, and configure the plugin while it is running.
 
+Current runtime behaviour is also more explicit: when a polar lookup cannot be completed or a required input has no usable value, the plugin writes `null` for the affected output paths and the `/live` and `/status` endpoints expose that state clearly. Idle input recovery is enabled for all live subscriptions, so temporary silence is handled without leaving the plugin in a stale state.
+
 ---
 
 ## Installation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-polar-performance-plugin",
-  "version": "1.2.1",
+  "version": "1.3.2",
   "description": "Calculates live sailing performance from polar data, with built-in polar management and import tools.",
   "main": "plugin/index.js",
   "exports": {
@@ -26,7 +26,7 @@
     "prepublishOnly": "npm test"
   },
   "dependencies": {
-    "signalkutilities": "^3.0.1"
+    "signalkutilities": "^3.1.0"
   },
   "repository": {
     "type": "git",

package/plugin/index.js

@@ -17,6 +17,8 @@ const {
 
 const CURRENT_SETTINGS_VERSION = 1
 
+const STALE_RESUBSCRIBE_PERIOD = 60000 // ms — idle period before live input subscriptions are re-established
+
 const DEFAULT_SETTINGS = {
   settingsVersion: CURRENT_SETTINGS_VERSION,
   activePolar: '',
@@ -52,6 +54,8 @@ module.exports = (app) => {
   let bspSmoother = null
   let hdgSmoother = null
   let metaSentPaths = new Set()  // tracks paths that have had metadata emitted
+  let lifecycleWarningMap = new Map()
+  let lifecycleWarnings = []
 
   // Last-computed output values, updated by computeAndSend on every cycle.
   // Keys match the settings keys; values are SI numbers or null.
@@ -75,6 +79,52 @@ module.exports = (app) => {
   // Helpers
   // ---------------------------------------------------------------------------
 
+  function _setLifecycleWarning(id, status, path) {
+    const safePath = path || 'unknown path'
+    const message = status === 'idle'
+      ? `Input ${id} is idle on ${safePath}; resubscribing`
+      : `Input ${id} is stale on ${safePath}`
+    lifecycleWarningMap.set(id, {
+      id,
+      status,
+      path: safePath,
+      message,
+      updatedAt: Date.now()
+    })
+    lifecycleWarnings = Array.from(lifecycleWarningMap.values())
+      .sort((a, b) => b.updatedAt - a.updatedAt)
+  }
+
+  function _clearLifecycleWarning(id) {
+    if (!lifecycleWarningMap.has(id)) return
+    lifecycleWarningMap.delete(id)
+    lifecycleWarnings = Array.from(lifecycleWarningMap.values())
+      .sort((a, b) => b.updatedAt - a.updatedAt)
+  }
+
+  function _wireHandlerWatchdog({ id, getPath, unsubscribe, subscribe }) {
+    return {
+      idlePeriod: STALE_RESUBSCRIBE_PERIOD,
+      onDelta: () => {
+        _clearLifecycleWarning(id)
+      },
+      onStale: () => {
+        if (!isRunning) return
+        const path = getPath()
+        app.debug(`[${plugin.id}] stale input ${id} on ${path}`)
+        _setLifecycleWarning(id, 'stale', path)
+      },
+      onIdle: () => {
+        if (!isRunning) return
+        const path = getPath()
+        app.debug(`[${plugin.id}] idle input ${id} on ${path}; resubscribing`)
+        _setLifecycleWarning(id, 'idle', path)
+        unsubscribe()
+        subscribe()
+      }
+    }
+  }
+
   function getSmootherClass(type) {
     switch (type) {
       case 'None':          return BaseSmoother
@@ -184,11 +234,13 @@ module.exports = (app) => {
       if (hdgSmoother)  { hdgSmoother.setSmootherClass(SC);  hdgSmoother.setSmootherOptions(so)  }
     }
 
-    // Speed source change — re-point the BSP handler; it auto-resubscribes
+    // Speed source change — re-point the BSP handler with an explicit unsubscribe/subscribe cycle.
     if (keys.includes('useSOG') && bspSmoother) {
+      bspSmoother.unsubscribe()
       bspSmoother.handler.path = settings.useSOG
         ? 'navigation.speedOverGround'
         : 'navigation.speedThroughWater'
+      bspSmoother.subscribe()
     }
 
     // Tack heading toggle
@@ -199,7 +251,12 @@ module.exports = (app) => {
         hdgSmoother = new SmoothedAngle(app, plugin.id, 'hdg', 'navigation.headingTrue', {
           angleRange: '0to2pi',
           SmootherClass: SC,
-          smootherOptions: so
+          smootherOptions: so,
+          ..._wireHandlerWatchdog({
+            get path() { return hdgSmoother?.handler?.path ?? 'navigation.headingTrue' },
+            unsubscribe: () => hdgSmoother?.unsubscribe(),
+            subscribe: () => hdgSmoother?.subscribe(false, true),
+          })
         })
       } else if (!settings.tackTrue && hdgSmoother) {
         hdgSmoother.terminate()
@@ -374,14 +431,11 @@ module.exports = (app) => {
         }
       }
     } else {
-      // Zero out to prevent stale values accumulating in the data model
+      // Clear these paths so no stale non-zero value remains on the SK bus
       if (settings.polarSpeed) {
-        add('performance.polarSpeed', 0, 'm/s',
-          'Polar chart boat speed for current TWS and TWA.')
-        add('performance.polarSpeedRatio', 0, 'ratio',
-          'Actual boat speed divided by polar speed.')
-        add('performance.targetSpeed', 0, 'm/s',
-          'Boat speed needed to achieve target VMG at the optimal angle.')
+        values.push({ path: 'performance.polarSpeed', value: null })
+        values.push({ path: 'performance.polarSpeedRatio', value: null })
+        values.push({ path: 'performance.targetSpeed', value: null })
       }
     }
 
@@ -850,7 +904,7 @@ module.exports = (app) => {
       // Returns null for any field not yet available (plugin not running,
       // no BSP source, polar not loaded, or boat in irons).
       router.get('/live', (req, res) => {
-        const wind = windSmoother ? windSmoother.polarValue : null
+        const wind = windSmoother?.ready ? windSmoother.polarValue : null
         const TWS       = wind ? wind.magnitude : null
         const TWAsigned = wind ? wind.angle : null
         const TWA       = Number.isFinite(TWAsigned) ? Math.abs(TWAsigned) : null
@@ -896,7 +950,7 @@ module.exports = (app) => {
         const rawBsp = si(bspSmoother?.handler?.value ?? null)
         const rawHdg = si(hdgSmoother?.handler?.value ?? null)
 
-        const wind = windSmoother ? windSmoother.polarValue : null
+        const wind = windSmoother?.ready ? windSmoother.polarValue : null
         const TWS       = wind ? wind.magnitude : null
         const TWAsigned = wind ? wind.angle     : null
         const BSP       = bspSmoother ? bspSmoother.value : null
@@ -941,7 +995,8 @@ module.exports = (app) => {
             }
           },
           outputs,
-          polarState
+          polarState,
+          lifecycleWarnings
         })
       })
 
@@ -1062,6 +1117,8 @@ module.exports = (app) => {
 
     start(options) {
       metaSentPaths = new Set()  // reset so metadata is re-emitted after restart
+      lifecycleWarningMap = new Map()
+      lifecycleWarnings = []
 
       store = new PolarFileStore(app.getDataDirPath())
       importService = new ImportService(store)
@@ -1100,7 +1157,17 @@ module.exports = (app) => {
         app,
         pluginId: plugin.id,
         SmootherClass,
-        smootherOptions
+        smootherOptions,
+        ..._wireHandlerWatchdog({
+          id: 'wind.smoothed',
+          getPath: () => `${windSmoother?.polar?.pathMagnitude ?? 'environment.wind.speedTrue'}, ${windSmoother?.polar?.pathAngle ?? 'environment.wind.angleTrueWater'}`,
+          unsubscribe: () => windSmoother?.unsubscribe(),
+          subscribe: () => windSmoother?.subscribe(true, true),
+        }),
+        onDelta: () => {
+          _clearLifecycleWarning('wind.smoothed')
+          computeAndSend()
+        }
       })
 
       // Boat speed (STW or SOG depending on settings)
@@ -1113,7 +1180,13 @@ module.exports = (app) => {
         app,
         pluginId: plugin.id,
         SmootherClass,
-        smootherOptions
+        smootherOptions,
+        ..._wireHandlerWatchdog({
+          id: 'bsp.smoothed',
+          getPath: () => bspSmoother?.handler?.path ?? (settings.useSOG ? 'navigation.speedOverGround' : 'navigation.speedThroughWater'),
+          unsubscribe: () => bspSmoother?.unsubscribe(),
+          subscribe: () => bspSmoother?.subscribe(),
+        })
       })
 
       // Optional heading handler for opposite-tack computation.
@@ -1123,13 +1196,16 @@ module.exports = (app) => {
         hdgSmoother = new SmoothedAngle(app, plugin.id, 'hdg', 'navigation.headingTrue', {
           angleRange: '0to2pi',
           SmootherClass,
-          smootherOptions
+          smootherOptions,
+          ..._wireHandlerWatchdog({
+            id: 'hdg.smoothed',
+            getPath: () => hdgSmoother?.handler?.path ?? 'navigation.headingTrue',
+            unsubscribe: () => hdgSmoother?.unsubscribe(),
+            subscribe: () => hdgSmoother?.subscribe(false, true),
+          })
         })
       }
 
-      // Trigger performance computation whenever a new smoothed wind value is ready
-      windSmoother.onChange = computeAndSend
-
       isRunning = true
       app.debug('Plugin started')
     },
@@ -1141,6 +1217,8 @@ module.exports = (app) => {
       if (windSmoother) { windSmoother.terminate(); windSmoother = null }
       if (bspSmoother)  { bspSmoother.terminate();  bspSmoother = null  }
       if (hdgSmoother)  { hdgSmoother.terminate();  hdgSmoother = null  }
+      lifecycleWarningMap = new Map()
+      lifecycleWarnings = []
       app.debug('Plugin stopped')
     }
   }

package/public/app.js

@@ -309,6 +309,7 @@ let settings     = null
 let polarsList   = []
 let importFormats = []
 let internetOnline = false
+let lifecycleWarnings = []
 
 // Canvas state
 let polar          = null
@@ -443,6 +444,7 @@ async function refreshLive() {
   const st = await apiGet('/status')
   if (st) {
     statusData = st
+    lifecycleWarnings = Array.isArray(st.lifecycleWarnings) ? st.lifecycleWarnings : []
     // Populate rawValues and outputValues from /status for the Inputs/Outputs pages
     if (st.inputs) {
       rawValues.tws = st.inputs.raw.tws
@@ -690,9 +692,9 @@ function _tickInputs() {
   setStale('in-bsp-smo', d?.bsp        == null)
 
   const warns = []
-  if (rawValues.tws == null) warns.push('environment.wind.speedTrue — no data from instruments')
-  if (rawValues.twa == null) warns.push('environment.wind.angleTrueWater — no data from instruments')
-  if (rawValues.bsp == null) warns.push((settings?.useSOG ? 'navigation.speedOverGround' : 'navigation.speedThroughWater') + ' — no data from instruments')
+  lifecycleWarnings.forEach(w => {
+    if (w && typeof w.message === 'string') warns.push(w.message)
+  })
   updateWarnings(document.getElementById('in-warnings'), warns)
 }
 

package/public/index.html

@@ -16,29 +16,44 @@
         el.href = href
         document.head.appendChild(el)
       }
+      let manifestFailure = 'manifest contained no CSS assets'
       try {
         const res = await fetch('/admin/.vite/manifest.json')
         if (res.ok) {
           const manifest = await res.json()
-          let found = false
+          const stylesheets = new Set()
           for (const entry of Object.values(manifest)) {
-            if (!entry.isEntry) continue
-            for (const css of entry.css ?? []) {
-              appendStylesheet('/admin/' + css)
-              found = true
+            if (entry.file?.endsWith('.css')) {
+              stylesheets.add(entry.file)
             }
+            if (entry.isEntry) {
+              for (const css of entry.css ?? []) {
+                stylesheets.add(css)
+              }
+            }
+          }
+          if (stylesheets.size > 0) {
+            for (const css of stylesheets) appendStylesheet('/admin/' + css)
+            return
           }
-          if (found) return
+        } else {
+          manifestFailure = `manifest request returned ${res.status}`
         }
-      } catch (e) { /* fall through */ }
+      } catch (e) {
+        manifestFailure = `manifest request failed: ${e.message}`
+      }
       try {
         const res  = await fetch('/')
         const html = await res.text()
         const doc  = new DOMParser().parseFromString(html, 'text/html')
         const link = doc.querySelector('link[rel="stylesheet"]')
-        if (link) appendStylesheet(new URL(link.getAttribute('href'), res.url).href)
+        if (link) {
+          appendStylesheet(new URL(link.getAttribute('href'), res.url).href)
+          return
+        }
+        console.warn(`[polar] Could not load SignalK admin stylesheet: ${manifestFailure}; legacy admin page contained no stylesheet link.`)
       } catch (e) {
-        console.warn('[polar] Could not load SignalK admin stylesheet:', e)
+        console.warn(`[polar] Could not load SignalK admin stylesheet: ${manifestFailure}; legacy fallback failed: ${e.message}`)
       }
     })()
   </script>