signalk-vessels-to-ais 1.5.1 → 1.6.0

package/.github/dependabot.yml

@@ -0,0 +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"

package/README.md

@@ -1,31 +1,32 @@
-# signalk-vessels-to-ais
-[![npm version](https://badge.fury.io/js/signalk-vessels-to-ais.svg)](https://badge.fury.io/js/signalk-vessels-to-ais)
-[![Known Vulnerabilities](https://snyk.io/test/github/KEGustafsson/signalk-vessels-to-ais/badge.svg)](https://snyk.io/test/github/KEGustafsson/signalk-vessels-to-ais)
-
-SignalK server plugin to convert other vessel data to NMEA0183 AIS format and forward it out to 3rd party applications.
-
-User can configure:
-- How often data is sent out
-- Own data can be added to AIS sending
-
-New:
-- v1.5.1, fix: fix: improve shipName type checking
-- v1.5.0, fix: callSign reading 
-- v1.4.0, add: Event output name to user configurable 
-- v1.3.0, add: Navigational Status variations
-- v1.2.2, fix: if own position is not available
-- v1.2.1, fix: own vessel sending
-- v1.2.0, updated fetch method, no need for NODE_TLS_REJECT_UNAUTHORIZED=0 anymore
-- v1.1.5, updated vessels within selected timeframe are sent out, radius filtering around own vessel and tag-block option added
-- v1.1.4, small fix
-- v1.1.3, add: own vessel data and sending interval modified
-- v1.1.2, fix: http/https url selection and better error info
-- v1.1.1, fix: current status of the plugin updated
-- v1.1.0, fix: numeric value test for text strings of AIS
-- v1.0.0, v1 release
-- v0.0.6, fix: node-fetch issue with self signed cert
-- v0.0.5, fix: callSign default value
-- v0.0.4, fix: beam calc
-- v0.0.3, fix: ais path
-- v0.0.2, fix: data parsing
-- v0.0.1, 1st version
+# signalk-vessels-to-ais
+[![npm version](https://badge.fury.io/js/signalk-vessels-to-ais.svg)](https://badge.fury.io/js/signalk-vessels-to-ais)
+[![Known Vulnerabilities](https://snyk.io/test/github/KEGustafsson/signalk-vessels-to-ais/badge.svg)](https://snyk.io/test/github/KEGustafsson/signalk-vessels-to-ais)
+
+SignalK server plugin to convert other vessel data to NMEA0183 AIS format and forward it out to 3rd party applications.
+
+User can configure:
+- How often data is sent out
+- Own data can be added to AIS sending
+
+New:
+- v1.6.0, fix: enhance error handling for AIS timestamp retrieval
+- v1.5.1, fix: fix: improve shipName type checking
+- v1.5.0, fix: callSign reading 
+- v1.4.0, add: Event output name to user configurable 
+- v1.3.0, add: Navigational Status variations
+- v1.2.2, fix: if own position is not available
+- v1.2.1, fix: own vessel sending
+- v1.2.0, updated fetch method, no need for NODE_TLS_REJECT_UNAUTHORIZED=0 anymore
+- v1.1.5, updated vessels within selected timeframe are sent out, radius filtering around own vessel and tag-block option added
+- v1.1.4, small fix
+- v1.1.3, add: own vessel data and sending interval modified
+- v1.1.2, fix: http/https url selection and better error info
+- v1.1.1, fix: current status of the plugin updated
+- v1.1.0, fix: numeric value test for text strings of AIS
+- v1.0.0, v1 release
+- v0.0.6, fix: node-fetch issue with self signed cert
+- v0.0.5, fix: callSign default value
+- v0.0.4, fix: beam calc
+- v0.0.3, fix: ais path
+- v0.0.2, fix: data parsing
+- v0.0.1, 1st version

package/index.js

@@ -1,455 +1,463 @@
-/* eslint-disable no-bitwise */
-/*
-MIT License
-
-Copyright (c) 2020 Karl-Erik Gustafsson
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-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');
-const AisEncode = require('ggencoder').AisEncode;
-const moment = require('moment');
-const haversine = require('haversine-distance');
-
-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
-
-  const httpsAgent = new https.Agent({
-    rejectUnauthorized: false,
-  });
-
-  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
-
-  function aisOut(encMsg, aisTime) {
-    const enc = new AisEncode(encMsg);
-    const sentence = enc.nmea;
-    let taggString = '';
-    if (useTag) {
-      // eslint-disable-next-line no-use-before-define
-      taggString = createTagBlock(aisTime);
-    }
-    if (sentence && sentence.length > 0) {
-      app.debug(taggString + sentence);
-      app.emit(eventName, taggString + 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];
-  }
-
-  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);
-    }
-    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) {
-              if (i === 0) {
-                aisTime = jsonContent[jsonKey].navigation.position.timestamp;
-              } else {
-                aisTime = null;
-              }
-            }
-
-            aisDelay = (parseFloat((moment(new Date(Date.now()))
-              .diff(aisTime) / 1000).toFixed(3))) < positionUpdate;
-
-            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));
-    }
-  }
-
-  //----------------------------------------------------------------------------
-
-  plugin.stop = function stop() {
-    clearInterval(intervalRun);
-    app.debug('Stopped');
-  };
-
-  plugin.schema = {
-    type: 'object',
-    properties: {
-      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,
-      },
-      sendOwn: {
-        type: 'boolean',
-        title: 'Send own AIS data, VDO',
-        default: true,
-      },
-      useTag: {
-        type: 'boolean',
-        title: 'Add Tag-block',
-        default: false,
-      },
-      distance: {
-        type: 'integer',
-        default: 100,
-        title: 'AIS target within range [km]',
-      },
-      eventName: {
-        type: 'string',
-        default: 'nmea0183out',
-        title: 'Output event name',
-      },
-    },
-  };
-
-  return plugin;
-};
+/* eslint-disable no-bitwise */
+/*
+MIT License
+
+Copyright (c) 2020 Karl-Erik Gustafsson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+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');
+const AisEncode = require('ggencoder').AisEncode;
+const moment = require('moment');
+const haversine = require('haversine-distance');
+
+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
+
+  const httpsAgent = new https.Agent({
+    rejectUnauthorized: false,
+  });
+
+  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
+
+  function aisOut(encMsg, aisTime) {
+    const enc = new AisEncode(encMsg);
+    const sentence = enc.nmea;
+    let taggString = '';
+    if (useTag) {
+      // eslint-disable-next-line no-use-before-define
+      taggString = createTagBlock(aisTime);
+    }
+    if (sentence && sentence.length > 0) {
+      app.debug(taggString + sentence);
+      app.emit(eventName, taggString + 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];
+  }
+
+  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);
+    }
+    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));
+    }
+  }
+
+  //----------------------------------------------------------------------------
+
+  plugin.stop = function stop() {
+    clearInterval(intervalRun);
+    app.debug('Stopped');
+  };
+
+  plugin.schema = {
+    type: 'object',
+    properties: {
+      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,
+      },
+      sendOwn: {
+        type: 'boolean',
+        title: 'Send own AIS data, VDO',
+        default: true,
+      },
+      useTag: {
+        type: 'boolean',
+        title: 'Add Tag-block',
+        default: false,
+      },
+      distance: {
+        type: 'integer',
+        default: 100,
+        title: 'AIS target within range [km]',
+      },
+      eventName: {
+        type: 'string',
+        default: 'nmea0183out',
+        title: 'Output event name',
+      },
+    },
+  };
+
+  return plugin;
+};

package/package.json

@@ -1,26 +1,26 @@
-{
-  "name": "signalk-vessels-to-ais",
-  "version": "1.5.1",
-  "description": "SignalK server plugin to convert other vessel data to NMEA0183 AIS format and forward it out to 3rd party applications",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [
-    "signalk-node-server-plugin"
-  ],
-  "repository": "https://github.com/KEGustafsson/signalk-vessels-to-ais",
-  "author": "Karl-Erik Gustafsson",
-  "license": "MIT",
-  "dependencies": {
-    "haversine-distance": "^1.2.1",
-    "moment": "^2.29.1",
-    "node-fetch": "^3.1.1",
-    "ggencoder": "^1.0.5"
-  },
-  "devDependencies": {
-    "eslint": "^7.17.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.22.1"
-  }
-}
+{
+  "name": "signalk-vessels-to-ais",
+  "version": "1.6.0",
+  "description": "SignalK server plugin to convert other vessel data to NMEA0183 AIS format and forward it out to 3rd party applications",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "signalk-node-server-plugin"
+  ],
+  "repository": "https://github.com/KEGustafsson/signalk-vessels-to-ais",
+  "author": "Karl-Erik Gustafsson",
+  "license": "MIT",
+  "dependencies": {
+    "haversine-distance": "^1.2.1",
+    "moment": "^2.29.1",
+    "node-fetch": "^3.1.1",
+    "ggencoder": "^1.0.5"
+  },
+  "devDependencies": {
+    "eslint": "^7.17.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.22.1"
+  }
+}