@signalk/freeboard-sk 2.20.0 → 2.21.0

package/README.md

@@ -187,11 +187,9 @@ The following features require that the Signal K server have plugins / providers
 
 The following plugins are recommended for installation on the Signal K Server to enable full functionality:
 
-- @signalk/course-provider _(Course calculations e.g. XTE, DTG, etc.)_
-- @signalk/charts-plugin *(Mapbox tiles chart provider)*
-- signalk-pmtiles-plugin *(ProtoMaps chart provider)*
-- signalk-anchoralarm-plugin _(Anchor alarm settings & notifications)_
-- signalk-simple-notifications _(Depth alarm notifications)_
+- Charts: `@signalk/charts-plugin`, `signalk-chart-provider-simple`, `signalk-pmtiles-plugin`, etc.
+- Anchor Watch: `signalk-anchoralarm-plugin`
+- Weather Forcasts: `signalk-openweather-provider`
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "2.20.0",
+  "version": "2.21.0",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",
@@ -40,7 +40,7 @@
   ],
   "license": "Apache-v2",
   "dependencies": {
-    "@signalk/server-api": "^2.22.0",
+    "@signalk/server-api": "^2.24.0",
     "geolib": "^3.3.3",
     "google-protobuf": "^4.0.1",
     "tslib": "^2.0.0",

package/plugin/alarms/alarms.js

@@ -7,19 +7,6 @@ const uuid = tslib_1.__importStar(require("uuid"));
 const geolib_1 = require("geolib");
 const AREA_TRIGGERS = ['entry', 'exit'];
 const AREA_GEOMETRIES = ['polygon', 'circle', 'region'];
-const STANDARD_ALARMS = [
-    'mob',
-    'fire',
-    'sinking',
-    'flooding',
-    'collision',
-    'grounding',
-    'listing',
-    'adrift',
-    'piracy',
-    'abandon',
-    'aground'
-];
 const ALARM_API_PATH = '/signalk/v2/api/alarms';
 class AreaAlarmManager {
     alarms;
@@ -62,7 +49,6 @@ class AreaAlarmManager {
      * @param id Area identifier
      */
     silence(id) {
-        // clean up notification
         const n = getSelfPathValue(`notifications.area.${id}`);
         if (n?.value && Array.isArray(n.value.method)) {
             const m = n.value.method.filter((i) => i !== 'sound');
@@ -98,7 +84,6 @@ class AreaAlarmManager {
                 notify = true;
                 server.debug(`*** active -> to inactive (${id})`);
             }
-            alarm.lastUpdate == Date.now();
         }
         else {
             if (condition === 'outside' && !alarm.active) {
@@ -115,6 +100,7 @@ class AreaAlarmManager {
             }
         }
         if (notify) {
+            alarm.lastUpdate = Date.now();
             const msg = area.trigger === 'entry'
                 ? alarm.active
                     ? `Monitored area ${area.name ? area.name + ' ' : ''}has been entered.`
@@ -147,13 +133,6 @@ const initAlarms = (app, id) => {
     server = app;
     pluginId = id;
     server.debug(`** initAlarms() **`);
-    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}`, handleV1PutRequest, pluginId);
-        });
-    }
     initAlarmEndpoints();
     setTimeout(() => parseRegionList(), 5000);
     // subscribe to deltas
@@ -351,147 +330,6 @@ const initAlarmEndpoints = async () => {
             });
         }
     });
-    const f = await server.getFeatures();
-    // test for notifications API
-    if (!f.apis.includes('notifications')) {
-        // standard alarms
-        server.post(`${ALARM_API_PATH}/:alarmType`, (req, res, next) => {
-            server.debug(`** ${req.method} ${ALARM_API_PATH}/${req.params.alarmType}`);
-            if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
-                next();
-                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}.${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
-                }, buildAlarmData()));
-                res.status(r.statusCode).json(Object.assign(r, { id: id }));
-            }
-            catch (e) {
-                res.status(400).json({
-                    state: 'FAILED',
-                    statusCode: 400,
-                    message: e.message
-                });
-            }
-        });
-        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({
-                    state: 'COMPLETED',
-                    statusCode: 200,
-                    message: `Unsupported Alarm (${req.params.alarmType}).`
-                });
-                return;
-            }
-            try {
-                const al = getSelfPathValue(`notifications.${req.params.alarmType}.${req.params.id}`);
-                if (al?.value) {
-                    server.debug('Alarm value....');
-                    if (al.value.method &&
-                        al.value.method.includes(server_api_1.ALARM_METHOD.sound)) {
-                        server.debug('Alarm has sound... silence!!!');
-                        al.value.method = al.value.method.filter((i) => i !== server_api_1.ALARM_METHOD.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.');
-                        res.status(200).json({
-                            state: 'COMPLETED',
-                            statusCode: 200,
-                            message: `Alarm (${req.params.alarmType}) is already silent.`
-                        });
-                    }
-                }
-                else {
-                    throw new Error(`Alarm (${req.params.alarmType}.${req.params.id}) 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/: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}.${req.params.id}`, {
-                    message: '',
-                    method: [],
-                    state: server_api_1.ALARM_STATE.normal
-                });
-                res.status(r.statusCode).json(r);
-            }
-            catch (e) {
-                res.status(400).json({
-                    state: 'FAILED',
-                    statusCode: 400,
-                    message: e.message
-                });
-            }
-        });
-    }
-};
-const handleV1PutRequest = (context, path, value, cb) => {
-    cb(handleAlarm(context, path, value));
-};
-const buildAlarmData = () => {
-    const pos = getSelfPathValue('navigation.position');
-    const r = {
-        createdAt: new Date().toISOString()
-    };
-    if (pos?.value) {
-        r.position = pos.value;
-    }
-    return r;
-};
-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 {
-            state: 'COMPLETED',
-            resultStatus: 400,
-            statusCode: 400,
-            message: `Invalid reference!`
-        };
-    }
-    const pa = path.split('.');
-    const alarmType = pa[1];
-    server.debug(`alarmType: ${JSON.stringify(alarmType)}`);
-    if (STANDARD_ALARMS.includes(alarmType)) {
-        server.debug(`****** Sending Delta (Std Alarm Notification): ******`);
-        emitNotification({
-            path: path,
-            value: value ?? null
-        });
-        return { state: 'COMPLETED', resultStatus: 200, statusCode: 200 };
-    }
-    else {
-        return {
-            state: 'COMPLETED',
-            resultStatus: 400,
-            statusCode: 400,
-            message: `Invalid reference!`
-        };
-    }
 };
 // emit notification delta message **
 const emitNotification = (msg) => {

package/plugin/index.js

@@ -4,7 +4,7 @@ const tslib_1 = require("tslib");
 const server_api_1 = require("@signalk/server-api");
 const alarms_1 = require("./alarms/alarms");
 const openapi = tslib_1.__importStar(require("./openApi.json"));
-const defaultPollInterval = 60;
+//const defaultPollInterval = 60;
 const CONFIG_SCHEMA = {
     properties: {}
 };

package/plugin/openApi.json

@@ -1,7 +1,7 @@
 {
     "openapi": "3.0.0",
     "info": {
-        "version": "2.18.0",
+        "version": "2.20.0",
         "title": "Freeboard-SK API",
         "description": "API endpoints exposed by Freeboard-SK to support application functionality and experimental features.",
         "termsOfService": "http://signalk.org/terms/",
@@ -14,16 +14,7 @@
         "url": "http://signalk.org/specification/",
         "description": "Signal K specification."
     },
-    "servers": [
-        {
-            "url": "/"
-        }
-    ],
     "tags": [
-        {
-            "name": "Alarms",
-            "description": "Standard alarms."
-        },
         {
             "name": "Areas",
             "description": "Area alarms."
@@ -142,28 +133,6 @@
                 "schema": {
                     "type": "number"
                 }
-            },
-            "AlarmTypeParam": {
-                "in": "path",
-                "required": true,
-                "name": "alarmType",
-                "description": "Alarm type.",
-                "schema": {
-                    "type": "string",
-                    "enum": [
-                        "mob",
-                        "fire",
-                        "sinking",
-                        "flooding",
-                        "collision",
-                        "grounding",
-                        "listing",
-                        "adrift",
-                        "piracy",
-                        "abandon",
-                        "aground"
-                    ]
-                }
             }
         },
         "securitySchemes": {
@@ -182,16 +151,19 @@
     "security": [{ "cookieAuth": [] }, { "bearerAuth": [] }],
     "paths": {
         "/signalk/v2/api/alarms/area": {
-            "post": {
+            "get": {
                 "tags": ["Areas"],
-                "summary": "Set Alarm area.",
+                "summary": "List Area Alarms.",
                 "requestBody": {
-                    "description": "Sets the defined area to monitor for vessel entry /exit.",
+                    "description": "Lists the areas to monitor for vessel entry /exit.",
                     "required": true,
                     "content": {
                         "application/json": {
                             "schema": {
-                                "$ref": "#/components/schemas/AreaAlarmDef"
+                                "type": "array",
+                                "items": {
+                                    "$ref": "#/components/schemas/AreaAlarmDef"
+                                }
                             }
                         }
                     }
@@ -204,19 +176,12 @@
                         "$ref": "#/components/responses/ErrorResponse"
                     }
                 }
-            }
-        },
-        "/signalk/v2/api/alarms/area/{id}": {
-            "parameters": [
-                {
-                    "$ref": "#/components/parameters/AlarmIdParam"
-                }
-            ],
-            "put": {
+            },
+            "post": {
                 "tags": ["Areas"],
-                "summary": "Update Alarm area OR Set the `Region` resource with the supplied identifier as the alarm area.",
+                "summary": "Set Alarm area.",
                 "requestBody": {
-                    "description": "Updates the area details for the supplied area identfier.",
+                    "description": "Sets the defined area to monitor for vessel entry /exit.",
                     "required": true,
                     "content": {
                         "application/json": {
@@ -234,62 +199,24 @@
                         "$ref": "#/components/responses/ErrorResponse"
                     }
                 }
-            },
-            "delete": {
-                "tags": ["Areas"],
-                "summary": "Clear / cancel Area Alarm.",
-                "responses": {
-                    "200ActionResponse": {
-                        "$ref": "#/components/responses/200OKResponse"
-                    },
-                    "default": {
-                        "$ref": "#/components/responses/ErrorResponse"
-                    }
-                }
             }
         },
-        "/signalk/v2/api/alarms/area/{id}/silence": {
+        "/signalk/v2/api/alarms/area/{id}": {
             "parameters": [
                 {
                     "$ref": "#/components/parameters/AlarmIdParam"
                 }
             ],
-            "post": {
+            "put": {
                 "tags": ["Areas"],
-                "summary": "Silence Area Alarm.",
-                "responses": {
-                    "200ActionResponse": {
-                        "$ref": "#/components/responses/200OKResponse"
-                    },
-                    "default": {
-                        "$ref": "#/components/responses/ErrorResponse"
-                    }
-                }
-            }
-        },
-        "/signalk/v2/api/alarms/{alarmType}": {
-            "parameters": [
-                {
-                    "$ref": "#/components/parameters/AlarmTypeParam"
-                }
-            ],
-            "post": {
-                "tags": ["Alarms"],
-                "summary": "Raise Alarm.",
+                "summary": "Update Alarm area OR Set the `Region` resource with the supplied identifier as the alarm area.",
                 "requestBody": {
-                    "description": "Alarm message text.",
-                    "required": false,
+                    "description": "Updates the area details for the supplied area identfier.",
+                    "required": true,
                     "content": {
                         "application/json": {
                             "schema": {
-                                "type": "object",
-                                "properties": {
-                                    "message": {
-                                        "type": "string",
-                                        "description": "Alarm message text.",
-                                        "example": "Person overboard!"
-                                    }
-                                }
+                                "$ref": "#/components/schemas/AreaAlarmDef"
                             }
                         }
                     }
@@ -302,20 +229,10 @@
                         "$ref": "#/components/responses/ErrorResponse"
                     }
                 }
-            }
-        },
-        "/signalk/v2/api/alarms/{alarmType}/{id}": {
-            "parameters": [
-                {
-                    "$ref": "#/components/parameters/AlarmTypeParam"
-                },
-                {
-                    "$ref": "#/components/parameters/AlarmIdParam"
-                }
-            ],
+            },
             "delete": {
-                "tags": ["Alarms"],
-                "summary": "Clear / cancel Alarm.",
+                "tags": ["Areas"],
+                "summary": "Clear / cancel Area Alarm.",
                 "responses": {
                     "200ActionResponse": {
                         "$ref": "#/components/responses/200OKResponse"
@@ -326,18 +243,15 @@
                 }
             }
         },
-        "/signalk/v2/api/alarms/{alarmType}/{id}/silence": {
+        "/signalk/v2/api/alarms/area/{id}/silence": {
             "parameters": [
-                {
-                    "$ref": "#/components/parameters/AlarmTypeParam"
-                },
                 {
                     "$ref": "#/components/parameters/AlarmIdParam"
                 }
             ],
             "post": {
-                "tags": ["Alarms"],
-                "summary": "Silence Alarm.",
+                "tags": ["Areas"],
+                "summary": "Silence Area Alarm.",
                 "responses": {
                     "200ActionResponse": {
                         "$ref": "#/components/responses/200OKResponse"

package/public/assets/help/index.html

@@ -220,7 +220,9 @@
               <tr>
                 <td>Chart display</td>
                 <td>
-                  <b>@signalk/charts-plugin</b>
+                  <b>@signalk/charts-plugin</b><br />
+                  <b>signalk-charts-provider-simple</b><br />
+                  <b>signalk-pmtiles-plugin</b>
                 </td>
               </tr>
               <tr>
@@ -2275,7 +2277,9 @@
           <br />
           <b>Distance Units</b>: <i>Kilometres</i> / <i>Nautical Miles</i>
           <br />
-          <b>Depth Units</b>: <i>Metres</i> / <i>Feet</i>
+          <b>Depth Units</b>: <i>Metres</i> / <i>Feet</i> / <i>Fathom</i>
+          <br />
+          <b>Length Units</b>: <i>Metres</i> / <i>Feet</i>
           <br />
           <b>Speed Units</b>: <i>Knots</i> / <i>m/sec</i> / <i>km/h</i> /
           <i>mph</i>
@@ -2339,6 +2343,7 @@
             </li>
           </ul>
           <b>Vector Charts:</b><br />
+          Options that apply to S57 charts.
           <ul>
             <li>
               <b>Graphics Style</b>: Select this option in order to a close a
@@ -2351,6 +2356,10 @@
             <li><b>Shallow Depth</b>: Enter the depth in meters.</li>
             <li><b>Safety Depth</b>: Enter the depth in meters.</li>
             <li><b>Deep Depth</b>: Enter the depth in meters.</li>
+            <li>
+              <b>Layers</b>: Select S57 layers to display
+              <i>(when avaiable)</i>.
+            </li>
           </ul>
           <hr />
 
@@ -2427,7 +2436,7 @@
                   <b>Default</b>: Calculates the length of the line displayed
                   based on the vessel SOG and the map scale.
                 </li>
-                <li><b>(x) NM</b> Length of the line to display.</li>
+                <li><b>(x) nmi</b> Length of the line to display.</li>
               </ul>
             </li>
             <li>