@sailingnaturali/signalk-dsc 0.5.3 → 0.5.4

package/index.js

@@ -27,10 +27,15 @@ const path = require('node:path');
 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');
+const {
+  EventStore,
+  buildMarkerResourceSets,
+  buildMessage,
+  buildLogbookText,
+  captureOwnShip,
+  buildObservations,
+  unwrap,
+} = require('@sailingnaturali/signalk-distress-core');
 
 const DSC_PGN = 129808;
 const NOTIFICATION_STATES = { distress: 'emergency', urgency: 'alarm', safety: 'alert' };

package/lib/dsc.js

@@ -22,6 +22,8 @@
  * 10: expansion flag — 'E' means a $--DSE sentence follows
  */
 
+const { NATURES, deviceBeaconFor } = require('@sailingnaturali/signalk-distress-core');
+
 const FORMATS = {
   '02': 'area',
   '12': 'distressAlert',
@@ -38,40 +40,9 @@ const CATEGORIES = {
   '12': 'distress',
 };
 
-const NATURES = {
-  '00': 'fire',
-  '01': 'flooding',
-  '02': 'collision',
-  '03': 'grounding',
-  '04': 'listing',
-  '05': 'sinking',
-  '06': 'adrift',
-  '07': 'undesignated',
-  '08': 'abandon',
-  '09': 'piracy',
-  '10': 'mob',
-  '12': 'epirb',
-};
-
 // Telecommand 21 on a non-distress call = "ship position" — field 5 holds a position.
 const TELECOMMAND_SHIP_POSITION = '21';
 
-// AIS device-beacon MMSI prefixes (ITU 97x). A modern SART / MOB / EPIRB can
-// send a DSC distress directly; the prefix lets a consumer correlate it with
-// the matching AIS target.
-const DEVICE_BEACONS = {
-  '970': 'sart',
-  '972': 'mob',
-  '974': 'epirb',
-};
-
-// Tag the AIS device class (sart/mob/epirb) for a 97x device-beacon MMSI, else
-// undefined. Shared with the N2K (PGN 129808) path so both transports agree.
-function deviceBeaconFor(mmsi) {
-  if (typeof mmsi !== 'string') return undefined;
-  return DEVICE_BEACONS[mmsi.substring(0, 3)];
-}
-
 // Resolve a nature-of-distress code to its name. The code arrives over the air
 // unsanitised: only a clean 1–2 digit numeric code may reach the NATURES lookup
 // or the code-NN fallback. A key like "__proto__" would otherwise resolve to

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailingnaturali/signalk-dsc",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "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": {
@@ -47,5 +47,8 @@
   },
   "engines": {
     "node": ">=18"
+  },
+  "dependencies": {
+    "@sailingnaturali/signalk-distress-core": "^0.1.0"
   }
 }

package/lib/format.js

@@ -1,102 +0,0 @@
-'use strict';
-
-/*
- * Two renderings of a DSC event:
- *
- * - buildMessage: the notification message. This ends up SPOKEN by the voice
- *   pipeline, so it is deliberately minimal — type, vessel, situation, range
- *   and direction from us, action. Nothing else.
- * - buildLogbookText: the ship's-log entry — full detail (MMSI, coordinates,
- *   reported time, transport), GMDSS radio-log style.
- */
-
-const { distanceNm, bearingDegrees, compassWord } = require('./geo');
-
-const NATURE_TEXT = {
-  fire: 'fire and explosion',
-  flooding: 'flooding',
-  collision: 'collision',
-  grounding: 'grounding',
-  listing: 'listing, in danger of capsize',
-  sinking: 'sinking',
-  adrift: 'disabled and adrift',
-  undesignated: 'undesignated distress',
-  abandon: 'abandoning ship',
-  piracy: 'piracy attack',
-  mob: 'man overboard',
-  epirb: 'EPIRB emission',
-};
-
-function formatCoordinate(value, axis) {
-  const hemisphere = axis === 'lat' ? (value < 0 ? 'S' : 'N') : value < 0 ? 'W' : 'E';
-  const abs = Math.abs(value);
-  const degrees = Math.floor(abs);
-  const minutes = (abs - degrees) * 60;
-  return `${degrees}°${minutes.toFixed(3)}′${hemisphere}`;
-}
-
-function formatPosition(position) {
-  return `${formatCoordinate(position.latitude, 'lat')} ${formatCoordinate(position.longitude, 'lon')}`;
-}
-
-// Spoken form. No MMSI fallback here on purpose: TTS reads 366123456 as
-// "three hundred sixty-six million...". The MMSI stays in the call log and
-// the logbook entry.
-function vesselPhrase(event, vesselName) {
-  return vesselName ? `vessel ${vesselName}` : 'unidentified vessel';
-}
-
-/** "2.3 nautical miles northwest" | "position 48°47.700′N ..." | "position unknown" */
-function wherePhrase(event, ownPosition, { spoken }) {
-  if (event.position && ownPosition) {
-    const range = distanceNm(ownPosition, event.position);
-    const direction = compassWord(bearingDegrees(ownPosition, event.position));
-    const unit = spoken ? 'nautical miles' : 'NM';
-    const suffix = spoken ? '' : ' of us';
-    return `${range.toFixed(1)} ${unit} ${direction}${suffix}`;
-  }
-  if (event.position) return `position ${formatPosition(event.position)}`;
-  return 'position unknown';
-}
-
-function buildMessage(event, { ownPosition, vesselName } = {}) {
-  const who = vesselPhrase(event, vesselName);
-  const where = wherePhrase(event, ownPosition, { spoken: true });
-  if (event.category === 'distress') {
-    const nature = NATURE_TEXT[event.natureOfDistress] || event.natureOfDistress || 'undesignated distress';
-    const lead = event.relay ? 'DSC distress relay' : 'DSC distress alert';
-    return `${lead}: ${who}, ${nature}, ${where}. Monitor channel 16.`;
-  }
-  const kind = event.category === 'unknown' ? 'call' : `${event.category} call`;
-  return `DSC ${kind}: ${who}, ${where}.`;
-}
-
-function buildLogbookText(event, { ownPosition, vesselName } = {}) {
-  const parts = [];
-  const name = vesselName ? `${vesselName} (MMSI ${event.mmsi || 'unknown'})` : `MMSI ${event.mmsi || 'unknown'}`;
-  if (event.category === 'distress') {
-    const nature = NATURE_TEXT[event.natureOfDistress] || event.natureOfDistress || 'undesignated distress';
-    if (event.relay) {
-      // Name the casualty (distressedMmsi) and the relaying station (name).
-      const casualty = event.distressedMmsi ? `MMSI ${event.distressedMmsi}` : 'an unidentified vessel';
-      parts.push(`DISTRESS RELAY from ${name} reporting ${casualty}: ${nature}`);
-    } else {
-      parts.push(`DISTRESS alert from ${name}: ${nature}`);
-    }
-  } else {
-    parts.push(`${event.category} call from ${name}`);
-  }
-  if (event.position) {
-    let pos = `position ${formatPosition(event.position)}`;
-    if (event.utcTime) pos += ` at ${event.utcTime} UTC`;
-    if (ownPosition) pos += `, ${wherePhrase(event, ownPosition, { spoken: false })}`;
-    parts.push(pos);
-  } else if (event.utcTime) {
-    parts.push(`reported at ${event.utcTime} UTC`);
-  }
-  if (event.workingChannel) parts.push(`proposed working channel ${event.workingChannel}`);
-  if (event.source) parts.push(`via ${event.source}`);
-  return `[DSC] ${parts.join('. ')}`;
-}
-
-module.exports = { buildMessage, buildLogbookText, formatPosition };

package/lib/geo.js

@@ -1,45 +0,0 @@
-'use strict';
-
-/* Range and bearing from own ship to a reported position, for voice alerts. */
-
-const EARTH_RADIUS_NM = 3440.065;
-
-function toRad(deg) {
-  return (deg * Math.PI) / 180;
-}
-
-function distanceNm(from, to) {
-  const dLat = toRad(to.latitude - from.latitude);
-  const dLon = toRad(to.longitude - from.longitude);
-  const a =
-    Math.sin(dLat / 2) ** 2 +
-    Math.cos(toRad(from.latitude)) * Math.cos(toRad(to.latitude)) * Math.sin(dLon / 2) ** 2;
-  return 2 * Math.asin(Math.sqrt(a)) * EARTH_RADIUS_NM;
-}
-
-function bearingDegrees(from, to) {
-  const phi1 = toRad(from.latitude);
-  const phi2 = toRad(to.latitude);
-  const dLon = toRad(to.longitude - from.longitude);
-  const y = Math.sin(dLon) * Math.cos(phi2);
-  const x =
-    Math.cos(phi1) * Math.sin(phi2) - Math.sin(phi1) * Math.cos(phi2) * Math.cos(dLon);
-  return ((Math.atan2(y, x) * 180) / Math.PI + 360) % 360;
-}
-
-const COMPASS_WORDS = [
-  'north',
-  'northeast',
-  'east',
-  'southeast',
-  'south',
-  'southwest',
-  'west',
-  'northwest',
-];
-
-function compassWord(bearing) {
-  return COMPASS_WORDS[Math.round(((bearing % 360) + 360) % 360 / 45) % 8];
-}
-
-module.exports = { distanceNm, bearingDegrees, compassWord };

package/lib/markers.js

@@ -1,80 +0,0 @@
-'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] = {
-      // Freeboard's isResourceSet() requires this exact discriminator, else it
-      // filters the resource out and the chart layer renders nothing.
-      type: 'ResourceSet',
-      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/lib/snapshot.js

@@ -1,98 +0,0 @@
-'use strict';
-
-/*
- * Own-ship context snapshot, taken at DSC call receive time.
- *
- * The stored event is the forensic record of the moment a call arrived; the
- * snapshot answers "what was our situation when we heard it". Values are
- * stored exactly as SignalK provides them (rad, m/s, Pa, meters) — absent
- * sensor, absent field, never fabricated. Conversion to logbook units
- * happens only in buildObservations.
- */
-
-const DEFAULT_SNAPSHOT_FIELDS = [
-  { field: 'position', path: 'navigation.position' },
-  { field: 'cog', path: 'navigation.courseOverGroundTrue' },
-  { field: 'sog', path: 'navigation.speedOverGround' },
-  { field: 'heading', path: 'navigation.headingTrue' },
-  { field: 'wind.speed', path: 'environment.wind.speedOverGround' },
-  { field: 'wind.direction', path: 'environment.wind.directionTrue' },
-  { field: 'pressure', path: 'environment.outside.pressure' },
-  // signalk-logbook conventions (no SignalK spec paths exist for these).
-  { field: 'seaState', path: 'environment.water.swell.state' },
-  { field: 'visibility', path: 'environment.outside.visibility' },
-  { field: 'cloudCoverage', path: 'environment.outside.cloudCoverage' },
-];
-
-const UNSAFE_KEY = /^(__proto__|constructor|prototype)$/;
-
-function unwrap(node) {
-  return node && typeof node === 'object' && 'value' in node ? node.value : node;
-}
-
-/** Read the default + configured paths off the data model. Best-effort:
- *  a throwing read skips that field. Returns undefined when empty. */
-function captureOwnShip(app, extraFields = []) {
-  const snapshot = {};
-  const fields = DEFAULT_SNAPSHOT_FIELDS.concat(Array.isArray(extraFields) ? extraFields : []);
-  for (const entry of fields) {
-    if (!entry || typeof entry.field !== 'string' || typeof entry.path !== 'string') continue;
-    const keys = entry.field.split('.');
-    if (keys.some((k) => !k || UNSAFE_KEY.test(k))) continue;
-    let value;
-    try {
-      value = unwrap(app.getSelfPath(entry.path));
-    } catch {
-      continue;
-    }
-    // Decouple from the live data model and refuse anything that could
-    // break the JSON store on the alarm-critical receive path.
-    try {
-      value = JSON.parse(JSON.stringify(value));
-    } catch {
-      continue;
-    }
-    if (value === undefined || value === null) continue;
-    let target = snapshot;
-    for (const key of keys.slice(0, -1)) {
-      if (typeof target[key] !== 'object' || target[key] === null) target[key] = {};
-      target = target[key];
-    }
-    target[keys[keys.length - 1]] = value;
-  }
-  return Object.keys(snapshot).length ? snapshot : undefined;
-}
-
-// Upper bounds (meters, exclusive) for fog-scale codes 0–8; ≥50 km is 9.
-const FOG_SCALE_METERS = [50, 200, 500, 1000, 2000, 4000, 10000, 20000, 50000];
-
-/** Meters → logbook fog-scale 0–9. A small integer (≤9) is assumed to
- *  already be a fog-scale code and passes through. */
-function visibilityToFogScale(value) {
-  if (typeof value !== 'number' || !Number.isFinite(value) || value < 0) return undefined;
-  if (Number.isInteger(value) && value <= 9) return value;
-  const idx = FOG_SCALE_METERS.findIndex((limit) => value < limit);
-  return idx === -1 ? 9 : idx;
-}
-
-/** signalk-logbook observations block from a snapshot. Only keys with valid
- *  values; undefined when there are none. */
-function buildObservations(ownShip) {
-  if (!ownShip) return undefined;
-  const obs = {};
-  if (Number.isInteger(ownShip.seaState) && ownShip.seaState >= 0 && ownShip.seaState <= 9) {
-    obs.seaState = ownShip.seaState;
-  }
-  if (
-    Number.isInteger(ownShip.cloudCoverage) &&
-    ownShip.cloudCoverage >= 0 &&
-    ownShip.cloudCoverage <= 8
-  ) {
-    obs.cloudCoverage = ownShip.cloudCoverage;
-  }
-  const visibility = visibilityToFogScale(ownShip.visibility);
-  if (visibility !== undefined) obs.visibility = visibility;
-  return Object.keys(obs).length ? obs : undefined;
-}
-
-module.exports = { captureOwnShip, buildObservations, visibilityToFogScale, unwrap, DEFAULT_SNAPSHOT_FIELDS };

package/lib/store.js

@@ -1,102 +0,0 @@
-'use strict';
-
-const fs = require('node:fs');
-const path = require('node:path');
-
-/*
- * Append-only JSONL store for received DSC calls. DSC traffic is rare (a busy
- * day in range of a coast station might see dozens of calls), so synchronous
- * I/O and full-file compaction are entirely adequate — and the simplest thing
- * that survives a power cut mid-write (a torn last line is skipped on load).
- */
-class EventStore {
-  constructor({ filePath, maxEvents = 1000 }) {
-    this.filePath = filePath;
-    this.maxEvents = maxEvents;
-    this.events = [];
-    this._load();
-  }
-
-  _load() {
-    let raw;
-    try {
-      raw = fs.readFileSync(this.filePath, 'utf8');
-    } catch {
-      return; // no log yet
-    }
-    for (const line of raw.split('\n')) {
-      if (!line.trim()) continue;
-      try {
-        this.events.push(JSON.parse(line));
-      } catch {
-        // torn/corrupt line — skip it, keep the rest
-      }
-    }
-    if (this.events.length > this.maxEvents) {
-      this.events = this.events.slice(-this.maxEvents);
-      this._compact();
-    }
-  }
-
-  _compact() {
-    const tmp = `${this.filePath}.tmp`;
-    fs.mkdirSync(path.dirname(this.filePath), { recursive: true });
-    fs.writeFileSync(tmp, this.events.map((e) => JSON.stringify(e)).join('\n') + '\n');
-    fs.renameSync(tmp, this.filePath);
-  }
-
-  add(event) {
-    if (!event.id) {
-      event.id = `${event.receivedAt || new Date().toISOString()}-${event.mmsi || 'unknown'}`;
-    }
-    this.events.push(event);
-    if (this.events.length > this.maxEvents) {
-      this.events = this.events.slice(-this.maxEvents);
-      this._compact();
-    } else {
-      fs.mkdirSync(path.dirname(this.filePath), { recursive: true });
-      fs.appendFileSync(this.filePath, JSON.stringify(event) + '\n');
-    }
-    return event;
-  }
-
-  update(id, patch) {
-    const event = this.get(id);
-    if (!event) return undefined;
-    Object.assign(event, patch);
-    this._compact();
-    return event;
-  }
-
-  list() {
-    return this.events;
-  }
-
-  get(id) {
-    return this.events.find((e) => e.id === id);
-  }
-
-  /** Stamp `clearedAt` on every matching event not already cleared. Returns the
-   *  count newly stamped; compacts once. */
-  markCleared(predicate, at) {
-    let touched = 0;
-    for (const e of this.events) {
-      if (predicate(e) && !e.clearedAt) { e.clearedAt = at; touched += 1; }
-    }
-    if (touched) this._compact();
-    return touched;
-  }
-
-  /** Newest event matching `predicate` received within `windowMs` of `nowMs`. */
-  findRecent(predicate, nowMs, windowMs) {
-    for (let i = this.events.length - 1; i >= 0; i--) {
-      const e = this.events[i];
-      const age = nowMs - Date.parse(e.receivedAt);
-      if (age > windowMs) return undefined;
-      if (age >= 0 && predicate(e)) return e;
-    }
-    return undefined;
-  }
-}
-
-module.exports = { EventStore };