@signalk/freeboard-sk 2.13.1 → 2.14.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # CHANGELOG: Freeboard
 
+### v2.14.0
+
+#### Deprecated: Local PyPilot support.
+ `pypilot-autopilot-provider` plugin now required!
+
+---
+
+- **New**: Alert list to display and manage alerts and raise alarms.
+
+- **Fixed**: Raised alarms do not include identifier in path. (#261)
+- **Fixed**: Track list not displaying tracks when filer text is undefined. (#262)
+- **Fixed**: Export to GPX dialog formatting. (#263)
+- **Fixed**: Re-ordered map layers. (#265)
+- **Added**: Additional CEVNI icons. (#264)
+
+### v2.13.2
+
+- **Added**: Data loading progress indicator. (#240)
+- **Added**: Ability to edit waypoint coordinates in details dialog. (#238)
+- **Added**: Additional operating modes for anchor watch. (#248)
+- **Change**: Main menu style / layout. (#243)
+- **Change**: CSS style of links in note descriptions. (#245)
+- **Change**: Track list layout. (#251)
+- **Fixed**: Read-only flag not respected by Region Details dialog and formatting. (#244, #258)
+- **Fixed**: "Navigate To" not correctly determining pointer location on IOS devices. (#241)
+- **Fixed**: Heading up setting sometimes not applied at startup. (#254)
+- **Fixed**: Regions not being fetched after initial app load. (#256)
+- **Fixed**: Route point drag / drop re-ordering.
+
 ### v2.13.1
 
 - **Change**: `Load GPX` and `Load GeoJSON` menu options have been combined as `Import` option in the Resource Layers menu.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "2.13.1",
+  "version": "2.14.0",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",
@@ -41,7 +41,8 @@
   "dependencies": {
     "@signalk/server-api": "^2.3.0",
     "socket.io-client": "^4.6.0",
-    "tslib": "^2.0.0"
+    "tslib": "^2.0.0",
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@angular-devkit/build-angular": "^18.1.0",

package/plugin/alarms/alarms.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initAlarms = void 0;
 const server_api_1 = require("@signalk/server-api");
+const uuid = require("uuid");
 const STANDARD_ALARMS = [
     'mob',
     'fire',
@@ -12,7 +13,8 @@ const STANDARD_ALARMS = [
     'listing',
     'adrift',
     'piracy',
-    'abandon'
+    'abandon',
+    'aground'
 ];
 let server;
 let pluginId;
@@ -40,16 +42,16 @@ const initAlarmEndpoints = () => {
             return;
         }
         try {
+            const id = uuid.v4();
             const msg = req.body.message
                 ? req.body.message
                 : req.params.alarmType;
-            const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}`, {
+            const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}.${id}`, Object.assign({
                 message: msg,
                 method: [server_api_1.ALARM_METHOD.sound, server_api_1.ALARM_METHOD.visual],
-                state: server_api_1.ALARM_STATE.emergency,
-                data: buildAlarmData()
-            });
-            res.status(200).json(r);
+                state: server_api_1.ALARM_STATE.emergency
+            }, buildAlarmData()));
+            res.status(r.statusCode).json(Object.assign(r, { id: id }));
         }
         catch (e) {
             res.status(400).json({
@@ -59,7 +61,7 @@ const initAlarmEndpoints = () => {
             });
         }
     });
-    server.post(`${ALARM_API_PATH}/:alarmType/silence`, (req, res) => {
+    server.post(`${ALARM_API_PATH}/:alarmType/:id/silence`, (req, res) => {
         server.debug(`** ${req.method} ${req.path}`);
         if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
             res.status(200).json({
@@ -70,14 +72,14 @@ const initAlarmEndpoints = () => {
             return;
         }
         try {
-            const al = server.getSelfPath(`notifications.${req.params.alarmType}`);
+            const al = server.getSelfPath(`notifications.${req.params.alarmType}.${req.params.id}`);
             if (al && al.value) {
                 server.debug('Alarm value....');
                 if (al.value.method && al.value.method.includes('sound')) {
                     server.debug('Alarm has sound... silence!!!');
-                    al.value.method = al.value.method.filter((i) => i !== 'sound');
-                    const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}`, al.value);
-                    res.status(200).json(r);
+                    al.value.method = al.value.method.filter(i => i !== 'sound');
+                    const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}.${req.params.id}`, al.value);
+                    res.status(r.statusCode).json(r);
                 }
                 else {
                     server.debug('Alarm has no sound... no action required.');
@@ -89,7 +91,7 @@ const initAlarmEndpoints = () => {
                 }
             }
             else {
-                throw new Error(`Alarm (${req.params.alarmType}) has no value or was not found!`);
+                throw new Error(`Alarm (${req.params.alarmType}.${req.params.id}) has no value or was not found!`);
             }
         }
         catch (e) {
@@ -100,19 +102,19 @@ const initAlarmEndpoints = () => {
             });
         }
     });
-    server.delete(`${ALARM_API_PATH}/:alarmType`, (req, res, next) => {
+    server.delete(`${ALARM_API_PATH}/:alarmType/:id`, (req, res, next) => {
         server.debug(`** ${req.method} ${ALARM_API_PATH}/${req.params.alarmType}`);
         if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
             next();
             return;
         }
         try {
-            const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}`, {
+            const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}.${req.params.id}`, {
                 message: '',
                 method: [],
                 state: server_api_1.ALARM_STATE.normal
             });
-            res.status(200).json(r);
+            res.status(r.statusCode).json(r);
         }
         catch (e) {
             res.status(400).json({
@@ -128,10 +130,13 @@ const handleV1PutRequest = (context, path, value, cb) => {
 };
 const buildAlarmData = () => {
     const pos = server.getSelfPath('navigation.position');
-    return {
-        position: pos ? pos.value : null,
-        timestamp: new Date().toISOString()
+    const r = {
+        createdAt: new Date().toISOString()
     };
+    if (pos) {
+        r.position = pos.value;
+    }
+    return r;
 };
 const handleAlarm = (context, path, value) => {
     server.debug(`context: ${context}`);
@@ -147,7 +152,7 @@ const handleAlarm = (context, path, value) => {
         };
     }
     const pa = path.split('.');
-    const alarmType = pa[pa.length - 1];
+    const alarmType = pa[1];
     server.debug(`alarmType: ${JSON.stringify(alarmType)}`);
     if (STANDARD_ALARMS.includes(alarmType)) {
         server.debug(`****** Sending Delta (Std Alarm Notification): ******`);

package/plugin/index.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const alarms_1 = require("./alarms/alarms");
 const weather_service_1 = require("./weather/weather-service");
-const pypilot_1 = require("./autopilot/pypilot");
 const openapi = require("./openApi.json");
 const defaultPollInterval = 60;
 const CONFIG_SCHEMA = {
@@ -39,29 +38,6 @@ const CONFIG_SCHEMA = {
                     description: 'Select the interval at which the weather service is polled.'
                 }
             }
-        },
-        pypilot: {
-            type: 'object',
-            title: 'PyPilot.',
-            description: 'PyPilot host connection settings.',
-            properties: {
-                enable: {
-                    type: 'boolean',
-                    default: false,
-                    title: 'Enable PyPilot',
-                    description: ' '
-                },
-                host: {
-                    type: 'string',
-                    title: 'Host name / address',
-                    default: 'localhost'
-                },
-                port: {
-                    type: 'number',
-                    title: 'Port number',
-                    default: 8000
-                }
-            }
         }
     }
 };
@@ -98,11 +74,6 @@ module.exports = (server) => {
             apiVersion: 3,
             apiKey: '',
             pollInterval: defaultPollInterval
-        },
-        pypilot: {
-            enable: false,
-            host: 'localhost',
-            port: 8000
         }
     };
     // ******** REQUIRED PLUGIN DEFINITION *******
@@ -145,14 +116,6 @@ module.exports = (server) => {
                 enable: true
             };
             settings.alarms.enable = true;
-            settings.pypilot = options.pypilot ?? {
-                enable: false,
-                host: 'localhost',
-                port: 8000
-            };
-            settings.pypilot.enable = options.pypilot.enable ?? false;
-            settings.pypilot.host = options.pypilot.host ?? 'localhost';
-            settings.pypilot.port = options.pypilot.port ?? 8000;
             server.debug(`Applied config: ${JSON.stringify(settings)}`);
             if (settings.alarms.enable) {
                 (0, alarms_1.initAlarms)(server, plugin.id);
@@ -162,8 +125,6 @@ module.exports = (server) => {
                 msg = `Started - Providing: weather`;
                 (0, weather_service_1.initWeather)(server, plugin.id, settings.weather);
             }
-            // *** DEPRECATED ***
-            (0, pypilot_1.initPyPilot)(server, plugin.id, settings.pypilot);
             server.setPluginStatus(msg);
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }
@@ -178,7 +139,6 @@ module.exports = (server) => {
     const doShutdown = () => {
         server.debug('** shutting down **');
         (0, weather_service_1.stopWeather)();
-        (0, pypilot_1.closePyPilot)();
         server.debug('** Un-subscribing from events **');
         const msg = 'Stopped';
         server.setPluginStatus(msg);

package/public/3rdpartylicenses.txt

@@ -198,6 +198,34 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
+@signalk/server-api
+Apache-2.0
+
+baconjs
+MIT
+The MIT License
+
+Copyright (c) 2017 Juha Paananen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
 base64-js
 MIT
 The MIT License (MIT)