signalk-polar-performance-plugin 0.0.24 → 0.0.27

package/README.md

@@ -42,17 +42,19 @@ In the plugin configuration you can toggle the following options:
  - Wind angle for maximum speed at this wind speed
  - Fill up the ends of the polar diagram
  - Visualisation of the polar diagram
+ - Configurable damping alorithm on inputs
+ - Extrapolation of polar data towards 0
+ - Configurable overall performance adjustment ratio
 
 ### To-do list
  - Improved interpolation
  - Make moment to do calculation smarter/configurable
  - API to see JSON of polar
- - Extrapolation of polar data
+ - Extrapolation of polar data towards 50 kts?
  - Create polar from live data
  -- Save polar info to file
  -- Save new record speed for angle in polar
  -- Determine if we're on a steady course to avoid fake records
- -- Dampening algoritms
  -- Configure the resolution of the polar diagram
  - Support multiple polar diagrams
  - Capture heel in polar diagram

package/package.json

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

package/plugin/index.js

@@ -50,6 +50,12 @@ module.exports = function (app) {
         type: 'boolean',
         title: 'Enable writing of maximum speed angle and boat speed for a given TWS'
       },
+      perfAdjust: {
+        type: 'number',
+        description: 'This ratio allows you to lower the polar boat speeds in case you are not expecting to meet 100% due to e.g. weight. 1 = 100%, 0.8 = 80% etc',
+        title: 'Performance adjustment ratio',
+        default: 1
+      },
       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.',
@@ -402,7 +408,7 @@ module.exports = function (app) {
         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.polarVelocityMadeGood = Math.abs(performance.polarSpeed * Math.cos(targetTWA))
           performance.polarVelocityMadeGoodRatio = performance.velocityMadeGood / performance.polarVelocityMadeGood
         }
       } else {
@@ -462,7 +468,7 @@ module.exports = function (app) {
           for (let index = 0; index < row.length-1; index++) {
             if (row[index+1] != 0) {
               polar[index][angleName] = angle
-              let tbs = ktsToMs(Number(row[index+1]))
+              let tbs = ktsToMs(Number(row[index+1])) * (options.perfAdjust || 1)
               let vmg = tbs * Math.abs(Math.cos(angle))
               polar[index][VMGName] = roundDec(vmg)
               if (typeof polar[index]['twa'] == 'undefined') {
@@ -483,7 +489,7 @@ module.exports = function (app) {
             if (typeof polar[index].twa == 'undefined') {
               polar[index].twa = []
             }
-            let tbs = ktsToMs(Number(row[index+1]))
+            let tbs = ktsToMs(Number(row[index+1])) * (options.perfAdjust || 1)
             let vmg = tbs * Math.abs(Math.cos(angle))
             let Obj = {"twa": angle, "tbs": tbs, "vmg": vmg}
             // app.debug('Adding Obj: %s', JSON.stringify(Obj))
@@ -546,6 +552,23 @@ module.exports = function (app) {
       }
 
       // And now fill in some missing ends to avoid doing expensive calculations in the main loop
+      if (polar[0].tws > 0) {
+        // Add a 0 line to allow interpolation at very low wind speeds
+        app.debug('Add a 0 line to allow interpolation at very low wind speeds')
+        let Obj = {
+           tws: 0.0001,
+          'Beat angle': polar[0]['Beat angle'],
+          'Beat VMG': polar[0]['Beat VMG'],
+          'Run angle': polar[0]['Run angle'],
+          'Run VMG': polar[0]['Run VMG'],
+          twa: []
+        }
+        Object.keys(polar[0].twa).forEach(twaObj => {
+          Obj.twa.push({twa: twaObj.twa, tbs: 0})
+        })
+        polar.unshift(Obj)
+      }
+
       for (let index = 0; index < polar.length; index++) {
         // Sorted on angle, so first is lowest
         let tws = polar[index].tws
@@ -568,7 +591,7 @@ module.exports = function (app) {
         polar[index].twa = topArray.concat(twaArray)
       }
 
-      for (let index = 0; index < polar.length-1; index++) {
+      for (let index = 0; index < polar.length; index++) {
         let tws = polar[index].tws
         let twaArray = polar[index].twa
         let highTBS = twaArray[twaArray.length-1].tbs
@@ -635,6 +658,8 @@ module.exports = function (app) {
           data.datasets[index].pointRadius.push(radius)
         }
       }
+      // Remove 0 kts line
+      data.datasets.shift()
       return data
     }