Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.59 KB

course_calculations.md

File metadata and controls

70 lines (52 loc) · 2.59 KB

Course Calculations and Providers

The Course API defines the path /vessels/self/navigation/course/calcValues to accommodate the calculated values related to course navigation.

These paths are available to be populated by a "course provider" plugin that uses the course information set using the Course API. This approach promotes the extensibility of Signal K server providing flexibility and interoperability. See Course Provider Plugins below.

Calculated value paths: calcValues

The following paths are defined to hold values calculated using the information maintained by Course API operations:

  • calcMethod: ("Rhumbline" or "GreatCircle")
  • crossTrackError
  • bearingTrackTrue
  • bearingTrackMagnetic
  • estimatedTimeOfArrival (e.g. "2022-04-22T05:02:56.484Z")
  • distance
  • bearingTrue
  • bearingMagnetic
  • velocityMadeGood
  • timeToGo
  • targetSpeed
  • previousPoint.distance

Example:

{
  "calcMethod": "Rhumbline",
  "crossTrackError": 458.784,
  "bearingTrackTrue": 4.58491,
  "bearingTrackMagnetic": 4.51234,
  "estimatedTimeOfArrival": "2022-04-22T05:02:56.484Z",
  "distance": 10157,
  "bearingTrue": 4.58491,
  "bearingMagnetic": 4.51234,
  "velocityMadeGood": 7.2653,
  "timeToGo": 8491,
  "targetSpeed": 2.2653,
  "previousPoint": {
    "distance": 10157
  }
}

Course Notifications

Calculated course values that cross a threshold should trigger a notification so that the necessary action can be taken.

The Course API defines the following notifications which should be implemented by a course provider:

  • navigation.course.arrivalCircleEntered
  • navigation.course.perpendicularPassed

Course Provider Plugins

Signal K server includes the Course Data Provider plugin as part of the installation to provide out-of-the-box support for course calculations nd notifications.

This plugin can be replaced with others from the AppStore, or your own, to extend the number and types of calculations performed.

If you are looking to develop a course provider plugin, following are the recommended guidlines:

  1. Ensure values are generated for ALL the defined paths (above)
  2. Values MUST be calculated using /vessels/self/navigation/course path values mainntained by the Course API
  3. Ensure values are set to null when no destination is set or the value cannot be calculated
  4. Perform the calculations using a "worker thread" to minimise impact on the server "main thread"
  5. Ensure the worker is set up and shut down as part of plugin "start" and "stop" functions
  6. Raise the notifications outlined above.