signalk-polar-performance-plugin 0.0.22 → 0.0.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-polar-performance-plugin",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "A plugin that calculates performance information based on a (CSV) polar diagram.",
   "main": "plugin/index.js",
   "scripts": {

package/plugin/index.js

@@ -5,6 +5,7 @@ module.exports = function (app) {
   var plugin = {}
   var unsubscribes = []
   var timers = []
+  var damping = {}
 
   plugin.id = 'signalk-polar-performance-plugin'
   plugin.name = 'Polar performance plugin'
@@ -49,6 +50,22 @@ module.exports = function (app) {
         type: 'boolean',
         title: 'Enable writing of maximum speed angle and boat speed for a given TWS'
       },
+      dampingTWA: {
+        type: 'number',
+        description: 'If data appears erratic or too sensitive, damping may be applied to amke information appear more stable. With damping set to 0, the data is presented in raw form wih no damping applied.',
+        title: 'True Wind Angle damping seconds',
+        default: 1
+      },
+      dampingTWS: {
+        type: 'number',
+        title: 'True Wind Speed damping seconds',
+        default: 1
+      },
+      dampingBSP: {
+        type: 'number',
+        title: 'Boat speed damping damping',
+        default: 1
+      },
       csvTable: {
         type: "string",
         title: "Copy/paste the csv content of the polar in http://jieter.github.io/orc-data/site/ style."
@@ -141,20 +158,21 @@ module.exports = function (app) {
       deltas.forEach(delta => {
 	      // app.debug('handleData: %s', JSON.stringify(delta))
 	      if (delta.path == 'navigation.speedThroughWater') {
-	        STW = delta.value
+	        STW = applyDamping (delta.value, 'BSP', options.dampingBSP || 0)
           BSP = STW
 	        // app.debug('speedThroughWater (STW): %d', STW)
 	      } else if (delta.path == 'navigation.speedOverGround') {
-	        SOG = delta.value
+	        SOG = applyDamping (delta.value, 'BSP', options.dampingBSP || 0)
           BSP = SOG
 	        // app.debug('speedThroughWater (STW): %d', STW)
 	      } else if (delta.path == 'navigation.headingTrue') {
 	        HDG = delta.value
 	        // app.debug('heading (HDG): %d', HDG)
 	      } else if (delta.path == 'environment.wind.speedTrue') {
-	        TWS = delta.value
-	        // app.debug('environment.wind.speedTrue (TWS): %d', TWS)
-	        app.debug('TWS: %d TWA: %d BSP: %d', msToKts(TWS), radToDeg(TWA)*port, msToKts(BSP))
+          // applyDamping (Xn, unit, a, n)
+	        TWS = applyDamping (delta.value, 'TWS', options.dampingTWS || 0)
+	        // app.debug('environment.wind.speedTrue (TWS): %d applyDamping: %d', delta.value, TWS)
+	        // app.debug('TWS: %d TWA: %d BSP: %d', msToKts(TWS), radToDeg(TWA)*port, msToKts(BSP))
           sendUpdates(getPerformanceData(TWS, TWA, BSP))
 	      } else if (delta.path == 'environment.wind.angleTrueWater') {
           if (delta.value < 0) {
@@ -162,7 +180,8 @@ module.exports = function (app) {
           } else {
             port = 1
           }
-	        TWA = Math.abs(delta.value)
+	        TWA = Math.abs(applyDamping (delta.value, 'TWA', options.dampingTWA || 0))
+	        app.debug('environment.wind.angleTrueWater (TWA): %s applyDamping: %s', radToDeg(delta.value).toFixed(0), radToDeg(TWA).toFixed(0))
 	      }
       })
     }
@@ -210,10 +229,12 @@ module.exports = function (app) {
       if (typeof perfObj.polarSpeed != 'undefined') {
         values.push({path: 'performance.polarSpeed', value: roundDec(perfObj.polarSpeed)})
         values.push({path: 'performance.polarSpeedRatio', value: roundDec(perfObj.polarSpeedRatio)})
-        if (options.VMG == true) {
+        if (typeof perfObj.velocityMadeGood != 'undefined') {
           values.push({path: 'performance.velocityMadeGood', value: roundDec(perfObj.velocityMadeGood)})
           values.push({path: 'performance.polarVelocityMadeGood', value: roundDec(perfObj.polarVelocityMadeGood)})
+          metas.push({path: 'performance.polarVelocityMadeGood', value: {"units": "m/s"}})
           values.push({path: 'performance.polarVelocityMadeGoodRatio', value: roundDec(perfObj.polarVelocityMadeGoodRatio)})
+          metas.push({path: 'performance.polarVelocityMadeGoodRatio', value: {"units": "ratio"}})
         }
       }
       if (typeof perfObj.maxSpeed != 'undefined') {
@@ -616,6 +637,27 @@ module.exports = function (app) {
       }
       return data
     }
+
+		function applyDamping (Xn, unit, RC) {
+      if (RC == 0) {
+        return Xn
+      } else {
+			  if (typeof damping[unit] == 'undefined') {
+			    // Doesn't exist yet, make obj for unit
+			    damping[unit] = {Yn: Xn, dt: Date.now()}
+			  }
+	      // Calculate a
+	      let dt = (Date.now() - damping[unit].dt)/1000
+	      damping[unit].dt = Date.now()
+	      let a = dt / (RC + dt)
+			  // Yn = (1-a) * Yn-1 + a * Xn
+			  let Yn = (1-a) * (damping[unit].Yn || Xn) + a * Xn
+			  // Remember Yn
+			  damping[unit].Yn = Yn
+			  // app.debug('Unit: %s  dt: %d  a: %d  obj: %s', unit, dt, a, JSON.stringify(damping[unit]))
+			  return Yn
+			}
+	  }
   }
 
   plugin.stop = function () {
@@ -652,6 +694,11 @@ function msToKts(ms) {
 }
 
 function roundDec (value) {
-  value = Number(value.toFixed(3))
-  return value
+  if (typeof value == 'undefined') {
+    return undefined
+  } else {
+    value = Number(value.toFixed(3))
+    return value
+  }
 }
+