@sailingnaturali/signalk-dsc 0.1.0 → 0.1.2

package/README.md

@@ -1,4 +1,4 @@
-# signalk-dsc
+# @sailingnaturali/signalk-dsc
 
 SignalK plugin that receives, logs, and alerts on **DSC** (VHF digital selective
 calling) traffic — distress, urgency, safety, and routine calls — from both
@@ -14,6 +14,17 @@ has **no** PGN 129808 mapping at all. If you might be the nearest boat, you want
 every received alert stored with its position and surfaced as an alarm — that is
 this plugin.
 
+Logging that traffic is also the regulatory standard. Maritime radio rules
+require *compulsorily-equipped* vessels to record every distress, urgency, and
+safety call **made or intercepted**, with the time and position of the station
+in distress ([47 CFR §80.409](https://www.law.cornell.edu/cfr/text/47/80.409);
+SOLAS Ch. IV; ITU Radio Regulations; Canada's TP 1539). Pleasure craft are
+generally exempt from the log mandate — this just gives you that same
+SOLAS-grade record automatically. The parser gaps and the regulation are written
+up in more detail [on the engineering blog][writeup].
+
+[writeup]: https://engineering.sailingnaturali.com/signalk-dsc-distress-call-logging-nmea0183-dse-pgn-129808/
+
 ## What you get
 
 For every DSC call heard by a connected radio:
@@ -65,15 +76,59 @@ For every DSC call heard by a connected radio:
 
 ## Trying it without a radio
 
-Feed sentences through any NMEA 0183 connection (TCP, UDP, file playback):
+### Quick test script
+
+The repo includes a script that builds a valid DSC sentence and fires it at the
+server over UDP. First add a UDP input in your SignalK pipedProviders (Settings →
+Connections → Add):
+
+```json
+{
+  "id": "dsc-test-udp",
+  "pipeElements": [{ "type": "providers/simple",
+    "options": { "type": "NMEA0183", "subOptions": { "type": "udp", "port": "7777" } } }]
+}
+```
+
+Then send a fake distress call:
+
+```bash
+# Default: sinking, MMSI 366191919, near Boundary Pass → naturalaspi.local:7777
+node scripts/send-test-dsc.js
+
+# npm alias
+npm run send-test-dsc
+
+# Different nature of distress
+node scripts/send-test-dsc.js --nature fire
+node scripts/send-test-dsc.js --nature mob --category urgency
+
+# Different vessel / position
+node scripts/send-test-dsc.js --mmsi 316555777 --lat 48.9 --lon -123.5
+
+# Different host / port
+node scripts/send-test-dsc.js --host localhost --port 7777
+```
+
+All `--nature` values: `fire`, `flooding`, `collision`, `grounding`, `listing`,
+`sinking`, `adrift`, `abandon`, `piracy`, `mob`, `epirb`.
+
+Verify the call was captured:
+
+```
+GET /signalk/v2/api/resources/dsc-calls
+```
+
+### Manual sentence injection
+
+You can also feed raw sentences through any NMEA 0183 connection (TCP, UDP, file
+playback):
 
 ```
 $CDDSC,12,3380400790,12,05,00,1423108312,2019,,,S,E*69
 $CDDSE,1,1,A,3380400790,00,45894494*1B
 ```
 
-…then `GET /signalk/v2/api/resources/dsc-calls`.
-
 ## Limitations
 
 - Distress relays, acknowledgements, and cancellations are stored (with

package/lib/dsc.js

@@ -112,8 +112,15 @@ function parseDsc(parts) {
   const distress = event.category === 'distress';
   if (distress) {
     const natureCode = field(parts, 3);
-    event.natureOfDistress =
-      NATURES[natureCode] || (natureCode ? `code-${natureCode}` : 'undesignated');
+    // natureCode arrives over the air, unsanitised. Only a clean numeric code
+    // may reach the NATURES lookup or the code-NN fallback: a key like
+    // "__proto__" would otherwise resolve to Object.prototype, and any dotted
+    // value would inject extra segments into the notification path that the
+    // server walks unguarded (SignalK/signalk-server#2768). Anything else
+    // collapses to a safe constant.
+    event.natureOfDistress = /^\d{1,2}$/.test(natureCode)
+      ? NATURES[natureCode] || `code-${natureCode}`
+      : 'undesignated';
     event.distressedMmsi = parseMmsi(parts[7]);
   }
 

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@sailingnaturali/signalk-dsc",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "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"
+    "test": "node --test",
+    "send-test-dsc": "node scripts/send-test-dsc.js"
   },
   "keywords": [
     "signalk-node-server-plugin",
@@ -25,9 +26,17 @@
   "bugs": {
     "url": "https://github.com/sailingnaturali/signalk-dsc/issues"
   },
+  "signalk": {
+    "displayName": "DSC",
+    "screenshots": [
+      "./docs/screenshots/config.png",
+      "./docs/screenshots/data-table.png"
+    ]
+  },
   "files": [
     "index.js",
-    "lib"
+    "lib",
+    "docs/screenshots/"
   ],
   "publishConfig": {
     "access": "public"