signalk-polar-performance-plugin 0.0.3 → 0.0.5

package/README.md

@@ -9,14 +9,20 @@ The following paths are read
  - navigation.speedThroughWater
  - environment.wind.speedTrue
  - environment.wind.angleTrueWater
+ - navigation.speedOverGround (optional)
 
-## Polar diagram
-Use the plugin config to configure the polar diagram.
-Simple interpolation will be used to get the corresponding values from the polar diagram info.
-For polar diagrams you can check [ORC sailboat data](https://jieter.github.io/orc-data/site/).
+## Plugin configuration
+### Polar diagram
+The polar diagram can be configured through CSV notation as used on [ORC sailboat data](https://jieter.github.io/orc-data/site/).
+
+### Plugin options
+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)
 
 ## Calculated performance data
-### The following data is calculated
+### Currently supported
  - Upwind / beat angle (performance.beatAngle) 
  - Downwind / run / gybe angle (performance.gybeAngle) 
  - Upwind / beat VMG (performance.beatAngleVelocityMadeGood) 
@@ -25,10 +31,10 @@ For polar diagrams you can check [ORC sailboat data](https://jieter.github.io/or
  - Optimal Wind Angle (diff between TWA and environment.wind.directionTrue)
  - Polar Boat Speed (performance.polarSpeed)
  - Polar Speed Ratio (performance.polarSpeedRatio)
+ - Plugin option to use SOG as boat speed
 
 ### To-do list
  - Fill up the ends of the polar diagram
- - A switch to use SOG as boat speed
  - Wind angle for maximum speed at this wind speed
  - Improved interpolation
  - Make moment to do calculation smarter/configurable

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-polar-performance-plugin",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "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 calculation of Optimal 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.'
+      },
       csvTable: {
         type: "string",
         title: "Enter csv with polar in http://jieter.github.io/orc-data/site/ style."
@@ -75,6 +79,14 @@ module.exports = function (app) {
       ]
     }
 
+    // Additional subscribes based on options
+    if (options.useSOG == true) {
+      localSubscription.subscribe.push({
+        path: 'navigation.speedOverGround',
+        policy: 'instant'
+      })
+    }
+
     app.subscriptionmanager.subscribe(
       localSubscription,
       unsubscribes,
@@ -97,6 +109,10 @@ module.exports = function (app) {
 	        STW = delta.value
           BSP = STW
 	        // app.debug('speedThroughWater (STW): %d', STW)
+	      } else if (delta.path == 'navigation.speedOverGround') {
+	        SOG = delta.value
+          BSP = SOG
+	        // app.debug('speedThroughWater (STW): %d', STW)
 	      } else if (delta.path == 'environment.wind.speedTrue') {
 	        TWS = delta.value
 	        // app.debug('environment.wind.speedTrue (TWS): %d', TWS)