@signalk/freeboard-sk 2.12.2 → 2.13.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG: Freeboard
 
+### v2.13.0
+- **New**: Support for Signal K [Autopilot API](https://demo.signalk.org/documentation/develop/rest-api/open_api.html).
+- **New**: Use of maritime icons from [OpenBridge](https://www.figma.com/community/file/1445713209741917748)
+- **New**: Display specific Note icons when "skIcon" property matches a POI type.
+- **Fixed**: Notes popover and dialog formatting. (#214, #223)
+- **Fixed**: Navigation data panel alignment on smaller screens. (#212)
+- **Fixed**: Update TTG display format based on magnitude of value. (#226)
+- **Updated**: Resource Set feature popover formatting. (#213)
+- **Updated**: Show more / less ui icons in AIS properties. (#217)
+- **Updated**: Relocated close button on resource lists. (#218)
+- **Updated**: Additional aisCogLine length options. (#209)
+- **Added**: %map:zoom% token for use in Notes fetch filter (#222)
 
 ### v2.12.2
 - **Fixed**: Issue applying URL query parameters. (#201)

package/README.md

@@ -77,6 +77,19 @@ Whilst not specifically defined in the Signal K specification, Freeboard-SK supp
 
 ---
 
+### Autopilot Console:  
+
+Freeboard-SK supports the Signal K Autopilot API which enables common operations to be performed
+including:
+- Engage / Disengage the autopilot
+- Setting the operation mode e.g. compass, route, gps, etc.
+- Setting and adjusting the target heading
+- Dodging obstacles
+
+![image](https://github.com/user-attachments/assets/e771fa83-92cd-4e65-ad78-a349646049c8)
+
+---
+
 ### Alarms and Notifications:
 
 Freeboard-SK can display alarms _(visual and audio)_ & messages contained in *Notification* messages transmitted by the Signal K server.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "2.12.2",
+  "version": "2.13.0",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",
@@ -21,6 +21,7 @@
     "test": "ng test",
     "format": "prettier --ignore-path .gitignore --write \"src/**/*.+(ts|html)\"",
     "format:helper": "prettier --ignore-path .gitignore --write \"helper/**/*.+(ts|html)\"",
+    "format:all": "npm run format && npm run format:helper",
     "build:helper": "tsc -p tsconfig-helper.json",
     "build:web": "ng build -c production --output-hashing all",
     "build:all": "npm run build:helper && npm run build:web",
@@ -65,10 +66,10 @@
     "@types/node": "^20.4.5",
     "@types/topojson-specification": "^1.0.2",
     "@types/xml2js": "^0.4.14",
-    "@typescript-eslint/eslint-plugin": "^5.10.0",
-    "@typescript-eslint/parser": "^5.10.0",
+    "@typescript-eslint/eslint-plugin": "^8.18.1",
+    "@typescript-eslint/parser": "^8.18.1",
     "codelyzer": "^6.0.0",
-    "eslint": "^8.33.0",
+    "eslint": "^9.17.0",
     "geolib": "^3.3.3",
     "jasmine-core": "~3.8.0",
     "jasmine-spec-reporter": "~5.0.0",

package/plugin/alarms/alarms.js

@@ -21,11 +21,11 @@ const initAlarms = (app, id) => {
     server = app;
     pluginId = id;
     server.debug(`** initAlarms() **`);
-    if (server.registerPutHandler) {
+    if (server.registerActionHandler) {
         server.debug(`** Registering Alarm Action Handler(s) **`);
         STANDARD_ALARMS.forEach((i) => {
             server.debug(`** Registering ${i} Handler **`);
-            server.registerPutHandler('vessels.self', `notifications.${i}`, handlePutAlarmState);
+            server.registerPutHandler('vessels.self', `notifications.${i}`, handleV1PutRequest);
         });
     }
     initAlarmEndpoints();
@@ -34,7 +34,7 @@ exports.initAlarms = initAlarms;
 const initAlarmEndpoints = () => {
     server.debug(`** Registering Alarm Action API endpoint(s) **`);
     server.post(`${ALARM_API_PATH}/:alarmType`, (req, res, next) => {
-        server.debug(`** POST ${ALARM_API_PATH}/${req.params.alarmType}`);
+        server.debug(`** ${req.method} ${ALARM_API_PATH}/${req.params.alarmType}`);
         if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
             next();
             return;
@@ -43,10 +43,11 @@ const initAlarmEndpoints = () => {
             const msg = req.body.message
                 ? req.body.message
                 : req.params.alarmType;
-            const r = handlePutAlarmState('vessels.self', `notifications.${req.params.alarmType}`, {
+            const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}`, {
                 message: msg,
                 method: [server_api_1.ALARM_METHOD.sound, server_api_1.ALARM_METHOD.visual],
-                state: server_api_1.ALARM_STATE.emergency
+                state: server_api_1.ALARM_STATE.emergency,
+                data: buildAlarmData()
             });
             res.status(200).json(r);
         }
@@ -59,7 +60,7 @@ const initAlarmEndpoints = () => {
         }
     });
     server.post(`${ALARM_API_PATH}/:alarmType/silence`, (req, res) => {
-        server.debug(`** POST ${req.path}`);
+        server.debug(`** ${req.method} ${req.path}`);
         if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
             res.status(200).json({
                 state: 'COMPLETED',
@@ -75,7 +76,7 @@ const initAlarmEndpoints = () => {
                 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 = handlePutAlarmState('vessels.self', `notifications.${req.params.alarmType}`, al.value);
+                    const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}`, al.value);
                     res.status(200).json(r);
                 }
                 else {
@@ -100,13 +101,13 @@ const initAlarmEndpoints = () => {
         }
     });
     server.delete(`${ALARM_API_PATH}/:alarmType`, (req, res, next) => {
-        server.debug(`** DELETE ${ALARM_API_PATH}/${req.params.alarmType}`);
+        server.debug(`** ${req.method} ${ALARM_API_PATH}/${req.params.alarmType}`);
         if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
             next();
             return;
         }
         try {
-            const r = handlePutAlarmState('vessels.self', `notifications.${req.params.alarmType}`, {
+            const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}`, {
                 message: '',
                 method: [],
                 state: server_api_1.ALARM_STATE.normal
@@ -122,10 +123,20 @@ const initAlarmEndpoints = () => {
         }
     });
 };
-const handlePutAlarmState = (context, path, value) => {
-    server.debug(context);
-    server.debug(path);
-    server.debug(JSON.stringify(value));
+const handleV1PutRequest = (context, path, value, cb) => {
+    cb(handleAlarm(context, path, value));
+};
+const buildAlarmData = () => {
+    const pos = server.getSelfPath('navigation.position');
+    return {
+        position: pos ? pos.value : null,
+        timestamp: new Date().toISOString()
+    };
+};
+const handleAlarm = (context, path, value) => {
+    server.debug(`context: ${context}`);
+    server.debug(`path: ${path}`);
+    server.debug(`value: ${JSON.stringify(value)}`);
     if (!path) {
         server.debug('Error: no path provided!');
         return {
@@ -137,33 +148,13 @@ const handlePutAlarmState = (context, path, value) => {
     }
     const pa = path.split('.');
     const alarmType = pa[pa.length - 1];
-    server.debug(JSON.stringify(alarmType));
-    let noti;
-    if (value) {
-        const alm = value.state === server_api_1.ALARM_STATE.normal ? null : buildAlarmData();
-        noti = {
-            path: `notifications.${alarmType}`,
-            value: {
-                state: value.state ?? null,
-                method: value.method ?? null,
-                message: value.message
-            }
-        };
-        if (alm && alm.data) {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            noti.value.data = alm.data;
-        }
-    }
-    else {
-        noti = {
-            path,
-            value: null
-        };
-    }
+    server.debug(`alarmType: ${JSON.stringify(alarmType)}`);
     if (STANDARD_ALARMS.includes(alarmType)) {
-        // ** send delta **
         server.debug(`****** Sending Delta (Std Alarm Notification): ******`);
-        emitNotification(noti);
+        emitNotification({
+            path: path,
+            value: value ?? null
+        });
         return { state: 'COMPLETED', resultStatus: 200, statusCode: 200 };
     }
     else {
@@ -175,14 +166,6 @@ const handlePutAlarmState = (context, path, value) => {
         };
     }
 };
-const buildAlarmData = () => {
-    const pos = server.getSelfPath('navigation.position');
-    return {
-        data: {
-            position: pos ? pos.value : null
-        }
-    };
-};
 // ** send notification delta message **
 const emitNotification = (msg) => {
     const delta = {

package/plugin/autopilot/pypilot.js

@@ -18,21 +18,25 @@ const apData = {
 let server;
 let pluginId;
 let socket;
+let isEnabled = false;
 const AUTOPILOT_API_PATH = '/signalk/v2/api/vessels/self/steering/autopilot';
 const DEAFULT_AP = `${AUTOPILOT_API_PATH}/default`;
 // initialise connection to autopilot, register socket listeners and SK AP path PUT handlers
 const initPyPilot = (app, id, config) => {
     server = app;
     pluginId = id;
-    server.debug(`** Connecting to PyPilot **`);
-    socket = (0, socket_io_client_1.io)(`http://${config.host}:${config.port}`);
-    if (!socket) {
-        console.log(`PyPilot NOT connected @ ${config.host}:${config.port}... ensure 'pypilot_web' is running.`);
+    isEnabled = config.enable;
+    if (isEnabled) {
+        server.debug(`** Connecting to PyPilot **`);
+        socket = (0, socket_io_client_1.io)(`http://${config.host}:${config.port}`);
+        if (!socket) {
+            console.log(`PyPilot NOT connected @ ${config.host}:${config.port}... ensure 'pypilot_web' is running.`);
+        }
+        // API endpoints
+        initApiRoutes();
+        emitAPDelta('defaultPilot', pluginId);
+        initPyPilotListeners();
     }
-    // API endpoints
-    initApiRoutes();
-    emitAPDelta('defaultPilot', pluginId);
-    initPyPilotListeners();
 };
 exports.initPyPilot = initPyPilot;
 const closePyPilot = () => {
@@ -45,14 +49,18 @@ const initApiRoutes = () => {
     server.debug(`** Registering API endpoint(s): ${AUTOPILOT_API_PATH} **`);
     server.get(`${DEAFULT_AP}`, (req, res) => {
         server.debug(`${req.method} ${DEAFULT_AP}`);
-        res.status(200);
-        res.json(apData);
+        res.status(200).json(apData);
     });
     server.get(`${AUTOPILOT_API_PATH}`, (req, res) => {
-        server.debug(`${req.method} ${AUTOPILOT_API_PATH}`);
-        res.status(200).json({
-            'freeboard-sk': { provider: 'freeboard-sk', isDefault: true }
-        });
+        server.debug(`${req.method} ${AUTOPILOT_API_PATH} (isEnabled: ${isEnabled})`);
+        if (isEnabled) {
+            res.status(200).json({
+                'freeboard-sk': { provider: 'freeboard-sk', isDefault: true }
+            });
+        }
+        else {
+            res.status(400).json({});
+        }
     });
     server.get(`${AUTOPILOT_API_PATH}/defaultPilot`, (req, res) => {
         server.debug(`${req.method} ${AUTOPILOT_API_PATH}/defaultPilot`);
@@ -118,7 +126,7 @@ const initApiRoutes = () => {
             });
             return;
         }
-        let deg = req.body.value * (180 / Math.PI);
+        let deg = req.body.value;
         if (deg > 359) {
             deg = 359;
         }
@@ -138,8 +146,7 @@ const initApiRoutes = () => {
             });
             return;
         }
-        const v = req.body.value * (180 / Math.PI);
-        let deg = apData.target + v;
+        let deg = apData.target + req.body.value;
         if (deg > 360) {
             deg = 360;
         }

package/plugin/icons/icons.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initIcons = void 0;
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+let server;
+let pluginId;
+const ICON_API_PATH = '/signalk/v2/api/resources/icons';
+let iconPath;
+const initIcons = (app, id) => {
+    server = app;
+    pluginId = id;
+    server.debug(`** initIcons() **`);
+    initFs();
+    initIconEndpoints();
+};
+exports.initIcons = initIcons;
+// check / create path to persist resources
+const initFs = async () => {
+    iconPath = server.getDataDirPath() + '/icons';
+    try {
+        try {
+            await (0, promises_1.access)(
+            // check path exists
+            iconPath, fs_1.constants.W_OK | fs_1.constants.R_OK);
+            server.debug(`${iconPath} - OK...`);
+        }
+        catch (error) {
+            // if not then create it
+            server.debug(`${iconPath} does NOT exist...`);
+            server.debug(`Creating ${iconPath} ...`);
+            try {
+                await (0, promises_1.mkdir)(iconPath, { recursive: true });
+                server.debug(`Created ${iconPath} - OK...`);
+            }
+            catch (error) {
+                throw new Error(`Unable to create ${iconPath}!`);
+            }
+        }
+    }
+    catch (error) {
+        throw new Error(`Unable to create ${iconPath}!`);
+    }
+    return true;
+};
+const initIconEndpoints = () => {
+    server.debug(`** Registering Icon resources endpoint(s) **`);
+    server.get(`${ICON_API_PATH}`, (req, res, next) => {
+        server.debug(`** ${req.method} ${req.path}`);
+        try {
+            res.status(200).json({ message: 'Signal K Icon Resources' });
+        }
+        catch (e) {
+            res.status(400).json({
+                state: 'FAILED',
+                statusCode: 400,
+                message: e.message
+            });
+        }
+    });
+    server.get(`${ICON_API_PATH}/:icon`, (req, res) => {
+        server.debug(`** ${req.method} ${req.path}`);
+        try {
+            res.sendFile(`${iconPath}/${req.params.icon}.png`, (err) => {
+                res.status(400).json({
+                    state: 'FAILED',
+                    statusCode: 400,
+                    message: err.message
+                });
+            });
+        }
+        catch (e) {
+            res.status(400).json({
+                state: 'FAILED',
+                statusCode: 400,
+                message: e.message
+            });
+        }
+    });
+};

package/plugin/index.js

@@ -162,9 +162,8 @@ module.exports = (server) => {
                 msg = `Started - Providing: weather`;
                 (0, weather_service_1.initWeather)(server, plugin.id, settings.weather);
             }
-            if (settings.pypilot.enable) {
-                (0, pypilot_1.initPyPilot)(server, plugin.id, settings.pypilot);
-            }
+            // *** DEPRECATED ***
+            (0, pypilot_1.initPyPilot)(server, plugin.id, settings.pypilot);
             server.setPluginStatus(msg);
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }

package/public/3rdpartylicenses.txt

@@ -1,5 +1,27 @@
 @angular/animations
 MIT
+The MIT License
+
+Copyright (c) 2010-2024 Google LLC. https://angular.dev/license
+
+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.
+
 
 @angular/cdk
 MIT
@@ -28,12 +50,78 @@ THE SOFTWARE.
 
 @angular/common
 MIT
+The MIT License
+
+Copyright (c) 2010-2024 Google LLC. https://angular.dev/license
+
+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.
+
 
 @angular/core
 MIT
+The MIT License
+
+Copyright (c) 2010-2024 Google LLC. https://angular.dev/license
+
+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.
+
 
 @angular/forms
 MIT
+The MIT License
+
+Copyright (c) 2010-2024 Google LLC. https://angular.dev/license
+
+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.
+
 
 @angular/material
 MIT
@@ -62,6 +150,28 @@ THE SOFTWARE.
 
 @angular/platform-browser
 MIT
+The MIT License
+
+Copyright (c) 2010-2024 Google LLC. https://angular.dev/license
+
+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.
+
 
 @kolkov/angular-editor
 MIT