speedandcurrent 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -4,7 +4,15 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
-## [0.1.0] - 2025-1-? First version
+## [1.0.1] - 2025-1-27
 ### Added
 - basic functionality to estimate speed, leeway and current using Kalman filters
 - basic functionality for a webapp that shows what is going on
+
+## [1.1.0] - 2025-8-20
+### Changed
+- Path names for current. It now is self.environment.current.setTrue and self.environment.current.drift
+### Fixed
+- Case error in filename that prevented the webapp from displaying the correction table
+- Corrected speed through water is now calculated when the correction table is fixed
+

package/README.md

@@ -74,12 +74,12 @@ The graphical representation of the speed vectors, current vector, and correctio
 - A correction table stores speed errors for steps in speed and heel angle.
 - Each cell in the correction table contains a **Kalman filter** that updates speed corrections with new measurements.
 - The speed measurement is corrected by subtracting the correction from the correction table. The correction is **interpolated** based on nearby table cells, weighted by the uncertainty provided by the Kalman filter.
-- ![correction model](correctionModel.png)
+- ![correction model](https://github.com/Asw1n/speedandcurrent/raw/main/correctionModel.png)
 
 ### **2. Current Estimation Model**
 - The water current is estimated as a **slowly changing** vector.
 - A **Kalman filter** updates the current based on the difference between GPS speed and corrected speed.
-- ![current estimation model](currentModel.png)
+- ![current estimation model](https://github.com/Asw1n/speedandcurrent/raw/main/currentModel.png)
 
 ---
 

package/index.js

@@ -12,7 +12,7 @@ module.exports = function (app) {
   let isRunning = false;
   let corrTable = null;
   let lastSave = null;
-  var residual, heading, attitude, boatSpeed, boatSpeedPolar, correctedBoatSpeed, groundSpeed, current, currentDelta, speedCorrection, reporter;
+  var residual, heading, attitude, boatSpeed, boatSpeedPolar, correctedBoatSpeed, groundSpeed, current, speedCorrection, reporter;
 
 
   const plugin = {};
@@ -237,8 +237,7 @@ module.exports = function (app) {
     attitude.subscribe(app, plugin.id, unsubscribes);
  
     // current
-    currentDelta = new DeltaBase("environment.current");
-    current = new PolarDeltaBase();
+    current = new PolarDeltaBase("self.environment.current.drift","self.environment.current.setTrue");
     current.setDisplayAttributes("current", "ref_ground", "current");
 
     const currentStat = new PolarStat(current);
@@ -370,14 +369,8 @@ module.exports = function (app) {
 
 
       // Send calculated delta's
-      if (options.estimateCurrent) {
-        // translate current into signalK data structure
-        const c = current.getPValue();
-        const cc = { drift: current.speed, setTrue: current.angle, setMagnetic: (current.angle - variance.value + Math.PI) % (2 * Math.PI) - Math.PI };
-        currentDelta.setValue(cc);
-        DeltaBase.sendDeltas(app, plugin.id, [currentDelta]);
-      }
-      if (options.estimateBoatSpeed) PolarDeltaBase.sendDeltas(app, plugin.id, [correctedBoatSpeed]);
+      if (options.estimateCurrent) PolarDeltaBase.sendDeltas(app, plugin.id, [current]);
+        if (options.estimateBoatSpeed) PolarDeltaBase.sendDeltas(app, plugin.id, [correctedBoatSpeed]);
 
       // Save correction table 
       // periodically 
@@ -535,7 +528,7 @@ module.exports = function (app) {
           // locked table
           options.doStartFresh = false;
           options.updateCorrectionTable = false;
-          options.estimateBoatSpeed = false;
+          options.estimateBoatSpeed = true;
           options.assumeCurrent = true;
           options.estimateCurrent = true;
           options.currentStability = 2;
@@ -576,7 +569,6 @@ module.exports = function (app) {
         correctedBoatSpeed = null;
         groundSpeed = null;
         current = null;
-        currentDelta = null;
         speedCorrection = null;
         reporter = null;
         isRunning = false;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "speedandcurrent",
-  "version": "1.0.0",
-  "description": "An experimental plugin that uses sensor fusion to get boat speed, current and leeway.",
+  "version": "1.1.0",
+  "description": "A plugin that automatically corrects boat speed and calculates current and leeway using sensor fusion.",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/public/app.js

@@ -1,5 +1,5 @@
 const API_BASE_URL = "/plugins/speedandcurrent"; // Adjust based on your server configuration
-import TableRenderer from './tableRenderer.js';
+import TableRenderer from './TableRenderer.js';
 
 
 let updateInterval = 1000;