signalk-polar-performance-plugin 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +4 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,12 +11,12 @@ The following paths are read
11
11
  - environment.wind.angleTrueWater
12
12
 
13
13
  ## Polar diagram
14
- For starters, use the plugin config to set one polar diagram.
14
+ Use the plugin config to configure the polar diagram.
15
15
  Simple interpolation will be used to get the corresponding values from the polar diagram info.
16
16
  For polar diagrams you can check [ORC sailboat data](https://jieter.github.io/orc-data/site/).
17
17
 
18
18
  ## Calculated performance data
19
- The following data is calculated
19
+ ### The following data is calculated
20
20
  - Upwind / beat angle (performance.beatAngle)
21
21
  - Downwind / run / gybe angle (performance.gybeAngle)
22
22
  - Upwind / beat VMG (performance.beatAngleVelocityMadeGood)
@@ -26,7 +26,7 @@ The following data is calculated
26
26
  - Polar Boat Speed (performance.polarSpeed)
27
27
  - Polar Speed Ratio (performance.polarSpeedRatio)
28
28
 
29
- ## To-do list
29
+ ### To-do list
30
30
  - Fill up the ends of the polar diagram
31
31
  - A switch to use SOG as boat speed
32
32
  - Wind angle for maximum speed at this wind speed
@@ -38,5 +38,6 @@ The following data is calculated
38
38
  -- Determine if we're on a steady course to avoid fake records
39
39
  -- Dampening algoritms
40
40
  -- Configure the resolution of the polar diagram
41
+ - Support multiple polar diagrams
41
42
  - Capture heel in polar diagram
42
43
  - Visualisation of the polar diagram
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "signalk-polar-performance-plugin",
3
- "version": "0.0.2",
3
+ "version": "0.0.3",
4
4
  "description": "A plugin that calculates performance information based on a (CSV) polar diagram.",
5
5
  "main": "plugin/index.js",
6
6
  "scripts": {