signalk-racer 0.9.13 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 # Signal K Racing Plugin
 
-This plugin adds sail racing-relevant data to a Signal K server. It focuses on real-time information useful during the start of a race, such as:
+This plugin adds sail racing relevant data to a Signal K server. It focuses on real-time information useful during the start of a race, such as:
  + A server side race timer that can be displayed on multiple screens and be finely adjusted
  + A mechanism to set and adjust the start line using waypoints and REST commands
  + Calculation of the distance to the line.
@@ -26,9 +26,10 @@ This plugin calculates and publishes the following Signal K paths:
 | `navigation.racing.`<br/>`timeToStart`          | Period of time until the race start                    | `s`                    | Y   |
 | `navigation.racing.`<br/>`startTime`            | The start time as an ISO timestamp                     | `rfc3339`              |     |
 
-These values can be displayed in KIP widgets, Freeboard-SK, or other Signal K clients.
+These values can be displayed in KIP widgets, Freeboard-SK, or other Signal K clients.  
+There are dedicated widgets for the start timer and line adjustment since 3.5.0 of KIP 
 
-![KIP and Freeboard Screenshot](kip-freeboard-screenshot.png)
+![KIP and Freeboard Screenshot](racer-kip.png)
 
 There is also a webapp to adjust the line and timer.
 
@@ -95,7 +96,7 @@ If `navigation.headingTrue` is not available, then `navigation.courseOverGroundT
 
 ## 🌐 API Access
 
-This plugin uses WebSocket-based PUT requests to Signal K model paths.
+This plugin uses the following WebSocket-based PUT requests to Signal K model paths.
 
 ### `navigation.racing.setStartLine`
 
@@ -133,13 +134,15 @@ Used to **start**, **sync**, **reset**, or **set a fixed start time**.
 ---
 
 ## 🧩 KIP Widgets
-KIP components for `racer-timer` and `racer-line` have been developed and will be available in a future release of KIP.
+KIP components for `racer-timer` and `racer-line` have been developed and are available from release 3.5.0 of KIP.
 
 ## 🔄 Dependencies
 
 ### Plugins
+- [KIP >= 3.5.0](https://github.com/mxtommy/Kip) for graphic widget support
+- [FreeboardSK](https://github.com/SignalK/freeboard-sk#readme) for graphic display of the start line
 - [resources-provider](https://www.npmjs.com/package/@signalk/resources-provider) plugin with waypoints enabled
-- [course-provider](https://www.npmjs.com/package/@signalk/course-provider) plugin
+- [course-provider](https://www.npmjs.com/package/@signalk/course-provider) plugin to enable the next leg calculations
 
 ### Libraries
 - `geolib`: for distance and bearing calculations.
@@ -151,7 +154,6 @@ KIP components for `racer-timer` and `racer-line` have been developed and will b
 - Add calculations for:
 - **Time to line** (using STW and heading or polar speeds)
 - **Laylines** and distance/time to them
-- Better integration with **Freeboard-SK** and **KIP** dashboards
 
 --- 
 ## 📬 Feedback

package/ReleaseNotes.md

@@ -1,3 +1,6 @@
+## 1.0.0 GA Release with KIP Widgets
+ + Fixed bias to be towards wind
+
 ## 0.9.13 GA Release Candidate
  + handle reverse routes
  + Improve startAt date handling

package/index.js

@@ -105,7 +105,7 @@ module.exports = (app) => {
         ]
     });
 
-    // send multiple deltas, each in the form of { path, value, units?}
+    // send multiple deltas, each in the form of { path, value }
     function sendDeltas(updatesArray) {
         const timestamp = new Date().toISOString();
 
@@ -199,14 +199,12 @@ module.exports = (app) => {
         app.debug(`putStartLineEnd: ${end} ${JSON.stringify(position)}`);
 
         try {
-            if (!end || !position || typeof position.latitude !== 'number' || typeof position.longitude !== 'number') {
+            if (!end || !position || typeof position.latitude !== 'number' || typeof position.longitude !== 'number')
                 return complete(callback, 400, 'Failed to put start line end: !end || !position');
-            }
 
             end = end.toLowerCase();
-            if (end !== 'port' && end !== 'stb') {
+            if (end !== 'port' && end !== 'stb')
                 return complete(callback, 400, 'Failed to put start line end: unknown end');
-            }
 
             let startLine = state.startLine;
             if (startLine) {
@@ -427,9 +425,8 @@ module.exports = (app) => {
                 }
 
                 case 'sync': {
-                    if (!state.timerRunning || state.timeToStart == null) {
+                    if (!state.timerRunning || state.timeToStart == null)
                         return complete(callback, 500, 'sync timer: !running');
-                    }
 
                     const rounded = Math.round(state.timeToStart / 60) * 60;
                     state.timeToStart = rounded;
@@ -465,7 +462,7 @@ module.exports = (app) => {
                             {path: 'navigation.racing.timeToStart', value: 0},
                             {path: 'navigation.racing.startTime', value: null}
                         ]);
-                        return complete(callback, 200, 'set timer: 0K');
+                        return complete(callback, 200, 'set timer: Ignored negative start time');
                     }
 
                     state.timerRunning = true;
@@ -483,15 +480,16 @@ module.exports = (app) => {
 
                 case 'adjust': {
                     const delta = Number(args.delta);
-                    if (isNaN(delta) || state.timeToStart == null || !state.startTime) {
-                        cb(null, {state: 'FAILED', message: 'Cannot adjust: invalid state or delta'});
-                        return;
-                    }
+                    if (isNaN(delta))
+                        return complete(callback, 400, 'adjust timer: Cannot adjust invalid delta');
+
+                    if (state.timeToStart == null)
+                        return complete(callback, 400, 'adjust timer: Cannot adjust start time');
 
                     const nextTimeToStart = state.timeToStart + delta;
-                    if (nextTimeToStart <= 1) {
-                        return;
-                    }
+                    if (nextTimeToStart <= 0)
+                        return complete(callback, 200, 'adjust timer: Ignored negative start time');
+
                     state.timeToStart = nextTimeToStart;
 
                     if (state.timerRunning) {
@@ -518,8 +516,8 @@ module.exports = (app) => {
                 }
             }
         } catch (err) {
-            app.debug('startTimerCommand:', JSON.stringify(err));
-            return complete(callback, 500, 'Failed to command timer: ' + JSON.stringify(err));
+            app.debug('startTimerCommand:', err);
+            return complete(callback, 500, 'Failed to command timer: ' + err.message);
         }
     }
 
@@ -659,6 +657,7 @@ module.exports = (app) => {
             state.distanceToLine = null;
             sendDeltas([
                 {path: 'navigation.racing.distanceStartline', value: null},
+                {path: 'navigation.racing.startLineBias', value: null},
             ]);
         }
     }
@@ -684,7 +683,7 @@ module.exports = (app) => {
         const startLine = state.startLine;
         if (startLine && isNearLineInRoute()) {
             app.debug(`processWind ${twd} to ${JSON.stringify(startLine)}`);
-            bias = - startLine.length * Math.cos(toRadians(startLine.bearing) - (twd + Math.PI));
+            bias = - startLine.length * Math.cos(toRadians(startLine.bearing) - twd);
         }
 
         sendDeltas([
@@ -958,23 +957,25 @@ module.exports = (app) => {
                 (delta) => {
                     app.debug('DELTAS START LINE ENDS ' + JSON.stringify(delta));
                     delta.updates.forEach((u) => {
-                        u.values.forEach((v) => {
-                            app.debug(`DELTA START LINE END from ${u.source.label}: ${v.path} = ${JSON.stringify(v.value)}`);
-                            if (u.source && u.source.label && u.source.label !== 'signalk-racer') {
-                                switch (v.path) {
-                                    case 'navigation.racing.startLinePort' :
-                                        putStartLineEnd('port', v.value, ignored => {
-                                        }, false).then(ignored => {
-                                        });
-                                        break;
-                                    case 'navigation.racing.startLineStb' :
-                                        putStartLineEnd('port', v.value, ignored => {
-                                        }, false).then(ignored => {
-                                        });
-                                        break;
+                        if (u.values) {
+                            u.values.forEach((v) => {
+                                app.debug(`DELTA START LINE END from ${u.source.label}: ${v.path} = ${JSON.stringify(v.value)}`);
+                                if (u.source && u.source.label && u.source.label !== 'signalk-racer') {
+                                    switch (v.path) {
+                                        case 'navigation.racing.startLinePort' :
+                                            putStartLineEnd('port', v.value, ignored => {
+                                            }, false).then(ignored => {
+                                            });
+                                            break;
+                                        case 'navigation.racing.startLineStb' :
+                                            putStartLineEnd('port', v.value, ignored => {
+                                            }, false).then(ignored => {
+                                            });
+                                            break;
+                                    }
                                 }
-                            }
-                        })
+                            });
+                        }
                     });
                 }
             );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-racer",
-  "version": "0.9.13",
+  "version": "1.0.0",
   "description": "Signalk plugin to calculate values of interest to sail racers: such as Time to Start, Time of Start, Distance to Line; Next leg TWA.",
   "main": "index.js",
   "repository": {