Moving to Signal K Server & Freeboard SK Version 2

Moving to Signal K Server & Freeboard SK Version 2

This page contains guidance for configuring Freeboard-SK v2 after updating to Signal K server v2.

Note: Freeboard-SK v1.x can be continued to be used on Signal K server v1.x!

Freeboard-SK v2 makes use the new Reources API and Course API introduced by Signal K server v2 and due to this some changes to your configuration will need to be made. (See the new API specifications under Documentation -> OpenAPI in the Signal K Server v2 administration screen.

Configuration changes required.

1. Routes and Waypoints (Resources).

The Signal K server now has a built-in resource provider and no longer requires the the installation of the sk-resources-fs plugin.

To continue using existing your exisiting resource data, you will need to copy / move your resource files to the following path: $HOME/.signalk/plugin-config-data/resources-provider/resources.

Example:

/home
  /pi
    /.signalk
      /plugin-config-data
        /resources-provider
          /resources
            /routes
            /waypoints
            /notes
            /regions
            /fishingzones

Once the files have been relocated, from within the Plugin Config for Resources Provider (built-in) plugin, add any additional paths for non-standard resource types you have. (i.e. fishingzones in the above example.)

Ensure the Resources Provider (built-in) plugin is enabled.

Finally disable / uninstall the sk-resources-fs plugin.

Note: You may need to re-select the resources to display in Freeboard-SK.

2. Disable / Uninstall freeboard-sk-helper plugin

This plugin is no longer required.

Note: Helper plugin features are available under Freeboard-SK in the Plugin Config screen.

3. Update Course Data calculation settings.

Signal K Server now includes a Course Data Provider plugin which uses the destination data set by the Course API to calculate both GreatCircle and Rhumbline values for DTG, XTE, BRG VMG, etc.

If you are using the signalk-derived-data plugin and have configured it to calculate these course values, you will need to update your configuration to stop the signalk-derived-data plugin from doing the calculations.**

• Course DTG, XTE, BRG, TTG, etc
• Velocity Made Good towards next waypoint

Finally ensure the Course Data Provider plugin is enabled.

---

FAQ

Why doesn't Freeboard-SK show my Routes and Waypoints after upgrading to v2?

Because Freeboard-SK uses the new Resources API under /signalk/api/v2/resources, you cannot continue to use sk-resources-fs plugin.

To update your configuration see 1. Routes and Waypoints (Resources). above.

Why doesn't Freeboard-SK show my calculated course data after upgrading to v2?

Because Freeboard-SK uses the new Course API under /signalk/api/v2/vessels/self/navigation/course, you need to ensure that the Course Data Provider plugin is enabled.

See 3. Update Course Data calculation settings. above.