Chart Sources - SignalK/freeboard-sk GitHub Wiki

Defining Charts Sources in Freeboard-SK

Freeboard-SK v2.12.0 and later provide the ability to create chart metadata entries for supported chart sources.

Once added, the charts become available within the charts list and can be displayed alongside any other existing charts.

Note: To use this functionality, the resources-provider plugin installed with the Signal K server must be enabled and the charts configuration enabled.

The following types of chart sources are supported:

  • WMTS (Web Map Tile Server)
  • WMS (Web Map Server)
  • JSON Sources (i.e. TileJSON, Mapbox Style)

Adding a Chart Source

To add a chart source:

  • Click the Resourcce Layers button and select Charts to display the Chart List.
  • Click the + button and choose the appropriate chart source type

image

Mapbox Style

To use a Mapbox Style JSON file as a source:

  • Select JSON Map Source
  • The Add JSON Map Source screen is displayed
  • Enter the url to the mapbox style json file (including the access_token query string if required.)
  • Click -> to retrieve the file contents
  • Once retrieved the following details are displayed:
    • Source: This indicates the type of JSON source and will read Mapbox Style
    • Name: The name of the map
    • Version: The file version
    • Layers: A list of the available layers

image

  • Click Save to generate the chart metadata and save it to the Signal K server
  • Once saved, a new chart source will appear in the chart list.

TileJSON

To use a TileJSON file as a source:

  • Select JSON Map Source
  • The Add JSON Map Source screen is displayed
  • Enter the url to the map TileJSON source
  • Click -> to retrieve the file contents
  • Once retrieved the following details are displayed:
    • Source: This indicates the type of JSON source and will read TileJSON
    • Name: The name of the map
    • Version: The file version
    • Layers: A list of the available layers

image

  • Click Save to generate the chart metadata and save it to the Signal K server
  • Once saved, a new chart source will appear in the chart list.

WMTS

To use a WMTS map ource:

  • Select WMTS
  • The Add WMTS Source screen is displayed
  • Enter the url that returns the GetCapabilities.xml data from WMTS server
  • Click -> to retrieve the data
  • Once retrieved, a list of the available layers is displayed

image

  • Select one or more layers using the checkbox beside each entry.
  • Click Save to generate metadata for each selected layer and save it to the Signal K server
  • Once saved, a new chart source will appear in the chart list for each layer that was selected.

WMS

To use a WMS map ource:

  • Select WMS
  • The Add WMS Source screen is displayed
  • Enter the WMS host url
  • Click -> to retrieve the data
  • Once retrieved, a list of the available layers is displayed

image

  • Select one or more layers using the checkbox beside each entry.
  • Click Save to generate metadata for each selected layer and save it to the Signal K server
  • Once saved, a new chart source will appear in the chart list for each layer that was selected.