signalk-racer 0.9.2 → 0.9.3

package/README.MD

@@ -91,12 +91,13 @@ The plugin supports **partial line configuration**: you can set just one end (po
 
 ### 📮 API Endpoints
 
-| Method | Endpoint                                 | Description                                                                                          |
-|--------|------------------------------------------|------------------------------------------------------------------------------------------------------|
-| `GET`  | `/plugins/signalk-racer/startline/port`  | Get the last known **port (pin)** end position                                                       |
-| `PUT`  | `/plugins/signalk-racer/startline/port`  | Set the **port (pin)** end of the start line to the current position of the boat plus the bow offset |
-| `GET`  | `/plugins/signalk-racer/startline/stb`   | Get the last known **starboard (boat)** end position                                                 |
-| `PUT`  | `/plugins/signalk-racer/startline/stb`   | Set the **starboard (boat)** end of the line to the current position of the boat plus the bow offset |
+| Method | Endpoint                                | Description                                                                                          |
+|--------|-----------------------------------------|------------------------------------------------------------------------------------------------------|
+| `GET`  | `/plugins/signalk-racer/startline/port` | Get the last known **port (pin)** end position                                                       |
+| `PUT`  | `/plugins/signalk-racer/startline/port` | Set the **port (pin)** end of the start line to the current position of the boat plus the bow offset |
+| `GET`  | `/plugins/signalk-racer/startline/stb`  | Get the last known **starboard (boat)** end position                                                 |
+| `PUT`  | `/plugins/signalk-racer/startline/stb`  | Set the **starboard (boat)** end of the line to the current position of the boat plus the bow offset |
+| `PUT`  | `/plugins/signalk-racer/timeToStart`    | Set the **timeToStart** in seconds and receive the current **distanceToLine**                        |
 
 
 ## 🔄 Dependencies

package/ReleaseNotes.md

@@ -4,4 +4,6 @@
 + formating for the README.TXT
 ## 0.9.2 Set Start Line
 + Added API to set the start line
-+ Added webapp to call start line API
++ Added webapp to call start line API
+## 0.9.3 KIP racer-timer integration
+ + added timeToStart API

package/index.js

@@ -93,7 +93,7 @@ module.exports = (app) => {
     const plugin = {
         id: 'signalk-racer',
         name: 'SignalK Racing Plugin',
-        start: (options, restartPlugin) => {
+        start: (options) => {
             if (!options.startLinePort || !options.startLineStb) {
                 app.error('Missing waypoint names: startLinePort and/or startLineStb not configured.');
                 return;
@@ -178,6 +178,32 @@ module.exports = (app) => {
                 return bow;
             }
 
+            plugin.setTimeToStart = async (req, res) => {
+                try {
+                    const body = req.body;
+                    if (!body || typeof body.timeToStart !== 'number') {
+                        res.status(400).json({ error: 'Missing or invalid `timeToStart`' });
+                        return;
+                    }
+
+                    const timeToStart = body.timeToStart; // value in seconds, or whatever unit you agree on
+                    app.debug(`Setting timeToStart to ${timeToStart}`);
+
+                    sendDeltas([
+                        {path: 'navigation.racing.timeToStart', value: timeToStart},
+                    ]);
+
+                    res.json({
+                        message: 'OK',
+                        timeToStart,
+                        distanceToLine: state.distanceToLine ? state.distanceToLine : null,
+                    });
+                } catch (err) {
+                    app.error('Failed to set time to start:', err);
+                    res.status(500).json({ error: 'Failed to set time to start' });
+                }
+            }
+
             plugin.setStartLineEnd = async (req, res) => {
                 try {
                     const end = req.params.end;  // "port" or "stb"
@@ -584,6 +610,7 @@ module.exports = (app) => {
             router.get('/startline/port', (req, res) => res.json(state.startLine ? state.startLine.port : null));
             router.get('/startline/stb', (req, res) => res.json(state.startLine ? state.startLine.stb : null));
             router.put('/startline/:end', plugin.setStartLineEnd);
+            router.put('/timeToStart', plugin.setTimeToStart);
         },
 
         getOpenApi: () => require('./openapi.json'),

package/openapi.json

@@ -8,13 +8,14 @@
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },
-
   "paths": {
     "/startline/port": {
       "get": {
         "summary": "Set the port end of the start line",
         "responses": {
-          "200": { "description": "Port end set" }
+          "200": {
+            "description": "Port end set"
+          }
         }
       }
     },
@@ -23,7 +24,58 @@
         "summary": "Set the starboard end of the start line",
         "description": "Set the starboard end of the start line to the boats position plus the bow offset.",
         "responses": {
-          "200": { "description": "Starboard end set" }
+          "200": {
+            "description": "Starboard end set"
+          }
+        }
+      }
+    },
+    "/timeToStart": {
+      "put": {
+        "summary": "Set time to start",
+        "description": "Update the countdown timer value used for start line calculations.",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "timeToStart": {
+                    "type": "number",
+                    "description": "Time to start in seconds"
+                  }
+                },
+                "required": [
+                  "timeToStart"
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Time to start set",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": { "type": "string" },
+                    "timeToStart": {
+                      "type": "number",
+                      "description": "Time to start in seconds"
+                    },
+                    "distanceToLine": {
+                      "type": "number",
+                      "description": "Distance to the line in meters"
+                    }
+                  },
+                  "required": ["message", "timeToStart"]
+                }
+              }
+            }
+          }
         }
       }
     }

package/package.json

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

package/public/index.html

@@ -6,7 +6,7 @@
     <style>
         body {
             font-family: sans-serif;
-            max-width: 600px;
+            max-width: 100%;
             margin: 3em auto;
             text-align: center;
         }
@@ -25,8 +25,9 @@
 </head>
 <body>
 <h1>Set Start Line Ends</h1>
-<button onclick="setEnd('port')">Set Port End (Pin)</button>
-<button onclick="setEnd('stb')">Set Starboard End (Boat)</button>
+<div id="buttons">
+  <button onclick="setEnd('port')">Set Port End (Pin)</button><button onclick="setEnd('stb')">Set Starboard End (Boat)</button>
+</div>
 <div id="status"></div>
 
 <script>