signalk-server
Version:
An implementation of a [Signal K](http://signalk.org) server for boats.
108 lines (107 loc) • 13.3 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NMEA0183 Data Server | Signal K</title><meta name="description" content="Documentation for Signal K"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1750891486567"/><link rel="stylesheet" href="../assets/highlight.css?cache=1750891486567"/><script defer src="../assets/main.js?cache=1750891486567"></script><script async src="../assets/icons.js?cache=1750891486567" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1750891486567" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1750891486567" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js?cache=1750891486567" id="tsd-hierarchy-script"></script><link rel="stylesheet" href="../assets/theme.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title"><img src="../assets/logo.svg" alt="Signal K"/></a><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg><span class="visible@s">Search</span></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><div id="tsd-toolbar-links"><a href="https://discord.gg/uuZrwz4dCS" target="_blank" rel="noopener" class="toolbar-icon visible@s" aria-label="Discord"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M524.5 69.8a1.5 1.5 0 0 0 -.8-.7A485.1 485.1 0 0 0 404.1 32a1.8 1.8 0 0 0 -1.9 .9 337.5 337.5 0 0 0 -14.9 30.6 447.8 447.8 0 0 0 -134.4 0 309.5 309.5 0 0 0 -15.1-30.6 1.9 1.9 0 0 0 -1.9-.9A483.7 483.7 0 0 0 116.1 69.1a1.7 1.7 0 0 0 -.8 .7C39.1 183.7 18.2 294.7 28.4 404.4a2 2 0 0 0 .8 1.4A487.7 487.7 0 0 0 176 479.9a1.9 1.9 0 0 0 2.1-.7A348.2 348.2 0 0 0 208.1 430.4a1.9 1.9 0 0 0 -1-2.6 321.2 321.2 0 0 1 -45.9-21.9 1.9 1.9 0 0 1 -.2-3.1c3.1-2.3 6.2-4.7 9.1-7.1a1.8 1.8 0 0 1 1.9-.3c96.2 43.9 200.4 43.9 295.5 0a1.8 1.8 0 0 1 1.9 .2c2.9 2.4 6 4.9 9.1 7.2a1.9 1.9 0 0 1 -.2 3.1 301.4 301.4 0 0 1 -45.9 21.8 1.9 1.9 0 0 0 -1 2.6 391.1 391.1 0 0 0 30 48.8 1.9 1.9 0 0 0 2.1 .7A486 486 0 0 0 610.7 405.7a1.9 1.9 0 0 0 .8-1.4C623.7 277.6 590.9 167.5 524.5 69.8zM222.5 337.6c-29 0-52.8-26.6-52.8-59.2S193.1 219.1 222.5 219.1c29.7 0 53.3 26.8 52.8 59.2C275.3 311 251.9 337.6 222.5 337.6zm195.4 0c-29 0-52.8-26.6-52.8-59.2S388.4 219.1 417.9 219.1c29.7 0 53.3 26.8 52.8 59.2C470.7 311 447.5 337.6 417.9 337.6z"></path></svg></a><a href="https://github.com/SignalK/signalk-server" target="_blank" rel="noopener" class="toolbar-icon visible@s" aria-label="Discord"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3 .3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5 .3-6.2 2.3zm44.2-1.7c-2.9 .7-4.9 2.6-4.6 4.9 .3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3 .7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3 .3 2.9 2.3 3.9 1.6 1 3.6 .7 4.3-.7 .7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3 .7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3 .7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg></a><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../Guides.html">Guides</a></li><li><a href="" aria-current="page">NMEA0183 Data Server</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="signal-k-server-as-a-nmea0183-data-server" class="tsd-anchor-link">Signal K Server as a NMEA0183 Data Server<a href="#signal-k-server-as-a-nmea0183-data-server" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This document details how to setup Signal K Server to read AIS and navigation data from a NMEA2000 (or any other) network and make it available on a WiFi network for use with popular phone / tablet apps like:</p>
<ul>
<li>Navionics</li>
<li>iSailor</li>
<li>iNavX</li>
<li>Aqua Map</li>
<li>WilhelmSK.</li>
</ul>
<p>The Signal K Server does this by passing the data received from the configured Data Connections, through two plugins which transform it to NMEA0183 sentences, which are then transmitted on the WiFi network.</p>
<h2 id="prerequisites" class="tsd-anchor-link">Prerequisites<a href="#prerequisites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>A Signal K Server:</p>
<ul>
<li>Installed on a suitable device (e.g. Victron GX, RaspberryPi, etc). <em>See <a href="../Installation.html">Installation</a> for details.</em></li>
<li>Connected to a NMEA2000, etc network and Data Connections configured.</li>
<li>Connected to a WiFi network. <em>(Beyond the scope of this document.)</em></li>
</ul>
<h2 id="server-setup-and-configuration" class="tsd-anchor-link">Server Setup and Configuration<a href="#server-setup-and-configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>All configuration is done from within the Signal K Server Admin UI. Open the Admin UI in your browser and complete the following steps.</p>
<h4 id="step-1-enter-vessel-base-data" class="tsd-anchor-link"><em>Step 1.</em> Enter Vessel Base Data:<a href="#step-1-enter-vessel-base-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
<li>
<p>Select <em>Server -> Setup</em> from the menu.</p>
</li>
<li>
<p>The <strong>Vessel Base Data</strong> section, enter values for <em>Length</em>, <em>GPS Distance from Bow</em> and <em>GPS Distance from Center</em>.</p>
</li>
</ul>
<img src="../media/vesseldata-1.png" width=600px/>
<h4 id="step-2-install-and-configure-plugins" class="tsd-anchor-link"><em>Step 2.</em> Install and Configure Plugins:<a href="#step-2-install-and-configure-plugins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The following plugins are required to process and transform the received data to NMEA0183:</p>
<ul>
<li><code>signalk-to-nmea0183</code> (<a href="https://www.npmjs.com/package/@signalk/signalk-to-nmea0183">documentation</a> on npmjs)</li>
<li><code>signalk-n2kais-to-nmea0183</code> (<a href="https://www.npmjs.com/package/signalk-n2kais-to-nmea0183">documentation</a> on npmjs)</li>
</ul>
<p><em>Note: Starting with Signal K Server version 2.2.0 these plugins are pre-installed. It is recommended that these plugins be updated to the current version.</em></p>
<p><strong>To install the plugins:</strong></p>
<ul>
<li>In the Admin UI, select <em>Appstore -> Available-> All</em> from the menu</li>
<li>Locate the <code>signalk-to-nmea0183</code>plugin and click the install icon</li>
<li>Locate the <code>signalk-n2kais-to-nmea0183</code> plugin and click the install icon</li>
<li>Restart the Signal K Server.</li>
</ul>
<p><em>Note: If the <strong>Restart</strong> button is not displayed in the upper right of screen, refer to <a href="../Security.html#enabling-security">Enabling Security</a> for details.</em></p>
<p><strong>To configure the plugins:</strong></p>
<ul>
<li>
<p>In the Admin UI, select <em>Server -> Plugin Config</em> from the menu.</p>
</li>
<li>
<p>Locate <code>signalk-to-nmea0183</code> plugin.</p>
<ol>
<li>Ensure it is enabled</li>
<li>Check ALL the boxes to transmit all NMEA0183 sentence types</li>
<li>Leave the transmission interval (throttle) at 0</li>
<li>Click the <strong>Submit</strong> button to save your choices.</li>
</ol>
<img src="../media/sk2nmea0183.png" width="450px" />
</li>
<li>
<p>Locate <code>signalk-n2kais-to-nmea0183</code> plugin. This plugin transmits all the AIS targets.</p>
<ol>
<li>Ensure it is enabled</li>
<li>Enter <em>nmea0183out</em> in the <strong>NMEA 0183 Out Events</strong> field.</li>
<li>Click the <strong>Submit</strong> button to save the configuration.</li>
</ol>
<img src="../media/n2kais2nmea0183.png" width="450px" />
</li>
</ul>
<h4 id="step-3-enable-nmea0183-on-the-wifi-network" class="tsd-anchor-link"><em>Step 3.</em> Enable NMEA0183 on the WiFi network:<a href="#step-3-enable-nmea0183-on-the-wifi-network" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
<li>
<p>In the Admin UI, select <em>Server -> Settings</em></p>
</li>
<li>
<p>Locate the <strong>Server Settings</strong> section</p>
</li>
<li>
<p>Ensure that <strong>NMEA 0183 over TCP (10110)</strong> is set to <strong>On</strong></p>
</li>
<li>
<p>Click <strong>Save</strong> and <strong>Restart</strong> the Signal K Server.</p>
<img src="../media/enable0183.png" width="450px" />
</li>
</ul>
<p>Once restarted the Signal K Server will transmit NMEA0183 sentences containing all your navigation and available AIS target data on the WiFi network on TCP port 10110.</p>
<p><em>Note: It is recommended that <strong>Signal K over TCP (8375)</strong> is set to <strong>On</strong> if you are using an app (e.g. Aqua Map) which supports the “Signal K over TCP” protocol as it is more feature rich.</em></p>
<h2 id="configuring-apps" class="tsd-anchor-link">Configuring Apps<a href="#configuring-apps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Device apps can now be configured to connect to the NMEA0183 data stream from the Signal K Server.</p>
<p>Following is an example of how to connect the Navionics boating app.</p>
<ul>
<li>
<p>Open the menu</p>
</li>
<li>
<p>Select <strong>Paired devices</strong> and add a new paired device</p>
</li>
<li>
<p>Enter a name for the device <em>e.g. MySignalK Server</em></p>
</li>
<li>
<p>In <strong>Host</strong> enter the IP address of the Signal K Server you configured in the steps above</p>
</li>
<li>
<p>In <strong>Port</strong> enter <em>10110</em></p>
</li>
<li>
<p>Select <strong>TCP</strong></p>
</li>
<li>
<p>Click <strong>Save</strong></p>
<img src="../media/navionics.png" width="450px" /></li>
</ul>
</div></div><div class="col-sidebar"><div class="page-menu"><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#prerequisites"><span>Prerequisites</span></a><a href="#server-setup-and-configuration"><span>Server <wbr/>Setup and <wbr/>Configuration</span></a><a href="#configuring-apps"><span>Configuring <wbr/>Apps</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Signal K</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>