signalk-tides 1.0.0 → 1.1.0

package/README.md

@@ -19,10 +19,21 @@ It publishes the following [tide data](https://signalk.org/specification/1.7.0/d
 * `environment.tide.heightLow`
 * `environment.tide.timeLow`
 
-It also registers a `tides` resource, which returns tide predictions for the next 7 days for the vessel's position:
+### Tides resource
+
+It also registers a `tides` resource, which returns tide predictions for yesterday and the next 6 days for the vessel's position.
 
 ```
 $ curl http://localhost:3000/signalk/v2/api/resources/tides
+```
+
+##### Request Parameters
+
+* `date` (optional) - the date for which to get the tide predictions in the format `YYYY-MM-DD`. Default: yesterday's date.
+
+##### Response
+
+```json
 {
    "id" : "9710441",
    "name" : "Nurse Channel",
@@ -95,10 +106,13 @@ $ curl http://localhost:3000/signalk/v2/api/resources/tides
 }
 ```
 
+
+
 ## Sources
 
 - [NOAA](https://tidesandcurrents.noaa.gov/web_services_info.html) (US only)
 - [WorldTides API](https://www.worldtides.info/) (requires an API key)
+- [StormGlass.io](https://stormglass.io/) (requires an API key)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-tides",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Tidal predictions for the vessel's position from various online sources.",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -14,8 +14,9 @@
  * limitations under the License.
  */
 
+const noaa = require('./sources/noaa');
+const stormglass = require('./sources/stormglass');
 const worldtides = require('./sources/worldtides');
-const noaa = require('./sources/noaa')
 
 module.exports = function(app) {
   // Interval to update tide data
@@ -24,6 +25,7 @@ module.exports = function(app) {
 
   const sources = [
     noaa(app),
+    stormglass(app),
     worldtides(app),
   ];
 

package/src/sources/noaa.js

@@ -63,21 +63,18 @@ class NoaaProvider {
     this.stations = stations;
   }
 
-  async listResources(params) {
+  async listResources({ date = moment().subtract(1, "days") } = {}) {
     const position = this.app.getSelfPath("navigation.position.value");
     if (!position) throw new Error("no position");
 
     const station = this.stations.closestTo(position);
 
-    // Use server date, or current date if not available
-    const now = new Date(this.app.getSelfPath("navigation.datetime.value") ?? Date.now());
-
     const endpoint = new URL(dataGetterUrl);
     endpoint.search = new URLSearchParams({
       product: "predictions",
       application: "signalk.org/node-server",
-      begin_date: moment(now).subtract(1, "day").format("YYYYMMDD"),
-      end_date: moment(now).add(1, "day").format("YYYYMMDD"),
+      begin_date: moment(date).format("YYYYMMDD"),
+      end_date: moment(date).add(7, "days").format("YYYYMMDD"),
       datum,
       station: station.reference_id,
       time_zone: "gmt",
@@ -90,7 +87,8 @@ class NoaaProvider {
 
     try {
       const res = await fetch(endpoint);
-      if (!res.ok) throw new Error("Failed to fetch NOAA tides: " + res.statusText);
+      if (!res.ok)
+        throw new Error("Failed to fetch NOAA tides: " + res.statusText);
       const body = await res.json();
       this.app.debug("NOAA response: \n" + JSON.stringify(body, null, 2));
 
@@ -103,13 +101,13 @@ class NoaaProvider {
           latitude: station.lat,
           longitude: station.lng,
         },
-        extremes: body.predictions.map(({t, v, type}) => {
+        extremes: body.predictions.map(({ t, v, type }) => {
           return {
             type: type === "H" ? "High" : "Low",
             value: Number(v),
             time: new Date(`${t}Z`).toISOString(),
           };
-        })
+        }),
       };
 
       return tides;

package/src/sources/stormglass.js

@@ -0,0 +1,70 @@
+const moment = require('moment');
+
+module.exports = function (app, plugin) {
+  return {
+    id: 'stormglass',
+    title: 'StormGlass.io',
+    properties: {
+      stormglassApiKey: {
+        type: 'string',
+        title: 'StormGlass.io API key'
+      }
+    },
+
+    start(options) {
+      app.debug("Using StormGlass.io API");
+      return {
+        async listResources({ date = moment().subtract(1, "days") } = {}) {
+          const endPoint = new URL("https://api.stormglass.io/v2/tide/extremes/point");
+
+          const position = app.getSelfPath("navigation.position.value");
+          if (!position) throw new Error("no position");
+
+          endPoint.search = new URLSearchParams({
+            start: moment(date).format("YYYY-MM-DD"),
+            end: moment(date).add(7, "days").format("YYYY-MM-DD"),
+            // datum: "CD",
+            lat: position.latitude,
+            lng: position.longitude,
+          });
+
+          app.debug("Fetching StormGlass.io", endPoint.toString());
+
+          const res = await fetch(endPoint, {
+            headers: { Authorization: options.stormglassApiKey },
+          });
+
+          if(!res.ok) throw new Error('Failed to fetch StormGlass.io: ' + res.statusText);
+
+          const data = await res.json();
+          app.debug(JSON.stringify(data, null, 2));
+
+          return {
+            name: data.meta.station.name,
+            position: {
+              latitude: data.meta.station.lat,
+              longitude: data.meta.station.lng,
+            },
+            extremes: data.data.map(({ type, time, height}) => {
+              return {
+                type: type === "high" ? "High" : "Low",
+                value: height,
+                time: new Date(time).toISOString(),
+              };
+            }),
+          };
+        },
+        getResource: (id, property) => {
+          throw new Error("Not implemented");
+        },
+        setResource: (id, value) => {
+          throw new Error("Not implemented");
+        },
+        deleteResource: (id) => {
+          throw new Error("Not implemented");
+        },
+      };
+
+    }
+  }
+}

package/src/sources/worldtides.js

@@ -1,3 +1,5 @@
+const moment = require('moment');
+
 module.exports = function (app, plugin) {
   return {
     id: 'WorldTides.info',
@@ -12,15 +14,14 @@ module.exports = function (app, plugin) {
     start(options) {
       app.debug("Using WorldTides API");
       return {
-        async listResources() {
-          const endPoint = new URL("https://www.worldtides.info/api");
+        async listResources({ date = moment().subtract(1, "days") } = {}) {
+          const endPoint = new URL("https://www.worldtides.info/api/v3");
 
           const position = app.getSelfPath("navigation.position.value");
-
           if (!position) throw new Error("no position");
 
           endPoint.search = new URLSearchParams({
-            date: "today",
+            date: moment(date).format("YYYY-MM-DD"),
             datum: "CD",
             days: 7,
             extremes: true,
@@ -31,11 +32,11 @@ module.exports = function (app, plugin) {
 
           app.debug("Fetching worldtides", endPoint.toString());
 
-          // return fetch(endPoint).then(async (res) => {
           const res = await fetch(endPoint);
           if(!res.ok) throw new Error('Failed to fetch worldtides: ' + res.statusText);
 
           const data = await res.json();
+          app.debug(JSON.stringify(data, null, 2));
 
           if (data.status != 200) throw new Error("worldtides data: " + data.error ? data.error : "none");