signalk-polar-performance-plugin 0.0.14 → 0.0.15

package/package.json

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

package/plugin/index.js

@@ -28,6 +28,10 @@ module.exports = function (app) {
         type: 'boolean',
         title: 'Enable sending Target TWA (performance.targetAngle)'
       },
+      tackTrue: {
+        type: 'boolean',
+        title: 'Enable calculating Opposite Tack True (performance.tackTrue)'
+      },
       optimumWindAngle: {
         type: 'boolean',
         title: 'Enable calculation of Optimum Wind Angle (difference between TWA and beat/run angle (depends on beat/run angle)'
@@ -64,7 +68,7 @@ module.exports = function (app) {
     app.debug('polar: %s', JSON.stringify(polar))
    
     // Global variables
-    var BSP, STW, TWA, TWS, port // Angles in rad, speed in m/s
+    var BSP, STW, TWA, targetTWA, TWS, HDG, port // Angles in rad, speed in m/s
     var halfPi = Math.PI / 2
 
     // Subscribe to paths
@@ -93,6 +97,12 @@ module.exports = function (app) {
         policy: 'instant'
       })
     }
+    if (options.tackTrue == true) {
+      localSubscription.subscribe.push({
+          path: 'navigation.headingTrue',
+          policy: 'instant'
+      })
+    }
 
     app.subscriptionmanager.subscribe(
       localSubscription,
@@ -120,6 +130,9 @@ module.exports = function (app) {
 	        SOG = delta.value
           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)
@@ -186,6 +199,11 @@ module.exports = function (app) {
         values.push({path: 'performance.maxSpeedAngle', value: roundDec(perfObj.maxSpeedAngle)})
         metas.push({path: 'performance.maxSpeedAngle', value: {"units": "rad"}})
       }
+      if (options.tackTrue == true) {
+        if (typeof perfObj.tackTrue != 'undefined') {
+          values.push({path: 'performance.tackTrue', value: roundDec(perfObj.tackTrue)})
+        }
+      }
 
       app.debug('sendUpdates: %s', JSON.stringify(values))
       app.handleMessage(plugin.id, {
@@ -218,6 +236,7 @@ module.exports = function (app) {
 	            let beatLower = polar[indexTWS]['Beat angle']
 	            let beatUpper = polar[indexTWS+1]['Beat angle']
 	            performance.beatAngle = beatLower + ((beatUpper - beatLower) * twsGapRatio)
+              targetTWA = performance.beatAngle
             }
 	          // Calculate optimum wind angle (B&G thing)
 	          if (options.optimumWindAngle == true) {
@@ -239,6 +258,7 @@ module.exports = function (app) {
 	            let runUpper = polar[indexTWS+1]['Run angle']
 	            //app.debug('runLower: %s runUpper: %s', runLower, runUpper)
 	            performance.runAngle = runLower + ((runUpper - runLower) * twsGapRatio)
+              targetTWA = performance.runAngle
             }
 	          if (options.optimumWindAngle == true) {
               if (typeof performance.runAngle != 'undefined') {
@@ -254,6 +274,21 @@ module.exports = function (app) {
 	            performance.runVMG = VMGLower + ((VMGUpper - VMGLower) * twsGapRatio)
             }
           }
+          // Calculate opposite Tack True
+          // app.debug('tackTrue: port: %d HDG: %d targetTWA: %d', port, radToDeg(HDG), radToDeg(targetTWA))
+          if (port) {
+            let tackTrue = HDG - targetTWA
+            if (tackTrue < 0) {
+              tackTrue = tackTrue + (2*Math.PI)
+            }
+            performance.tackTrue = tackTrue
+          } else {
+            let tackTrue = HDG + targetTWA
+            if (tackTrue > (2*Math.PI)) {
+              tackTrue = tackTrue - (2*Math.PI)
+            }
+            performance.tackTrue = tackTrue
+          }
           // Calculate polar target boat speed
 
           // Interpolate Define the 4 near data points
@@ -420,9 +455,9 @@ module.exports = function (app) {
         for (let index = 0; index < polar.length-1; index++) {
           let tws = polar[index].tws
           let beatVMG = 0
-          let beatVMGelement = 0
+          let beatElement = 0
           let runVMG = 0
-          let runVMGelement = 0
+          let runElement = 0
 
           let twaArray = polar[index].twa
           for (let element = 0; element < twaArray.length-1; element++) {
@@ -439,12 +474,12 @@ module.exports = function (app) {
               }
             }
           }
-          app.debug('beatVMG for %d is %d (angel %d)', tws, twaArray[beatVMGelement].vmg, twaArray[beatVMGelement].twa)
-          app.debug(' runVMG for %d is %d (angel %d)', tws, twaArray[runVMGelement].vmg, twaArray[runVMGelement].twa)
-          polar[index]['Beat angle'] = twaArray[beatVMGelement].twa
-          polar[index]['Beat VMG'] = twaArray[beatVMGelement].vmg
-          polar[index]['Run angle'] = twaArray[runVMGelement].twa
-          polar[index]['Run VMG'] = twaArray[runVMGelement].vmg
+          app.debug('beatVMG for %d is %d (angel %d)', tws, twaArray[beatElement].vmg, twaArray[beatElement].twa)
+          app.debug(' runVMG for %d is %d (angel %d)', tws, twaArray[runElement].vmg, twaArray[runElement].twa)
+          polar[index]['Beat angle'] = twaArray[beatElement].twa
+          polar[index]['Beat VMG'] = twaArray[beatElement].vmg
+          polar[index]['Run angle'] = twaArray[runElement].twa
+          polar[index]['Run VMG'] = twaArray[runElement].vmg
         }
         
       }