Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 1.06 KB

README.md

File metadata and controls

30 lines (18 loc) · 1.06 KB

Mock Autopilot Provider Plugin for Signal K

About

Signal K server plugin that provides a mock Autopilot Provider for use with the Autopilot API.

It can be used as the basis for creating your own provider for autopilot device(s).

This repository should be used in conjunction with Signal K Autopilot API documentation.


Usage

  • Clone this repository
  • Change the package name and description
  • Change the plugin id and name (index.js)
  • Set AP_TYPE to reflect the autopilot type identifier (mock-pilot.js)
  • Set AP_OPTIONS to the relevant values for the target device type (mock-pilot.js)
  • Map defaultState key values to the relevant state in AP_OPTIONS (mock-pilot.js)

For information on plugin development see Getting started with Plugin development.


Related Links