https://github.com/panaaj/freeboard-sk-helper
Freeboard-SK Helper Plugin
https://github.com/panaaj/freeboard-sk-helper
Last synced: 3 months ago
JSON representation
Freeboard-SK Helper Plugin
- Host: GitHub
- URL: https://github.com/panaaj/freeboard-sk-helper
- Owner: panaaj
- License: apache-2.0
- Created: 2019-12-08T05:33:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-09T10:20:00.000Z (almost 2 years ago)
- Last Synced: 2024-10-18T06:06:03.891Z (8 months ago)
- Language: TypeScript
- Size: 135 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
./vesels/self/navigation/courseGreatCircle/nextPoint/value/href
./vesels/self/navigation/course/targetArrivalTime
```
_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
vessels.self.navigation.courseGreatCircle.nextPoint.value.href
vessels.self.navigation.course.targetArrivalTime
```
_Deltas: (sent for the following paths)_
```
navigation.courseGreatCircle.activeRoute.href
navigation.courseGreatCircle.activeRoute.startTime
navigation.courseGreatCircle.nextPoint.position
navigation.courseGreatCircle.nextPoint.arrivalCircle
navigation.courseGreatCircle.nextPoint.value.href
navigation.course.targetArrivalTime
```
#### 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