Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 3.52 KB

README.md

File metadata and controls

82 lines (49 loc) · 3.52 KB
Raw

Signal K server Charts plugin

Signal K Node server plugin to provide chart metadata, such as name, description and location of the actual chart tile data.

Supports both v1 and v2 Signal K resources api paths.

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

Note: v2 resource paths will only be made available on Signal K server >= v2.

Usage

  1. Install "Signal K Charts" plugin from Signal K Appstore

  2. Configure plugin in Plugin Config

  • Add "Chart paths" which are the paths to the folders where chart files are stored. Defaults to ${signalk-configuration-path}/charts
  1. Add "Chart paths" in plugin configuration. Defaults to ${signalk-configuration-path}/charts

Chart paths configuration

  1. Put charts into selected paths

  2. Add optional online chart providers

Online chart providers configuration

WMS example:

server type configuration

  1. Activate plugin

  2. Use one of the client apps supporting Signal K charts, for example:

Supported chart formats

  • MBTiles file
  • Directory with cached TMS tiles and tilemapresource.xml
  • Directory with XYZ tiles and metadata.json
  • Online TMS

Publicly available MBTiles charts can be found from:

API

Plugin adds support for /resources/charts endpoints described in Signal K specification:

  • GET /signalk/v1/api/resources/charts/ returns metadata for all available charts
  • GET /signalk/v1/api/resources/charts/${identifier}/ returns metadata for selected chart
  • GET /signalk/v1/api/resources/charts/${identifier}/${z}/${x}/${y} returns a single tile for selected offline chart. As charts-plugin isn't proxy, online charts is not available via this request. You should look the metadata to find proper request.

License

Copyright 2018 Mikko Vesikkala

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.