signalk-polar-performance-plugin 0.0.20 → 0.0.22

package/package.json

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

package/plugin/index.js

@@ -1,3 +1,4 @@
+const halfPi = Math.PI / 2
 var sourceAddress
 
 module.exports = function (app) {
@@ -36,6 +37,10 @@ module.exports = function (app) {
         type: 'boolean',
         title: 'Enable calculation of Optimum Wind Angle (difference between TWA and beat/run angle (depends on beat/run angle)'
       },
+      VMG: {
+        type: 'boolean',
+        title: 'Enable calculation of VMG, polarVMG and polar VMG ratio'
+      },
       useSOG: {
         type: 'boolean',
         title: 'Use speed over ground (SOG) as boat speed.'
@@ -46,7 +51,7 @@ module.exports = function (app) {
       },
       csvTable: {
         type: "string",
-        title: "Enter csv with polar in http://jieter.github.io/orc-data/site/ style."
+        title: "Copy/paste the csv content of the polar in http://jieter.github.io/orc-data/site/ style."
       }
     }
   }
@@ -83,7 +88,6 @@ module.exports = function (app) {
    
     // Global variables
     var BSP, STW, TWA, targetTWA, TWS, HDG, port // Angles in rad, speed in m/s
-    var halfPi = Math.PI / 2
 
     // Subscribe to paths
     let localSubscription = {
@@ -206,6 +210,11 @@ 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) {
+          values.push({path: 'performance.velocityMadeGood', value: roundDec(perfObj.velocityMadeGood)})
+          values.push({path: 'performance.polarVelocityMadeGood', value: roundDec(perfObj.polarVelocityMadeGood)})
+          values.push({path: 'performance.polarVelocityMadeGoodRatio', value: roundDec(perfObj.polarVelocityMadeGoodRatio)})
+        }
       }
       if (typeof perfObj.maxSpeed != 'undefined') {
         values.push({path: 'performance.maxSpeed', value: roundDec(perfObj.maxSpeed)})
@@ -369,11 +378,21 @@ module.exports = function (app) {
       }
       // Calculate polar performance ratio
       if (typeof performance.polarSpeed != 'undefined') {
-        performance.polarSpeedRatio = (1 / performance.polarSpeed) * BSP
+        performance.polarSpeedRatio = BSP / performance.polarSpeed
+        if (options.VMG == true) {
+          performance.velocityMadeGood = Math.abs(BSP * Math.cos(TWA))
+          performance.polarVelocityMadeGood = Math.abs(performance.polarSpeed * Math.cos(TWA))
+          performance.polarVelocityMadeGoodRatio = performance.velocityMadeGood / performance.polarVelocityMadeGood
+        }
       } else {
         // No value would create stale values
         performance.polarSpeed = 0
         performance.polarSpeedRatio = 0
+        if (options.VMG == true) {
+          performance.velocityMadeGood = 0
+          performance.polarVelocityMadeGood = 0
+          performance.polarRatioVelocityMadeGood = 0
+        }
       }
       return performance
     }
@@ -394,6 +413,7 @@ module.exports = function (app) {
         if (row[0] == 'twa/tws') {
           // The row with TWS columns
           // Create empty TWS objects in polar object
+          app.debug('First row with TWS columns')
           polar = []
           for (let index = 1; index < row.length; index++) {
             
@@ -401,20 +421,23 @@ module.exports = function (app) {
             polar.push(twsObj)
           }
           app.debug('polar: %s', JSON.stringify(polar))
-        } else if (row[0] == '0') {
+        } else if (row.filter(i => i === '0').length > 1) {
           app.debug('beat and run angles are included')
-        } else if (row.includes('0')) {
           // Beat / Run angle
           let angle = degToRad(Number(row[0]))
           let angleName
           let VMGName
+          app.debug('angle < halfPi   %d < %d', angle, halfPi)
           if (angle < halfPi) {
             angleName = 'Beat angle'
             VMGName = 'Beat VMG'
+            app.debug('cvsToPolar: row includes Beat angle: %s', row.join(';'))
           } else {
             angleName = 'Run angle'
             VMGName = 'Run VMG'
+            app.debug('cvsToPolar: row includes Run angle: %s', row.join(';'))
           }
+
           for (let index = 0; index < row.length-1; index++) {
             if (row[index+1] != 0) {
               polar[index][angleName] = angle
@@ -465,16 +488,19 @@ module.exports = function (app) {
       })
 
       // Find the beat/run angle if not set yet.
-      if (typeof polar[0].beatAngle == 'undefined') {
-        for (let index = 0; index < polar.length-1; index++) {
-          let tws = polar[index].tws
+      for (let index = 0; index < polar.length; index++) {
+        let tws = polar[index].tws
+        app.debug('Beat angle for TWS %s is %s', msToKts(tws).toFixed(0), polar[index]['Beat angle'])
+        // app.debug(polar[index]['Beat angle'])
+        if (typeof polar[index]['Beat angle'] == 'undefined') {
+          app.debug('Finding beat angle for TWS %s')
           let beatVMG = 0
           let beatElement = 0
           let runVMG = 0
           let runElement = 0
 
           let twaArray = polar[index].twa
-          for (let element = 0; element < twaArray.length-1; element++) {
+          for (let element = 0; element < twaArray.length; element++) {
             let Obj = twaArray[element]
             if (Obj.twa < halfPi) {
               // Beat
@@ -488,8 +514,8 @@ module.exports = function (app) {
               }
             }
           }
-          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)
+          app.debug('beatVMG for %s is %s (angle %s)', msToKts(tws).toFixed(0), msToKts(twaArray[beatElement].vmg).toFixed(2), radToDeg(twaArray[beatElement].twa).toFixed(1))
+          app.debug('runVMG for %s is %s (angle %s)', msToKts(tws).toFixed(0), msToKts(twaArray[runElement].vmg).toFixed(2), radToDeg(twaArray[runElement].twa).toFixed(1))
           polar[index]['Beat angle'] = twaArray[beatElement].twa
           polar[index]['Beat VMG'] = twaArray[beatElement].vmg
           polar[index]['Run angle'] = twaArray[runElement].twa
@@ -499,18 +525,19 @@ module.exports = function (app) {
       }
 
       // And now fill in some missing ends to avoid doing expensive calculations in the main loop
-      for (let index = 0; index < polar.length-1; index++) {
+      for (let index = 0; index < polar.length; index++) {
         // Sorted on angle, so first is lowest
         let tws = polar[index].tws
         let twaArray = polar[index].twa
         let lowTBS = twaArray[0].tbs
         let lowTWA = twaArray[0].twa
 
-        app.debug('Padding polar for %s from 0 to first given angle (%d deg, %d kts)', msToKts(tws).toFixed(0), radToDeg(lowTWA), msToKts(lowTBS))
+        // app.debug('Padding polar for %s from 0 to first given angle (%d deg, %d kts)', msToKts(tws).toFixed(0), radToDeg(lowTWA), msToKts(lowTBS))
         
         // Now put some extra values at the beginning
         var topArray = []
         for (let angle = 0; angle < lowTWA; angle = angle + degToRad(5)) {
+          app.debug('Padding for angle %d (< lowTWA)', radToDeg(angle).toFixed(1), radToDeg(lowTWA).toFixed(1))
           let tbs = (angle / lowTWA) * Math.pow(Math.cos((-1*lowTWA + angle)*2),2) * lowTBS
           if (tbs < 0 ) { tbs = 0 }
           let Obj = {'twa': angle, 'tbs': tbs}
@@ -546,7 +573,7 @@ module.exports = function (app) {
     function getChartData () {
       var backgroundColor = []
       var borderColor = []
-      for (let c = 0; c < 8; c++) {
+      for (let c = 0; c < 20; c++) {
         let r = 0 + (c*10)
         let g = 130 + (c*20 % 100)
         let b = 80 + (c*30 % 120)
@@ -565,7 +592,7 @@ module.exports = function (app) {
       for (let angle = 0; angle <= 180; angle += 5) {
         data.labels.push(angle)
       }
-      for (let index = 0; index < polar.length -1; index++) {
+      for (let index = 0; index < polar.length; index++) {
         // Add x axis label TWS
         let tws = msToKts(polar[index].tws).toFixed(0)
         let twaArray = polar[index].twa
@@ -583,7 +610,7 @@ module.exports = function (app) {
           if (twaObj.twa == polar[index]['Beat angle'] || twaObj.twa == polar[index]['Run angle']) {
             radius = 5
           }
-          data.datasets[index].data.push({x: Math.round(radToDeg(twaObj.twa)), y: Number(msToKts(twaObj.tbs).toFixed(2))})
+          data.datasets[index].data.push({x: Number(radToDeg(twaObj.twa).toFixed(1)), y: Number(msToKts(twaObj.tbs).toFixed(2))})
           data.datasets[index].pointRadius.push(radius)
         }
       }