signalk-server
Version:
An implementation of a [Signal K](http://signalk.org) server for boats.
25 lines (23 loc) • 12.9 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>What's New | 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="../Developing.html">Developing</a></li><li><a href="" aria-current="page">What's New</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="whats-new-in-version-2" class="tsd-anchor-link">What's new in Version 2.<a href="#whats-new-in-version-2" 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>Signal K Server version 2 introduces new REST APIs designed to perform specific operations <em>(e.g. set destination, advance to next point, etc)</em>.</p>
<p>These APIs have been implemented to ensure the integrity of the underlying Signal K data model by maintaining values in all related paths associated with the operation. In this way a cohesive, reliable data set is presented to all connected applications and devices.</p>
<p>The new APIs are mounted under <code>/signalk/v2/api</code>, their definitions available as OpenApi documents accessible via <em>Documentation -> OpenAPI</em> in the server admin user interface. They coexist with <code>/signalk/v1/api</code> paths to ensure continued operation of applications.</p>
<p>Some REST APIs provide an <code>interface</code> for use by plugins via the <a href="../_signalk/server-api/ServerAPI.html" class="tsd-kind-interface">Server Plugin API</a> to enable them to enact operations in a managed way.</p>
<p><em><strong>Important: The Signal K data paths maintained by the REST APIs should NOT be updated directly by any other plugin or process!</strong></em></p>
<p>With the move towards operation based APIs some paths are flagged for deprecation. Please see <a href="Breaking_Changes.html">Changes & Deprecations</a> for details.</p>
<hr>
<h3 id="course-api" class="tsd-anchor-link">Course API<a href="#course-api" 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></h3><p>Provides common course operations via <code>/signalk/v2/api/vessels/self/navigation/course</code>.</p>
<p>See the <a href="REST_APIs/Course_API.html">Course API</a> for details.</p>
<hr>
<h3 id="resources-api" class="tsd-anchor-link">Resources API<a href="#resources-api" 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></h3><p>Provides operations for creating, maintaining and accessing resources such as routes, waypoints, etc via <code>/signalk/v2/api/resources</code>.</p>
<p>See the <a href="REST_APIs/Resources_API.html">Resources API</a> for details.</p>
<hr>
<h2 id="notes-for-developers" class="tsd-anchor-link">Notes for Developers:<a href="#notes-for-developers" 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><h3 id="nmea0183--nmea2000-message-processing" class="tsd-anchor-link">NMEA0183 / NMEA2000 message processing<a href="#nmea0183--nmea2000-message-processing" 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></h3><p>Whilst the Course API and its associated operations provide a means of setting a course, NMEA data streams are the source of information when the course is set on a connected device.</p>
<p>In the past, plugins processing NMEA data streams have directly populated the mapped <code>v1</code> Signal K paths based on the received sentence / PGN values. Moving forward these plugins should utilise the relevant <a href="../_signalk/server-api/ServerAPI.html" class="tsd-kind-interface">Server Plugin API</a> methods to enact course operations.</p>
<h3 id="stream-updates" class="tsd-anchor-link">Stream updates<a href="#stream-updates" 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></h3><p>The new REST APIs emit <code>v2</code> deltas with values that are objects.</p>
<p>For example, when a course is activated, deltas will be emitted for <code>navigation.course.previousPoint</code>, <code>navigation.course.nextPoint</code> and <code>navigation.course.activeRoute</code> where the value is an object.</p>
<p><em>Example: v2 Delta</em></p>
<pre><code class="JSON"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-6">"path"</span><span class="hl-1">: </span><span class="hl-2">"navigation.course.previousPoint"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">"value"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-6">"position"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-6">"latitude"</span><span class="hl-1">: </span><span class="hl-3">65.0</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">"longitude"</span><span class="hl-1">: </span><span class="hl-3">3.754</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-6">"type"</span><span class="hl-1">: </span><span class="hl-2">"Location"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">"href"</span><span class="hl-1">: </span><span class="hl-3">null</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<h4 id="connection-with-v1-full-data-model" class="tsd-anchor-link">Connection with v1 Full Data Model<a href="#connection-with-v1-full-data-model" 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 current implementation of Signal K Server provides only a single <code>stream</code> endpoint <em>(<code>/signalk/v1/stream</code>)</em> and all values emitted as deltas <em>(both <code>v1</code> & <code>v2</code>)</em> will continue appear there.</p>
<p>It should be noted, that even though both <code>v1</code> & <code>v2</code> deltas appear in the one stream, only <code>v1</code> deltas will populate the <em>full data model</em> and be available under the <code>/signalk/v1/api</code> path!</p>
</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"><ul><li><a href="#course-api"><span>Course <wbr/>API</span></a></li><li><a href="#resources-api"><span>Resources <wbr/>API</span></a></li></ul><a href="#notes-for-developers"><span>Notes for <wbr/>Developers:</span></a><ul><li><a href="#nmea0183--nmea2000-message-processing"><span>NMEA0183 / <wbr/>NMEA2000 message processing</span></a></li><li><a href="#stream-updates"><span>Stream updates</span></a></li></ul></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>