signalk-polar-performance-plugin 0.0.6 → 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-polar-performance-plugin",
-  "version": "0.0.6",
+  "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,9 +24,9 @@ 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',
@@ -120,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) {
@@ -129,7 +129,6 @@ module.exports = function (app) {
             port = 1
           }
 	        TWA = Math.abs(delta.value)
-	        // app.debug('environment.wind.angleTrueWater (TWA): %d', TWA)
 	      }
       })
     }
@@ -143,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)})
@@ -150,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)})
@@ -201,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) {
@@ -220,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
@@ -398,7 +401,7 @@ function ktsToMs(knots) {
   return knots / 1.94384
 }
 
-function MsToKts(ms) {
+function msToKts(ms) {
   return ms * 1.94384
 }