search

SignalK / specification

Signal K is a JSON-based format for storing and sharing marine data from different sources (e.g. nmea 0183, 2000, seatalk, etc)
Other
91 stars 68 forks source link

Waypoint ID added to Course Definitions #660

Open Techstyleuk opened 4 months ago

Techstyleuk commented 4 months ago

Updating the specification to be inline with how its parsed in some of the nmea0183-signalk hooks. for example, APB. see: https://github.com/SignalK/nmea0183-signalk/issues/239 This is a partial fix

panaaj commented 4 months ago

This should be aligned with the Course API where possible.

Techstyleuk commented 4 months ago

I think between:

Course API - the Spec. - nmea0183-signalk (APB)

there are inconsistencies, APB writes the Waypoint as ......nextPoint.ID, but this is not in the spec.

I added to the spec. If this shouldn't be in the spec. or if Course API should be updated to reflect the change, let me know what you are thinking?

Having read the API, I am not sure what I would put to close that loop out

panaaj commented 4 months ago

I think that there are some paths written by plugins that addressed a specific need / use case at the time. That said, there are also some areas to address from an API perspective, for example aligning data coming from NMEA devices.

For me, if the waypoint id is meaningful (has relevance) only to the device that transmitted it, I would question the need for a path in the spec. But if we are clear about what role the id has, and if it is of wider interest to other connected devices, then we should add it to the spec and describe the value it holds and the relationship to other course paths (Course paths need to be managed as a collection).

Some questions that probably need to be answered....