@signalk/course-provider
v1.1.0
Published
Course data provider plugin for SignalK Server.
Downloads
1,694
Readme
Course Provider Plugin:
Signal K server plugin that acts as a Course data provider.
Note: This plugin should ONLY be installed on Signal K Server version 2.0 or later!
This plugin populates the following course data paths found under navigation.course.calcValues
as well as providing an API endpoint at /signalk/v2/api/vessels/self/navigation/course/calcValues
:
calcMethod
bearingTrackTrue
bearingTrackMagnetic
crossTrackError
previousPoint.distance
distance
bearingTrue
bearingMagnetic
velocityMadeGood
timeToGo
estimatedTimeOfArrival
targetSpeed
AND
performance.velocityMadeGoodToWaypoint
Additionally it will raise the following notification:
notifications.navigation.arrivalCircleEntered
: alert message is sent when the value ofdistance
falls below the value ofnavigation.course.nextPoint.arrivalCircle
.notifications.navigation.perpendicularPassed
: alert message is sent when the perpendicular line (relative tonavigation.course.previousPoint.position
at the destination has been passed by the vessel.
Configuration
Notifications: provides configuration for generated notifications.
- Enable sound: Checking this option sets the
sound
flag for any notifications generated.
Calculation method: Select the course calculation method to use and the paths to populate.
- GreatCircle (default): populates values using GreatCircle calculations.
- Rhumbline: populates values using Rhumbline calculations.