@sailingnaturali/signalk-currents 0.2.0 → 0.3.0

package/README.md

@@ -99,7 +99,8 @@ ebb — fill them from a current atlas or pilot book for your stations.
 
 ### `/currents` resource
 
-Mounted at `/plugins/signalk-currents/currents`:
+Served at `/signalk/v2/api/resources/currents` (anonymously readable under
+`allow_readonly`):
 
 ```json
 {
@@ -109,6 +110,8 @@ Mounted at `/plugins/signalk-currents/currents`:
       "label": "Gillard Passage",
       "lat": 50.3933,
       "lon": -125.1567,
+      "floodDir": 160,
+      "ebbDir": 340,
       "events": [
         { "utc": "2026-06-06T04:14:00.000Z", "kind": "slack", "speedKn": 0 },
         { "utc": "2026-06-06T05:40:00.000Z", "kind": "flood", "speedKn": 4.1 }
@@ -119,6 +122,8 @@ Mounted at `/plugins/signalk-currents/currents`:
 ```
 
 `kind` is `slack` | `flood` | `ebb`; `speedKn` is the event speed magnitude in knots.
+`floodDir` / `ebbDir` are the station's set directions in °true, straight from the
+station config — so consumers can say which way the water flows, not just when it turns.
 
 ## Development
 

package/dist/routes.d.ts

@@ -9,6 +9,8 @@ export declare function currentsPayload(series: Map<string, StationSeries>): {
         label: string;
         lat: number;
         lon: number;
+        floodDir: number;
+        ebbDir: number;
         events: CurrentEvent[];
     }[];
 };

package/dist/routes.js

@@ -7,7 +7,9 @@ function currentsPayload(series) {
     return {
         stations: [...series.values()].map(s => ({
             stationId: s.station.stationId, label: s.station.label,
-            lat: s.station.lat, lon: s.station.lon, events: s.events,
+            lat: s.station.lat, lon: s.station.lon,
+            floodDir: s.station.floodDir, ebbDir: s.station.ebbDir,
+            events: s.events,
         })),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailingnaturali/signalk-currents",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Publish CHS/NOAA tidal-current predictions to SignalK — environment.current + a /currents resource, for a configured station list.",
   "main": "dist/index.js",
   "scripts": {