signalk-server

<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Anchor Alarm | 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=1749583844244"/><link rel="stylesheet" href="../assets/highlight.css?cache=1749583844244"/><script defer src="../assets/main.js?cache=1749583844244"></script><script async src="../assets/icons.js?cache=1749583844244" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1749583844244" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1749583844244" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js?cache=1749583844244" 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">Anchor Alarm</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="feature-anchor-alarm" class="tsd-anchor-link">Feature: Anchor Alarm<a href="#feature-anchor-alarm" 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 describes how to setup an anchor alarm using Signal K Server and the WilhelmSK app that:</p> <ul> <li>Uses the GPS data from your navigation system, not your phone</li> <li>Has a graphical map + satellite view</li> <li>Vessel movement is saved and displayed as Track on a map</li> <li>Provides the ability to move the anchor location</li> <li>Sends push notifications to your iPhone (not Android), both remotely via the Internet and locally on the boat</li> <li>Sound an audible alarm on a Fusion stereo or via a common speaker connected to a Yacht Devices N2K device</li> <li>Does not depend on your phone having enough battery, GPS reception to wake you up</li> </ul> <img src="../media/wsk.png" width=400px> <p><em>Image: WilhelmSK App on iPad.</em></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><ul> <li>SignalK server installed, for example on a Victron GX device or RaspberryPi. See <a href="../Installation.html">Installation</a> for details.</li> <li><a href="https://itunes.apple.com/us/app/wilhelmsk/id1150499484?mt=8">WilhelmSK iOS App</a></li> </ul> <p>For use with other Apps (Android, web apps, etc) see <a href="#alternatives-to-wilhelmsk">Alternatives to WilhelmSK</a>.</p> <h2 id="configuration" class="tsd-anchor-link">Configuration<a href="#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><strong>Step 1.</strong> Configure the Vessel data in SignalK server: <img src="../media/vesseldata.png" width=600px></p> <p>Be sure to set:</p> <ul> <li>Boat length</li> <li>GPS Distance from Bow</li> <li>GPS Distance from Center.</li> </ul> <h4 id="step-2-install-required-signal-k-server-plugins" class="tsd-anchor-link">Step 2. Install required Signal K Server plugins:<a href="#step-2-install-required-signal-k-server-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><ul> <li>Open the Signal K Admin UI and if necessary <em>Login</em></li> <li>Select <em>Appstore -> Available</em> from the menu</li> <li>Under <em>Available Apps</em> select <em>All</em> from the dropdown</li> </ul> <img src="../media/appstore_available.png" width=600px> <p>Locate and install each of the following plugins:</p> <ul> <li><strong>signalk-anchoralarm-plugin</strong></li> <li><strong>signalk-push-notifications</strong></li> <li><strong>signalk-alarm-silencer</strong></li> <li><strong>@signalk/tracks-plugin</strong></li> </ul> <p>After installation is complete, restart the server.</p> <p><em>Note: The _Restart</em> button only appears at the upper right of the screen when security has been enabled. (See <a href="../Security.html#enabling-security">Enabling Security</a> for details.)_</p> <h4 id="step-3-configure-the-plugins" class="tsd-anchor-link">Step 3 Configure the plugins:<a href="#step-3-configure-the-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>Each of the plugins you installed in the previous step need to be configured and enabled. To do this:</p> <ul> <li>Select `Server -> Plugin Config`` from the menu</li> <li>Locate the plugin</li> <li>Set the appropriate configuration values</li> <li>Click <em>Submit</em>.</li> <li>Ensure the plugin is <em>Enabled</em>.</li> </ul> <p>Following are details of how to configure each plugin:</p> <p><strong><em>Anchor Alarm plugin:</em></strong></p> <p>This plugin only needs to be enabled.</p> <p>No configuration is required as the settings values are populated by WilhelmSK.</p> <img src="../media/anchoralarmplugin.jpg" width=600px> <p><strong><em>Alarm Silencer plugin:</em></strong></p> <p>This plugin only needs to be enabled.</p> <p>No configuration options available.</p> <img src="../media/alarmsilencer.jpg" width=600px> <p><strong><em>Push Notifications plugin:</em></strong></p> <ul> <li>To send notifications via an Internet connection check <em>Enable Remote Push</em>.</li> </ul> <p><em>Note: The WilhelmSK app uses an Amazon RDS service to deliver push notifications. No additional accounts, etc are required as they are included with purchase.</em></p> <ul> <li> <p><em>Local Push SSIDs</em>: Enter the SSID(s) of the WiFi network(s) on your boat which the devices that are to receive notifications are connected.</p> </li> <li> <p><em>Local Push Port</em> specifies the port number that WilhelmSK app will receive the local push notifications. The default value is <em>3001</em> and only needs to be changed if that port number is already in use by another app / plugin on the Signal K Server.</p> </li> </ul> <p><em>Note: It is not necessary to set the same value in the WilhelmSK app, it auto configures itself.</em></p> <img src="../media/pushnotificationplugin.jpg" width=350px> <p><strong><em>Tracks plugin</em></strong></p> <p>This plugin keeps track of the position of vessels visible to the Signal K Server. This enables apps to display a track of vessel movements.</p> <p>The configuration values chosen will determince the amount of resource required run the plugin (and potentially the performance of the Signal K Server) so please consider this when making entries.</p> <p>The following settings represent conservative values that are suitable for use with an anchor alarm:</p> <ul> <li>Track resolution: 60000 (60 seconds)</li> <li>Points to keep: 240 (4 hours)</li> <li>Max idle time: 600 (10 minutes)</li> <li>Max Radius: 1 meter (no other vessels).</li> </ul> <p><em>Note: This plugin stores the track all the time, not only when on anchor. Which comes in handy when you enable the the anchor alarm a while after having dropped the anchor.</em></p> <img src="../media/tracks.jpg" width=350px> <p><strong><em>Step 4.</em></strong> Connect WilhelmSK to your SignalK server</p> <p>After installing the WilhelmSK app, go to the iOS settings screen and check that it has network access permissions.</p> <img src="../media/wsk_ios.jpg" width=350px> <p>Also ensure that Background App Refresh also enabled as it is required for local push notifications and to raise an alarm while WilhelmSK app in not open on your phone or tablet.</p> <p>Once network access has been enabled, start the WilhelmSK app and go to the connections menu.</p> <img src="../media/connections.jpg" width=350px> <p>Your boat's name <em>(as entered in the vessel data, in step 1 above)</em> and suffixed with (Discovered) should appear in the list. <em>(If you can’t see it please ensure WilhelmSK has been granted network access permissions.)</em></p> <p>Select your boat from the list and the configuration screen is displayed:</p> <img src="../media/wsk_connections.jpg" width=350px> <ul> <li> <p>Enter the user name and password that you use when logging into Signal K Server.</p> </li> <li> <p>Select <em>AutoConnect On This Network</em>. This will cause WilhelmSK to auto-select this connection when on the currently connected WiFi network.</p> </li> </ul> <p>With regards to the other available config options:</p> <ul> <li><em>Request Admin Access</em> provides an alternative to using user name and password using a security token instead. Selecting this option sends an <a href="../Security/Generating_Tokens.html#access-requests">Access Request</a> to the SignalK Server. The request will then need to be approved in the <em>Security -> Access Requests</em> screen of the Signal K Admin UI .</li> <li><em>Port</em>: 3000 is the standard port.</li> <li><em>AutoConnect Default</em> is used for a remote connection, which is out of scope of this manual.</li> </ul> <p>Finally, verify your connection. Swipe left to back to the main menu and select the same connection:</p> <img src="../media/wsk_connection.jpg" width=350px> <p><strong><em>Step 5.</em></strong> Enable WilhelmSK to receive push notifications</p> <p>From the <em>Settings</em> menu select <em>Notifications</em>.</p> <img src="../media/wsk_notifications.jpg" width=350px> <p>Note that the actual monitoring of the GPS coordinates is done by Signal K Server itself, not the WilhelmSK app. The app is only used to configure the anchor location, enable the alarm and to receive the alarm notifications.</p> <p>It is also possible, and highly recommended, to add other notifications. For example via Fusion stereo, if installed, or by using a dry contact with audible alarm. <em>(These are out of scope of this manual.)</em></p> <p><em>Tip: For using the Fusion stereo: search the server plugins with the keyword Fusion.</em></p> <h2 id="using-the-anchor-alarm" class="tsd-anchor-link">Using the Anchor Alarm<a href="#using-the-anchor-alarm" 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>Now that the connections have been configured, go to the main screen of the WilhelmSK App where you’ll see something similar to the following screenshot.</p> <p>If data is being received from the Signal K server, green dots are displayed in the top right of each gauge to indicate that the value displayed is current.</p> <img src="../media/wsk_screen.png" width=300px> <p>In case of incorrect username and/or password or other connection errors, these will be displayed at the top of the screen as warning.</p> <img src="../media/wsk_error.jpg" width=300px> <p>With an established connection and data being received, swipe to the right a few times to display the anchor watch page.</p> <img src="../media/wsk_phone.png" width=400px> <p>Clicking the anchor on the top left of screen (next to the menu button), cycles through the sequence of arming / disarming the alarm:</p> <ul> <li>White anchor indicates disarmed. Click when dropping the anchor and the color will change to yellow.</li> <li>Yellow anchor indicates that the rode length is being calculated. Click when you have finished letting out the anchor and the colour will change to green.</li> <li>Green anchor means the alarm is armed and ready.</li> </ul> <p>Use the “four arrows icon” on the top left of screen to move the anchor location.</p> <p>You can also change the alarm radius.</p> <p>Clicking the green anchor will prompt you to confirm that you want to disarm the alarm / raise the anchor.</p> <p><em>TIP: To return to other pages (i.e. COG and AWA gauges) swipe left by holding the Course up/Head up/North up menu.</em></p> <hr> <h2 id="alarms--notifications" class="tsd-anchor-link">Alarms & Notifications<a href="#alarms--notifications" 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>For most use cases, push notifications shouldn’t be the only means of receiving alarms as the phone can decide to hide notifications, etc so additional means of sounding the alarm should be employed.</p> <p>Following are some alternatives.</p> <h3 id="audible-alarms-using-the-raspberry-pi-audio-connector" class="tsd-anchor-link">Audible alarms using the Raspberry Pi audio connector<a href="#audible-alarms-using-the-raspberry-pi-audio-connector" 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>To have the Signal K Server produce audible notifications using a speaker connected directly to the Raspberry Pi audio connector install the <a href="https://www.npmjs.com/package/@meri-imperiumi/signalk-audio-notifications">signalk-audio-notifications</a> plugin.</p> <h3 id="alarm-to-nmea2000-network" class="tsd-anchor-link">Alarm to NMEA2000 network<a href="#alarm-to-nmea2000-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></h3><p>To have the Signal K Server forward the alarm to the NMEA2000 network to appear on connected devices, install and configure the <a href="https://www.npmjs.com/package/signalk-to-nmea2000">signalk-to-nmea2000</a> plugin.</p> <h4 id="raymarine-alarm-compatibility" class="tsd-anchor-link">Raymarine alarm compatibility<a href="#raymarine-alarm-compatibility" 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>With the Raymarine options enabled in the <em>signalk-to-nmea2000</em> plugin, an audible alarm will be generated on the Raymarine SeaTalkNG Auxiliary Alarm Buzzer - A8061 and will display on Raymarine Axiom plotters.</p> <p>_Note: The anchor alarm will be displayed as a “Shallow anchor alarm” on Raymarine, as that is the most suitable alarm type. Interpret that as just an anchor alarm, which has nothing to do with shallow. Here is how it looks on the Raymarine plotter:</p> <img src="../media/mfd_notification.png" > <h4 id="garmin-alarm-compatibility" class="tsd-anchor-link">Garmin alarm compatibility<a href="#garmin-alarm-compatibility" 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>Compatible</p> <h4 id="navico-bg-simrad-lowrance-alarm-compatibility" class="tsd-anchor-link">Navico (B&G, Simrad, Lowrance) alarm compatibility<a href="#navico-bg-simrad-lowrance-alarm-compatibility" 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>Not compatible</p> <h4 id="yacht-devices-compatibility" class="tsd-anchor-link">Yacht Devices compatibility<a href="#yacht-devices-compatibility" 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 <a href="https://www.yachtd.com/products/alarm_button.html">YDAB-01</a> is a very flexible and configurable device sold by Yacht Devices.</p> <p>It is connected to the NMEA2000 network and has a 10W audio amplifier which can output sound via a 4 or 8 Ohm speaker which directly connected. It has bank of 28 sound signals can be configured to sound on receipt of the anchor alarm.</p> <h4 id="additional-information" class="tsd-anchor-link">Additional information<a href="#additional-information" 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 post on Panbo is a great resource with regards to the N2K Alert PGNs: <a href="https://panbo.com/nmea-2000-network-alert-pgns-seem-great-so-why-are-they-hardly-used/">Link</a></p> <h3 id="remote-notifications" class="tsd-anchor-link">Remote notifications<a href="#remote-notifications" 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>There are a number of Signal K Server plugins which enable notifications to be sent remotely, following are just a few:</p> <h4 id="signalk-pushover-notification-relay" class="tsd-anchor-link">signalk-pushover-notification-relay<a href="#signalk-pushover-notification-relay" 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>This plugin listens for a change of state in Signal K notifications and sends the updates to the Pushover App which is available for both Apple and Android phones and tablets.</p> <p>This is a paid service from <a href="https://pushover.net/">Pushover</a>.</p> <p><em>Plugin:</em> <a href="https://www.npmjs.com/package/signalk-pushover-notification-relay">signalk-pushover-notification-relay</a></p> <h4 id="signalk-notifications-manager" class="tsd-anchor-link">signalk-notifications-manager<a href="#signalk-notifications-manager" 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>This plugin also works with <a href="https://pushover.net/">Pushover</a> to deliver notifications as push messages on your phone or tablet, but it also:</p> <ul> <li>Keeps a history of alerts stored in a local database</li> <li>Includes a Signal K web app to manage the notifications.</li> </ul> <p><em>Plugin:</em> <a href="https://www.npmjs.com/package/signalk-notifications">signalk-notifications-manager</a></p> <h4 id="signalk-clicksend-notifications-relay" class="tsd-anchor-link">signalk-clicksend-notifications-relay<a href="#signalk-clicksend-notifications-relay" 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>This plugin forwards notifications via the (paid) Clicksend SMS gateway, which can deliver notifications to your phone.</p> <p><em>Plugin:</em> <a href="https://www.npmjs.com/package/signalk-clicksend-notification-relay">signalk-clicksend-notifications-relay</a></p> <h3 id="switching-a-relay" class="tsd-anchor-link">Switching a relay<a href="#switching-a-relay" 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>Operating a switch or relay provides a range of options for sounding an alarm but will require diving a bit deeper into the various (and extensive) automation options made available by Signal K Server.</p> <p>A good place to start is the <a href="https://github.com/sbender9/signalk-switch-automation">signalk-switch-automation</a> plugin.</p> <hr> <h2 id="alternatives-to-wilhelmsk" class="tsd-anchor-link">Alternatives to WilhelmSK<a href="#alternatives-to-wilhelmsk" 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>As the data processing to "watch" the anchor and generate the alarm messages is performed by the Signal K Server, client applications, any client application that supports the <em>anchor-alarm</em> plugin can be used to arm / disarm and configure it.</p> <p>Listed below are some other apps and supported operations:</p> <table> <thead> <tr> <th>Client App</th> <th>Arm / disarm</th> <th>Set radius</th> <th>Move location</th> <th>See track</th> <th>Plays sound</th> </tr> </thead> <tbody> <tr> <td><strong>Wilhelm SK</strong><br>(iOS)</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td><strong>Anchor alarm plugin</strong><br>(web app)</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>no</td> </tr> <tr> <td><strong>Freeboard SK</strong><br>(web app)</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td><strong>Aqua Map</strong><br>(iOS & Android)</td> <td>?</td> <td>?</td> <td>?</td> <td>?</td> <td>?</td> </tr> </tbody> </table> <h3 id="anchor-alarm-plugin" class="tsd-anchor-link">Anchor Alarm Plugin<a href="#anchor-alarm-plugin" 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 anchor alarm plugin provides a web user interface available under <em>WebApps</em> in the Signal K Server Admin UI.</p> <p>It provides the ability to arm / disarm, set the radius and shift the anchor but does not display the alarm on screen or play a sound.</p> <img src="../media/anchor_alarm_plugin_ui.png" width=300px> <h3 id="freeboard-sk" class="tsd-anchor-link">Freeboard SK<a href="#freeboard-sk" 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>Freeboard SK provides a "sequence" driven user interface to "step" through the setting of the anchor alarm.</p> <p>It provides the ability to drop / raise the anchor, set / adjust the alarm radius and shift the anchor position via the <em>Anchor Watch</em> feature in the main menu.</p> <p>When set, it will:</p> <ul> <li>Display the alarm radius on the map</li> <li>Show the vessel track whilst anchored</li> </ul> <p>When alarm is triggered:</p> <ul> <li>Display an alarm notification on screen</li> <li>Play a sound</li> </ul> <p>It is available under <em>WebApps</em> in the Signal K Server Admin UI.</p> <img src="../media/freeboardsk_anchor_watch.png" width=300px> <img src="../media/freeboardsk_anchor_alarm.png" width=300px></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="#configuration"><span>Configuration</span></a><a href="#using-the-anchor-alarm"><span>Using the <wbr/>Anchor <wbr/>Alarm</span></a><a href="#alarms--notifications"><span>Alarms & <wbr/>Notifications</span></a><ul><li><a href="#audible-alarms-using-the-raspberry-pi-audio-connector"><span>Audible alarms using the <wbr/>Raspberry <wbr/>Pi audio connector</span></a></li><li><a href="#alarm-to-nmea2000-network"><span>Alarm to <wbr/>NMEA2000 network</span></a></li><li><a href="#remote-notifications"><span>Remote notifications</span></a></li><li><a href="#switching-a-relay"><span>Switching a relay</span></a></li></ul><a href="#alternatives-to-wilhelmsk"><span>Alternatives to <wbr/>Wilhelm<wbr/>SK</span></a><ul><li><a href="#anchor-alarm-plugin"><span>Anchor <wbr/>Alarm <wbr/>Plugin</span></a></li><li><a href="#freeboard-sk"><span>Freeboard <wbr/>SK</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>