@signalk/freeboard-sk 2.18.2 → 2.19.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "2.18.2",
+  "version": "2.19.0-beta.1",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",

package/plugin/index.js

@@ -2,83 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const server_api_1 = require("@signalk/server-api");
 const alarms_1 = require("./alarms/alarms");
-/** @deprecated */
-const weather_service_1 = require("./weather/weather-service");
 const openapi = require("./openApi.json");
 const defaultPollInterval = 60;
 const CONFIG_SCHEMA = {
-    properties: {
-        /** @deprecated */
-        weather: {
-            type: 'object',
-            title: 'Weather API.',
-            description: 'OpenWeather service settings.',
-            properties: {
-                enable: {
-                    type: 'boolean',
-                    default: false,
-                    title: 'Enable Weather',
-                    description: ' '
-                },
-                apiVersion: {
-                    type: 'number',
-                    title: 'API Version',
-                    default: 3,
-                    enum: [3, 2],
-                    description: 'Note: v2 API not supported after April 2024!'
-                },
-                apiKey: {
-                    type: 'string',
-                    title: 'API Key',
-                    default: '',
-                    description: 'Get your API key at https://openweathermap.org/home/sign_up'
-                },
-                pollInterval: {
-                    type: 'number',
-                    title: 'Polling Interval',
-                    default: 60,
-                    enum: weather_service_1.WEATHER_POLL_INTERVAL,
-                    description: 'Select the interval at which the weather service is polled.'
-                }
-            }
-        }
-    }
-};
-const CONFIG_UISCHEMA = {
-    /** @deprecated */
-    weather: {
-        enable: {
-            'ui:widget': 'checkbox',
-            'ui:title': ' ',
-            'ui:help': ' '
-        },
-        apiVersion: {
-            'ui:widget': 'select',
-            'ui-help': ' '
-        },
-        apiKey: {
-            'ui:disabled': false,
-            'ui-help': ''
-        },
-        pollInterval: {
-            'ui:widget': 'select',
-            'ui:title': 'Polling Interval (mins)',
-            'ui:help': ' '
-        }
-    }
+    properties: {}
 };
+const CONFIG_UISCHEMA = {};
 module.exports = (server) => {
     // ** default configuration settings
     let settings = {
         alarms: {
             enable: true
-        },
-        /** @deprecated */
-        weather: {
-            enable: false,
-            apiVersion: 3,
-            apiKey: '',
-            pollInterval: defaultPollInterval
         }
     };
     // ******** REQUIRED PLUGIN DEFINITION *******
@@ -111,17 +45,6 @@ module.exports = (server) => {
              * @todo remove after merge of https://github.com/SignalK/specification/pull/662
              */
             emitMeteoMetas();
-            settings.weather = options.weather ?? {
-                enable: false,
-                apiVersion: 3,
-                apiKey: '',
-                pollInterval: defaultPollInterval
-            };
-            settings.weather.enable = options.weather.enable ?? false;
-            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
             };
@@ -130,12 +53,7 @@ module.exports = (server) => {
             if (settings.alarms.enable) {
                 (0, alarms_1.initAlarms)(server, plugin.id);
             }
-            let msg = '';
-            if (settings.weather.enable) {
-                msg = `Started - Providing: weather`;
-                (0, weather_service_1.initWeather)(server, plugin.id, settings.weather);
-            }
-            server.setPluginStatus(msg);
+            server.setPluginStatus('Started');
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }
         catch (error) {
@@ -148,7 +66,6 @@ module.exports = (server) => {
     };
     const doShutdown = () => {
         server.debug('** shutting down **');
-        (0, weather_service_1.stopWeather)();
         server.debug('** Un-subscribing from events **');
         const msg = 'Stopped';
         server.setPluginStatus(msg);
@@ -161,7 +78,10 @@ module.exports = (server) => {
             });
         });
     };
-    // ensure meteo path metas are emitted
+    /**
+     * Ensure meta delta are emitted for environment paths
+     * @todo remove after merge of https://github.com/SignalK/specification/pull/662
+     */
     const emitMeteoMetas = () => {
         const pathRoot = 'environment';
         const metas = [];

package/public/assets/help/index.html

@@ -662,20 +662,17 @@
         <div class="panel" id="resources">
           <h4><i class="material-icons">layers</i> Resources / Layers</h4>
 
-          Freeboard provides functionality for in-built Signal K resource types:
-          routes, waypoints, charts, notes and regions.
+          Freeboard provides Create / Update / Delete (CrUD) functionality for
+          all in-built Signal K resource types:
+          <i>routes, waypoints, charts, notes and regions</i>.
           <br />
-          Each resource type is displayed in a separate map layer which can be
-          controlled from the
-          <i class="material-icons" style="color: green">layers</i> toolbar
-          button.
+          Each resource type is managed in a separate map layer which can be
+          controlled from the <i class="material-icons">layers</i> toolbar
+          button, which when clicked will contain options for the various
+          resource types.
           <br />
-          The menu displayed when clicked will contain options for the Signal K
-          specified resources (Routes, Waypoints, Notes, Charts) as well as
-          additional available resource paths enabled in Settings.
-          <br />
-          Resource groups can also be defined which enables "one-click"
-          selection of resources to display on the screen.
+          Resources can be <i>grouped</i> which enables them to be displayed or
+          hidden with a single click.
           <br />
           Additionally resources can be exported to a GPX file by selecting the
           <b><i class="material-icons">save</i> Export</b> menu.
@@ -683,32 +680,39 @@
           <ul>
             <li class="nobullet">
               <i class="material-icons">category</i>
-              <b>Resource Groups:</b>
-              Displays a list of Resource Groups.
+              <b>Resource Groups</b>
             </li>
           </ul>
 
           <div style="display: flex; flex-wrap: wrap">
             <div style="padding-left: 15px">
               Groups provide a means of defining a set of resources so they can
-              be easily selected for display.
+              be easily displayed or hidden.
               <br />
-              Selecting a Group will display on the map all resources within the
-              group and hide all other resources.
+              Selecting a Group will display all of the resources within the
+              group on the map and hide all other resources.
               <br />
               Resources can be added to groups directly from the specfic
-              resource list (e.g. Routes, Waypoints).
+              resource list <i>(e.g. Routes, Waypoints)</i> or when editing a
+              Group's properties.
               <br />
-              A resource can belong to more than one resource group.
+              <i
+                >Note: A resource can belong to more than one resource group.</i
+              >
               <ul>
                 <li>
                   <i class="material-icons">add</i> <b>New Group:</b> Create a
-                  new Group container.
+                  new resource Group.
                 </li>
                 <li>
                   <i class="material-icons">edit</i>
-                  <b>Update Group:</b> Displays the Group properties. Use this
-                  to: Rename the group, view, add and remove resources from the
+                  <b>Update Group:</b> Display / update a Group's properties.
+                  Use this to:
+                  <ul>
+                    <li>Rename the group</li>
+                    <li>Display the resourcces within the group</li>
+                    <li>Add and Remove resources from the group</li>
+                  </ul>
                   group.
                 </li>
                 <li>
@@ -723,10 +727,23 @@
           <div style="display: flex; flex-wrap: wrap">
             <div style="padding-left: 15px; background-color: orange">
               <b>Enabling Resource Groups</b><br />
-              To use Resource Groups you will need to configure a
+              Freeboard will try to create a resource collection on the Signal K
+              server to store resource groups. <br />
+              <i
+                >Note: this requires that:
+                <ol>
+                  <li>You are logged in to the Signal K server</li>
+                  <li>
+                    <b>resources-provider</b> plugin version 1.4.1 or greater is
+                    installed on the server
+                  </li>
+                </ol>
+              </i>
+
+              If Freeboard cannot create the store then you can configure a
               <i>groups</i> resource endpoint on the Signal K server.
               <br />
-              To configure:
+              To do this:
               <ul>
                 <li>
                   In the Signal K server Admin console select
@@ -740,8 +757,82 @@
                 </li>
                 <li>Click <b>Submit</b></li>
               </ul>
-              Note: Freeboard-SK will need to be re-loaded to make the Resource
-              Groups options available.
+              <i
+                >Note: Freeboard-SK will need to be re-loaded to make the
+                Resource Groups menu item available.</i
+              >
+            </div>
+          </div>
+
+          <hr />
+          <ul>
+            <li class="nobullet">
+              <i class="material-icons">layers</i>
+              <b>Overlays</b>
+            </li>
+          </ul>
+
+          <div style="display: flex; flex-wrap: wrap">
+            <div style="padding-left: 15px">
+              Overlays allow information to be "overlaid" on charts as map
+              layers.
+              <br />
+              They can be configured to be refreshed at regular intervals to
+              update the displayed data from the source.
+              <br />
+              The opacity of the overlay can be configured to control the
+              visibility of the underlying chart layers.
+              <br />
+              <ul>
+                <li>
+                  <i class="material-icons">add</i> <b>New Overlay:</b> Create a
+                  new overlay from a WMS or WMTS source.
+                </li>
+                <li>
+                  <i class="material-icons">delete</i>
+                  <b>Delete Overlay:</b> Delete the overlay definition from the
+                  server.
+                </li>
+              </ul>
+            </div>
+          </div>
+          <div style="display: flex; flex-wrap: wrap">
+            <div style="padding-left: 15px; background-color: orange">
+              <b>Enabling Overlays</b><br />
+              Freeboard will try to create a resource collection on the Signal K
+              server to store Overlays. <br />
+              <i
+                >Note: this requires that:
+                <ol>
+                  <li>You are logged in to the Signal K server</li>
+                  <li>
+                    <b>resources-provider</b> plugin version 1.4.1 or greater is
+                    installed on the server
+                  </li>
+                </ol>
+              </i>
+
+              If Freeboard cannot create the store then you can configure a
+              <i>infolayers</i> resource endpoint on the Signal K server.
+              <br />
+              To do this:
+              <ul>
+                <li>
+                  In the Signal K server Admin console select
+                  <b>Server | Plugin Config</b>
+                </li>
+                <li>Select the <b>Resources Provider</b> plugin</li>
+                <li>
+                  In the <b>Resources (Custom)</b> section, click
+                  <i class="material-icons">add</i> and type
+                  <i>infolayers</i> in the <b>Resource Type</b>
+                </li>
+                <li>Click <b>Submit</b></li>
+              </ul>
+              <i
+                >Note: Freeboard-SK will need to be re-loaded to make the
+                Overlays menu item available.</i
+              >
             </div>
           </div>
 

package/public/index.html

@@ -59,5 +59,5 @@
         </div>
       </div>
     </app-root>
-  <script src="runtime.e598c35c8d15b7e2.js" type="module"></script><script src="polyfills.0823dc027f0a1d2e.js" type="module"></script><script src="main.cf0744e0baadbec3.js" type="module"></script></body>
+  <script src="runtime.e598c35c8d15b7e2.js" type="module"></script><script src="polyfills.0823dc027f0a1d2e.js" type="module"></script><script src="main.30f0db8afdde9114.js" type="module"></script></body>
 </html>