signalk-racer 0.9.8 → 0.9.10

package/ReleaseNotes.md

@@ -1,3 +1,10 @@
+## 0.9.10 Updates for KIP widgets
+ + Do not set a start time unless timer is running
+ + Schema RFC 3339 units for start time.
+
+## 0.9.9 Working with KIP prototypes
+ + Fixed API handlers to use return status rather than callback
+
 ## 0.9.8
  + Minor updates to webapp UI
 

package/index.js

@@ -1,4 +1,3 @@
-
 module.exports = (app) => {
     const state = {};
     const geolib = require('geolib')
@@ -51,6 +50,7 @@ module.exports = (app) => {
                     {
                         "path": "navigation.racing.startLineLength",
                         "value": {
+                            "type": "number",
                             "units": "m",
                             "description": "Length of the start line",
                             "displayName": "Length of the start line",
@@ -60,6 +60,7 @@ module.exports = (app) => {
                     {
                         "path": "navigation.racing.stbLineBias",
                         "value": {
+                            "type": "number",
                             "units": "m",
                             "description": "Bias of the start line for the starboard end",
                             "displayName": "Bias of the start line for the starboard end",
@@ -69,6 +70,7 @@ module.exports = (app) => {
                     {
                         "path": "navigation.racing.nextLegHeading",
                         "value": {
+                            "type": "number",
                             "units": "rad",
                             "description": "Heading of the next leg of the course",
                             "displayName": "Next Heading",
@@ -78,12 +80,26 @@ module.exports = (app) => {
                     {
                         "path": "navigation.racing.nextLegTrueWindAngle",
                         "value": {
+                            "type": "number",
                             "units": "rad",
                             "description": "TWA on the next leg of the course",
                             "displayName": "Next TWA",
                             "shortName": "NextTWA",
                         }
                     },
+                    {
+                        "path": "navigation.racing.startTime",
+                        "value": {
+                            "type": "string",
+                            "units": "RFC 3339 (UTC)",
+                            "example": "2014-04-10T08:33:53.123Z",
+                            "format": "date-time",
+                            "pattern" : ".*Z$",
+                            "description": "Time of the race start in RFC 3339 UTC only format ",
+                            "displayName": "Start Time",
+                            "shortName": "StartTime",
+                        }
+                    },
                 ]
             }
         ]
@@ -136,10 +152,13 @@ module.exports = (app) => {
     }
 
     function toOtherEnd(end) {
-        switch(end) {
-            case 'port' : return 'stb';
-            case 'stb' : return 'port';
-            default: return null;
+        switch (end) {
+            case 'port' :
+                return 'stb';
+            case 'stb' :
+                return 'port';
+            default:
+                return null;
         }
     }
 
@@ -170,9 +189,9 @@ module.exports = (app) => {
     }
 
     function complete(callback, statusCode, message, details) {
-        const result = {state: 'COMPLETED', statusCode, message, details};
+        const result = {state: statusCode === 200 ? 'SUCCESS' : 'FAILURE', statusCode, message, details};
         app.debug(JSON.stringify(result));
-        callback(result);
+        return result;
     }
 
     // Put an absolute position
@@ -180,30 +199,26 @@ module.exports = (app) => {
         app.debug(`putStartLineEnd: ${end} ${JSON.stringify(position)}`);
 
         try {
-            if (!end || !position || typeof position.latitude !== 'number' || typeof position.longitude !== 'number' ) {
-                complete(callback, 400, 'Failed to put start line end: !end || !position');
-                return;
+            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') {
-                complete(callback, 400, 'Failed to put start line end: unknown end');
-                return;
+                return complete(callback, 400, 'Failed to put start line end: unknown end');
             }
 
             let startLine = state.startLine;
             if (startLine) {
                 // We have a line, check if this end is the same?
                 if (startLine[end].latitude === position.latitude && startLine[end].longitude === position.longitude) {
-                    complete(callback, 304, 'Put start line end: unchanged line end');
-                    return;
+                    return complete(callback, 304, 'Put start line end: unchanged line end');
                 }
             } else {
                 // We don't have a line, so check if this is just an update for one end of the line?
                 const thisEnd = app.getSelfPath(`navigation.racing.startLine${camelCase(end)}`);
                 if (thisEnd && thisEnd.value.lat === position.latitude && thisEnd.value.longitude === position.longitude) {
-                    complete(callback, 304, 'Put start line end: unchanged end');
-                    return;
+                    return complete(callback, 304, 'Put start line end: unchanged end');
                 }
 
                 // If we now have both ends, we have a line!
@@ -237,7 +252,7 @@ module.exports = (app) => {
 
             // Set/create the waypoint if we are configured to do so
             if (state.options.updateStartLineWaypoint || updateWaypoint) {
-                const waypointConfig =`startLine${camelCase(end)}`;
+                const waypointConfig = `startLine${camelCase(end)}`;
                 app.debug(`waypointConfig: ${waypointConfig}`);
                 const waypointName = state.options[waypointConfig];
                 app.debug(`waypointName: ${waypointName}`);
@@ -268,6 +283,11 @@ module.exports = (app) => {
                             coordinates: [position.longitude, position.latitude]
                         },
                         properties: {}
+                    },
+                    type: end === 'port' ? 'start-pin' : 'start-boat',
+                    position: {
+                        latitude: position.latitude,
+                        longitude: position.longitude
                     }
                 }
 
@@ -283,36 +303,33 @@ module.exports = (app) => {
                 app.debug('startline waypoint not updated');
             }
 
-            // Complete the handler successfully
-            complete(callback, 200, 'Put start line end: OK');
 
             // If we have a startLine, then process position against the new line
             if (startLine)
                 processPosition(null);
+            // Complete the handler successfully
+            return complete(callback, 200, 'Put start line end: OK');
         } catch (err) {
-            complete(callback, 500,  'Put start line end: Failed ' + JSON.stringify(err));
+            return complete(callback, 500, 'Put start line end: Failed ' + JSON.stringify(err));
         }
-
-        return { state: 'PENDING' }
     }
 
     async function setStartLine(context, path, args, callback) {
         try {
             app.debug('setStartLine:', JSON.stringify(args));
             if (!args || !args.end || typeof args.end !== 'string') {
-                complete(callback, 400,  'Failed to set the startLine: !end');
-                return;
+                return complete(callback, 400, 'Failed to set the startLine: !end');
             }
             const end = args.end.toLowerCase();
             if (end !== 'port' && end !== 'stb') {
-                complete(callback, 400,  'Failed to set the startLine: unknown end');
-                return;
+                return complete(callback, 400, 'Failed to set the startLine: unknown end');
             }
 
             // Get the position either as arg or as the current bow position
             let position = args.position;
-            if (position === 'bow') {
+            if (position === 'bow' || !position && !args.delta && !args.rotate ) {
                 position = app.getSelfPath('navigation.position');
+                app.debug('bowPosition:' + JSON.stringify(position));
                 if (position)
                     position = bowPosition(position.value);
             }
@@ -332,7 +349,7 @@ module.exports = (app) => {
                 app.debug(`initialBearing: ${initialBearing} currentDistance: ${currentDistance}`);
 
                 const newDistance = args.delta && typeof args.delta === 'number' ? (currentDistance + args.delta) : currentDistance;
-                const newBearing = args.rotate && typeof args.rotate === 'number'? (initialBearing + toDegrees(args.rotate)) : initialBearing;
+                const newBearing = args.rotate && typeof args.rotate === 'number' ? (initialBearing + toDegrees(args.rotate)) : initialBearing;
                 app.debug(`newDistance: ${newDistance} newBearing: ${newBearing}`);
 
                 const newPosition = geolib.computeDestinationPoint(otherEnd, newDistance, newBearing);
@@ -342,11 +359,10 @@ module.exports = (app) => {
 
             if (position)
                 return putStartLineEnd(end, position, callback, args.updateWaypoint === true);
-            complete(callback, 500,  'Failed to set the startLine: No position');
+            return complete(callback, 500, 'Failed to set the startLine: No position');
         } catch (err) {
-            complete(callback, 500,  'Failed to set the startLine: ' + JSON.stringify(err));
+            return complete(callback, 500, 'Failed to set the startLine: ' + JSON.stringify(err));
         }
-        return { state: 'PENDING' }
     }
 
     function setTimer() {
@@ -358,7 +374,7 @@ module.exports = (app) => {
                 return;
             }
             state.timeToStart--;
-            sendDeltas([{ path: 'navigation.racing.timeToStart', value: state.timeToStart }]);
+            sendDeltas([{path: 'navigation.racing.timeToStart', value: state.timeToStart}]);
         }, 1000);
     }
 
@@ -367,13 +383,11 @@ module.exports = (app) => {
         try {
             app.debug('startTimerCommand:', JSON.stringify(args));
             if (!args || !args.command || typeof args.command !== 'string') {
-                complete(callback, 400,  'Failed to command timer: no command');
-                return;
+                return complete(callback, 400, 'Failed to command timer: no command');
             }
             const command = args.command.toLowerCase();
 
-            switch (command)
-            {
+            switch (command) {
                 case 'start': {
                     const now = new Date();
                     const timeToStart = state.timeToStart ?? state.options.timer ?? 300;
@@ -389,8 +403,7 @@ module.exports = (app) => {
                     ]);
 
                     setTimer();
-                    complete(callback, 200,  'start timer: OK');
-                    break;
+                    return complete(callback, 200, 'start timer: OK');
                 }
                 case 'reset': {
                     state.timerRunning = false;
@@ -401,14 +414,12 @@ module.exports = (app) => {
                         {path: 'navigation.racing.timeToStart', value: state.timeToStart},
                         {path: 'navigation.racing.startTime', value: null}
                     ]);
-                    complete(callback, 200,  'reset timer: OK');
-                    break;
+                    return complete(callback, 200, 'reset timer: OK');
                 }
 
                 case 'sync': {
                     if (!state.timerRunning || state.timeToStart == null) {
-                        complete(callback, 500,  'sync timer: !running');
-                        return;
+                        return complete(callback, 500, 'sync timer: !running');
                     }
 
                     const rounded = Math.round(state.timeToStart / 60) * 60;
@@ -416,24 +427,21 @@ module.exports = (app) => {
                     state.startTime = new Date(Date.now() + rounded * 1000).toISOString();
 
                     sendDeltas([
-                        { path: 'navigation.racing.timeToStart', value: state.timeToStart },
-                        { path: 'navigation.racing.startTime', value: state.startTime }
+                        {path: 'navigation.racing.timeToStart', value: state.timeToStart},
+                        {path: 'navigation.racing.startTime', value: state.startTime}
                     ]);
-                    complete(callback, 200,  'sync timer: OK');
-                    break;
+                    return complete(callback, 200, 'sync timer: OK');
                 }
 
                 case 'set': {
                     const input = args.startTime;
                     if (!input) {
-                        complete(callback, 400,  'reset timer: !startTime');
-                        return;
+                        return complete(callback, 400, 'reset timer: !startTime');
                     }
 
                     const inputTime = new Date(input);
                     if (isNaN(inputTime)) {
-                        complete(callback, 400,  'reset timer: invalid startTime');
-                        return;
+                        return complete(callback, 400, 'reset timer: invalid startTime');
                     }
 
                     const now = new Date();
@@ -444,11 +452,10 @@ module.exports = (app) => {
                         state.timeToStart = 0;
                         state.startTime = null;
                         sendDeltas([
-                            { path: 'navigation.racing.timeToStart', value: 0 },
-                            { path: 'navigation.racing.startTime', value: null }
+                            {path: 'navigation.racing.timeToStart', value: 0},
+                            {path: 'navigation.racing.startTime', value: null}
                         ]);
-                        complete(callback, 200,  'set timer: 0K');
-                        return;
+                        return complete(callback, 200, 'set timer: 0K');
                     }
 
                     state.timerRunning = true;
@@ -456,46 +463,47 @@ module.exports = (app) => {
                     state.startTime = inputTime.toISOString();
 
                     sendDeltas([
-                        { path: 'navigation.racing.timeToStart', value: state.timeToStart },
-                        { path: 'navigation.racing.startTime', value: state.startTime }
+                        {path: 'navigation.racing.timeToStart', value: state.timeToStart},
+                        {path: 'navigation.racing.startTime', value: state.startTime}
                     ]);
 
                     setTimer();
-                    complete(callback, 200,  'set timer: OK');
-                    break;
+                    return complete(callback, 200, 'set timer: OK');
                 }
 
                 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' });
+                        cb(null, {state: 'FAILED', message: 'Cannot adjust: invalid state or delta'});
                         return;
                     }
 
-                    state.timeToStart += delta;
-                    if (state.timeToStart < 0) state.timeToStart = 0;
+                    state.timeToStart = Math.max(state.timeToStart + delta, 0);
 
-                    let now = Date.now();
-                    const adjustedStart = new Date(now - (now % 1000) + state.timeToStart * 1000).toISOString();
-                    state.startTime = adjustedStart;
+                    if (state.timerRunning) {
+                        let now = Date.now();
+                        state.startTime = new Date(now - (now % 1000) + state.timeToStart * 1000).toISOString();
+                    }
 
-                    sendDeltas([
-                        { path: 'navigation.racing.timeToStart', value: state.timeToStart },
-                        { path: 'navigation.racing.startTime', value: adjustedStart }
-                    ]);
-                    complete(callback, 200,  'adjust timer: OK');
-                    break;
+                    const deltas = [
+                        { path: 'navigation.racing.timeToStart', value: state.timeToStart }
+                    ];
+                    if (state.timerRunning && state.startTime) {
+                        deltas.push({path: 'navigation.racing.startTime', value: state.startTime });
+                    }
+                    sendDeltas(deltas);
+
+                    return complete(callback, 200, 'adjust timer: OK');
                 }
 
                 default : {
-                    complete(callback, 400,  'Failed to command timer: unknown command');
-                    return;
+                    return complete(callback, 400, 'Failed to command timer: unknown command');
                 }
             }
         } catch (err) {
-            complete(callback, 500,  'Failed to command timer: ' + JSON.stringify(err));
+            app.debug('startTimerCommand:', JSON.stringify(err));
+            return complete(callback, 500, 'Failed to command timer: ' + JSON.stringify(err));
         }
-        return { state: 'PENDING' }
     }
 
     function findLineAndThenProcess(position, alwaysFindLine = false) {
@@ -613,8 +621,7 @@ module.exports = (app) => {
             sendDeltas([
                 {path: 'navigation.racing.distanceStartline', value: distanceToLine},
             ]);
-        }
-        else if (state.distanceToLine) {
+        } else if (state.distanceToLine) {
             state.distanceToLine = null;
             sendDeltas([
                 {path: 'navigation.racing.distanceStartline', value: null},
@@ -841,8 +848,8 @@ module.exports = (app) => {
                 {
                     context: 'vessels.' + app.selfId,
                     subscribe: [
-                        { path: 'navigation.racing.startLinePort', policy: 'instant'},
-                        { path: 'navigation.racing.startLineStb', policy: 'instant'},
+                        {path: 'navigation.racing.startLinePort', policy: 'instant'},
+                        {path: 'navigation.racing.startLineStb', policy: 'instant'},
                     ]
                 },
                 unsubscribes,
@@ -857,10 +864,14 @@ module.exports = (app) => {
                             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 =>{});
+                                        putStartLineEnd('port', v.value, ignored => {
+                                        }, false).then(ignored => {
+                                        });
                                         break;
                                     case 'navigation.racing.startLineStb' :
-                                        putStartLineEnd('port', v.value, ignored => {}, false).then(ignored =>{});
+                                        putStartLineEnd('port', v.value, ignored => {
+                                        }, false).then(ignored => {
+                                        });
                                         break;
                                 }
                             }

package/package.json

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