Skip to content

Signal K Node server Resource Provider plugin enabling the use of maps published via WMTS (Web Map Tile Server) hosts.

License

Notifications You must be signed in to change notification settings

panaaj/signalk-wmts-plugin

Repository files navigation

WMTS Chart provider for Signal K server

Signal K Node server resource provider plugin enabling the use of maps published via WMTS (Web Map Tile Server) hosts.

Note: Requires Signal K server running on NodeJS v18 or later!

The plugin requires that WMTS hosts implement the GetCapabilities request to return GetCapabilities.xml response. Experience has found that not all servers respond correctly to ?service=wmts&request=GetCapabilities queries, so it is worth checking first.

The plugin also supports the Signal K server v2 Resources API and can be used in conjunction with other chart resource provider plugins.

Chart metadata is made available to client apps via both v1 and v2 API paths.

Server Version API Path
1.x.x v1 /signalk/v1/api/resources/charts
2.x.x v2 /signalk/v2/api/resources/charts

Example:

{
    "mapa_base_rioja": {
		"identifier": "mapa_base_rioja",
		"name": "WMTS Mapa Base IDErioja",
		"description": "Mapa Base IDErioja",
		"type": "wmts",
		"bounds": [-180, -90, 180, 90],
		"format": "png",
		"tilemapUrl": "https://rts.larioja.org/wmts/mapa_base_rioja",
		"chartLayers": ["mapa_base_rioja"]
	}
}

Usage

  1. Install signalk-wmts-plugin from the Appstore screen in the Signal K server admin console

  2. Once installed, restart the server and the locate WMTS Chart provider in the Plugin Config screen

  3. Add the url for each WMTS host publishing the maps you require.

Important: The host url is the path to the WMTS service. It should NOT contain request or service parameters!

Example: https://rts.larioja.org/wmts/mapa_base_rioja

The following example is incorrect!

https://rts.larioja.org/wmts/mapa_base_rioja?service=wmts&request=GetCapabilities
  1. Check Disable to not query the WMTS host. This allows multiple WMTS host entries to be maintained and only return map listings from selected ones.

  2. Click Submit to save the changes.

  3. Enable plugin


System Requirements

  • Signal K server running on NodeJS v18 (or later).

About

Signal K Node server Resource Provider plugin enabling the use of maps published via WMTS (Web Map Tile Server) hosts.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published