@airframes/acars-decoder 1.4.3 → 1.4.5

package/src/plugins/Label_H1_M1BPOS.ts

@@ -0,0 +1,60 @@
+import { DecoderPlugin } from '../DecoderPlugin';
+
+export class Label_H1_M1BPOS extends DecoderPlugin { // eslint-disable-line camelcase
+  name = 'label-h1-m1bpos';
+
+  qualifiers() { // eslint-disable-line class-methods-use-this
+    return {
+      labels: ['H1'],
+      preambles: ['#M1BPOS'],
+    };
+  }
+
+  decode(message: any, options: any = {}) : any {
+    const decodeResult: any = this.defaultResult;
+    decodeResult.decoder.name = this.name;
+
+    if (options.debug) {
+      console.log('DECODER: #M1BPOS detected');
+    }
+    const parts = message.text.replace('#M1BPOS', '').split('/');
+    const firstHalf = parts[0];
+    const secondHalf = parts[1];
+    const items = firstHalf.split(',');
+
+    const coordsRegex = /(?<lac>[NS])(?<la>.+)\s*(?<lnc>[EW])(?<ln>.+)/;
+    const results = items[0].match(coordsRegex);
+
+    if (results && results.length >= 4) {
+      decodeResult.raw.position = {
+        latitudeDirection: results.groups.lac,
+        latitude: (results.groups.la / 1000) * (results.groups.lac === 'S' ? -1 : 1),
+        longitudeDirection: results.groups.lnc,
+        longitude: (results.groups.ln / 1000) * (results.groups.lnc === 'W' ? -1 : 1),
+      };
+
+      let route = items.slice(1).filter((part: any) => !/^\d(.+)$/.test(part));
+      route = route.map((hop: any) => hop || '?');
+      decodeResult.raw.route = route;
+
+      decodeResult.formatted.description = 'Position Report';
+      decodeResult.formatted.items = {
+        coordinates: {
+          label: 'Position',
+          value: this.coordinateString(decodeResult.raw.position),
+        },
+        route: {
+          label: 'Route',
+          value: `${route.join(' > ')}`,
+        },
+      };
+      decodeResult.decoded = true;
+      decodeResult.decodeLevel = 'partial';
+    }
+    decodeResult.remaining.text = secondHalf;
+
+    return decodeResult;
+  }
+}
+
+export default {};

package/src/plugins/Label_H1_M1BPRG.ts

@@ -0,0 +1,40 @@
+import { DecoderPlugin } from '../DecoderPlugin';
+
+export class Label_H1_M1BPRG extends DecoderPlugin { // eslint-disable-line camelcase
+  name = 'label-h1-m1bprg';
+
+  qualifiers() { // eslint-disable-line class-methods-use-this
+    return {
+      labels: ['H1'],
+      preambles: ['#M1BPRG'],
+    };
+  }
+
+  decode(message: any, options: any = {}) : any {
+    const decodeResult: any = this.defaultResult;
+    decodeResult.decoder.name = this.name;
+
+    // console.log('DECODER: H1 #M1BPRG detected');
+    const parts = message.text.split('/');
+    for (const part of parts) { // eslint-disable-line no-restricted-syntax
+      if (part.includes('#M')) {
+        const regex = /#M(?<fms>\w+)PRG/;
+      }
+
+      if (part.includes('DT')) {
+        const regex = /DT(?<dest>\w+),(?<rway>.+),(?<fuel>.+),(?<eta>.+),(?<rem>.+)/;
+        const result = message.text.match(regex);
+        // console.log('DT result');
+        // console.log(result);
+      }
+
+      if (part.includes('FN')) {
+        const regex = /FN(?<flight>\w+)/;
+      }
+    }
+
+    return decodeResult;
+  }
+}
+
+export default {};

package/src/plugins/Label_QP.ts

@@ -0,0 +1,54 @@
+import { DecoderPlugin } from '../DecoderPlugin';
+
+export class Label_QP extends DecoderPlugin {
+  name = 'label-qp';
+
+  qualifiers() { // eslint-disable-line class-methods-use-this
+    return {
+      labels: ['QP'],
+    };
+  }
+
+  decode(message: any, options: any = {}) : any {
+    const decodeResult: any = this.defaultResult;
+    decodeResult.decoder.name = this.name;
+    
+    decodeResult.raw.origin = message.text.substring(0, 4);
+    decodeResult.raw.destination = message.text.substring(4, 8);
+    decodeResult.raw.gate_out = message.text.substring(8, 12);
+    decodeResult.remaining.text = message.text.substring(12);
+
+    decodeResult.formatted.description = 'OUT Report';
+
+    decodeResult.formatted.items = [
+      {
+        type: 'origin',
+        code: 'ORG',
+        label: 'Origin',
+        value: decodeResult.raw.origin,
+      },
+      {
+        type: 'destination',
+        code: 'DST',
+        label: 'Destination',
+        value: decodeResult.raw.destination,
+      },
+      {
+        type: 'gate_out',
+        code: 'GOUT',
+        label: 'Gate OUT',
+        value: decodeResult.raw.gate_out,
+      }
+    ];
+
+    decodeResult.decoded = true;
+    if(decodeResult.remaining.text === "") 
+	decodeResult.decoder.decodeLevel = 'full';
+    else
+	decodeResult.decoder.decodeLevel = 'partial';
+
+    return decodeResult;
+  }
+}
+
+export default {};

package/src/plugins/Label_QQ.ts

@@ -0,0 +1,54 @@
+import { DecoderPlugin } from '../DecoderPlugin';
+
+export class Label_QQ extends DecoderPlugin {
+  name = 'label-qq';
+
+  qualifiers() { // eslint-disable-line class-methods-use-this
+    return {
+      labels: ['QQ'],
+    };
+  }
+
+  decode(message: any, options: any = {}) : any {
+    const decodeResult: any = this.defaultResult;
+    decodeResult.decoder.name = this.name;
+    
+    decodeResult.raw.origin = message.text.substring(0, 4);
+    decodeResult.raw.destination = message.text.substring(4, 8);
+    decodeResult.raw.wheels_off = message.text.substring(8, 12);
+    decodeResult.remaining.text = message.text.substring(12);
+
+    decodeResult.formatted.description = 'OFF Report';
+
+    decodeResult.formatted.items = [
+      {
+        type: 'origin',
+        code: 'ORG',
+        label: 'Origin',
+        value: decodeResult.raw.origin,
+      },
+      {
+        type: 'destination',
+        code: 'DST',
+        label: 'Destination',
+        value: decodeResult.raw.destination,
+      },
+      {
+        type: 'wheels_off',
+        code: 'WOFF',
+        label: 'Wheels OFF',
+        value: decodeResult.raw.wheels_off,
+      }
+    ];
+
+    decodeResult.decoded = true;
+    if(decodeResult.remaining.text === "") 
+	decodeResult.decoder.decodeLevel = 'full';
+    else
+	decodeResult.decoder.decodeLevel = 'partial';
+
+    return decodeResult;
+  }
+}
+
+export default {};

package/src/plugins/Label_QR.ts

@@ -0,0 +1,54 @@
+import { DecoderPlugin } from '../DecoderPlugin';
+
+export class Label_QR extends DecoderPlugin {
+  name = 'label-qr';
+
+  qualifiers() { // eslint-disable-line class-methods-use-this
+    return {
+      labels: ['QR'],
+    };
+  }
+
+  decode(message: any, options: any = {}) : any {
+    const decodeResult: any = this.defaultResult;
+    decodeResult.decoder.name = this.name;
+    
+    decodeResult.raw.origin = message.text.substring(0, 4);
+    decodeResult.raw.destination = message.text.substring(4, 8);
+    decodeResult.raw.wheels_on = message.text.substring(8, 12);
+    decodeResult.remaining.text = message.text.substring(12);
+
+    decodeResult.formatted.description = 'ON Report';
+
+    decodeResult.formatted.items = [
+      {
+        type: 'origin',
+        code: 'ORG',
+        label: 'Origin',
+        value: decodeResult.raw.origin,
+      },
+      {
+        type: 'destination',
+        code: 'DST',
+        label: 'Destination',
+        value: decodeResult.raw.destination,
+      },
+      {
+        type: 'wheels_on',
+        code: 'WON',
+        label: 'Wheels ON',
+        value: decodeResult.raw.wheels_on,
+      }
+    ];
+
+    decodeResult.decoded = true;
+    if(decodeResult.remaining.text === "") 
+	decodeResult.decoder.decodeLevel = 'full';
+    else
+	decodeResult.decoder.decodeLevel = 'partial';
+
+    return decodeResult;
+  }
+}
+
+export default {};

package/src/plugins/Label_QS.ts

@@ -0,0 +1,54 @@
+import { DecoderPlugin } from '../DecoderPlugin';
+
+export class Label_QS extends DecoderPlugin {
+  name = 'label-qs';
+
+  qualifiers() { // eslint-disable-line class-methods-use-this
+    return {
+      labels: ['QS'],
+    };
+  }
+
+  decode(message: any, options: any = {}) : any {
+    const decodeResult: any = this.defaultResult;
+    decodeResult.decoder.name = this.name;
+    
+    decodeResult.raw.origin = message.text.substring(0, 4);
+    decodeResult.raw.destination = message.text.substring(4, 8);
+    decodeResult.raw.gate_in = message.text.substring(8, 12);
+    decodeResult.remaining.text = message.text.substring(12);
+
+    decodeResult.formatted.description = 'IN Report';
+
+    decodeResult.formatted.items = [
+      {
+        type: 'origin',
+        code: 'ORG',
+        label: 'Origin',
+        value: decodeResult.raw.origin,
+      },
+      {
+        type: 'destination',
+        code: 'DST',
+        label: 'Destination',
+        value: decodeResult.raw.destination,
+      },
+      {
+        type: 'gate_in',
+        code: 'GIN',
+        label: 'Gate IN',
+        value: decodeResult.raw.gate_in,
+      }
+    ];
+
+    decodeResult.decoded = true;
+    if(decodeResult.remaining.text === "") 
+	decodeResult.decoder.decodeLevel = 'full';
+    else
+	decodeResult.decoder.decodeLevel = 'partial';
+
+    return decodeResult;
+  }
+}
+
+export default {};

package/src/plugins/Label_SQ.ts

@@ -0,0 +1,111 @@
+import { DecoderPlugin } from '../DecoderPlugin';
+
+export class Label_SQ extends DecoderPlugin {
+  name = 'label-sq';
+
+  qualifiers() { // eslint-disable-line class-methods-use-this
+    return {
+      labels: ['SQ'],
+    };
+  }
+
+  decode(message: any, options: any = {}) : any {
+    const decodeResult: any = this.defaultResult;
+    decodeResult.decoder.name = this.name;
+
+    decodeResult.raw.preamble = message.text.substring(0, 4);
+    decodeResult.raw.version = message.text.substring(1, 2);
+    decodeResult.raw.network = message.text.substring(3, 4);
+
+    if (decodeResult.raw.version === '2') {
+      const regex = /0(\d)X(?<org>\w)(?<iata>\w\w\w)(?<icao>\w\w\w\w)(?<station>\d)(?<lat>\d+)(?<latd>[NS])(?<lng>\d+)(?<lngd>[EW])V(?<vfreq>\d+)\/.*/;
+      const result = message.text.match(regex);
+
+      if (result && result.length >= 8) {
+        decodeResult.raw.groundStation = {
+          number: result.groups.station,
+          iataCode: result.groups.iata,
+          icaoCode: result.groups.icao,
+          coordinates: {
+            latitude: (Number(result.groups.lat) / 100) * (result.groups.latd === 'S' ? -1 : 1),
+            longitude: (Number(result.groups.lng) / 100) * (result.groups.lngd === 'W' ? -1 : 1)
+          }
+        }
+        decodeResult.raw.vdlFrequency = result.groups.vfreq / 1000.0;
+      }
+    }
+
+    decodeResult.formatted.description = 'Ground Station Squitter';
+
+    var formattedNetwork = 'Unknown';
+    if (decodeResult.raw.network == 'A') {
+      formattedNetwork = 'ARINC';
+    } else if (decodeResult.raw.network == 'S') {
+      formattedNetwork = 'SITA';
+    }
+    decodeResult.formatted.items = [
+      {
+        type: 'network',
+        label: 'Network',
+        value: formattedNetwork,
+      },
+      {
+        type: 'version',
+        label: 'Version',
+        value: decodeResult.raw.version,
+      }
+    ];
+
+    if (decodeResult.raw.groundStation) {
+      if (decodeResult.raw.groundStation.icaoCode && decodeResult.raw.groundStation.number) {
+        decodeResult.formatted.items.push({
+          type: 'ground_station',
+          label: 'Ground Station',
+          value: `${decodeResult.raw.groundStation.icaoCode}${decodeResult.raw.groundStation.number}`,
+        });
+      }
+      if (decodeResult.raw.groundStation.iataCode) {
+        decodeResult.formatted.items.push({
+          type: 'iataCode',
+          label: 'IATA',
+          value: decodeResult.raw.groundStation.iataCode,
+        });
+      }
+      if (decodeResult.raw.groundStation.icaoCode) {
+        decodeResult.formatted.items.push({
+          type: 'icaoCode',
+          label: 'ICAO',
+          value: decodeResult.raw.groundStation.icaoCode,
+        });
+      }
+      if (decodeResult.raw.groundStation.coordinates.latitude) {
+        decodeResult.formatted.items.push({
+          type: 'coordinates',
+          label: 'Ground Station Location',
+          value: `${decodeResult.raw.groundStation.coordinates.latitude}, ${decodeResult.raw.groundStation.coordinates.longitude}`,
+        });
+      }
+      if (decodeResult.raw.groundStation.airport) {
+        decodeResult.formatted.items.push({
+          type: 'airport',
+          label: 'Airport',
+          value: `${decodeResult.raw.groundStation.airport.name} (${decodeResult.raw.groundStation.airport.icao}) in ${decodeResult.raw.groundStation.airport.location}`,
+        });
+      }
+    }
+
+    if (decodeResult.raw.vdlFrequency) {
+      decodeResult.formatted.items.push({
+        type: 'vdlFrequency',
+        label: 'VDL Frequency',
+        value: `${decodeResult.raw.vdlFrequency} MHz`
+      });
+    }
+    decodeResult.decoded = true;
+    decodeResult.decoder.decodeLevel = 'full';
+
+    return decodeResult;
+  }
+}
+
+export default {};

package/src/plugins/official.ts

@@ -0,0 +1,22 @@
+export * from './Label_5Z';
+export * from './Label_15';
+export * from './Label_16_N_Space';
+export * from './Label_20_POS';
+export * from './Label_30_Slash_EA';
+export * from './Label_44_ETA';
+export * from './Label_44_IN';
+export * from './Label_44_OFF';
+export * from './Label_44_ON';
+export * from './Label_44_POS';
+export * from './Label_80';
+export * from './Label_8E';
+export * from './Label_B6';
+export * from './Label_ColonComma';
+export * from './Label_H1_M1BPOS';
+export * from './Label_H1_M1BPRG';
+export * from './Label_1M_Slash';
+export * from './Label_SQ';
+export * from './Label_QR';
+export * from './Label_QP';
+export * from './Label_QS';
+export * from './Label_QQ';

package/tsconfig.json

@@ -3,12 +3,11 @@
     "target": "esNext",
     "module": "commonjs",
     "declaration": true,
-    "outDir": "./dist",
+    "outDir": "dist",
     "strict": true
   },
   "include": [
-    "lib/*.ts",
-    "lib/**/*.ts",
+    "src",
   ],
   "exclude": [
     "node_modules"

package/index.d.ts

@@ -1,17 +0,0 @@
-import { MessageDecoder } from './lib/MessageDecoder';
-declare namespace AcarsDecoder {
-  interface DecoderPlugin {
-    decode: (data: string) => string;
-    coordinateString: (coords: any) => string;
-  }
-
-  interface MessageDecoder {
-    constructor(): MessageDecoder;
-    registerPlugin(plugin: DecoderPlugin): boolean;
-    decode: (data: string, options: any) => string;
-    lookupAirportByIata: (iata: string) => string;
-    name: string;
-    plugins: Array<DecoderPlugin>;
-    debug: boolean;
-  }
-}

package/index.ts

@@ -1,4 +0,0 @@
-export * from './lib/DateTimeUtils';
-export * from './lib/DecoderPlugin';
-export * from './lib/IcaoDecoder';
-export * from './lib/MessageDecoder';