@sailingnaturali/signalk-dsc 0.3.1 → 0.5.0

package/README.md

@@ -33,6 +33,16 @@ For every DSC call heard by a connected radio:
   `GET /signalk/v2/api/resources/dsc-calls` (anonymously readable when the server
   allows read-only access). Raw sentence/PGN is always kept alongside the parsed
   fields: time, MMSI, category, nature of distress, position, UTC time.
+- **A chart-marker layer** — `GET /signalk/v2/api/resources/dsc-call-markers`
+  serves logged calls as [Freeboard-SK](https://github.com/SignalK/freeboard-sk)
+  ResourceSets, one per category (distress/urgency/safety/routine), each a
+  GeoJSON `FeatureCollection` of Point markers whose popup carries the nature,
+  caller name/MMSI, and times. To use it in Freeboard: Settings → Resources
+  (Custom) → add resource type `dsc-call-markers`, reload, then toggle the
+  per-category layers. Non-distress calls drop off after `markerWindowHours`
+  (default 24); an active (un-cleared) distress call stays until you clear the alarm.
+  This is the *detail* layer — distinct from the prominent live SaR marker a
+  distress call also draws via the `sar.` context (see Remote-vessel deltas).
 - **Alarms under your own vessel** — `notifications.dsc.distress` (state
   `emergency`), `notifications.dsc.urgency` (`alarm`), `notifications.dsc.safety`
   (`alert`). Routine calls never alarm. Repeated re-transmissions of the same
@@ -48,8 +58,12 @@ For every DSC call heard by a connected radio:
   Full detail (MMSI, coordinates, reported time, transport) goes to the call
   log and the logbook entry instead, so TTS pipelines stay terse.
 - **Remote-vessel deltas** — the caller's `navigation.position` (and a distress
-  notification) under `vessels.urn:mrn:imo:mmsi:<caller>`, so chartplotters can
-  show where the call came from.
+  notification) under the caller's context, so chartplotters can show where the
+  call came from. A **distress** caller is emitted under the Search-and-Rescue
+  context `sar.urn:mrn:imo:mmsi:<caller>` — which plotters like
+  [Freeboard-SK](https://github.com/SignalK/freeboard-sk) render as a distress
+  (SaR) target rather than an ordinary AIS vessel; every other category stays
+  under `vessels.urn:mrn:imo:mmsi:<caller>`.
 - Every stored call carries an `ownShip` snapshot of the moment it arrived —
   position, course, heading, speed, wind, pressure, and (when a source publishes them)
   sea state, visibility, and cloud coverage. Absent sensor, absent field.
@@ -81,6 +95,7 @@ For every DSC call heard by a connected radio:
 | Option | Default | Notes |
 | --- | --- | --- |
 | `maxEvents` | `1000` | Oldest calls dropped beyond this. |
+| `markerWindowHours` | `24` | Non-distress calls leave the `dsc-call-markers` chart layer after this many hours; active distress stays until cleared. |
 | `logbookEnabled` | `true` | Requires signalk-logbook and a token. |
 | `logbookRoutine` | `false` | Also log routine calls. |
 | `logbookUrl` | `http://localhost:3000/plugins/signalk-logbook/logs` | |

package/index.js

@@ -28,6 +28,7 @@ const { parseDsc } = require('./lib/dsc');
 const { parseDse, refinePosition } = require('./lib/dse');
 const { normalizePgn129808 } = require('./lib/pgn129808');
 const { EventStore } = require('./lib/store');
+const { buildMarkerResourceSets } = require('./lib/markers');
 const { buildMessage, buildLogbookText } = require('./lib/format');
 const { captureOwnShip, buildObservations, unwrap } = require('./lib/snapshot');
 
@@ -56,6 +57,13 @@ module.exports = function makePlugin(app) {
         description: 'Oldest calls are dropped beyond this count.',
         default: 1000,
       },
+      markerWindowHours: {
+        type: 'number',
+        title: 'Chart marker window (hours)',
+        description:
+          'Non-distress calls drop off the dsc-call-markers chart layer after this many hours. Active (un-cleared) distress calls always remain.',
+        default: 24,
+      },
       logbookEnabled: {
         type: 'boolean',
         title: 'Write received calls to the ship\'s log (signalk-logbook)',
@@ -244,8 +252,14 @@ module.exports = function makePlugin(app) {
     return event;
   }
 
-  function remoteContext(mmsi) {
-    return `vessels.urn:mrn:imo:mmsi:${mmsi}`;
+  // The SignalK context the caller's position is emitted under. A distress
+  // caller is a vessel in extremis, so it goes under the Search-and-Rescue
+  // context (`sar.`) — which chartplotters (e.g. Freeboard-SK) render as a
+  // distress/SaR target rather than an ordinary AIS vessel. Every other
+  // category stays under `vessels.` like any AIS contact.
+  function callerContext(category, mmsi) {
+    const prefix = category === 'distress' ? 'sar' : 'vessels';
+    return `${prefix}.urn:mrn:imo:mmsi:${mmsi}`;
   }
 
   // Custom sentence parsers override the stock hooks (a superset of the
@@ -263,8 +277,8 @@ module.exports = function makePlugin(app) {
         receivedAt: input.tags && input.tags.timestamp,
       });
 
-      // Upstream-compatible delta under the sender's context so chartplotters
-      // and AIS-style consumers see the caller's position.
+      // Delta under the caller's context so chartplotters and AIS-style
+      // consumers see the caller's position (distress → SaR target).
       if (parsed.mmsi) {
         const values = [];
         if (parsed.position) {
@@ -281,7 +295,10 @@ module.exports = function makePlugin(app) {
           });
         }
         if (values.length) {
-          return { context: remoteContext(parsed.mmsi), updates: [{ values }] };
+          return {
+            context: callerContext(parsed.category, parsed.mmsi),
+            updates: [{ values }],
+          };
         }
       }
     } catch (err) {
@@ -306,7 +323,7 @@ module.exports = function makePlugin(app) {
       const refined = refinePosition(target.position, ext);
       store.update(target.id, { position: refined, positionResolution: 'enhanced' });
       return {
-        context: remoteContext(ext.mmsi),
+        context: callerContext(target.category, ext.mmsi),
         updates: [{ values: [{ path: 'navigation.position', value: refined }] }],
       };
     } catch (err) {
@@ -327,6 +344,7 @@ module.exports = function makePlugin(app) {
   plugin.start = function (opts) {
     options = {
       maxEvents: 1000,
+      markerWindowHours: 24,
       logbookEnabled: true,
       logbookRoutine: false,
       logbookUrl: 'http://localhost:3000/plugins/signalk-logbook/logs',
@@ -361,6 +379,33 @@ module.exports = function makePlugin(app) {
       },
     });
 
+    const buildSets = () =>
+      buildMarkerResourceSets(store.list(), {
+        now: Date.now(),
+        windowHours: options.markerWindowHours,
+        nameFor: vesselName,
+      });
+
+    app.registerResourceProvider({
+      type: 'dsc-call-markers',
+      methods: {
+        async listResources() {
+          return buildSets();
+        },
+        async getResource(id) {
+          const sets = buildSets();
+          if (!sets[id]) throw new Error(`No DSC calls in category: ${id}`);
+          return sets[id];
+        },
+        setResource() {
+          throw new Error('dsc-call-markers is read-only');
+        },
+        deleteResource() {
+          throw new Error('dsc-call-markers is read-only');
+        },
+      },
+    });
+
     app.emitPropertyValue('nmea0183sentenceParser', { sentence: 'DSC', parser: dscParser });
     app.emitPropertyValue('nmea0183sentenceParser', { sentence: 'DSE', parser: dseParser });
     app.on('N2KAnalyzerOut', onPgn);

package/lib/markers.js

@@ -0,0 +1,77 @@
+'use strict';
+
+// Per-category marker colour, emitted as the ResourceSet `styles.default`.
+// Freeboard styles a feature from styles[properties.styleRef] and falls back to
+// styles.default, so one default per category colours all of that set's markers.
+const CATEGORY_COLORS = {
+  distress: 'rgba(211,47,47,1)', // red
+  urgency: 'rgba(245,124,0,1)', // orange
+  safety: 'rgba(251,192,45,1)', // amber
+  routine: 'rgba(117,117,117,1)', // grey
+};
+
+const HOUR_MS = 60 * 60 * 1000;
+
+// Should this call appear at `now`? Un-cleared distress is always shown — a
+// MAYDAY must not age off the chart. Everything else (and cleared distress)
+// must fall within `windowHours` of receipt.
+function withinWindow(event, now, windowHours) {
+  if (event.category === 'distress' && !event.clearedAt) return true;
+  const received = Date.parse(event.receivedAt);
+  if (Number.isNaN(received)) return false;
+  return now - received <= windowHours * HOUR_MS;
+}
+
+function toFeature(event, nameFor) {
+  const mmsi = event.distressedMmsi || event.mmsi;
+  const vesselName = nameFor ? nameFor(mmsi) : undefined;
+  const properties = {
+    name: event.natureOfDistress
+      ? `${event.category}: ${event.natureOfDistress}`
+      : event.category,
+    category: event.category,
+    mmsi,
+    utcTime: event.utcTime,
+    receivedAt: event.receivedAt,
+  };
+  if (event.natureOfDistress) properties.natureOfDistress = event.natureOfDistress;
+  if (vesselName) properties.vesselName = vesselName;
+  return {
+    type: 'Feature',
+    geometry: {
+      type: 'Point',
+      coordinates: [event.position.longitude, event.position.latitude],
+    },
+    properties,
+  };
+}
+
+// Turn stored DSC call events into freeboard ResourceSets keyed by category.
+// Empty categories are omitted.
+function buildMarkerResourceSets(events, { now, windowHours = 24, nameFor } = {}) {
+  const buckets = {};
+  for (const event of events) {
+    if (
+      !event.position ||
+      typeof event.position.latitude !== 'number' ||
+      typeof event.position.longitude !== 'number'
+    )
+      continue;
+    if (!withinWindow(event, now, windowHours)) continue;
+    const category = event.category || 'routine';
+    (buckets[category] = buckets[category] || []).push(toFeature(event, nameFor));
+  }
+  const out = {};
+  for (const [category, features] of Object.entries(buckets)) {
+    const color = CATEGORY_COLORS[category] || CATEGORY_COLORS.routine;
+    out[category] = {
+      name: `DSC — ${category}`,
+      description: `DSC ${category} calls heard on channel 70`,
+      styles: { default: { width: 2, stroke: color, fill: color } },
+      values: { type: 'FeatureCollection', features },
+    };
+  }
+  return out;
+}
+
+module.exports = { buildMarkerResourceSets, CATEGORY_COLORS };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailingnaturali/signalk-dsc",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "description": "Receive, log, and alert on DSC (VHF digital selective calling) calls — distress, urgency, safety, routine — from NMEA 0183 ($CDDSC/$CDDSE) and NMEA 2000 (PGN 129808).",
   "main": "index.js",
   "scripts": {