Socket
Socket
Sign inDemoInstall

@signalk/course-provider

Package Overview
Dependencies
2
Maintainers
5
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @signalk/course-provider

Course data provider plugin for SignalK Server.


Version published
Weekly downloads
597
decreased by-22.16%
Maintainers
5
Created
Weekly downloads
 

Changelog

Source

v1.0.1

  • Update: - Change plugin catagory keyword to signalk-category-utility.

Readme

Source

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

Additionally it will raise the following notification:

  • notifications.navigation.arrivalCircleEntered: alert message is sent when the value of distance falls below the value of navigation.course.nextPoint.arrivalCircle.

  • notifications.navigation.perpendicularPassed: alert message is sent when the perpendicular line (relative to navigation.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.

Keywords

FAQs

Last updated on 04 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc