speedandcurrent 1.5.0 → 1.6.0

package/index.js

@@ -51,6 +51,12 @@ module.exports = function (app) {
   plugin.schema = {
     type: "object",
     properties: {
+      sogFallback: {
+        type: "boolean",
+        title: "SOG fallback",
+        description: "Allow fallback to SOG when paddlewheel is blocked.",
+        default: true
+      },
       startWithNewTable: {
         type: "boolean",
         title: "Start with new table",
@@ -148,6 +154,7 @@ module.exports = function (app) {
 
   plugin.uiSchema = {
     'ui:order': [
+      "sogFallback",
       "estimateBoatSpeed",
       "updateCorrectionTable",
       "assumeCurrent",
@@ -164,6 +171,9 @@ module.exports = function (app) {
       "attitudeSource",
       "preventDuplication"
     ],
+    sogFallback: {
+      "ui:widget": "checkbox"
+    },
     startWithNewTable: {
       "ui:widget": "checkbox"
     },
@@ -240,6 +250,9 @@ module.exports = function (app) {
 
 
     // current
+    // send metadata for current
+    MessageHandler.setMeta(app, plugin.id, "environment.current.drift", {units: "m/s", type: "number", description: "Speed of the current"});
+    MessageHandler.setMeta(app, plugin.id, "environment.current.setTrue", { units: "rad", type: "number", description: "Direction of the current" });
     rawCurrent = new Polar("current", "self.environment.current.drift", "self.environment.current.setTrue");
     rawCurrent.setDisplayAttributes({ label: "current", plane: "Ground" });
     rawCurrent.setAngleRange('0to2pi');
@@ -267,6 +280,7 @@ module.exports = function (app) {
     noCurrent.ySmoother.reset(0,0);
     PolarSmoother.send(app, plugin.id, [noCurrent]);
 
+
     // boat speed
     smoothedBoatSpeed = new SmoothedSpeedThroughWater(app, plugin.id, settings.boatSpeedSource, true, MovingAverageSmoother, smootherOptions, !settings.preventDuplication);
     rawBoatSpeed = smoothedBoatSpeed.polar;
@@ -339,6 +353,18 @@ module.exports = function (app) {
     smoothedBoatSpeed.onChange = () => {
       const wellUnderway = started < new Date() - 60 * 1000;
       const minSpeed = SI.fromKnots(settings.speedStep / 2);
+      
+      if (settings.sogFallback && fallingBackToSog( minSpeed) ){
+        app.setPluginStatus("Falling back to Speed Over Ground");
+        app.debug("Falling back");
+         return;
+      }
+      if (!wellUnderway) {
+        app.setPluginStatus("Stabilizing");
+      }
+      else {
+        app.setPluginStatus("Running");
+      }
       if (settings.estimateBoatSpeed) correct(wellUnderway);
       if (settings.updateCorrectionTable && wellUnderway) {
         updateTable(settings.assumeCurrent, minSpeed);
@@ -386,6 +412,15 @@ module.exports = function (app) {
     });
   };
 
+  function fallingBackToSog( minSpeed) {
+    if (!rawBoatSpeed.stale && rawBoatSpeed.magnitude > 0) return false;
+    if (rawGroundSpeed.stale || rawGroundSpeed.magnitude < minSpeed) return false;
+    // Fallback to SOG
+    correctedBoatSpeed.setVectorValue({ x: rawGroundSpeed.magnitude, y: 0 });
+    Polar.send(app, plugin.id, [correctedBoatSpeed]);
+    return true;
+  }
+
    /**
    * Estimates and applies corrections to boat speed, leeway, and current.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "speedandcurrent",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "A plugin that automatically corrects boat speed and calculates current and leeway using sensor fusion.",
   "main": "index.js",
   "scripts": {
@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "kalman-filter": "^2.3.0",
-    "signalkutilities": "^1.5.0"
+    "signalkutilities": "^1.5.1"
   },
   "files": [
     "index.js",