freeboard-sk-helper

    1.4.1 • Public • Published

    Freeboard-SK-Helper:

    Signal K Server helper plugin for Freeboard-SK that acts as an API provider for the Signal K paths that are required to support Freeboard-SK operation and which may not be serviced by a Signal K server or installed plugins:


    Note: this plugin may be used from time to time to provide functionality for experimental features that may become part of Feeboard-SK in the future.


    Serviced Signal K Paths:

    Course Data:

    Provider to support the setting of an Active Route or Waypoint / Location as the current Destination.

    Used in conjunction with the Derived Data plugin this enables the display of data related to the current destination.

    HTTP: (GET/PUT)

    ./vesels/self/navigation/courseGreatCircle/activeRoute/href
    
    ./vesels/self/navigation/courseGreatCircle/activeRoute/startTime
    
    ./vesels/self/navigation/courseGreatCircle/nextPoint/position
    
    ./vesels/self/navigation/courseGreatCircle/nextPoint/arrivalCircle
    

    Stream:

    vessels.self.navigation.courseGreatCircle.activeRoute.href
    
    vessels.self.navigation.courseGreatCircle.activeRoute.startTime
    
    vessels.self.navigation.courseGreatCircle.nextPoint.position
    
    vessels.self.navigation.courseGreatCircle.nextPoint.arrivalCircle
    

    Deltas: (sent for the following paths)

    navigation.courseGreatCircle.activeRoute.href
    
    navigation.courseGreatCircle.activeRoute.startTime
    
    navigation.courseGreatCircle.nextPoint.position
    
    navigation.courseGreatCircle.nextPoint.arrivalCircle
    

    Notifications / Alarms:

    Serves as a provider for the following paths:

    navigation.courseGreatCircle.nextPoint.arrivalCircle

    • Enables the radius of the circle surrounding the active destination to be defined to allow an arrival alarm (notifications.navigation.arrivalCircleEntered) to be raised.

    Signal K special alarms:

    notifications.mob

    notifications.fire

    notifications.sinking

    notifications.flooding

    notifications.collision

    notifications.grounding

    notifications.listing

    notifications.adrift

    notifications.piracy

    notifications.abandon

    Notifications: (sent for the following paths)

    notifications.navigation.arrivalCircleEntered
    notifications.mob
    notifications.fire
    notifications.sinking
    notifications.flooding
    notifications.collision
    notifications.grounding
    notifications.listing
    notifications.adrift
    notifications.piracy
    notifications.abandon
    

    Experiments:

    • N/A

    Install

    npm i freeboard-sk-helper

    DownloadsWeekly Downloads

    30

    Version

    1.4.1

    License

    Apache-2.0

    Unpacked Size

    87.8 kB

    Total Files

    10

    Last publish

    Collaborators

    • panaaj