signalk-tides 1.2.3 → 1.3.0

package/dist/calculations.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.approximateTideHeightAt = approximateTideHeightAt;
+/** Given a list of tide extremes, estimate the height at a specific time. */
+function approximateTideHeightAt(extremes, time) {
+    const sorted = extremes.slice().sort((a, b) => new Date(a.time).getTime() - new Date(b.time).getTime());
+    const prev = sorted.filter(h => new Date(h.time) <= time).at(-1);
+    const next = sorted.filter(h => new Date(h.time) >= time).at(0);
+    if (!prev)
+        throw new Error("Missing height data before " + time.toISOString());
+    if (!next)
+        throw new Error("Missing height data after " + time.toISOString());
+    const progress = (time.getTime() - new Date(prev.time).getTime()) /
+        (new Date(next.time).getTime() - new Date(prev.time).getTime());
+    const value = interpolate(prev.value, next.value, easeSine(progress));
+    return parseFloat(value.toFixed(3));
+}
+/** Interpolate between two values using the given progress (0-1). */
+function interpolate(start, end, progress) {
+    return start + (end - start) * progress;
+}
+function easeSine(progress) {
+    // Map progress [0..1] to angle [0..π]
+    const angle = progress * Math.PI;
+    // Use sine to ease in/out
+    return (1 - Math.cos(angle)) / 2;
+}

package/dist/index.js

@@ -20,10 +20,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 const noaa_js_1 = __importDefault(require("./sources/noaa.js"));
 const stormglass_js_1 = __importDefault(require("./sources/stormglass.js"));
 const worldtides_js_1 = __importDefault(require("./sources/worldtides.js"));
+const calculations_js_1 = require("./calculations.js");
 module.exports = function (app) {
     // Interval to update tide data
     const defaultPeriod = 60; // 1 hour
     let unsubscribes = [];
+    let lastForecast = null;
     const sources = [
         (0, noaa_js_1.default)(app),
         (0, stormglass_js_1.default)(app),
@@ -52,7 +54,7 @@ module.exports = function (app) {
                 period: {
                     title: "Update frequency",
                     type: "number",
-                    description: "How often to update tide data (minutes)",
+                    description: "How often to update tide forecast (minutes)",
                     default: 60,
                     minimum: 1,
                 },
@@ -104,18 +106,16 @@ module.exports = function (app) {
                 // @ts-expect-error: TODO[TS]: fix Delta type upstream
                 values.forEach(({ path }) => {
                     if (path === "navigation.position") {
-                        performUpdate();
+                        updateForecast();
                     }
                 });
             });
         });
-        async function performUpdate() {
+        async function updateForecast(now = new Date()) {
             try {
-                const { extremes } = await provider();
-                // Use server date, or current date if not available
-                const now = new Date(app.getSelfPath("navigation.datetime.value") ?? Date.now());
+                lastForecast = await provider();
                 const nextTide = {};
-                extremes.forEach(({ type, value, time }) => {
+                lastForecast.extremes.forEach(({ type, value, time }) => {
                     // Get the first tide of this type after now
                     if (!nextTide[type] && new Date(time) > now) {
                         nextTide[type] = { time, value };
@@ -137,6 +137,7 @@ module.exports = function (app) {
                 };
                 app.debug("Sending delta: " + JSON.stringify(delta));
                 app.handleMessage(plugin.id, delta);
+                updateHeightNow();
                 app.setPluginStatus("Updated tide data");
             }
             catch (e) {
@@ -146,8 +147,25 @@ module.exports = function (app) {
                 app.error(e);
             }
         }
+        async function updateHeightNow(now = new Date()) {
+            if (!lastForecast)
+                return;
+            // Combine heights and extremes to account for min/max being between height samples
+            const height = (0, calculations_js_1.approximateTideHeightAt)(lastForecast.extremes, now);
+            app.handleMessage(plugin.id, {
+                context: "vessels." + app.selfId,
+                updates: [
+                    {
+                        timestamp: now.toISOString(),
+                        values: [{ path: "environment.tide.heightNow", value: height }]
+                    }
+                ]
+            });
+        }
         // Perform initial update on startup after short delay to allow gnss position to be populated
-        delay(4000).then(() => { performUpdate(); });
+        delay(4000).then(() => { updateForecast(); });
+        // Update heightNow every minute
+        setInterval(updateHeightNow, 60 * 1000);
     };
     function delay(time) {
         return new Promise((resolve) => setTimeout(resolve, time));

package/package.json

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

package/CONTRIBUTING.md

@@ -1 +0,0 @@
-# Contributing