signalk-polar-performance-plugin 0.0.1 → 0.0.2
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 +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Generate performance information based on a polar diagram.
|
|
3
3
|
|
|
4
4
|
## Data correctness
|
|
5
|
-
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
|
|
5
|
+
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).
|
|
6
6
|
|
|
7
7
|
## Data sources
|
|
8
8
|
The following paths are read
|
|
@@ -13,7 +13,7 @@ The following paths are read
|
|
|
13
13
|
## Polar diagram
|
|
14
14
|
For starters, use the plugin config to set one polar diagram.
|
|
15
15
|
Simple interpolation will be used to get the corresponding values from the polar diagram info.
|
|
16
|
-
For polar diagrams you can check
|
|
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
19
|
The following data is calculated
|
|
@@ -21,7 +21,7 @@ The following data is calculated
|
|
|
21
21
|
- Downwind / run / gybe angle (performance.gybeAngle)
|
|
22
22
|
- Upwind / beat VMG (performance.beatAngleVelocityMadeGood)
|
|
23
23
|
- Downwind / run / gybe VMG (performance.gybeAngleVelocityMadeGood)
|
|
24
|
-
- Target TWA (performance.targetAngle)
|
|
24
|
+
- Target TWA (performance.targetAngle) (equals upwind or downwind angle)
|
|
25
25
|
- Optimal Wind Angle (diff between TWA and environment.wind.directionTrue)
|
|
26
26
|
- Polar Boat Speed (performance.polarSpeed)
|
|
27
27
|
- Polar Speed Ratio (performance.polarSpeedRatio)
|