signalk-polar-performance-plugin 0.0.5 → 0.0.8

package/README.md

@@ -1,6 +1,15 @@
 # Polar performance plugin
 Generate performance information based on a polar diagram.
 
+
+## MFD configuration
+
+### B&G
+To make use of the performance data and get e.g. lay lines you need to set:
+ - Settings -> Chart -> Laylines -> Targets... -> True wind angle to 'Actual'
+ - SailSteer screen -> Long press tile to add 'Performance -> Target TWA -> decollapse, choose SignalK'
+Now the Target TWA is coming from SignalK and the laylines will be drawn based on it's value.
+
 ## Data correctness
 It's assumed data is already corrected when it's read by this plugin. This can be sometimes be done by the sensor, sometimes upon entry into SignalK using the [calibration plugin](https://www.npmjs.com/package/@signalk/calibration).
 
@@ -19,7 +28,7 @@ The polar diagram can be configured through CSV notation as used on [ORC sailboa
 In the plugin configuration you can toggle the following options:
  - Enable calculation of beat/upwind and run/gybe/downwind angle
  - Enable calculation of beat/upwind and run/gybe/downwind VMG
- - Enable calculation of Optimal Wind Angle (difference between TWA and beat/run angle (depends on beat/run angle)
+ - Enable calculation of Optimum Wind Angle (difference between TWA and beat/run angle (depends on beat/run angle)
 
 ## Calculated performance data
 ### Currently supported
@@ -32,10 +41,10 @@ In the plugin configuration you can toggle the following options:
  - Polar Boat Speed (performance.polarSpeed)
  - Polar Speed Ratio (performance.polarSpeedRatio)
  - Plugin option to use SOG as boat speed
+ - Wind angle for maximum speed at this wind speed
 
 ### To-do list
  - Fill up the ends of the polar diagram
- - Wind angle for maximum speed at this wind speed
  - Improved interpolation
  - Make moment to do calculation smarter/configurable
  - Create polar from live data

package/package.json

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

package/plugin/index.js

@@ -24,14 +24,18 @@ module.exports = function (app) {
         type: 'boolean',
         title: 'Enable calculation of beat/upwind and run/gybe/downwind VMG'
       },
-      optimalWindAngle: {
+      optimumWindAngle: {
         type: 'boolean',
-        title: 'Enable calculation of Optimal Wind Angle (difference between TWA and beat/run angle (depends on beat/run angle)'
+        title: 'Enable calculation of Optimum Wind Angle (difference between TWA and beat/run angle (depends on beat/run angle)'
       },
       useSOG: {
         type: 'boolean',
         title: 'Use speed over ground (SOG) as boat speed.'
       },
+      maxSpeed: {
+        type: 'boolean',
+        title: 'Enable writing of maximum speed angle and boat speed for a given TWS'
+      },
       csvTable: {
         type: "string",
         title: "Enter csv with polar in http://jieter.github.io/orc-data/site/ style."
@@ -116,7 +120,7 @@ module.exports = function (app) {
 	      } 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', TWS, TWA, BSP)
+	        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) {
@@ -125,7 +129,6 @@ module.exports = function (app) {
             port = 1
           }
 	        TWA = Math.abs(delta.value)
-	        // app.debug('environment.wind.angleTrueWater (TWA): %d', TWA)
 	      }
       })
     }
@@ -139,6 +142,8 @@ module.exports = function (app) {
       }
       if (typeof perfObj.beatVMG != 'undefined') {
         values.push({path: 'performance.beatAngleVelocityMadeGood', value: roundDec(perfObj.beatVMG)})
+        values.push({path: 'performance.targetVelocityMadeGood', value: roundDec(perfObj.beatVMG)})
+        metas.push({path: 'performance.targetVelocityMadeGood', value: {"units": "rad"}})
       }
       if (typeof perfObj.runAngle != 'undefined') {
         values.push({path: 'performance.gybeAngle', value: roundDec(perfObj.runAngle)})
@@ -146,10 +151,12 @@ module.exports = function (app) {
       }
       if (typeof perfObj.runVMG != 'undefined') {
         values.push({path: 'performance.gybeAngleVelocityMadeGood', value: roundDec(perfObj.runVMG)})
+        values.push({path: 'performance.targetVelocityMadeGood', value: roundDec(perfObj.runVMG)})
+        metas.push({path: 'performance.targetVelocityMadeGood', value: {"units": "rad"}})
       }
-      if (typeof perfObj.optimalWindAngle != 'undefined') {
-        values.push({path: 'performance.optimalWindAngle', value: roundDec(perfObj.optimalWindAngle)})
-        metas.push({path: 'performance.optimalWindAngle', value: {"units": "rad"}})
+      if (typeof perfObj.optimumWindAngle != 'undefined') {
+        values.push({path: 'performance.optimumWindAngle', value: roundDec(perfObj.optimumWindAngle)})
+        metas.push({path: 'performance.optimumWindAngle', value: {"units": "rad"}})
       }
       if (typeof perfObj.targetSpeed != 'undefined') {
         values.push({path: 'performance.targetSpeed', value: roundDec(perfObj.targetSpeed)})
@@ -158,6 +165,12 @@ module.exports = function (app) {
         values.push({path: 'performance.polarSpeed', value: roundDec(perfObj.polarSpeed)})
         values.push({path: 'performance.polarSpeedRatio', value: roundDec(perfObj.polarSpeedRatio)})
       }
+      if (typeof perfObj.maxSpeed != 'undefined') {
+        values.push({path: 'performance.maxSpeed', value: roundDec(perfObj.maxSpeed)})
+        metas.push({path: 'performance.maxSpeed', value: {"units": "m/s"}})
+        values.push({path: 'performance.maxSpeedAngle', value: roundDec(perfObj.maxSpeedAngle)})
+        metas.push({path: 'performance.maxSpeedAngle', value: {"units": "rad"}})
+      }
 
       app.debug('sendUpdates: %s', JSON.stringify(values))
       app.handleMessage(plugin.id, {
@@ -191,9 +204,9 @@ module.exports = function (app) {
 	            let beatUpper = polar[indexTWS+1]['Beat angle']
 	            performance.beatAngle = beatLower + ((beatUpper - beatLower) * twsGapRatio)
             }
-	          // Calculate optimal wind angle
-	          if (options.optimalWindAngle == true) {
-	            performance.optimalWindAngle = performance.beatAngle - TWA * port
+	          // Calculate optimum wind angle (B&G thing)
+	          if (options.optimumWindAngle == true) {
+              performance.optimumWindAngle = (TWA - performance.beatAngle) * port
 	          }
 	          // Calculate beat VMG
 	          if (options.beatVMG == true) {
@@ -210,9 +223,9 @@ module.exports = function (app) {
 	            //app.debug('runLower: %s runUpper: %s', runLower, runUpper)
 	            performance.runAngle = runLower + ((runUpper - runLower) * twsGapRatio)
             }
-	          if (options.optimalWindAngle == true) {
-	            // Calculate optimal wind angle
-	            performance.optimalWindAngle = performance.runAngle - TWA * port
+	          if (options.optimumWindAngle == true) {
+	            // Calculate optimum wind angle
+	            performance.optimumWindAngle = (performance.runAngle - TWA) * port * -1
 	          }
 	          if (options.beatVMG == true) {
 	            // Calculate run VMG
@@ -246,17 +259,25 @@ module.exports = function (app) {
               // Calculate upper tws boat speed
 	            let upperTBS = upperTWAlower.tbs + ((upperTWAupper.tbs - upperTWAlower.tbs) * twaGapRatio)
 
-              // Calculate target boat speed
+              // Calculate polar performance
               performance.polarSpeed = lowerTBS + ((upperTBS - lowerTBS) * twsGapRatio)
 	            // app.debug('lowerTBS: %d TBS: %d upperTBS: %d', lowerTBS, performance.polarSpeed, upperTBS)
 
-              // Calculate polar performance
+              // Calculate polar performance ratio
               performance.polarSpeedRatio = (1 / performance.polarSpeed) * BSP
-
+              break
             } 
           }
-
-          // Calculate polar performance ratio
+          if (options.maxSpeed == true) {
+            let lowerMax = polar[indexTWS]['Max speed']
+            let upperMax = polar[indexTWS+1]['Max speed']
+            let maxSpeed = lowerMax + ((upperMax - lowerMax) * twsGapRatio)
+            performance.maxSpeed = maxSpeed
+            let lowerMaxAngle = polar[indexTWS]['Max speed angle']
+            let upperMaxAngle = polar[indexTWS+1]['Max speed angle']
+            let maxSpeedAngle = lowerMaxAngle + ((upperMaxAngle - lowerMaxAngle) * twsGapRatio)
+            performance.maxSpeedAngle = maxSpeedAngle
+          }
         } else {
           // app.debug('%d not >= %d && <= %d', TWS, lower, upper)
         }
@@ -305,17 +326,16 @@ module.exports = function (app) {
             if (row[index] != 0) {
               polar[index-1][angleName] = degToRad(angle)
               polar[index-1][VMGName] = roundDec(Number((row[index]) * Math.abs(Math.cos(angle))))
-              app.debug('polar[index-1]: %s', polar[index-1])
               if (typeof polar[index-1]['twa'] == 'undefined') {
                 polar[index-1]['twa'] = []
               }
-              app.debug('polar[index-1]: %s', polar[index-1])
-              app.debug('Adding TargetBoatSpeed')
-              let Obj = {"twa": degToRad(angle), "tbs": ktsToMs(Number(row[index]))}
-              app.debug('Obj: %s', JSON.stringify(Obj))
+              let tbs = ktsToMs(Number(row[index]))
+              let Obj = {"twa": degToRad(angle), "tbs": tbs}
               polar[index-1]['twa'] = polar[index-1]['twa'].concat(Obj)
-              app.debug('polar[index-1]["twa"]: %s', polar[index-1]['twa'])
-              app.debug('polar: %s', JSON.stringify(polar))
+              if (typeof polar[index-1]['Max speed'] == 'undefined' || tbs > polar[index-1]['Max speed']) {
+                polar[index-1]['Max speed'] = tbs
+                polar[index-1]['Max speed angle'] = degToRad(angle)
+              }
             }
           }
         } else {
@@ -325,9 +345,13 @@ module.exports = function (app) {
             if (typeof polar[index-1].twa == 'undefined') {
               polar[index-1].twa = []
             }
-            let Obj = {"twa": angle, "tbs": ktsToMs(Number(row[index]))}
+            let tbs = ktsToMs(Number(row[index]))
+            let Obj = {"twa": angle, "tbs": tbs}
             polar[index-1]['twa'] = polar[index-1]['twa'].concat(Obj)
-            app.debug('polar: %s', JSON.stringify(polar))
+            if (tbs > polar[index-1]['Max speed']) {
+              polar[index-1]['Max speed'] = tbs
+              polar[index-1]['Max speed angle'] = angle
+            }
           }
         }
       })
@@ -377,7 +401,7 @@ function ktsToMs(knots) {
   return knots / 1.94384
 }
 
-function MsToKts(ms) {
+function msToKts(ms) {
   return ms * 1.94384
 }