@signalk/freeboard-sk 2.7.0 → 2.8.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG: Freeboard
 
+### v2.8.0
+
+- **Added**: Option to display laylines when destination is active. (#149)
+- **Added**: Support for Signal K server "Features" API.
+- **Updated**: Measure function displays both segment details and total distance. (#153)
+- **Updated**: Clearing an alarm sets alarm state to normal rather than `null`.
+- **Fixed**: Inverted label color not correctly applied after feature update.
+
+### v2.7.1
+
+- **Added**: Set a default waypoint name when adding a waypoint at vessel position. (#146)
+
 ### v2.7.0
 
 - **Added**: OpenWeather OneCall v3.0 support. _(v2.5 is deprecated April 2024)_

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",
@@ -87,6 +87,7 @@
     "proj4": "2.6.2",
     "protractor": "~7.0.0",
     "rxjs": "~6.6.3",
+    "semver": "^7.6.0",
     "signalk-client-angular": "^2.0.3",
     "signalk-worker-angular": "^1.1.4",
     "simplify-ts": "^1.0.2",
@@ -97,4 +98,4 @@
     "xml2js": "^0.6.2",
     "zone.js": "~0.14.4"
   }
-}
+}

package/plugin/alarms/alarms.js

@@ -16,6 +16,7 @@ const STANDARD_ALARMS = [
 ];
 let server;
 let pluginId;
+const ALARM_API_PATH = '/signalk/v1/api/alarms';
 const initAlarms = (app, id) => {
     server = app;
     pluginId = id;
@@ -32,8 +33,8 @@ const initAlarms = (app, id) => {
 exports.initAlarms = initAlarms;
 const initAlarmEndpoints = () => {
     server.debug(`** Registering Alarm Action API endpoint(s) **`);
-    server.put('/signalk/v2/api/notifications/:alarmType', (req, res, next) => {
-        server.debug(`** PUT /signalk/v2/api/notifications/${req.params.alarmType}`);
+    server.post(`${ALARM_API_PATH}/:alarmType`, (req, res, next) => {
+        server.debug(`** POST ${ALARM_API_PATH}/${req.params.alarmType}`);
         if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
             next();
             return;
@@ -57,14 +58,59 @@ const initAlarmEndpoints = () => {
             });
         }
     });
-    server.delete('/signalk/v2/api/notifications/:alarmType', (req, res, next) => {
-        server.debug(`** DELETE /signalk/v2/api/notifications/${req.params.alarmType}`);
+    server.post(`${ALARM_API_PATH}/:alarmType/silence`, (req, res) => {
+        server.debug(`** POST ${req.path}`);
+        if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
+            res.status(200).json({
+                state: 'COMPLETED',
+                statusCode: 200,
+                message: `Unsupported Alarm (${req.params.alarmType}).`
+            });
+            return;
+        }
+        try {
+            const al = server.getSelfPath(`notifications.${req.params.alarmType}`);
+            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 = handlePutAlarmState('vessels.self', `notifications.${req.params.alarmType}`, al.value);
+                    res.status(200).json(r);
+                }
+                else {
+                    server.debug('Alarm has no sound... no action required.');
+                    res.status(200).json({
+                        state: 'COMPLETED',
+                        statusCode: 200,
+                        message: `Alarm (${req.params.alarmType}) is already silent.`
+                    });
+                }
+            }
+            else {
+                throw new Error(`Alarm (${req.params.alarmType}) has no value or was not found!`);
+            }
+        }
+        catch (e) {
+            res.status(400).json({
+                state: 'FAILED',
+                statusCode: 400,
+                message: e.message
+            });
+        }
+    });
+    server.delete(`${ALARM_API_PATH}/:alarmType`, (req, res, next) => {
+        server.debug(`** DELETE ${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}`, null);
+            const r = handlePutAlarmState('vessels.self', `notifications.${req.params.alarmType}`, {
+                message: '',
+                method: [],
+                state: server_api_1.ALARM_STATE.normal
+            });
             res.status(200).json(r);
         }
         catch (e) {
@@ -94,16 +140,16 @@ const handlePutAlarmState = (context, path, value) => {
     server.debug(JSON.stringify(alarmType));
     let noti;
     if (value) {
-        const alm = buildAlarmMessage(value.message);
+        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: alm.message
+                message: value.message
             }
         };
-        if (alm.data) {
+        if (alm && alm.data) {
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             noti.value.data = alm.data;
         }
@@ -129,10 +175,9 @@ const handlePutAlarmState = (context, path, value) => {
         };
     }
 };
-const buildAlarmMessage = (message) => {
+const buildAlarmData = () => {
     const pos = server.getSelfPath('navigation.position');
     return {
-        message: message,
         data: {
             position: pos ? pos.value : null
         }
@@ -143,5 +188,5 @@ const emitNotification = (msg) => {
     const delta = {
         updates: [{ values: [msg] }]
     };
-    server.handleMessage(pluginId, delta);
+    server.handleMessage(pluginId, delta, server_api_1.SKVersion.v2);
 };

package/plugin/index.js

@@ -7,19 +7,6 @@ const openapi = require("./openApi.json");
 const defaultPollInterval = 60;
 const CONFIG_SCHEMA = {
     properties: {
-        alarms: {
-            type: 'object',
-            title: 'Standard Alarms.',
-            description: 'Standard Alarms request handler (MOB, etc.)',
-            properties: {
-                enable: {
-                    type: 'boolean',
-                    default: true,
-                    title: 'Enable Standard Alarms',
-                    description: ' '
-                }
-            }
-        },
         weather: {
             type: 'object',
             title: 'Weather API.',
@@ -34,8 +21,8 @@ const CONFIG_SCHEMA = {
                 apiVersion: {
                     type: 'number',
                     title: 'API Version',
-                    default: 2,
-                    enum: [2, 3],
+                    default: 3,
+                    enum: [3, 2],
                     description: 'Note: v2 API not supported after April 2024!'
                 },
                 apiKey: {
@@ -108,7 +95,7 @@ module.exports = (server) => {
         },
         weather: {
             enable: false,
-            apiVersion: 2,
+            apiVersion: 3,
             apiKey: '',
             pollInterval: defaultPollInterval
         },
@@ -145,19 +132,19 @@ module.exports = (server) => {
             }
             settings.weather = options.weather ?? {
                 enable: false,
-                apiVersion: 2,
+                apiVersion: 3,
                 apiKey: '',
                 pollInterval: defaultPollInterval
             };
             settings.weather.enable = options.weather.enable ?? false;
-            settings.weather.apiVersion = options.weather.apiVersion ?? 2;
+            settings.weather.apiVersion = options.weather.apiVersion ?? 3;
             settings.weather.apiKey = options.weather.apiKey ?? '';
             settings.weather.pollInterval =
                 options.weather.pollInterval ?? defaultPollInterval;
             settings.alarms = options.alarms ?? {
                 enable: true
             };
-            settings.alarms.enable = options.alarms.enable ?? true;
+            settings.alarms.enable = true;
             settings.pypilot = options.pypilot ?? {
                 enable: false,
                 host: 'localhost',

package/plugin/openApi.json

@@ -16,14 +16,10 @@
     },
     "servers": [
         {
-            "url": "/signalk/v2/api"
+            "url": "/"
         }
     ],
     "tags": [
-        {
-            "name": "Alarms",
-            "description": "Raise and clear Signal K alarms."
-        },
         {
             "name": "OpenWeather",
             "description": "Weather data from OpenWeather service."
@@ -470,7 +466,7 @@
     },
     "security": [{ "cookieAuth": [] }, { "bearerAuth": [] }],
     "paths": {
-        "/meteo/{id}": {
+        "/signalk/v2/api/meteo/{id}": {
             "parameters": [
                 {
                     "$ref": "#/components/parameters/StationIdParam"
@@ -493,7 +489,7 @@
                 }
             }
         },
-        "/meteo/{id}/observations": {
+        "/signalk/v2/api/meteo/{id}/observations": {
             "parameters": [
                 {
                     "$ref": "#/components/parameters/StationIdParam"
@@ -519,7 +515,7 @@
                 }
             }
         },
-        "/meteo/{id}/observations/{entryId}": {
+        "/signalk/v2/api/meteo/{id}/observations/{entryId}": {
             "parameters": [
                 {
                     "$ref": "#/components/parameters/StationIdParam"
@@ -545,7 +541,7 @@
                 }
             }
         },
-        "/meteo/{id}/forecasts": {
+        "/signalk/v2/api/meteo/{id}/forecasts": {
             "parameters": [
                 {
                     "$ref": "#/components/parameters/StationIdParam"
@@ -571,7 +567,7 @@
                 }
             }
         },
-        "/meteo/{id}/forecasts/{entryId}": {
+        "/signalk/v2/api/meteo/{id}/forecasts/{entryId}": {
             "parameters": [
                 {
                     "$ref": "#/components/parameters/StationIdParam"
@@ -597,7 +593,7 @@
                 }
             }
         },
-        "/meteo/{id}/warnings": {
+        "/signalk/v2/api/meteo/{id}/warnings": {
             "parameters": [
                 {
                     "$ref": "#/components/parameters/StationIdParam"
@@ -623,7 +619,7 @@
                 }
             }
         },
-        "/meteo/{id}/warnings/{entryId}": {
+        "/signalk/v2/api/meteo/{id}/warnings/{entryId}": {
             "parameters": [
                 {
                     "$ref": "#/components/parameters/StationIdParam"
@@ -648,31 +644,6 @@
                     }
                 }
             }
-        },
-        "/notifications/{alarmType}": {
-            "parameters": [
-                {
-                    "$ref": "#/components/parameters/AlarmTypeParam"
-                }
-            ],
-            "put": {
-                "tags": ["Alarms"],
-                "summary": "Raise alarm.",
-                "responses": {
-                    "default": {
-                        "$ref": "#/components/responses/200OKResponse"
-                    }
-                }
-            },
-            "delete": {
-                "tags": ["Alarms"],
-                "summary": "Clear alarm.",
-                "responses": {
-                    "default": {
-                        "$ref": "#/components/responses/200OKResponse"
-                    }
-                }
-            }
         }
     }
 }

package/plugin/weather/openweather.js

@@ -57,13 +57,13 @@ class OpenWeather {
                 },
                 outside: {
                     uvIndex: current.uvi ?? null,
-                    cloudCover: current.clouds ?? null,
+                    cloudCover: current.clouds / 100 ?? null,
                     horizontalVisibility: current.visibility ?? null,
                     temperature: current.temp ?? null,
                     feelsLikeTemperature: current.feels_like ?? null,
                     dewPointTemperature: current.dew_point ?? null,
                     pressure: current.pressure ? current.pressure * 100 : null,
-                    absoluteHumidity: current.humidity ?? null,
+                    absoluteHumidity: current.humidity / 100 ?? null,
                     precipitationType: current.rain && typeof current.rain['1h'] !== 'undefined'
                         ? 'rain'
                         : current.snow && typeof current.snow['1h'] !== 'undefined'
@@ -119,10 +119,10 @@ class OpenWeather {
                 }
                 forecast.outside.dewPointTemperature = f.dew_point ?? null;
                 forecast.outside.uvIndex = f.uvi ?? null;
-                forecast.outside.cloudCover = f.clouds ?? null;
+                forecast.outside.cloudCover = f.clouds / 100 ?? null;
                 forecast.outside.pressure =
                     typeof f.pressure !== 'undefined' ? f.pressure * 100 : null;
-                forecast.outside.absoluteHumidity = f.humidity ?? null;
+                forecast.outside.absoluteHumidity = f.humidity / 100 ?? null;
                 forecast.wind.speedTrue = f.wind_speed ?? null;
                 forecast.wind.directionTrue =
                     typeof f.wind_deg !== 'undefined'

package/plugin/weather/weather-service.js

@@ -457,7 +457,7 @@ const buildObservationMetas = (pathRoot) => {
         path: `${pathRoot}.outside.cloudCover`,
         value: {
             description: 'Cloud clover.',
-            units: '%'
+            units: 'ratio'
         }
     });
     metas.push({
@@ -517,14 +517,14 @@ const buildObservationMetas = (pathRoot) => {
         path: `${pathRoot}.outside.relativeHumidity`,
         value: {
             description: 'Relative humidity.',
-            units: '%'
+            units: 'ratio'
         }
     });
     metas.push({
         path: `${pathRoot}.outside.absoluteHumidity`,
         value: {
             description: 'Absolute humidity.',
-            units: '%'
+            units: 'ratio'
         }
     });
     metas.push({