Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Waypoint ID added to Course Definitions #660

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Techstyleuk
Copy link

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

Updating the specification to be inline with how its parsed in some of the nmea0183-signalk hooks.  for example, APB.  see: SignalK/nmea0183-signalk#239
This is a partial fix
this file was updated after running npm test
@panaaj
Copy link
Member

panaaj commented Feb 18, 2024

This should be aligned with the Course API where possible.

@Techstyleuk
Copy link
Author

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
Copy link
Member

panaaj commented Feb 18, 2024

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....

  • Is the id only relevant in the context of a waypoint being part of a route?
  • What relationship is there between this id and a SignalK waypoint resource?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants