signalk-vessels-to-ais 1.1.5 → 1.2.2

package/README.md

@@ -9,6 +9,9 @@ User can configure:
 - Own data can be added to AIS sending
 
 New:
+- 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

package/index.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-bitwise */
 /*
 MIT License
 
@@ -22,7 +23,8 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
-const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args));
+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');
@@ -38,22 +40,29 @@ module.exports = function createPlugin(app) {
   let sendOwn;
   let url;
   let intervalRun;
-  let readInfo;
   const setStatus = app.setPluginStatus || app.setProviderStatus;
 
-  let position_update;
   let useTag;
 
-  plugin.start = function (options, restartPlugin) {
-    position_update = options.position_update * 60;
+  const httpsAgent = new https.Agent({
+    rejectUnauthorized: false,
+  });
+
+  let getParam;
+
+  plugin.start = function (options) {
     useTag = options.useTag;
 
-    let port = options.port || 3000;
-    let portSec = options.portSec || 3443;
+    positionUpdate = options.position_update * 60;
+    distance = options.distance;
+    sendOwn = options.sendOwn;
+
+    const port = options.port || 3000;
+    const portSec = options.portSec || 3443;
 
-    process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-    url = 'https://localhost:' + portSec + '/signalk/v1/api/vessels';
-    fetch(url, { method: 'GET' })
+    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) {
@@ -62,26 +71,23 @@ module.exports = function createPlugin(app) {
         }
       })
       .catch(() => {
-        url = 'http://localhost:' + port + '/signalk/v1/api/vessels';
-        fetch(url, { method: 'GET' })
+        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");
             }
-          })
-          .catch(() => {
           });
+      })
+      .finally(() => {
+        // eslint-disable-next-line no-use-before-define
+        intervalRun = setInterval(readData, (positionUpdate * 1000), getParam);
       });
 
-    positionUpdate = options.position_update;
-    distance = options.distance;
-    sendOwn = options.sendOwn;
-
     app.debug('Plugin started');
-
-    intervalRun = setInterval(readInfo, (positionUpdate * 60000));
   };
 
   //----------------------------------------------------------------------------
@@ -124,15 +130,16 @@ module.exports = function createPlugin(app) {
     const sentence = enc.nmea;
     let taggString = '';
     if (useTag) {
-      taggString = createTagBlock(aisTime)
-    } 
+      // eslint-disable-next-line no-use-before-define
+      taggString = createTagBlock(aisTime);
+    }
     if (sentence && sentence.length > 0) {
-      app.debug(taggString+sentence);
-      app.emit('nmea0183out', taggString+sentence);
+      app.debug(taggString + sentence);
+      app.emit('nmea0183out', taggString + sentence);
     }
   }
 
-  const m_hex = [
+  const mHex = [
     '0',
     '1',
     '2',
@@ -148,245 +155,240 @@ module.exports = function createPlugin(app) {
     'C',
     'D',
     'E',
-    'F'
-  ]
-  
-  function toHexString (v) {
-    let msn = (v >> 4) & 0x0f
-    let lsn = (v >> 0) & 0x0f
-    return m_hex[msn] + m_hex[lsn]
+    '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
+  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)
+      tagBlockChecksum ^= tagBlock.charCodeAt(i);
     }
-    return `\\${tagBlock}*` + toHexString(tagBlockChecksum) + `\\`
+    return `\\${tagBlock}*${toHexString(tagBlockChecksum)}\\`;
   }
 
   //----------------------------------------------------------------------------
   // Read and parse AIS data
 
-  readInfo = function readData(options) {
-    let i, mmsi, aisTime, aisDelay, shipName, lat, lon, sog, cog, rot, navStat, hdg, dst, callSign, imo, id, type;
+  // 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;
-    let ownLat = app.getSelfPath('navigation.position.value.latitude');
-    let ownLon = app.getSelfPath('navigation.position.value.longitude');
-    fetch(url, { method: 'GET' })
-      .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;
-            if ((parseFloat((moment(new Date(Date.now())).diff(aisTime)/1000).toFixed(3))) < position_update) {
-              aisDelay = true;
-            } else {
-              aisDelay = false;
+    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;
+              }
             }
-          } catch (error) {
-            if (i === 0) {
-              aisTime = new Date(Date.now()).toISOString();
-              aisDelay = true;
-            } else {
-              aisTime = null;
-              aisDelay = false;
+
+            aisDelay = (parseFloat((moment(new Date(Date.now()))
+              .diff(aisTime) / 1000).toFixed(3))) < positionUpdate;
+
+            try {
+              mmsi = jsonContent[jsonKey].mmsi;
+            } catch (error) { mmsi = null; }
+            try {
+              shipName = jsonContent[jsonKey].name;
+            } 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 {
+              if (i === 0) {
+                callSign = jsonContent[jsonKey].communication.callsignVhf;
+              } else {
+                callSign = jsonContent[jsonKey].communication.value.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 = '';
             }
-          }
-          try {
-            mmsi = jsonContent[jsonKey].mmsi;
-          } catch (error) { mmsi = null; }
-          try {
-            shipName = jsonContent[jsonKey].name;
-          } 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 {
-            if (i === 0) {
-              callSign = jsonContent[jsonKey].communication.callsignVhf;
-            } else {
-              callSign = jsonContent[jsonKey].communication.value.callsignVhf;
+            if (dst % 1 === 0) {
+              dst = '';
+            }
+            if (callSign % 1 === 0) {
+              callSign = '';
+            }
+            if (type % 1 === 0) {
+              type = '';
             }
-          } 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;
-            if (sendOwn) {
-              ais = 'A';
+            if (i === 0) {
+              own = true;
+              if (sendOwn) {
+                ais = 'A';
+              } else {
+                ais = '';
+              }
             } else {
-              ais = '';
+              own = false;
             }
-          } else {
-            own = false;
-          }
 
-          const a = { lat: ownLat, lon: ownLon }
-          const b = { lat: lat, lon: lon }
-          let 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')) {
-              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 B, ${i}, time: ${aisTime}`);
-                aisOut(encMsg18, aisTime);
-                aisOut(encMsg240, aisTime);
-                aisOut(encMsg241, aisTime);
+            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')) {
+                // 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 B, ${i}, time: ${aisTime}`);
+                  aisOut(encMsg18, aisTime);
+                  aisOut(encMsg240, aisTime);
+                  aisOut(encMsg241, aisTime);
+                }
+                app.debug('--------------------------------------------------------');
               }
-              app.debug("--------------------------------------------------------");
-
             }
           }
-        }
-        const dateobj = new Date(Date.now());
-        const date = dateobj.toISOString();
-        app.handleMessage(plugin.id, {
-          context: `vessels.${app.selfId}`,
-          updates: [
-          ],
-        });
-        setStatus(`Number of AIS targets sent: ${numberAIS - 1} (${date})`);
-      })
-      .catch((err) => console.error(err));
-  };
+          const dateobj = new Date(Date.now());
+          const date = dateobj.toISOString();
+          setStatus(`AIS NMEA message send: ${date}`);
+        })
+        .catch((err) => console.error(err));
+    }
+  }
 
   //----------------------------------------------------------------------------
 
@@ -406,22 +408,22 @@ module.exports = function createPlugin(app) {
       port: {
         type: 'number',
         title: 'HTTP port',
-        default: 3000
+        default: 3000,
       },
       portSec: {
         type: 'number',
         title: 'HTTPS port',
-        default: 3443
+        default: 3443,
       },
       sendOwn: {
         type: 'boolean',
         title: 'Send own AIS data, VDO',
-        default: true
+        default: true,
       },
       useTag: {
         type: 'boolean',
         title: 'Add Tag-block',
-        default: false
+        default: false,
       },
       distance: {
         type: 'integer',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-vessels-to-ais",
-  "version": "1.1.5",
+  "version": "1.2.2",
   "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": {

package/.eslintrc.js

@@ -1,24 +0,0 @@
-module.exports = {
-  env: {
-    commonjs: true,
-    es2021: true,
-    node: true,
-    browser: true,
-    jquery: true,
-  },
-  extends: [
-    'airbnb-base',
-  ],
-  parserOptions: {
-    ecmaVersion: 12,
-  },
-  rules: {
-    'linebreak-style': 0,
-    'no-console': 0,
-    'func-names': 0,
-    'prefer-destructuring': 0,
-    'one-var-declaration-per-line': 0,
-    'one-var': 0,
-    'no-plusplus': 0,
-  },
-};