signalk-polar-performance-plugin 0.0.14 → 0.0.16

package/README.md

@@ -37,12 +37,12 @@ In the plugin configuration you can toggle the following options:
  - Plugin option to use SOG as boat speed
  - Wind angle for maximum speed at this wind speed
  - Fill up the ends of the polar diagram
+ - Visualisation of the polar diagram
 
 ### To-do list
  - Improved interpolation
  - Make moment to do calculation smarter/configurable
  - API to see JSON of polar
- - Visualisation of the polar diagram
  - Extrapolation of polar data
  - Create polar from live data
  -- Save polar info to file

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-polar-performance-plugin",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "A plugin that calculates performance information based on a (CSV) polar diagram.",
   "main": "plugin/index.js",
   "scripts": {
@@ -17,6 +17,7 @@
   },
   "homepage": "https://github.com/htool/signalk-polar-performance-plugin#readme",
   "keywords": [
+    "signalk-webapp",
     "signalk-node-server-plugin",
     "signalk-category-instruments",
     "signalk-category-chart-plotters"

package/plugin/index.js

@@ -28,6 +28,10 @@ module.exports = function (app) {
         type: 'boolean',
         title: 'Enable sending Target TWA (performance.targetAngle)'
       },
+      tackTrue: {
+        type: 'boolean',
+        title: 'Enable calculating Opposite Tack True (performance.tackTrue)'
+      },
       optimumWindAngle: {
         type: 'boolean',
         title: 'Enable calculation of Optimum Wind Angle (difference between TWA and beat/run angle (depends on beat/run angle)'
@@ -62,9 +66,23 @@ module.exports = function (app) {
     // Load polar table
     var polar = csvToPolarObject(options.csvTable)
     app.debug('polar: %s', JSON.stringify(polar))
+
+    plugin.registerWithRouter = function(router) {
+      // Will appear here; plugins/signalk-polar-performance-plugin/
+      app.debug("registerWithRouter")
+      router.get("/polar", (req, res) => {
+        res.contentType("application/json")
+        res.send(JSON.stringify(polar))
+      })
+      router.get("/chartData", (req, res) => {
+        res.contentType("application/json")
+        res.send(JSON.stringify(getChartData()))
+      })
+    }
+
    
     // Global variables
-    var BSP, STW, TWA, TWS, port // Angles in rad, speed in m/s
+    var BSP, STW, TWA, targetTWA, TWS, HDG, port // Angles in rad, speed in m/s
     var halfPi = Math.PI / 2
 
     // Subscribe to paths
@@ -93,6 +111,12 @@ module.exports = function (app) {
         policy: 'instant'
       })
     }
+    if (options.tackTrue == true) {
+      localSubscription.subscribe.push({
+          path: 'navigation.headingTrue',
+          policy: 'instant'
+      })
+    }
 
     app.subscriptionmanager.subscribe(
       localSubscription,
@@ -120,6 +144,9 @@ module.exports = function (app) {
 	        SOG = delta.value
           BSP = SOG
 	        // app.debug('speedThroughWater (STW): %d', STW)
+	      } else if (delta.path == 'navigation.headingTrue') {
+	        HDG = delta.value
+	        // app.debug('heading (HDG): %d', HDG)
 	      } else if (delta.path == 'environment.wind.speedTrue') {
 	        TWS = delta.value
 	        // app.debug('environment.wind.speedTrue (TWS): %d', TWS)
@@ -186,6 +213,11 @@ module.exports = function (app) {
         values.push({path: 'performance.maxSpeedAngle', value: roundDec(perfObj.maxSpeedAngle)})
         metas.push({path: 'performance.maxSpeedAngle', value: {"units": "rad"}})
       }
+      if (options.tackTrue == true) {
+        if (typeof perfObj.tackTrue != 'undefined') {
+          values.push({path: 'performance.tackTrue', value: roundDec(perfObj.tackTrue)})
+        }
+      }
 
       app.debug('sendUpdates: %s', JSON.stringify(values))
       app.handleMessage(plugin.id, {
@@ -218,6 +250,7 @@ module.exports = function (app) {
 	            let beatLower = polar[indexTWS]['Beat angle']
 	            let beatUpper = polar[indexTWS+1]['Beat angle']
 	            performance.beatAngle = beatLower + ((beatUpper - beatLower) * twsGapRatio)
+              targetTWA = performance.beatAngle
             }
 	          // Calculate optimum wind angle (B&G thing)
 	          if (options.optimumWindAngle == true) {
@@ -239,6 +272,7 @@ module.exports = function (app) {
 	            let runUpper = polar[indexTWS+1]['Run angle']
 	            //app.debug('runLower: %s runUpper: %s', runLower, runUpper)
 	            performance.runAngle = runLower + ((runUpper - runLower) * twsGapRatio)
+              targetTWA = performance.runAngle
             }
 	          if (options.optimumWindAngle == true) {
               if (typeof performance.runAngle != 'undefined') {
@@ -254,6 +288,21 @@ module.exports = function (app) {
 	            performance.runVMG = VMGLower + ((VMGUpper - VMGLower) * twsGapRatio)
             }
           }
+          // Calculate opposite Tack True
+          // app.debug('tackTrue: port: %d HDG: %d targetTWA: %d', port, radToDeg(HDG), radToDeg(targetTWA))
+          if (port) {
+            let tackTrue = HDG - targetTWA
+            if (tackTrue < 0) {
+              tackTrue = tackTrue + (2*Math.PI)
+            }
+            performance.tackTrue = tackTrue
+          } else {
+            let tackTrue = HDG + targetTWA
+            if (tackTrue > (2*Math.PI)) {
+              tackTrue = tackTrue - (2*Math.PI)
+            }
+            performance.tackTrue = tackTrue
+          }
           // Calculate polar target boat speed
 
           // Interpolate Define the 4 near data points
@@ -420,9 +469,9 @@ module.exports = function (app) {
         for (let index = 0; index < polar.length-1; index++) {
           let tws = polar[index].tws
           let beatVMG = 0
-          let beatVMGelement = 0
+          let beatElement = 0
           let runVMG = 0
-          let runVMGelement = 0
+          let runElement = 0
 
           let twaArray = polar[index].twa
           for (let element = 0; element < twaArray.length-1; element++) {
@@ -439,12 +488,12 @@ module.exports = function (app) {
               }
             }
           }
-          app.debug('beatVMG for %d is %d (angel %d)', tws, twaArray[beatVMGelement].vmg, twaArray[beatVMGelement].twa)
-          app.debug(' runVMG for %d is %d (angel %d)', tws, twaArray[runVMGelement].vmg, twaArray[runVMGelement].twa)
-          polar[index]['Beat angle'] = twaArray[beatVMGelement].twa
-          polar[index]['Beat VMG'] = twaArray[beatVMGelement].vmg
-          polar[index]['Run angle'] = twaArray[runVMGelement].twa
-          polar[index]['Run VMG'] = twaArray[runVMGelement].vmg
+          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)
+          polar[index]['Beat angle'] = twaArray[beatElement].twa
+          polar[index]['Beat VMG'] = twaArray[beatElement].vmg
+          polar[index]['Run angle'] = twaArray[runElement].twa
+          polar[index]['Run VMG'] = twaArray[runElement].vmg
         }
         
       }
@@ -462,7 +511,8 @@ module.exports = function (app) {
         // Now put some extra values at the beginning
         var topArray = []
         for (let angle = 0; angle < lowTWA; angle = angle + degToRad(5)) {
-          let tbs = (angle / lowTWA) * Math.pow(Math.cos((-1*lowTWA + angle)*3),3) * lowTBS
+          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}
           topArray.push(Obj)
         }
@@ -492,6 +542,41 @@ module.exports = function (app) {
       // app.debug(JSON.stringify(polar))
 		  return (polar)
 		}
+
+    function getChartData () {
+      const color = ["#0000FF","#3300FF","#6600FF","#9900FF","#CC00FF","#FF00FF","#0033FF","#3333FF","#6633FF","#9933FF","#CC33FF","#FF33FF","#0066FF","#3366FF","#6666FF","#9966FF","#CC66FF","#FF66FF"]
+
+      var data = {
+        labels: [],
+        datasets: []
+      }
+      for (let angle = 0; angle <= 180; angle += 5) {
+        data.labels.push(angle)
+      }
+      for (let index = 0; index < polar.length -1; index++) {
+        // Add x axis label TWS
+        let tws = msToKts(polar[index].tws).toFixed(0)
+        let twaArray = polar[index].twa
+        data.datasets[index] = {
+          data: [],
+          pointRadius: [],
+          borderColor: color[index],
+          fill: false,
+          parsing: false,
+          label: tws + ' kts'
+        }
+        for (let twaIndex = 0; twaIndex <= twaArray.length-1; twaIndex++) {
+          let twaObj = twaArray[twaIndex]
+          let radius = 2
+          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].pointRadius.push(radius)
+        }
+      }
+      return data
+    }
   }
 
   plugin.stop = function () {

package/public/index.html

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.5.0/Chart.min.js"></script>
+<script type='text/javascript' src='/jquery/dist/jquery.min.js'></script>
+<title>Polar performance</title>
+<body>
+
+<canvas id="myChart" style="width:100%;max-width:1200px"></canvas>
+
+<script>
+$.getJSON("/plugins/signalk-polar-performance-plugin/chartData", function(json) {
+  showChart(json)
+})
+
+function showChart (data) {
+  console.log(data)
+
+  new Chart("myChart", {
+    type: "scatter",
+    data: data,
+    options: {
+      legend: {display: true},
+      spanGaps: true,
+      scales: {
+        x: {
+          type: 'linear'
+        },
+        xAxes: [{
+          scaleLabel: {
+            display: true,
+            labelString: 'True wind angle (TWA)'
+          }
+        }],
+        yAxes: [{
+          scaleLabel: {
+            display: true,
+            labelString: 'Target boat speed (POL SPD)'
+          }
+        }],
+      }
+    }
+  })
+}
+</script>
+