DB Dashboards

Note

To run this app type this in a terminal:

openplotter-dashboards

mhelp Help opens an offline copy of this documentation in a browser and mSettings Settings opens the main app OpenPlotter Settings.

../_images/dashboards0.png

Select any app from the list and click DBinstall Install or DBuninstall Uninstall. Click DBrefresh Refresh after any of these actions to refresh the list.

Most of these dashboards are Signal K server plugins, but some are standalone third-party applications such as Grafana or InfluxDB. Once these applications are installed you can DBstart Start, DBstop Stop, DBrestart Restart and configure automatic startup by toggling Autostart in the DBprocess Processes tab:

../_images/dashboards1.png

Instrument Panel

../_images/instrumentpanel.png

This is the dashboard built into the Signal K server. It is highly configurable and you can even embed panels from other applications like Grafana.

You can access this dashboard by selecting Instrument Panel in the list and clicking DBshow Open or by typing this adddress in your local browser: http://localhost:3000/@signalk/instrumentpanel/. You can also connect to this page from any device connected to the same network as OpenPlotter using the address http://openplotter.local:3000/@signalk/instrumentpanel/.

Click on the DBhelp help icon to access full documtnation.

SailGauge

../_images/sailgauge.png

This signal K server plugin provides an all-in-one gauge for sailboats.

You can access this dashboard by selecting SailGauge in the list and clicking DBshow Open or by typing this adddress in your local browser: http://localhost:3000/@signalk/sailgauge/. You can also connect to this page from any device connected to the same network as OpenPlotter using the address http://openplotter.local:3000/@signalk/sailgauge/.

Kip

../_images/kip.png

Using this wonderful Signal K plugin you will be able to easily build sexy dashboards containing graphs, gauges, numeric and level panels…

You can access this dashboard by selecting Kip in the list and clicking DBshow Open or by typing this adddress in your local browser: http://localhost:3000/@mxtommy/kip/. You can also connect to this page from any device connected to the same network as OpenPlotter using the address http://openplotter.local:3000/@mxtommy/kip/.

Go to the plugin homepage for the list of features and tips: https://github.com/mxtommy/Kip

Node-Red Dashboard

../_images/nodered_dashboard.png

Node-RED is a tool that uses a browser-based visual editor to program the connections between hardware devices, and APIs such as Signal K. It allows you to gather, adjust, enhance and deliver the data without needing to understand complex programming languages such as C or Python.

In OpenPlotter, Node-RED is embedded in the Signal K server as a plugin, and contains some specific nodes to manage Signal K data. Go to the plugin homepage to see the list of nodes and some examples: https://github.com/SignalK/node-red-embedded

The installation also includes the node-red-dashboard plugin that adds more nodes for creating buttons, graphs, gauges, sliders, and so on.

You can build Node-RED dashboards by selecting Node-Red Dashboard in the list and clicking DBedit Edit or by typing this adddress in your local browser: http://localhost:3000/plugins/signalk-node-red/redAdmin/. You can also connect to this page from any device connected to the same network as OpenPlotter using the address http://openplotter.local:3000/plugins/signalk-node-red/redAdmin/.

You can see your Node-RED dashboards in action by selecting Node-Red Dashboard in the list and clicking DBshow Open or by typing this adddress in your local browser: http://localhost:3000/plugins/signalk-node-red/redApi/ui/. You can also connect to this page from any device connected to the same network as OpenPlotter using the address http://openplotter.local:3000/plugins/signalk-node-red/redApi/ui/.

Using and learning Node-RED takes some time and is not the goal of this document. If you are not a programmer but would like to learn some basic principles, Node-RED is the perfect starting point. Everything will be possible in OpenPlotter using Node-RED.