signalk-vessels-to-ais 1.6.1 → 2.0.0-beta.1

package/.github/dependabot.yml

@@ -1,11 +1,11 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "spec": "test/**/*.test.js",
+  "timeout": 5000,
+  "reporter": "spec"
+}

package/README.md

@@ -9,6 +9,7 @@ User can configure:
 - Own data can be added to AIS sending
 
 New:
+- v2.0.0, refactor: use direct data access (app.getPath) instead of REST API, removed node-fetch and moment dependencies, added unit tests
 - v1.6.1, fix: ggencoder ^1.0.9 is use
 - v1.6.0, fix: enhance error handling for AIS timestamp retrieval
 - v1.5.1, fix: fix: improve shipName type checking

package/index.js

@@ -23,399 +23,189 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
-const fetchNew = (...args) => import('node-fetch').then(({ default: fetch }) => fetch(...args));
-const https = require('https');
+/**
+ * Modified version using app.getPath() instead of REST API
+ * - No HTTP/HTTPS configuration needed
+ * - No node-fetch dependency
+ * - Direct access to SignalK data model
+ */
+
 const AisEncode = require('ggencoder').AisEncode;
-const moment = require('moment');
 const haversine = require('haversine-distance');
+const {
+  getValue,
+  getTimestamp,
+  createTagBlock,
+  extractVesselData,
+  buildAisMessage3,
+  buildAisMessage5,
+  buildAisMessage18,
+  buildAisMessage24A,
+  buildAisMessage24B,
+  isDataFresh,
+} = require('./lib/helpers');
 
 module.exports = function createPlugin(app) {
   const plugin = {};
-  plugin.id = 'signalk-vessels-to-ais';
-  plugin.name = 'Other vessels data to AIS NMEA0183';
-  plugin.description = 'SignalK server plugin to convert other vessel data to NMEA0183 AIS format and forward it out to 3rd party applications';
-
-  let positionUpdate = null;
-  let distance;
-  let sendOwn;
-  let url;
-  let intervalRun;
-  const setStatus = app.setPluginStatus || app.setProviderStatus;
-
-  let useTag;
-  let eventName
+  plugin.id = 'signalk-vessels-to-ais-ws';
+  plugin.name = 'Other vessels data to AIS NMEA0183 (WebSocket)';
+  plugin.description = 'SignalK server plugin to convert other vessel data to NMEA0183 AIS format using direct data access (no REST API)';
 
-  const httpsAgent = new https.Agent({
-    rejectUnauthorized: false,
-  });
+  let intervalId = null;
+  let positionUpdate = 60;
+  let distance = 100;
+  let sendOwn = true;
+  let useTag = false;
+  let eventName = 'nmea0183out';
 
-  let getParam;
-
-  plugin.start = function (options) {
-    useTag = options.useTag;
-    eventName = options.eventName;
-
-    positionUpdate = options.position_update * 60;
-    distance = options.distance;
-    sendOwn = options.sendOwn;
-
-    const port = options.port || 3000;
-    const portSec = options.portSec || 3443;
-
-    url = `https://localhost:${portSec}/signalk/v1/api/vessels`;
-    getParam = { method: 'GET', agent: httpsAgent };
-    fetchNew(url, getParam)
-      .then((res) => {
-        console.log(`${plugin.id}: SSL enabled, using https`);
-        if (!res.ok) {
-          console.error(`${plugin.id}: SSL enabled, but error accessing server. Check 'Allow Readonly Access' and enable it.`);
-          setStatus("Error accessing server. Check 'Allow Readonly Access' and enable it");
-        }
-      })
-      .catch(() => {
-        url = `http://localhost:${port}/signalk/v1/api/vessels`;
-        getParam = { method: 'GET' };
-        fetchNew(url, getParam)
-          .then((res) => {
-            console.log(`${plugin.id}: SSL disabled, using http`);
-            if (!res.ok) {
-              console.error(`${plugin.id}: SSL disabled, but error accessing server. Check 'Allow Readonly Access' and enable it.`);
-              setStatus("Error accessing server. Check 'Allow Readonly Access' and enable it");
-            }
-          });
-      })
-      .finally(() => {
-        // eslint-disable-next-line no-use-before-define
-        intervalRun = setInterval(readData, (positionUpdate * 1000), getParam);
-      });
-
-    app.debug('Plugin started');
-  };
-
-  //----------------------------------------------------------------------------
-  // State Mapping
-
-  const stateMapping = {
-    motoring: 0,
-    'UnderWayUsingEngine': 0,
-    'under way using engine': 0,
-    'underway using engine': 0,
-    anchored: 1,
-    'AtAnchor': 1,
-    'at anchor': 1,
-    'not under command': 2,
-    'restricted manouverability': 3,
-    'constrained by draft': 4,
-    'constrained by her draught': 4,
-    moored: 5,
-    'Moored': 5,
-    aground: 6,
-    fishing: 7,
-    'engaged in fishing': 7,
-    sailing: 8,
-    'UnderWaySailing': 8,
-    'under way sailing': 8,
-    'underway sailing': 8,
-    'hazardous material high speed': 9,
-    'hazardous material wing in ground': 10,
-    'reserved for future use': 13,
-    'ais-sart': 14,
-    default: 15,
-    'UnDefined': 15,
-    'undefined': 15,
-  };
-
-  //----------------------------------------------------------------------------
-  // Rad to Deg
-  function radToDegrees(radians) {
-    const pi = Math.PI;
-    return ((radians * 180) / pi);
-  }
-
-  //----------------------------------------------------------------------------
-  // m/s to  knots
-  function msToKnots(speed) {
-    return ((speed * 3.6) / 1.852);
-  }
-
-  //----------------------------------------------------------------------------
-  // nmea out
+  const setStatus = app.setPluginStatus || app.setProviderStatus;
 
-  function aisOut(encMsg, aisTime) {
+  // NMEA output
+  function aisOut(encMsg) {
     const enc = new AisEncode(encMsg);
     const sentence = enc.nmea;
-    let taggString = '';
+    let tagString = '';
     if (useTag) {
-      // eslint-disable-next-line no-use-before-define
-      taggString = createTagBlock(aisTime);
+      tagString = createTagBlock();
     }
     if (sentence && sentence.length > 0) {
-      app.debug(taggString + sentence);
-      app.emit(eventName, taggString + sentence);
+      app.debug(tagString + sentence);
+      app.emit(eventName, tagString + sentence);
     }
   }
 
-  const mHex = [
-    '0',
-    '1',
-    '2',
-    '3',
-    '4',
-    '5',
-    '6',
-    '7',
-    '8',
-    '9',
-    'A',
-    'B',
-    'C',
-    'D',
-    'E',
-    'F',
-  ];
-
-  function toHexString(v) {
-    const msn = (v >> 4) & 0x0f;
-    const lsn = (v >> 0) & 0x0f;
-    return mHex[msn] + mHex[lsn];
-  }
+  /**
+   * Main data processing function
+   * Uses app.getPath() instead of REST API
+   */
+  function processVessels() {
+    // Get own position for distance calculation
+    const ownPosition = app.getSelfPath('navigation.position.value');
+    if (!ownPosition || ownPosition.latitude === undefined || ownPosition.longitude === undefined) {
+      app.debug('Own position not available, skipping');
+      return;
+    }
 
-  function createTagBlock(aisTime) {
-    let tagBlock = '';
-    tagBlock += 's:SK0001,';
-    // tagBlock += 'c:' + aisTime + ','
-    tagBlock += `c:${Date.now(aisTime)},`;
-    tagBlock = tagBlock.slice(0, -1);
-    let tagBlockChecksum = 0;
-    for (let i = 0; i < tagBlock.length; i++) {
-      tagBlockChecksum ^= tagBlock.charCodeAt(i);
+    const ownLat = ownPosition.latitude;
+    const ownLon = ownPosition.longitude;
+
+    // Get all vessels using direct data access - NO REST API!
+    const vessels = app.getPath('vessels');
+    if (!vessels) {
+      app.debug('No vessels data available');
+      return;
     }
-    return `\\${tagBlock}*${toHexString(tagBlockChecksum)}\\`;
-  }
 
-  //----------------------------------------------------------------------------
-  // Read and parse AIS data
-
-  // eslint-disable-next-line no-shadow
-  function readData(getParam) {
-    let i, mmsi, aisTime, aisDelay, shipName, lat, lon, sog, cog, rot;
-    let navStat, hdg, dst, callSign, imo, id, type;
-    let draftCur, length, beam, ais, encMsg3, encMsg5, encMsg18, encMsg240, encMsg241, own;
-    const ownLat = app.getSelfPath('navigation.position.value.latitude');
-    const ownLon = app.getSelfPath('navigation.position.value.longitude');
-    if (typeof ownLat !== "undefined" && typeof ownLon !== "undefined") {
-      fetchNew(url, getParam)
-        .then((res) => res.json())
-        .then((json) => {
-          const jsonContent = JSON.parse(JSON.stringify(json));
-          const numberAIS = Object.keys(jsonContent).length;
-          for (i = 0; i < numberAIS; i++) {
-            const jsonKey = Object.keys(jsonContent)[i];
-            try {
-              aisTime = jsonContent[jsonKey].sensors.ais.class.timestamp;
-            } catch (error) {
-              try {
-                if (i === 0) {
-                  aisTime = jsonContent[jsonKey].navigation.position.timestamp;
-                } else {
-                  aisTime = null;
-                }
-              } catch (error) {
-                aisTime = null;
-              }
-            }
-
-            if (aisTime) {
-              aisDelay = (parseFloat((moment(new Date(Date.now()))
-              .diff(aisTime) / 1000).toFixed(3))) < positionUpdate;
-            } else {
-              aisDelay = false;
-            }
-
-
-            try {
-              mmsi = jsonContent[jsonKey].mmsi;
-            } catch (error) { mmsi = null; }
-            try {
-              shipName = typeof jsonContent[jsonKey]?.name === 'string' 
-                ? jsonContent[jsonKey].name 
-                : jsonContent[jsonKey]?.name?.value || '';
-            } catch (error) { shipName = ''; }
-            try {
-              lat = jsonContent[jsonKey].navigation.position.value.latitude;
-            } catch (error) { lat = null; }
-            try {
-              lon = jsonContent[jsonKey].navigation.position.value.longitude;
-            } catch (error) { lon = null; }
-            try {
-              sog = msToKnots(jsonContent[jsonKey].navigation.speedOverGround.value);
-            } catch (error) { sog = null; }
-            try {
-              cog = radToDegrees(jsonContent[jsonKey].navigation.courseOverGroundTrue.value);
-            } catch (error) { cog = null; }
-            try {
-              rot = radToDegrees(jsonContent[jsonKey].navigation.rateOfTurn.value);
-            } catch (error) { rot = null; }
-            try {
-              navStat = stateMapping[jsonContent[jsonKey].navigation.state.value];
-            } catch (error) { navStat = ''; }
-            try {
-              hdg = radToDegrees(jsonContent[jsonKey].navigation.headingTrue.value);
-            } catch (error) { hdg = null; }
-            try {
-              dst = jsonContent[jsonKey].navigation.destination.commonName.value;
-            } catch (error) { dst = ''; }
-            try {
-              callSign = jsonContent[jsonKey].communication.callsignVhf.value || jsonContent[jsonKey].communication.callsignVhf;                
-            } catch (error) { callSign = ''; }
-            try {
-              imo = (jsonContent[jsonKey].registrations.value.imo).substring(4, 20);
-            } catch (error) { imo = null; }
-            try {
-              id = jsonContent[jsonKey].design.aisShipType.value.id;
-            } catch (error) { id = null; }
-            try {
-              type = jsonContent[jsonKey].design.aisShipType.value.name;
-            } catch (error) { type = ''; }
-            try {
-              draftCur = (jsonContent[jsonKey].design.draft.value.current) / 10;
-            } catch (error) { draftCur = null; }
-            try {
-              length = jsonContent[jsonKey].design.length.value.overall;
-            } catch (error) { length = null; }
-            try {
-              beam = (jsonContent[jsonKey].design.beam.value) / 2;
-            } catch (error) { beam = null; }
-            try {
-              ais = jsonContent[jsonKey].sensors.ais.class.value;
-            } catch (error) { ais = null; }
-
-            if (shipName % 1 === 0) {
-              shipName = '';
-            }
-            if (dst % 1 === 0) {
-              dst = '';
-            }
-            if (callSign % 1 === 0) {
-              callSign = '';
-            }
-            if (type % 1 === 0) {
-              type = '';
-            }
-
-            if (i === 0) {
-              own = true;
-            } else {
-              own = false;
-            }
-
-            const a = { lat: ownLat, lon: ownLon };
-            const b = { lat, lon };
-            const dist = (haversine(a, b) / 1000).toFixed(2);
-
-            if (dist <= distance) {
-              encMsg3 = {
-                own,
-                aistype: 3, // class A position report
-                repeat: 0,
-                mmsi,
-                navstatus: navStat,
-                sog,
-                lon,
-                lat,
-                cog,
-                hdg,
-                rot,
-              };
-
-              encMsg5 = {
-                own,
-                aistype: 5, // class A static
-                repeat: 0,
-                mmsi,
-                imo,
-                cargo: id,
-                callsign: callSign,
-                shipname: shipName,
-                draught: draftCur,
-                destination: dst,
-                dimA: 0,
-                dimB: length,
-                dimC: beam,
-                dimD: beam,
-              };
-
-              encMsg18 = {
-                own,
-                aistype: 18, // class B position report
-                repeat: 0,
-                mmsi,
-                sog,
-                accuracy: 0,
-                lon,
-                lat,
-                cog,
-                hdg,
-              };
-
-              encMsg240 = {
-                own,
-                aistype: 24, // class B static
-                repeat: 0,
-                part: 0,
-                mmsi,
-                shipname: shipName,
-              };
-
-              encMsg241 = {
-                own,
-                aistype: 24, // class B static
-                repeat: 0,
-                part: 1,
-                mmsi,
-                cargo: id,
-                callsign: callSign,
-                dimA: 0,
-                dimB: length,
-                dimC: beam,
-                dimD: beam,
-              };
-
-              if (aisDelay && (ais === 'A' || ais === 'B' || ais === 'BASE')) {
-                // eslint-disable-next-line no-useless-concat
-                app.debug(`Distance range: ${distance}km, AIS target distance: ${dist}km` + `, Class ${ais} Vessel` + `, MMSI:${mmsi}`);
-                if (ais === 'A') {
-                  app.debug(`class A, ${i}, time: ${aisTime}`);
-                  aisOut(encMsg3, aisTime);
-                  aisOut(encMsg5, aisTime);
-                }
-                if (ais === 'B') {
-                  app.debug(`class ${ais}, ${i}, time: ${aisTime}`);
-                  aisOut(encMsg18, aisTime);
-                  aisOut(encMsg240, aisTime);
-                  aisOut(encMsg241, aisTime);
-                }
-                if (ais === 'BASE') {
-                  app.debug(`class ${ais}, ${i}, time: ${aisTime}`);
-                  aisOut(encMsg3, aisTime);
-                }
-                app.debug('--------------------------------------------------------');
-              }
-            }
-          }
-          const dateobj = new Date(Date.now());
-          const date = dateobj.toISOString();
-          setStatus(`AIS NMEA message sent: ${date}`);
-        })
-        .catch((err) => console.error(err));
+    const vesselIds = Object.keys(vessels);
+    let processedCount = 0;
+
+    // Get own vessel identifier for comparison
+    const selfId = app.selfId || 'self';
+
+    for (const vesselId of vesselIds) {
+      const vessel = vessels[vesselId];
+
+      // Determine if this is own vessel by checking 'self' key or matching selfId
+      const isOwn = vesselId === 'self' || vesselId === selfId;
+
+      // Skip own vessel if not configured to send
+      if (isOwn && !sendOwn) {
+        continue;
+      }
+
+      // Extract AIS timestamp for freshness check
+      let aisTime = getValue(vessel, 'sensors.ais.class.timestamp');
+      if (!aisTime) {
+        aisTime = getTimestamp(vessel, 'navigation.position');
+      }
+
+      // Check data freshness
+      const aisDelay = isDataFresh(aisTime, positionUpdate);
+
+      // Extract vessel data using helper
+      const data = extractVesselData(vessel);
+
+      // Skip if no position
+      if (data.lat === null || data.lon === null) {
+        continue;
+      }
+
+      // Calculate distance from own vessel
+      const a = { lat: ownLat, lon: ownLon };
+      const b = { lat: data.lat, lon: data.lon };
+      const dist = (haversine(a, b) / 1000).toFixed(2);
+
+      // Check if within distance range
+      if (parseFloat(dist) > distance) {
+        continue;
+      }
+
+      // Send AIS messages based on class
+      if (aisDelay && (data.aisClass === 'A' || data.aisClass === 'B' || data.aisClass === 'BASE')) {
+        app.debug(
+          `Distance range: ${distance}km, AIS target distance: ${dist}km, Class ${data.aisClass} Vessel, MMSI:${data.mmsi}`,
+        );
+
+        if (data.aisClass === 'A') {
+          app.debug(`Class A, MMSI: ${data.mmsi}, Name: ${data.shipName || 'Unknown'}`);
+          aisOut(buildAisMessage3(data, isOwn));
+          aisOut(buildAisMessage5(data, isOwn));
+          processedCount++;
+        }
+
+        if (data.aisClass === 'B') {
+          app.debug(`Class B, MMSI: ${data.mmsi}, Name: ${data.shipName || 'Unknown'}`);
+          aisOut(buildAisMessage18(data, isOwn));
+          aisOut(buildAisMessage24A(data, isOwn));
+          aisOut(buildAisMessage24B(data, isOwn));
+          processedCount++;
+        }
+
+        if (data.aisClass === 'BASE') {
+          app.debug(`Base Station, MMSI: ${data.mmsi}`);
+          aisOut(buildAisMessage3(data, isOwn));
+          processedCount++;
+        }
+
+        app.debug('--------------------------------------------------------');
+      }
+    }
+
+    const dateObj = new Date(Date.now());
+    const date = dateObj.toISOString();
+    setStatus(`${processedCount} AIS targets sent: ${date}`);
+
+    if (processedCount > 0) {
+      app.reportOutputMessages(processedCount);
     }
   }
 
-  //----------------------------------------------------------------------------
+  plugin.start = function (options) {
+    positionUpdate = (options.position_update || 1) * 60;
+    distance = options.distance || 100;
+    sendOwn = options.sendOwn !== false;
+    useTag = options.useTag || false;
+    eventName = options.eventName || 'nmea0183out';
+
+    app.debug('Plugin starting with direct data access (no REST API)');
+    app.debug(`Update interval: ${positionUpdate}s, Distance: ${distance}km`);
 
-  plugin.stop = function stop() {
-    clearInterval(intervalRun);
-    app.debug('Stopped');
+    // Initial run
+    processVessels();
+
+    // Set up periodic processing
+    intervalId = setInterval(processVessels, positionUpdate * 1000);
+
+    setStatus('Running');
+    app.debug('Plugin started');
+  };
+
+  plugin.stop = function () {
+    if (intervalId) {
+      clearInterval(intervalId);
+      intervalId = null;
+    }
+    app.debug('Plugin stopped');
   };
 
   plugin.schema = {
@@ -424,21 +214,12 @@ module.exports = function createPlugin(app) {
       position_update: {
         type: 'number',
         default: 1,
-        title: 'How often AIS data is sent to NMEA0183 out (in minutes). E.g. 0.5 = 30s, 1 = 1min',
-      },
-      port: {
-        type: 'number',
-        title: 'HTTP port',
-        default: 3000,
-      },
-      portSec: {
-        type: 'number',
-        title: 'HTTPS port',
-        default: 3443,
+        title: 'How often AIS data is sent to NMEA0183 out (in minutes)',
+        description: 'E.g. 0.5 = 30s, 1 = 1min',
       },
       sendOwn: {
         type: 'boolean',
-        title: 'Send own AIS data, VDO',
+        title: 'Send own AIS data (VDO)',
         default: true,
       },
       useTag: {