Skip to content

Latest commit

 

History

History
88 lines (51 loc) · 5.66 KB

README.md

File metadata and controls

88 lines (51 loc) · 5.66 KB
Raw


DashT - an OpenCPN plug-in with Dashboard, Tactics, Engine/Energy dials and Time Series DB functions with history line graphs

Codacy Badge

dashboard_tactics_pi in your OpenCPN plug-in catalog.

Introduction

DashT v1.5.11 was a forerunner in diversifying the data connectivity of a OpenCPN plug-in to enable direct network connections to resources available in a modern boat's computer and network infrastructure. This version, of which you can find installation packages for early adopters in Releases continues this philosophy and presents new features by collecting timestamped open data and making it available to external applications and data retrieval systems.

The next OpenCPN version, currently in 5.1beta is embracing the open marine data format Signal K. This hopefully encourage you to consider to install the fast, ubiquitous and reliable Signal K data format source in your boat's infrastructure: Signal K server node. As before, it is fully supported by DashT as an alternative and direct data source, allowing the creation of enhancements which are not present in the traditional OpenCPN Dashboard:

Dashboard and Tactics instruments do not require Signal K data but they work also with NMEA-0183 data from OpenCPN alone

  • Signal K data input streaming

    • Direct connection to the delta channel of a Signal K server node providing shortest possible path for:

      • Maximum volume of data ;
      • Lowest possible latency ;
      • Time stamps at source ;
      • Access to Engine, Energy and Status data from NMEA-2000, Bluetooth LE, GPIO over a single interface.

  • Engine and Energy dials

    • Provides Signal K engine and energy data on dials built using latest web techniques but fully integrated in OpenCPN Dashboard
    • Best explained by this short video (on a very small display)

  • Influx DB 2.0 ouput streaming and export

    • Time series based databases are essential with the data volumes and rates produced by Signal K enabled servers

    • Real-time storage and retrieval allows long-term monitoring and historical data browsing using external tools such as Grafana

    • Short-term historical data line graphs provided and integrated in OpenCPN Dashboard for race time or performance run real-time monitoring of key parameters

    • An all-received-data containing file can be registered to feed, off-line or after race InfluxDB v2.0 time series database

      • Enhances post-race analysis and off-line polar calculations with high sampling rate and accurately timestamped data

  • Comprehensive documentation

    • Detailed User's Manuals
    • Developer's information with performance analysis and debugging tips

Installation

See the Releases pages: pre-build packages for platforms Windows, Mac, Linux Ubuntu/Debian, Raspberry Pi 4.

Configuration

Please refer to User's Guides accessible from the documentation pages

Compiling

  • git clone git://github.com/canne/dashboard_tactics_pi.git

Windows build

This build is tested with Visual Studio 2019 on Windows 10

Please get first the library file "opencpn.lib". It is located in the build directory of OpenCPN after having built it; or your can search it from the various processes of CI (continuous integration) of this plug-in. Or try this one.

Starting from v2.0 this plug-in has moved in Windows entirely to use vcpkg for dependencies - hence the directive below. As usual the most annoying part is the wxWidgets package which cannot be STL-enabled, unfortunately in OpenCPN - in DashT it can: to help in this dilemma, there is a non-STL port with CMake find-script available here. Of course, one can install wxWidgets manually in C: - by no means DashT depends on its location; vcpkg is only for build process on Windows to provide libraries readily available on a Linux system:

  • cd build
  • cp ....\mydirectory\opencpn.lib .
  • cmake -G "Visual Studio 16 2019" -A Win32 -DCMAKE_TOOLCHAIN_FILE=C:\vcpkg\scripts\buildsystems\vcpkg.cmake ..
  • cmake --build . --target package --config release

Debian/Linux style build

  • cd build
  • cmake ..
  • make
  • make package
  • sudo gdebi packagename-version-etc.deb

License

The project is licensed under the terms of the GPL v3. The networked parts of the project are derived from and licensed under MIT license.