signalk-vessels-to-ais 1.1.4 → 1.1.5

package/README.md

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

package/index.js

@@ -22,8 +22,10 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
-const fetch = require('node-fetch');
+const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args));
 const AisEncode = require('ggencoder').AisEncode;
+const moment = require('moment');
+const haversine = require('haversine-distance');
 
 module.exports = function createPlugin(app) {
   const plugin = {};
@@ -32,16 +34,25 @@ module.exports = function createPlugin(app) {
   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 intervalStart;
   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;
+    useTag = options.useTag;
+
+    let port = options.port || 3000;
+    let portSec = options.portSec || 3443;
+
     process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-    url = 'https://localhost:3443/signalk/v1/api/vessels';
+    url = 'https://localhost:' + portSec + '/signalk/v1/api/vessels';
     fetch(url, { method: 'GET' })
       .then((res) => {
         console.log(`${plugin.id}: SSL enabled, using https`);
@@ -51,7 +62,7 @@ module.exports = function createPlugin(app) {
         }
       })
       .catch(() => {
-        url = 'http://localhost:3000/signalk/v1/api/vessels';
+        url = 'http://localhost:' + port + '/signalk/v1/api/vessels';
         fetch(url, { method: 'GET' })
           .then((res) => {
             console.log(`${plugin.id}: SSL disabled, using http`);
@@ -65,16 +76,11 @@ module.exports = function createPlugin(app) {
       });
 
     positionUpdate = options.position_update;
+    distance = options.distance;
     sendOwn = options.sendOwn;
 
     app.debug('Plugin started');
 
-    function clear() {
-      clearInterval(intervalStart);
-    }
-
-    intervalStart = setInterval(readInfo, (15000));
-    setTimeout(clear, 15000);
     intervalRun = setInterval(readInfo, (positionUpdate * 60000));
   };
 
@@ -113,21 +119,65 @@ module.exports = function createPlugin(app) {
   //----------------------------------------------------------------------------
   // nmea out
 
-  function aisOut(encMsg) {
+  function aisOut(encMsg, aisTime) {
     const enc = new AisEncode(encMsg);
     const sentence = enc.nmea;
+    let taggString = '';
+    if (useTag) {
+      taggString = createTagBlock(aisTime)
+    } 
     if (sentence && sentence.length > 0) {
-      app.debug(sentence);
-      app.emit('nmea0183out', sentence);
+      app.debug(taggString+sentence);
+      app.emit('nmea0183out', taggString+sentence);
+    }
+  }
+
+  const m_hex = [
+    '0',
+    '1',
+    '2',
+    '3',
+    '4',
+    '5',
+    '6',
+    '7',
+    '8',
+    '9',
+    'A',
+    'B',
+    'C',
+    'D',
+    'E',
+    'F'
+  ]
+  
+  function toHexString (v) {
+    let msn = (v >> 4) & 0x0f
+    let lsn = (v >> 0) & 0x0f
+    return m_hex[msn] + m_hex[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
 
   readInfo = function readData(options) {
-    let i, mmsi, shipName, lat, lon, sog, cog, rot, navStat, hdg, dst, callSign, imo, id, type;
+    let i, mmsi, aisTime, aisDelay, shipName, lat, lon, sog, cog, rot, 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) => {
@@ -136,6 +186,22 @@ module.exports = function createPlugin(app) {
         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;
+            }
+          } catch (error) {
+            if (i === 0) {
+              aisTime = new Date(Date.now()).toISOString();
+              aisDelay = true;
+            } else {
+              aisTime = null;
+              aisDelay = false;
+            }
+          }
           try {
             mmsi = jsonContent[jsonKey].mmsi;
           } catch (error) { mmsi = null; }
@@ -174,7 +240,7 @@ module.exports = function createPlugin(app) {
             }
           } catch (error) { callSign = ''; }
           try {
-            imo = (jsonContent[jsonKey].registrations.imo).substring(4, 20);
+            imo = (jsonContent[jsonKey].registrations.value.imo).substring(4, 20);
           } catch (error) { imo = null; }
           try {
             id = jsonContent[jsonKey].design.aisShipType.value.id;
@@ -211,89 +277,103 @@ module.exports = function createPlugin(app) {
           if (i === 0) {
             own = true;
             if (sendOwn) {
-              ais = 'B';
+              ais = 'A';
+            } else {
+              ais = '';
             }
           } else {
             own = false;
           }
 
-          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 (ais === 'A') {
-            app.debug(`class A ${i}`);
-            aisOut(encMsg3);
-            aisOut(encMsg5);
-          }
-          if (ais === 'B') {
-            app.debug(`class B ${i}`);
-            aisOut(encMsg18);
-            aisOut(encMsg240);
-            aisOut(encMsg241);
+          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);
+              }
+              app.debug("--------------------------------------------------------");
+
+            }
           }
         }
         const dateobj = new Date(Date.now());
@@ -323,11 +403,31 @@ module.exports = function createPlugin(app) {
         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]',
+      },
     },
   };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-vessels-to-ais",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "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": {
@@ -13,7 +13,9 @@
   "author": "Karl-Erik Gustafsson",
   "license": "MIT",
   "dependencies": {
-    "node-fetch": "^2.6.0",
+    "haversine-distance": "^1.2.1",
+    "moment": "^2.29.1",
+    "node-fetch": "^3.1.1",
     "ggencoder": "^1.0.5"
   },
   "devDependencies": {