signalk-polar-performance-plugin 0.0.2 → 0.0.4
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.
- package/README.md +12 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,13 +10,18 @@ The following paths are read
|
|
|
10
10
|
- environment.wind.speedTrue
|
|
11
11
|
- environment.wind.angleTrueWater
|
|
12
12
|
|
|
13
|
-
##
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
13
|
+
## Plugin configuration
|
|
14
|
+
### Polar diagram
|
|
15
|
+
The polar diagram can be configured through CSV notation as used on [ORC sailboat data](https://jieter.github.io/orc-data/site/).
|
|
16
|
+
|
|
17
|
+
### Plugin options
|
|
18
|
+
In the plugin configuration you can toggle the following options:
|
|
19
|
+
- Enable calculation of beat/upwind and run/gybe/downwind angle
|
|
20
|
+
- Enable calculation of beat/upwind and run/gybe/downwind VMG
|
|
21
|
+
- Enable calculation of Optimal Wind Angle (difference between TWA and beat/run angle (depends on beat/run angle)
|
|
17
22
|
|
|
18
23
|
## Calculated performance data
|
|
19
|
-
|
|
24
|
+
### Currently supported
|
|
20
25
|
- Upwind / beat angle (performance.beatAngle)
|
|
21
26
|
- Downwind / run / gybe angle (performance.gybeAngle)
|
|
22
27
|
- Upwind / beat VMG (performance.beatAngleVelocityMadeGood)
|
|
@@ -26,7 +31,7 @@ The following data is calculated
|
|
|
26
31
|
- Polar Boat Speed (performance.polarSpeed)
|
|
27
32
|
- Polar Speed Ratio (performance.polarSpeedRatio)
|
|
28
33
|
|
|
29
|
-
|
|
34
|
+
### To-do list
|
|
30
35
|
- Fill up the ends of the polar diagram
|
|
31
36
|
- A switch to use SOG as boat speed
|
|
32
37
|
- Wind angle for maximum speed at this wind speed
|
|
@@ -38,5 +43,6 @@ The following data is calculated
|
|
|
38
43
|
-- Determine if we're on a steady course to avoid fake records
|
|
39
44
|
-- Dampening algoritms
|
|
40
45
|
-- Configure the resolution of the polar diagram
|
|
46
|
+
- Support multiple polar diagrams
|
|
41
47
|
- Capture heel in polar diagram
|
|
42
48
|
- Visualisation of the polar diagram
|