@meri-imperiumi/signalk-mob-notifier 1.0.0

package/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "extends": "airbnb-base",
+  "parserOptions": {
+    "ecmaVersion": 11
+  }
+}

package/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish Node.js Package
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3.0.2
+      - uses: actions/setup-node@v3.1.1
+        with:
+          node-version: 22
+      - run: npm install
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3.0.2
+      - uses: actions/setup-node@v3.1.1
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org/
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Node CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Run test suite
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [22.x]
+    steps:
+    - uses: actions/checkout@v3.0.2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3.1.1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm test
+      env:
+        CI: true

package/README.md

@@ -0,0 +1,10 @@
+Signal K MOB notifier plugin
+============================
+
+This plugin detects if Signal K has seen an AIS MOB (MMSI starting with `972`) or SART (MMSI starting with `970`) beacon. If a beacon is detected, a [Signal K notification](https://signalk.org/specification/1.5.0/doc/notifications.html) will be raised. With the notification there are various ways to alert the crew:
+
+* Audio with plugins like [signalk-audio-notifications](https://github.com/meri-imperiumi/signalk-audio-notifications) and an attached speaker
+* Meshtastic message with [signalk-meshtastic](https://github.com/meri-imperiumi/signalk-meshtastic)
+* Visual with apps like Freeboard
+
+Please note that this plugin aims to aid with noticing and locating crew overboard. It is not a replacement for "proper" alerting mechanisms via dedicated alert buzzers, chartplotters, or a VHF radio.

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@meri-imperiumi/signalk-mob-notifier",
+  "version": "1.0.0",
+  "description": "Create Signal K notifications for discovered AIS MOB and SART beacons",
+  "main": "plugin/index.js",
+  "scripts": {
+    "test": "eslint ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/meri-imperiumi/signalk-mob-notifier.git"
+  },
+  "keywords": [
+    "signalk-node-server-plugin",
+    "signalk-category-utility"
+  ],
+  "author": "Henri Bergius <henri.bergius@iki.fi>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/meri-imperiumi/signalk-mob-notifier/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/meri-imperiumi/signalk-mob-notifier#readme",
+  "devDependencies": {
+    "eslint": "^8.57.1",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.32.0"
+  },
+  "dependencies": {
+    "where": "^0.4.2"
+  }
+}

package/plugin/index.js

@@ -0,0 +1,157 @@
+const { Point } = require('where');
+
+function longDirection(direction) {
+  switch (direction) {
+    case 'N': {
+      return 'north';
+    }
+    case 'NE': {
+      return 'northeast';
+    }
+    case 'E': {
+      return 'east';
+    }
+    case 'SE': {
+      return 'southeast';
+    }
+    case 'S': {
+      return 'south';
+    }
+    case 'SW': {
+      return 'southwest';
+    }
+    case 'W': {
+      return 'west';
+    }
+    case 'NW': {
+      return 'northwest';
+    }
+    default: {
+      return 'unknown';
+    }
+  }
+}
+
+module.exports = (app) => {
+  const plugin = {};
+  let interval;
+  const notified = [];
+  plugin.id = 'signalk-mob-notifier';
+  plugin.name = 'MOB Beacon Notifier';
+  plugin.description = 'Create notifications for discovered AIS MOB and SART beacons';
+
+  plugin.start = (settings) => {
+    interval = setInterval(() => {
+      // Check context for MOBs
+      const mobs = Object.keys(app.signalk.vessels)
+        .filter((context) => {
+          const mmsi = context.split(':').at(-1);
+          if (mmsi.indexOf('972') === 0) {
+            // MOB beacon seen!
+            return true;
+          }
+          if (mmsi.indexOf('970') === 0) {
+            // SART beacon seen!
+            return true;
+          }
+          return false;
+        });
+
+      // Clear notifications as needed
+      notified
+        .filter((mmsi) => {
+          if (mobs.indexOf(mmsi) !== -1) {
+            // This beacon is still active
+            return false;
+          }
+          return true;
+        })
+        .forEach((mmsi) => {
+          app.handleMessage('signalk-meshtastic', {
+            context: `vessels.${app.selfId}`,
+            updates: [
+              {
+                source: {
+                  label: plugin.id,
+                },
+                timestamp: (new Date().toISOString()),
+                values: [
+                  {
+                    path: `notifications.mob.${mmsi}`,
+                    value: null,
+                  },
+                ],
+              },
+            ],
+          });
+          notified.splice(notified.indexOf(mmsi), 1);
+        });
+
+      if (mobs.length === 0) {
+        // TODO: Clear notifications
+        return;
+      }
+      mobs.forEach((mmsi) => {
+        let message = 'Crew Overboard Beacon detected';
+        if (mmsi.indexOf('970') === 0) {
+          message = 'Search and Rescue Transponder Beacon detected';
+        }
+        // For each MOB get direction and range
+        const ownPosition = app.getSelfPath('navigation.position');
+        const mobPosition = app.getPath(`vessels.urn:mrn:imo:mmsi:${mmsi}.navigation.position`);
+        if (ownPosition && mobPosition) {
+          const me = new Point(ownPosition.latitude, ownPosition.longitude);
+          const they = new Point(mobPosition.latitude, mobPosition.longitude);
+          const distance = me.distanceTo(they, 'K') * 1000; // In meters
+          const direction = longDirection(me.directionTo(they));
+          message = `${message} ${distance} meters to ${direction}`;
+        }
+
+        // Raise notification
+        app.handleMessage('signalk-meshtastic', {
+          context: `vessels.${app.selfId}`,
+          updates: [
+            {
+              source: {
+                label: plugin.id,
+              },
+              timestamp: (new Date().toISOString()),
+              values: [
+                {
+                  path: `notifications.mob.${mmsi}`,
+                  value: {
+                    message,
+                    state: 'emergency',
+                    method: ['visual', 'sound'],
+                  },
+                },
+              ],
+            },
+          ],
+        });
+        notified.push(mmsi);
+      });
+    }, settings.interval * 1000);
+  };
+
+  plugin.stop = () => {
+    if (!interval) {
+      return;
+    }
+    clearInterval(interval);
+    interval = undefined;
+  };
+
+  plugin.schema = {
+    type: 'object',
+    properties: {
+      interval: {
+        type: 'integer',
+        default: 5,
+        title: 'How often to check for MOB Beacons (in seconds)?',
+      },
+    },
+  };
+
+  return plugin;
+};