Routes and Waypoints support

[sergei]

I'm considering to use the SignalK in my app running on Raspberry PI.

One of its functionalities is the navigation using routes from uploaded GPX files. It seems that SignalK schema does support routes and waypoints, but if I try to send this data:

{
  "requestId": "c0d79334-4e25-4245-8892-54e8ccc8021d",
  "put": {
    "path": "resources.waypoints.BONITA",
    "value": {
      "position": {
        "longitude": -122,
        "latitude": 38
      }
    }
  }
}

I'm getting this response from the sever:

[
  {
    "state": "COMPLETED",
    "requestId": "c0d79334-4e25-4245-8892-54e8ccc8021d",
    "statusCode": 405,
    "message": "PUT not supported for resources.waypoints.BONITA",
    "href": "/signalk/v1/requests/c0d79334-4e25-4245-8892-54e8ccc8021d"
  }
]

Does it mean I need to install/develop some plugin?

[sbender9]

By default, you can't put to any path.

Please see https://github.com/SignalK/specification/blob/put-clarification/gitbook-docs/put.md

This might do what you need https://github.com/panaaj/signalk-resources-fs#readme

[sbender9]

Sorry edited. I answered to quick without fully thinking.

[sergei]

Thanks a lot, it's getting clearer and clearer. :-)

• Once I installed and enabled the signalk-resources-fs plugin I'm able to create the waypoint with PUT method (of course using proper syntax).
• If I disable this plugin I'm getting the 405 PUT not supported.

I guess it means:

• Path resources/waypoints is not supported by the core server
• Any plugin can add support for path defined in the schema.
• Or maybe any plugin can add support for any path even it's not defined in the schema?

Related question. The way how the route is defined in the schema and in this plugin is not very compatible with my use case.

Usually I have GPX file with several routes each of them corresponding to one of the race courses. Each route consists of waypoints with assigned names (usually buoys names). My app shows and announces the names of the routes and the names of the marks. However the SignalK schema only provides the geometry of the route without ability to set the marks names.

What would be suggested action? Should I add my own plugin that defines new type for such route with named points? Or shall I modify the schema and signalk-resources-fs plugin to add this feature?

[sbender9]

Yeah, so the core server doesn't support PUT for many things. We let plugins handle most of that. This is because most things require some specific actions to take place (switching on a Hue light).

This is something the core server could support, since it's really just about storing some data. But happy to let plugins handle it for now...

Any plugin can add support for any path. We don't enforce the specification at all. This would horribly stifle innovation IMHO.

As for as the spec goes, that's a tough one. We won't make breaking changes to the v1.x spec, so if your changes would break existing stuff, then not the way go.

We do plan on a v2, so any input and changes there are welcomed.

You should probably reach out to Adrian as far as deciding about writing a new plugin or modifying sk-resources. He knows more about the waypoints/routes stuff than I do. Ideally your needs and freeboard's needs could coexist.

[panaaj]

@sergei The signalk-resources-fs plugin stores resources as per the Signalk K specification.
The Route resource, as you indicated, uses a GeoJSON object to store the coordinates of the route.
One option is to store the names associated with each point in the route properties section of the GeoJSON `object.

"properties":{
   "wptNames": ['wpt1","wpt2",.....]
}

This will be available to the software you are using when it references the desired route.

[sergei]

Thanks Adrian, I'll follow your advice.

[sergei]

@panaaj I created PR SignalK/freeboard-sk#95 please review it.