signalk-polar-performance
v0.1.1
Published
Sailing polar diagrams with live performance calculations for SignalK. Includes sail wardrobe management, polar tables per sail combination, crossover charts, and real-time performance metrics.
Maintainers
Readme
signalk-polar-performance
Sailing polar diagrams with live performance calculations for SignalK.
Features
- Sail wardrobe management — configure mainsail reef states and headsails (genua, gennaker, spinnaker)
- Polar tables per sail combination — auto-generated from sail wardrobe, each with its own polar data
- Live performance metrics — polar speed, polar performance %, optimal VMG, target TWA
- Crossover charts — compare sail combinations to find optimal sail selection per TWA/TWS
- NMEA replay — replay logged data for polar building and analysis
- SignalK webapp — integrated into SignalK's admin UI
Installation
From npm (recommended)
In the SignalK admin UI: Appstore → Available → search "polar" → Install
Or via command line:
cd ~/.signalk
npm install signalk-polar-performanceFrom source
cd ~/.signalk/node_modules
git clone https://github.com/TinkerSailor/signalk-polar-performance.git
cd ~/.signalk
npm install --save file:node_modules/signalk-polar-performanceConfiguration
- Enable the plugin in SignalK → Server → Plugin Config
- Configure your sail wardrobe (mainsail reef stages, headsails)
- Sail! Polar data is collected automatically from live wind and speed data
SignalK paths used
| Path | Description |
|---|---|
| environment.wind.speedTrue | True wind speed |
| environment.wind.angleTrueWater | True wind angle |
| navigation.speedThroughWater | Boat speed (STW) |
| navigation.courseOverGroundTrue | Course over ground |
Data files
Polar data is stored in ~/.signalk/plugin-config-data/signalk-polar-performance/.
Default polar files (genua.json, gennaker.json) are included as starting templates.
License
MIT
