@signalk/freeboard-sk 2.15.0 → 2.16.0

package/CHANGELOG.md

@@ -1,9 +1,25 @@
 # CHANGELOG: Freeboard
 
+
+### v2.16.0
+
+- **New**: Resource Groups: Add Routes and Waypoints to groups. Use groups to easily switch on / off resources to display on the map.
+- **New**: Added options to change the size of the vessel icon on the map. (#270)
+- **Updated**: Start-boat & start-pin waypoint icons
+- **Updated**: Always send metas for "weather service " `environment` paths at start-up (previously was just when weather service is enabled).
+- **Updated**: Weather service polling logic improved.
+
+
+### v2.15.1
+
+- **Updated**: Waypoint icon size alignment
+- **Removed**: Unused packages.
+
+
 ### v2.15.0
 
 - **New**: Night mode which is auto-set using the value of `environment.mode`. _Note: Enable this in settings by checking **Auto-set Night Mode**._ (#239)
-- **Updated**: Waypoint icons and types.
+- **Updated**: Waypoint icons and types. (#275)
 - **Fixed**: Temperature unit typo. 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "2.15.0",
+  "version": "2.16.0",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",
@@ -40,7 +40,6 @@
   "license": "Apache-v2",
   "dependencies": {
     "@signalk/server-api": "^2.3.0",
-    "socket.io-client": "^4.6.0",
     "tslib": "^2.0.0",
     "uuid": "^11.1.0"
   },

package/plugin/alarms/alarms.js

@@ -77,7 +77,7 @@ const initAlarmEndpoints = () => {
                 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');
+                    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);
                 }

package/plugin/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const server_api_1 = require("@signalk/server-api");
 const alarms_1 = require("./alarms/alarms");
 const weather_service_1 = require("./weather/weather-service");
 const openapi = require("./openApi.json");
@@ -101,6 +102,11 @@ module.exports = (server) => {
             if (typeof options !== 'undefined') {
                 settings = options;
             }
+            /**
+             * emit metas for environment paths
+             * @todo remove after merge of https://github.com/SignalK/specification/pull/662
+             */
+            emitMeteoMetas();
             settings.weather = options.weather ?? {
                 enable: false,
                 apiVersion: 3,
@@ -151,5 +157,243 @@ module.exports = (server) => {
             });
         });
     };
+    // ensure meteo path metas are emitted
+    const emitMeteoMetas = () => {
+        const pathRoot = 'environment';
+        const metas = [];
+        server.debug('**** Building METEO metas *****');
+        metas.push({
+            path: `${pathRoot}.date`,
+            value: {
+                description: 'Time of measurement.'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.sun.sunrise`,
+            value: {
+                description: 'Time of sunrise at the related position.'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.sun.sunset`,
+            value: {
+                description: 'Time of sunset at the related position.'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.uvIndex`,
+            value: {
+                description: 'Level of UV radiation. 1 UVI = 25mW/sqm',
+                units: 'UVI'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.cloudCover`,
+            value: {
+                description: 'Cloud clover.',
+                units: 'ratio'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.temperature`,
+            value: {
+                description: 'Outside air temperature.',
+                units: 'K'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.dewPointTemperature`,
+            value: {
+                description: 'Dew point.',
+                units: 'K'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.feelsLikeTemperature`,
+            value: {
+                description: 'Feels like temperature.',
+                units: 'K'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.horizontalVisibility`,
+            value: {
+                description: 'Horizontal visibility.',
+                units: 'm'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.horizontalVisibilityOverRange`,
+            value: {
+                description: 'Visibilty distance is greater than the range of the measuring equipment.'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.pressure`,
+            value: {
+                description: 'Barometric pressure.',
+                units: 'Pa'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.pressureTendency`,
+            value: {
+                description: 'Integer value indicating barometric pressure value tendency e.g. 0 = steady, etc.'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.pressureTendencyType`,
+            value: {
+                description: 'Description for the value of pressureTendency e.g. steady, increasing, decreasing.'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.relativeHumidity`,
+            value: {
+                description: 'Relative humidity.',
+                units: 'ratio'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.outside.absoluteHumidity`,
+            value: {
+                description: 'Absolute humidity.',
+                units: 'ratio'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.wind.averageSpeed`,
+            value: {
+                description: 'Average wind speed.',
+                units: 'm/s'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.wind.speedTrue`,
+            value: {
+                description: 'True wind speed.',
+                units: 'm/s'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.wind.directionTrue`,
+            value: {
+                description: 'The wind direction relative to true north.',
+                units: 'rad'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.wind.gust`,
+            value: {
+                description: 'Maximum wind gust.',
+                units: 'm/s'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.wind.gustDirectionTrue`,
+            value: {
+                description: 'Maximum wind gust direction.',
+                units: 'rad'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.wind.gust`,
+            value: {
+                description: 'Maximum wind gust.',
+                units: 'm/s'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.level`,
+            value: {
+                description: 'Water level.',
+                units: 'm'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.temperature`,
+            value: {
+                description: 'Water temperature.',
+                units: 'K'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.levelTendency`,
+            value: {
+                description: 'Integer value indicating water level tendency e.g. 0 = steady, etc.'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.levelTendencyType`,
+            value: {
+                description: 'Description for the value of levelTendency e.g. steady, increasing, decreasing.'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.current.set`,
+            value: {
+                description: 'Water current direction.',
+                units: 'rad'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.current.drift`,
+            value: {
+                description: 'Water current speed.',
+                units: 'm/s'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.waves.significantHeight`,
+            value: {
+                description: 'Significant wave height.',
+                units: 'm'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.waves.period`,
+            value: {
+                description: 'Wave period.',
+                units: 'ms'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.waves.direction`,
+            value: {
+                description: 'Wave direction.',
+                units: 'rad'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.swell.significantHeight`,
+            value: {
+                description: 'Significant swell height.',
+                units: 'm'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.swell.period`,
+            value: {
+                description: 'Swell period.',
+                units: 'ms'
+            }
+        });
+        metas.push({
+            path: `${pathRoot}.water.swell.directionTrue`,
+            value: {
+                description: 'Swell direction.',
+                units: 'rad'
+            }
+        });
+        server.debug('****  Sending METEO metas *****');
+        server.handleMessage(plugin.id, {
+            context: `meteo`,
+            updates: [
+                {
+                    meta: metas
+                }
+            ]
+        }, server_api_1.SKVersion.v1);
+    };
     return plugin;
 };

package/plugin/weather/openweather.js

@@ -127,7 +127,9 @@ class OpenWeather {
                 forecast.outside.cloudCover = f.clouds ? f.clouds / 100 : null;
                 forecast.outside.pressure =
                     typeof f.pressure !== 'undefined' ? f.pressure * 100 : null;
-                forecast.outside.absoluteHumidity = f.humidity ? (f.humidity / 100) : null;
+                forecast.outside.absoluteHumidity = f.humidity
+                    ? f.humidity / 100
+                    : null;
                 forecast.wind.speedTrue = f.wind_speed ?? null;
                 forecast.wind.directionTrue =
                     typeof f.wind_deg !== 'undefined'