@sailingnaturali/signalk-dsc 0.2.0 → 0.3.0

package/README.md

@@ -142,6 +142,19 @@ $CDDSC,12,3380400790,12,05,00,1423108312,2019,,,S,E*69
 $CDDSE,1,1,A,3380400790,00,45894494*1B
 ```
 
+### Clearing an alarm
+
+A received distress/urgency/safety call raises `notifications.dsc.<category>` and is
+re-raised for up to an hour across server restarts. To clear an active alarm — dropping
+the live notification and stopping the restart re-raise:
+
+```bash
+SIGNALK_TOKEN=<readwrite-token> npm run clear-dsc -- --category distress
+```
+
+`--category all` clears all three. Clearing is a write, so it needs a readwrite token
+(the same one used to fire a test MOB). A new incoming call still alarms normally.
+
 ## Limitations
 
 - Distress relays, acknowledgements, and cancellations are stored (with

package/index.js

@@ -153,6 +153,15 @@ module.exports = function makePlugin(app) {
     });
   }
 
+  /** Clear an active DSC alarm: drop the live notification from our own source
+   *  and stamp the stored events so the restart reannounce skips them. */
+  function clearCategory(category) {
+    app.handleMessage(plugin.id, {
+      updates: [{ values: [{ path: `notifications.dsc.${category}`, value: null }] }],
+    });
+    store.markCleared((e) => e.category === category, new Date().toISOString());
+  }
+
   function shouldLogbook(event) {
     if (options.logbookEnabled === false) return false;
     if (!options.logbookToken) return false;
@@ -354,6 +363,17 @@ module.exports = function makePlugin(app) {
     app.emitPropertyValue('nmea0183sentenceParser', { sentence: 'DSE', parser: dseParser });
     app.on('N2KAnalyzerOut', onPgn);
 
+    // Let an operator clear an active DSC alarm: a PUT to the notification path
+    // drops the live alert and marks the stored call(s) so a restart will not
+    // re-raise it. The readwrite device token authorizes this write.
+    for (const category of Object.keys(NOTIFICATION_STATES)) {
+      // Value ignored: any PUT to these paths means "clear" — no partial-update semantics.
+      app.registerPutHandler('vessels.self', `notifications.dsc.${category}`, () => {
+        clearCategory(category);
+        return { state: 'COMPLETED', statusCode: 200 };
+      });
+    }
+
     started = true;
 
     // Survive server restarts mid-incident: re-raise the newest alert per
@@ -369,6 +389,7 @@ module.exports = function makePlugin(app) {
       for (let i = events.length - 1; i >= 0; i--) {
         const event = events[i];
         if (!NOTIFICATION_STATES[event.category] || reannounced.has(event.category)) continue;
+        if (event.clearedAt) continue; // operator-cleared: never resurrect
         const at = Date.parse(event.lastReceivedAt || event.receivedAt);
         if (now - at <= REANNOUNCE_WINDOW_MS) {
           notify(event);

package/lib/store.js

@@ -76,6 +76,17 @@ class EventStore {
     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--) {

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@sailingnaturali/signalk-dsc",
-  "version": "0.2.0",
+  "version": "0.3.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": {
     "test": "node --test",
-    "send-test-dsc": "node scripts/send-test-dsc.js"
+    "send-test-dsc": "node scripts/send-test-dsc.js",
+    "clear-dsc": "node scripts/clear-dsc-alarm.js"
   },
   "keywords": [
     "signalk-node-server-plugin",