Plugins 〉Signal K


Developer

teppo.kurki@iki.fi

Sign up to receive occasional product news and updates:



Data Source
community

Signal K

  • Overview
  • Installation
  • Change log
  • Related content

SignalK-Datasource

Dynamic JSON Badge License

Overview

This is a datasource for using Signal K data over

  • streaming WebSocket connection for realtime data
  • the History HTTP API

For streaming data you will need a Signal K server providing access to the data. To test the functionality you can connect to https://demo.signalk.org. Streaming data opens a connection to the Signal K server that update as new data is received when you have Grafana open. With just streaming data you can have an updating dashboard, but you can not scroll back in time and all updates happening when the Grafana window is not active won't be shown.

For access to history data you will need a database where the data is stored and access to the data via Signal K server. This is provided by the signalk-to-influxdb2 plugin. The plugin stores the data in an InfluxDb v2 database and implements a History API that the datasource accesses.

Streaming WebSocket data and History API work transparently together so that when you open Grafana with timespan set relative to "now" the datasource will fill the data for the chosen time span from the History API and start streaming real time updates as they are received.

The main benefits of using this datasource over connecting directly to a database are:

  • no need to understand how to query the database - instead you can just pick Signal K paths and sources to choose the data you want
  • the datasource is aware of the Signal schema and metadata: it knows what each path's unit is and provides out of the box conversions to other units
  • it provides full access to your data, combining the realtime updates with full access to history

SignalK Datasource Screenshot

SignalK Datasource Graph Configuration Path picking

SignalK Datasource Graph Configuration

SignalK Datasource Conversion Configuration

Installing Signal K on Grafana Cloud:

For more information, visit the docs on plugin installation.

Changelog

1.0.0 (Unreleased)

Initial release.