Giter VIP home page Giter VIP logo

charts-plugin's Introduction

Signal K Node server Charts plugin

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

Usage

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

  2. Specify "Charts path" in plugin configuration. Defaults to ${signalk-configuration-path}/charts

Configuration options

  1. Put charts into selected path

  2. Activate plugin

  3. 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

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 chart

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.