signalk-activecaptain-resources

1.1.6 • Public • Published

SignalK Active Captain Resources

Release GitHub Issues GitHub Pull Requests License


A plugin for the node.js Signal K server for boats to import points of interest from the Garmin Active Captain API and make these available as resources.

📝 Table of Contents

🧐 About

  • Garmin's ActiveCaptain brings together the large boating community enabling sharing of information making boating safer, less expensive and more enjoyable.

  • Signal K is an open source server application that runs as a central information hub on a boat. It centralises data, provides a rich API to consume the data, and is extensible through a comprehensive suite of plugins (such as this one) and web applications.

  • Freeboard is a powerful chart plotter web application that runs as a webapp on the Signal K server.

This plugin's purpose is to bring together these 3 components by making information from the ActiveCaptain API available as resources throught the Signal K server which can then be consumed and displayed by Freeboard as an extra layer of information on the chart.

🏁 Getting Started

These instructions will get you up and running.

Prerequisites

  • A running instance of the Signal K node server with a position source (a GPS).

Instructions here

Installing this plugin

Through the Signal K server Appstore, search for signalk-activecaptain-resources, and click the Install button.

Signal K AppStore search

Configuration

In the Signal K menu, head to Server -> Plugin Config, and find Garmin Active Captain Resources then enable the plugin. Default values are fine for now, so just click Submit.

image

🎈 Usage

In the Signal K menu, head to Webapps and launch Freeboard-SK. Enjoy the new information.

image

✍️ Authors

Buy Me A Coffee

See also the list of contributors who participated in this project.

Package Sidebar

Install

npm i signalk-activecaptain-resources

Weekly Downloads

6

Version

1.1.6

License

MIT

Unpacked Size

927 kB

Total Files

26

Last publish

Collaborators

  • captain_spes