signalk-polar-performance-plugin 0.0.50 → 0.0.52

package/package.json

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

package/plugin/index.js

@@ -19,6 +19,11 @@ module.exports = function (app) {
   var schema = {
     // The plugin schema
     properties: {
+      trueWindSpeedPath: {
+        type: 'string',
+        default: 'environment.wind.speedTrue',
+        title: 'Wind speed path to use'
+      },
       beatAngle: {
         type: 'boolean',
         title:
@@ -50,6 +55,11 @@ module.exports = function (app) {
         type: 'boolean',
         title: 'Use speed over ground (SOG) as boat speed.'
       },
+      useSOGsource: {
+        type: 'string',
+        default: '',
+        title: 'Source (name.id) to filter SOG on'
+      },
       maxSpeed: {
         type: 'boolean',
         title:
@@ -76,7 +86,7 @@ module.exports = function (app) {
       },
       dampingBSP: {
         type: 'number',
-        title: 'Boat speed damping damping',
+        title: 'Boat speed damping seconds',
         default: 1
       },
       csvTable: {
@@ -125,15 +135,18 @@ module.exports = function (app) {
       subscribe: [
         {
           path: 'navigation.speedThroughWater',
-          policy: 'instant'
+          policy: 'instant',
+          minPeriod: 500
         },
         {
-          path: 'environment.wind.speedTrue',
-          policy: 'instant'
+          path: trueWindSpeedPath,
+          policy: 'instant',
+          minPeriod: 500
         },
         {
           path: 'environment.wind.angleTrueWater',
-          policy: 'instant'
+          policy: 'instant',
+          minPeriod: 500
         }
       ]
     }
@@ -142,7 +155,8 @@ module.exports = function (app) {
     if (options.useSOG == true) {
       localSubscription.subscribe.push({
         path: 'navigation.speedOverGround',
-        policy: 'instant'
+        policy: 'instant',
+        minPeriod: 500
       })
     }
     if (options.tackTrue == true) {
@@ -160,36 +174,40 @@ module.exports = function (app) {
       },
       delta => {
         delta.updates.forEach(u => {
-          // app.debug(u.values)
-          handleDelta(u.values)
+          // app.debug(u)
+          handleDelta(u.values,u['$source'])
         })
       }
     )
 
     // Handle delta
-    function handleDelta (deltas) {
+    function handleDelta (deltas, source) {
       deltas.forEach(delta => {
-        // app.debug('handleData: %s', JSON.stringify(delta))
+        app.debug('handleData (%s): %s', source, JSON.stringify(delta))
         if (
           delta.path == 'navigation.speedThroughWater' &&
           options.useSOG == false
         ) {
+          app.debug('STW useSOG: %j', options.useSOG)
           STW = applyDamping(delta.value, 'STW', options.dampingBSP || 0)
           BSP = STW
-          // app.debug('speedThroughWater (STW): %d', STW)
+          app.debug('speedThroughWater (STW): %d', STW)
         } else if (
           delta.path == 'navigation.speedOverGround' &&
           options.useSOG == true
         ) {
-          SOG = applyDamping(delta.value, 'SOG', options.dampingBSP || 0)
-          BSP = SOG
-          // app.debug('speedOverGround (SOG): %d', SOG)
+          app.debug('SOG useSOG: %j', options.useSOG)
+          if (options.useSOGsource == '' || source == options.useSOGsource) {
+            SOG = applyDamping(delta.value, 'SOG', options.dampingBSP || 0)
+            BSP = SOG
+            app.debug('speedOverGround (SOG) (%s): %d', source, SOG)
+          }
         } else if (delta.path == 'navigation.headingTrue') {
           HDG = delta.value
           // app.debug('heading (HDG): %d', HDG)
-        } else if (delta.path == 'environment.wind.speedTrue') {
+        } else if (delta.path == trueWindSpeedPath) {
           TWS = applyDamping(delta.value, 'TWS', options.dampingTWS || 0)
-          // app.debug('environment.wind.speedTrue (TWS): %d applyDamping: %d', delta.value, TWS)
+          // app.debug('%s (TWS): %d applyDamping: %d', trueWindSpeedPath, 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') {
@@ -200,12 +218,7 @@ module.exports = function (app) {
             port = 1
           }
           TWA = Math.abs(TWAtmp)
-          app.debug(
-            'environment.wind.angleTrueWater (TWA): %s applyDamping: %s port: %d',
-            delta.value,
-            TWA,
-            port
-          )
+          // app.debug('environment.wind.angleTrueWater (TWA): %s applyDamping: %s port: %d', delta.value, TWA, port)
         }
       })
     }
@@ -503,12 +516,9 @@ module.exports = function (app) {
       }
       // Calculate polar performance ratio
       if (typeof performance.polarSpeed != 'undefined') {
-        app.debug(
-          'performance.polarSpeedRatio = BSP (%s)/ performance.polarSpeed (%s)',
-          msToKts(BSP).toFixed(2),
-          msToKts(performance.polarSpeed).toFixed(2)
-        )
+        // app.debug('performance.polarSpeedRatio = BSP (%s)/ performance.polarSpeed (%s)', msToKts(BSP).toFixed(2), msToKts(performance.polarSpeed).toFixed(2))
         performance.polarSpeedRatio = BSP / performance.polarSpeed
+        app.debug('performance.polarSpeedRatio = %s', performance.polarSpeedRatio.toFixed(2))
         if (options.VMG == true) {
           performance.velocityMadeGood = Math.abs(BSP * Math.cos(TWA))
           performance.polarVelocityMadeGood = performance.targetVMG