signalk-sailboat-simulator 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.4.0] - 2026-09-15
+
+- Update `polar-math` to 1.1.1 so sparse polar rows are supported and beat-angle handling includes its latest fixes.
+- Disable polar extrapolation so the simulator follows explicitly entered speeds below the calculated beat angle instead of enforcing performance-oriented sailing limits.
+
+## [0.3.1] - 2026-09-09
+
+- Report polar loading and validation failures through the Signal K plugin error channel with their detailed cause.
+
 ## [0.3.0] - 2026-09-09
 
 - Calculate simulated boat speed directly from the active `signalk-polar-management` polar resource via `polar-math`.

package/README.md

@@ -96,6 +96,8 @@ The simulator publishes virtual wind for the rest of the Signal K stack. The pub
 
 The simulator uses the same true wind values with the active polar resource to calculate boat speed. The active polar must use the canonical `polar-format` structure provided by `signalk-polar-management`.
 
+Polar extrapolation is disabled: below the calculated beat angle, the simulator follows the speeds present in the entered polar curve. If the polar has no usable speed for the requested conditions, the boat stops instead of inventing a performance value.
+
 The simulator uses the calculated polar speed as boat speed, integrates heading from `steering.autopilot.output.turnRate`, and integrates position along that simulated heading. Current, leeway, route following and manoeuvre rules are intentionally left as separate steps.
 
 ## Configuration

package/index.js

@@ -199,7 +199,8 @@ module.exports = function createPlugin (app) {
       const result = polar.speedAt({
         tws: inputs.windSpeedTrue,
         twa: windAngleTrueWater,
-        performanceFactor
+        performanceFactor,
+        extrapolate: false
       })
       status.speedState = result.state
       if (Number.isFinite(result.value)) {
@@ -479,8 +480,13 @@ module.exports = function createPlugin (app) {
   }
 
   function setStatus () {
-    if (!app.setPluginStatus) return
-    if (runtime.status === 'sailing') {
+    if (runtime.status === 'polarError') {
+      setError(`Polar error: ${runtime.polar && runtime.polar.error ? runtime.polar.error : 'unable to calculate boat speed'}`)
+    } else if (runtime.status === 'error') {
+      setError(`Simulator error: ${runtime.error || 'unexpected runtime failure'}`)
+    } else if (!app.setPluginStatus) {
+      return
+    } else if (runtime.status === 'sailing') {
       app.setPluginStatus(`Sailing at ${runtime.speedOverGround.toFixed(2)} m/s, heading ${runtime.headingTrueDeg.toFixed(1)} deg`)
     } else if (runtime.status === 'groundingProtection') {
       app.setPluginStatus(`Stopped: distance to shore ${runtime.distanceToShore.toFixed(1)} m`)
@@ -489,6 +495,14 @@ module.exports = function createPlugin (app) {
     }
   }
 
+  function setError (message) {
+    if (typeof app.setPluginError === 'function') {
+      app.setPluginError(message)
+    } else if (typeof app.setPluginStatus === 'function') {
+      app.setPluginStatus(message)
+    }
+  }
+
   function registerWithRouter (router) {
     router.get('/api/status', (req, res) => {
       res.json({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-sailboat-simulator",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Signal K plugin that simulates a sailing boat from autopilot turn-rate output, weather and an active polar resource.",
   "main": "index.js",
   "scripts": {
@@ -36,7 +36,7 @@
     "node": ">=20"
   },
   "dependencies": {
-    "polar-math": "^1.0.0"
+    "polar-math": "^1.1.1"
   },
   "signalk-plugin-enabled-by-default": false,
   "signalk": {