adding H1 PRG and #M1BPRG parsing

lib/plugins/Label_H1_PRG.test.ts

@@ -0,0 +1,147 @@
+import { MessageDecoder } from '../MessageDecoder';
+import { Label_H1_PRG } from './Label_H1_PRG';
+
+
+test('Label H1 Preamble PRG decoder has right qualifiers', () => {
+  const decoder = new MessageDecoder();
+  const decoderPlugin = new Label_H1_PRG(decoder);
+
+  expect(decoderPlugin.decode).toBeDefined();
+  expect(decoderPlugin.name).toBe('label-h1-prg');
+  expect(decoderPlugin.qualifiers).toBeDefined();
+  expect(decoderPlugin.qualifiers()).toEqual({
+    labels: ['H1'],
+    preambles: ['PRG', '#M1BPRG'],
+  });
+});
+
+test('decodes Label H1 Preamble PRG message', () => {
+  const decoder = new MessageDecoder();
+  const decoderPlugin = new Label_H1_PRG(decoder);
+
+  // https://app.airframes.io/messages/2400672008
+  const text = 'PRG/FNEXS67TP/DTEGPF,23O,67,214405,298262';
+  const decodeResult = decoderPlugin.decode({ text: text });
+  console.log(JSON.stringify(decodeResult, null, 2));
+
+  expect(decodeResult.decoded).toBe(true);
+  expect(decodeResult.decoder.decodeLevel).toBe('full');
+  expect(decodeResult.decoder.name).toBe('label-h1-prg');
+  expect(decodeResult.raw.flight_number).toBe('EXS67TP');
+  expect(decodeResult.formatted.description).toBe('Progress Report');
+  expect(decodeResult.formatted.items.length).toBe(6);
+  expect(decodeResult.formatted.items[0].label).toBe('Destination');
+  expect(decodeResult.formatted.items[0].value).toBe('EGPF');
+  expect(decodeResult.formatted.items[1].label).toBe('Runway');
+  expect(decodeResult.formatted.items[1].value).toBe('23O');
+  expect(decodeResult.formatted.items[2].label).toBe('Fuel On Board');
+  expect(decodeResult.formatted.items[2].value).toBe('67');
+  expect(decodeResult.formatted.items[3].label).toBe('Estimated Time of Arrival');
+  expect(decodeResult.formatted.items[3].value).toBe('21:44:05');
+  expect(decodeResult.formatted.items[4].label).toBe('Fuel Remaining');
+  expect(decodeResult.formatted.items[4].value).toBe('29');
+  expect(decodeResult.formatted.items[5].label).toBe('Message Checksum');
+  expect(decodeResult.formatted.items[5].value).toBe('0x8262');
+});
+
+test('decodes Label H1 Preamble PRG/LR', () => {
+  const decoder = new MessageDecoder();
+  const decoderPlugin = new Label_H1_PRG(decoder);
+
+  // https://app.airframes.io/messages/2400672684
+  const text = 'PRG/LR,000855,SWA786,KBWI,KBOS,04R,25,1285,1192,93,1284,P4,001004,8,141K,D713,000950,2,291483';
+  const decodeResult = decoderPlugin.decode({ text: text });
+  console.log(JSON.stringify(decodeResult, null, 2));
+
+  expect(decodeResult.decoded).toBe(true);
+  expect(decodeResult.decoder.decodeLevel).toBe('partial');
+  expect(decodeResult.decoder.name).toBe('label-h1-prg');
+  expect(decodeResult.raw.flight_number).toBe('SWA786');
+  expect(decodeResult.formatted.description).toBe('Progress Report');
+  expect(decodeResult.formatted.items.length).toBe(4);
+  expect(decodeResult.formatted.items[0].label).toBe('Origin');
+  expect(decodeResult.formatted.items[0].value).toBe('KBWI');
+  expect(decodeResult.formatted.items[1].label).toBe('Destination');
+  expect(decodeResult.formatted.items[1].value).toBe('KBOS');
+  expect(decodeResult.formatted.items[2].label).toBe('Runway');
+  expect(decodeResult.formatted.items[2].value).toBe('04R');
+  expect(decodeResult.formatted.items[3].label).toBe('Message Checksum');
+  expect(decodeResult.formatted.items[3].value).toBe('0x1483');
+  expect(decodeResult.remaining.text).toBe('/LR,000855,25,1285,1192,93,1284,P4,001004,8,141K,D713,000950,2,29');
+});
+
+// TODO - figure out comma in the timestamp
+xtest('decodes Label H1 Preamble #M1BPRG', () => {
+  const decoder = new MessageDecoder();
+  const decoderPlugin = new Label_H1_PRG(decoder);
+
+  // https://app.airframes.io/messages/2403492320
+  const text = '#M1BPRG/DTEKCH,22L,69,141204,042/FNSAS87W/TS132645,2402246784';
+  const decodeResult = decoderPlugin.decode({ text: text });
+  console.log(JSON.stringify(decodeResult, null, 2));
+
+  expect(decodeResult.decoded).toBe(true);
+  expect(decodeResult.decoder.decodeLevel).toBe('full');
+  expect(decodeResult.decoder.name).toBe('label-h1-prg');
+  expect(decodeResult.raw.flight_number).toBe('SAS87W');
+  expect(decodeResult.raw.message_timestamp).toBe(1708781205);
+  expect(decodeResult.formatted.description).toBe('Progress Report');
+  expect(decodeResult.formatted.items.length).toBe(6);
+  expect(decodeResult.formatted.items[0].label).toBe('Destination');
+  expect(decodeResult.formatted.items[0].value).toBe('EKCH');
+  expect(decodeResult.formatted.items[1].label).toBe('Runway');
+  expect(decodeResult.formatted.items[1].value).toBe('22L');
+  expect(decodeResult.formatted.items[2].label).toBe('Fuel On Board');
+  expect(decodeResult.formatted.items[2].value).toBe('69');
+  expect(decodeResult.formatted.items[3].label).toBe('Estimated Time of Arrival');
+  expect(decodeResult.formatted.items[3].value).toBe('14:12:04');
+  expect(decodeResult.formatted.items[4].label).toBe('Fuel Remaining');
+  expect(decodeResult.formatted.items[4].value).toBe('42');
+  expect(decodeResult.formatted.items[5].label).toBe('Message Checksum');
+  expect(decodeResult.formatted.items[5].value).toBe('0x6784');});
+
+// TODO - figure out how to handle commas in the flightplan
+xtest('decodes Label H1 PRG with flightplan', () => {
+  const decoder = new MessageDecoder();
+  const decoderPlugin = new Label_H1_PRG(decoder);
+
+  // https://app.airframes.io/messages/2403398879
+  const text = 'PRG/DTGCRR,03O,62,163055/PR1544,286,350,239,,0,66,,,50,,,P19,P0,27440,,1305,303/RP:DA:EDDB:AA:GCRR..N50059E004552..N49588E004338..N49241E002528..N49122E002199..PON.UN872..ERIGA..FUJTI:WS:FUJTI,360..BAKUP..BATAX..TAKAV..VEDOD:A:TERT1P:AP:ILSZ03.BAPAL(03O)226D';
+  const decodeResult = decoderPlugin.decode({ text: text });
+  console.log(JSON.stringify(decodeResult, null, 2));
+
+  expect(decodeResult.decoded).toBe(true);
+  expect(decodeResult.decoder.decodeLevel).toBe('partial');
+  expect(decodeResult.decoder.name).toBe('label-h1-prg');
+  expect(decodeResult.formatted.description).toBe('Progress Report');
+  expect(decodeResult.formatted.items.length).toBe(7);
+  expect(decodeResult.formatted.items[0].label).toBe('Destination');
+  expect(decodeResult.formatted.items[0].value).toBe('GCRR');
+  expect(decodeResult.formatted.items[1].label).toBe('Runway');
+  expect(decodeResult.formatted.items[1].value).toBe('030');
+  expect(decodeResult.formatted.items[2].label).toBe('Route Status');
+  expect(decodeResult.formatted.items[2].value).toBe('Route Planned');
+  expect(decodeResult.formatted.items[3].label).toBe('Origin');
+  expect(decodeResult.formatted.items[3].value).toBe('EDDB');
+  expect(decodeResult.formatted.items[4].label).toBe('Arrival Procedure');
+  expect(decodeResult.formatted.items[4].value).toBe('TERT1P');
+  expect(decodeResult.formatted.items[5].label).toBe('Approach Procedure');
+  expect(decodeResult.formatted.items[5].value).toBe('ILSZ03 starting at BAPAL(03O)');
+  expect(decodeResult.formatted.items[6].label).toBe('Message Checksum');
+  expect(decodeResult.formatted.items[6].value).toBe('0x226d');
+  expect(decodeResult.remaining.text).toBe('<a lot of text>');
+});
+
+test('decodes Label H1 Preamble PRG <invalid>', () => {
+  const decoder = new MessageDecoder();
+  const decoderPlugin = new Label_H1_PRG(decoder);
+  const text = 'PRG Bogus message';
+  const decodeResult = decoderPlugin.decode({ text: text });
+  console.log(JSON.stringify(decodeResult, null, 2));
+
+  expect(decodeResult.decoded).toBe(false);
+  expect(decodeResult.decoder.decodeLevel).toBe('none');
+  expect(decodeResult.decoder.name).toBe('label-h1-prg');
+  expect(decodeResult.formatted.description).toBe('Progress Report');
+  expect(decodeResult.formatted.items.length).toBe(0); 
+});

lib/plugins/Label_H1_PRG.ts

@@ -0,0 +1,181 @@
+import { DateTimeUtils } from '../DateTimeUtils';
+import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
+import { FlightPlanUtils } from '../utils/flight_plan_utils';
+
+export class Label_H1_PRG extends DecoderPlugin { // eslint-disable-line camelcase
+  name = 'label-h1-prg';
+
+  qualifiers() { // eslint-disable-line class-methods-use-this
+    return {
+      labels: ['H1'],
+      preambles: ['PRG', '#M1BPRG'],
+    };
+  }
+
+  // https://acars-vdl2.groups.io/g/main/topic/decoding_last_part_of_prg/28964299
+  decode(message: Message, options: Options = {}) : DecodeResult {
+    const decodeResult: any = this.defaultResult;
+    decodeResult.decoder.name = this.name;
+    decodeResult.formatted.description = 'Progress Report';
+    decodeResult.message = message;
+    decodeResult.remaining.text = '';
+
+    // console.log('DECODER: H1 #M1BPRG detected');
+    const checksum = message.text.slice(-4);
+    //strip POS and checksum
+    const data = message.text.substring(3, message.text.length-4);
+    const fields = data.split(',');
+    if(fields.length === 5) {
+      const allKnownFields = parseHeader(decodeResult, fields[0]);
+      processRunway(decodeResult, fields[1]);
+      processCurrentFuel(decodeResult, fields[2]);
+      processETA(decodeResult, fields[3]);
+      processRemainingFuel(decodeResult, fields[4]);
+      addChecksum(decodeResult, checksum);
+
+      decodeResult.decoded = true;
+      decodeResult.decoder.decodeLevel = allKnownFields ? 'full' : 'partial';
+    } else if(fields.length === 6) {
+      const allKnownFields = parseHeader(decodeResult, fields[0]);
+      processRunway(decodeResult, fields[1]);
+      processCurrentFuel(decodeResult, fields[2]);
+      processETA(decodeResult, fields[3]);
+      processRemainingFuel(decodeResult, fields[4]);
+      addChecksum(decodeResult, checksum);
+
+      decodeResult.decoded = true;
+      decodeResult.decoder.decodeLevel = allKnownFields ? 'full' : 'partial';
+    } else if(fields.length === 19) {
+      const allKnownFields = parseHeader(decodeResult, fields[0]);
+      processUnknown(decodeResult, fields[1]);
+      processFlightNumber(decodeResult, fields[2]);
+      processDeptApt(decodeResult, fields[3]);
+      processArrvApt(decodeResult, fields[4]);
+      processRunway(decodeResult, fields[5]);
+      processUnknown(decodeResult, fields.slice(6, 19).join(','));
+      addChecksum(decodeResult, checksum);
+
+      decodeResult.decoded = true;
+      decodeResult.decoder.decodeLevel = 'partial';
+    } else if(fields.length === 21) {
+      const allKnownFields = parseHeader(decodeResult, fields[0]);
+      processRunway(decodeResult, fields[1]);
+      processUnknown(decodeResult, fields.slice(2, 21).join(','));
+      FlightPlanUtils.processFlightPlan(decodeResult, fields[21].split(':'));
+      addChecksum(decodeResult, checksum);
+
+      decodeResult.decoded = true;
+      decodeResult.decoder.decodeLevel = 'partial';
+    } else {
+      // Unknown
+      if (options.debug) {
+        console.log(`Decoder: Unknown H1 message: ${message.text}`);
+      }
+      decodeResult.remaining.text = message.text;
+      decodeResult.decoded = false;
+      decodeResult.decoder.decodeLevel = 'none';
+    }
+
+    return decodeResult;
+  }
+}
+
+export default {};
+
+function parseHeader(decodeResult: DecodeResult, header: string): boolean {
+  let allKnownFields = true;
+  const fields = header.split('/');
+  // fields[0] is msg type - we already know this
+  for(let i=1; i<fields.length; ++i) {
+      if (fields[i].startsWith('FN')) {
+          decodeResult.raw.flight_number = fields[i].substring(2); // Strip off 'FN'
+      } else if (fields[i].startsWith('SN')) {
+          decodeResult.raw.serial_number = fields[i].substring(2); // Strip off 'SN'
+      }  else if (fields[i].startsWith('TS')) {
+        const ts = fields[i].substring(2).split(',');
+        decodeResult.raw.message_timestamp = DateTimeUtils.convertDateTimeToEpoch(ts[0],ts[1]);
+    }   else if (fields[i].startsWith('DT')) {
+      processArrvApt(decodeResult, fields[i].substring(2)) // Strip off 'DT'
+  } else {
+          decodeResult.remaining.text += '/' + fields[i];
+          allKnownFields = false
+      }
+  }
+  return allKnownFields;
+};
+
+function processFlightNumber(decodeResult: any, value: string) {
+  decodeResult.raw.flight_number = value;
+};
+
+function processDeptApt(decodeResult: any, value: string) {
+  decodeResult.raw.departure_icao = value;
+  decodeResult.formatted.items.push({
+    type: 'origin',
+    code: 'ORG',
+    label: 'Origin',
+    value: decodeResult.raw.departure_icao,
+  });
+};
+
+function processArrvApt(decodeResult: any, value: string) {
+  decodeResult.raw.arrival_icao = value;
+  decodeResult.formatted.items.push({
+    type: 'destination',
+    code: 'DST',
+    label: 'Destination',
+    value: decodeResult.raw.arrival_icao,
+  });
+};
+
+function processETA(decodeResult:DecodeResult, value: string) {
+  decodeResult.formatted.items.push({
+    type: 'eta',
+    code: 'ETA',
+    label: 'Estimated Time of Arrival',
+    value: value.substring(0,2) + ':' + value.substring(2,4) + ':' + value.substring(4,6),
+  });
+}
+
+function processRunway(decodeResult: any, value: string) {
+  decodeResult.raw.runway = value;
+  decodeResult.formatted.items.push({
+    type: 'runway',
+    label: 'Runway',
+    value: decodeResult.raw.runway,
+  });
+};
+
+
+function processCurrentFuel(decodeResult: any, value: string) {
+  decodeResult.raw.fuel_on_board = Number(value);
+  decodeResult.formatted.items.push({
+    type: 'fuel_on_board',
+    code: 'FOB',
+    label: 'Fuel On Board',
+    value: decodeResult.raw.fuel_on_board.toString(),
+  });
+};
+function processRemainingFuel(decodeResult: any, value: string) {
+  decodeResult.raw.fuel_remaining = Number(value);
+  decodeResult.formatted.items.push({
+    type: 'fuel_remaining',
+    label: 'Fuel Remaining',
+    value: decodeResult.raw.fuel_remaining.toString(),
+  });
+};
+
+
+function addChecksum(decodeResult: DecodeResult, value: string) {
+    decodeResult.raw.checksum = Number("0x"+value);
+    decodeResult.formatted.items.push({
+      type: 'message_checksum',
+      code: 'CHECKSUM',
+      label: 'Message Checksum',
+      value: '0x' + ('0000' + decodeResult.raw.checksum.toString(16)).slice(-4),
+    });    
+  }
+  function processUnknown(decodeResult: any, value: string) {
+    decodeResult.remaining.text += ',' + value;
+  }

lib/plugins/official.ts

@@ -17,7 +17,7 @@ export * from './Label_B6';
 export * from './Label_ColonComma';
 export * from './Label_H1_FPN';
 export * from './Label_H1_M1BPOS';
-export * from './Label_H1_M1BPRG';
+export * from './Label_H1_PRG';
 export * from './Label_H1_POS';
 export * from './Label_SQ';
 export * from './Label_QR';