@airframes/acars-decoder 1.8.11 → 1.8.12

package/dist/index.js

@@ -441,15 +441,6 @@ var ResultFormatter = class {
       value: `${from} -> ${to}`
     });
   }
-  static freetext(decodeResult, value) {
-    decodeResult.raw.freetext = value;
-    decodeResult.formatted.items.push({
-      type: "freetext",
-      code: "FREE_TEXT",
-      label: "Free Text",
-      value
-    });
-  }
   static door_event(decodeResult, name, state) {
     decodeResult.raw.door_event = {
       door: name,
@@ -966,6 +957,24 @@ var ResultFormatter = class {
       value: DateTimeUtils.timestampToString(value, "epoch")
     });
   }
+  static sequenceNumber(decodeResult, value) {
+    decodeResult.raw.sequence_number = value;
+    decodeResult.formatted.items.push({
+      type: "sequence",
+      code: "SEQ",
+      label: "Sequence Number",
+      value: decodeResult.raw.sequence_number
+    });
+  }
+  static sequenceResponse(decodeResult, value) {
+    decodeResult.raw.sequence_response = value;
+    decodeResult.formatted.items.push({
+      type: "sequence",
+      code: "SEQ_RESP",
+      label: "Sequence Response",
+      value: decodeResult.raw.sequence_response
+    });
+  }
   static unknown(decodeResult, value, sep = ",") {
     if (!decodeResult.remaining.text) decodeResult.remaining.text = value;
     else decodeResult.remaining.text += sep + value;
@@ -3012,8 +3021,9 @@ var FlightPlanUtils = class _FlightPlanUtils {
   /**
    * Processes flight plan data
    *
-   * Expected format is [header, key1, val1, ... keyN, valN]
+   * Expected format is [header, fpei, val1, ... fpeiN, valN]
    *
+   * @see https://atlaske-content.garmin.com/filestorage//email/outbound/attachments/GTN_Flight_Plan_and_User_Waypoint_transfer_Time1712844670119.pdf
    * @param decodeResult - results
    * @param data - original message split by ':'
    * @returns whether all fields were processed or not
@@ -3021,9 +3031,9 @@ var FlightPlanUtils = class _FlightPlanUtils {
   static processFlightPlan(decodeResult, data) {
     let allKnownFields = _FlightPlanUtils.parseHeader(decodeResult, data[0]);
     for (let i = 1; i < data.length; i += 2) {
-      const key = data[i];
+      const fpei = data[i];
       const value = data[i + 1];
-      switch (key) {
+      switch (fpei) {
         case "A":
           _FlightPlanUtils.addProcedure(decodeResult, value, "arrival");
           break;
@@ -3058,7 +3068,7 @@ var FlightPlanUtils = class _FlightPlanUtils {
             decodeResult.remaining.text = "";
             allKnownFields = false;
           }
-          decodeResult.remaining.text += `:${key}:${value}`;
+          decodeResult.remaining.text += `:${fpei}:${value}`;
           decodeResult.decoder.decodeLevel = "partial";
       }
     }
@@ -3394,7 +3404,7 @@ var Label_4A_DIS = class extends DecoderPlugin {
       DateTimeUtils.convertHHMMSSToTod(fields[1].substring(2) + "00")
     );
     ResultFormatter.callsign(decodeResult, fields[2]);
-    ResultFormatter.freetext(decodeResult, fields.slice(3).join(""));
+    ResultFormatter.text(decodeResult, fields.slice(3).join(""));
     if (decodeResult.decoded) {
       if (!decodeResult.remaining.text)
         decodeResult.decoder.decodeLevel = "full";
@@ -4012,9 +4022,22 @@ var Label_ColonComma = class extends DecoderPlugin {
   }
 };
 
-// lib/utils/h1_helper.ts
-var H1Helper = class _H1Helper {
+// lib/utils/arinc_702_helper.ts
+var Arinc702Helper = class _Arinc702Helper {
+  /**
+   * Decodes an  ARINC 702 message
+   *
+   * Steps:
+   * 1. Check against known checksum algorithms to determine if message is valid
+   * 2. Parse the Imbedded Message Identifier (IMI) to determine the type of message
+   * 3. Iterate through the Information Elements (IEI) and decode known fields, while storing unknown fields for further analysis
+   *
+   * @param decodeResult - object to store decoded results in
+   * @param message - message to decode
+   * @returns boolean indicating if the message was successfully decoded
+   */
   static decodeH1Message(decodeResult, message) {
+    decodeResult.remaining.text = "";
     const checksum = parseInt(message.slice(-4), 16);
     const data = message.slice(0, message.length - 4);
     let checksumAlgorithmUsed = "";
@@ -4035,9 +4058,9 @@ var H1Helper = class _H1Helper {
       return false;
     }
     for (let i = 1; i < fields.length; ++i) {
-      const key = fields[i].substring(0, 2);
+      const iei = fields[i].substring(0, 2);
       const data2 = fields[i].substring(2);
-      switch (key) {
+      switch (iei) {
         case "AF":
           processAirField(decodeResult, data2.split(","));
           break;
@@ -4072,7 +4095,7 @@ var H1Helper = class _H1Helper {
           decodeResult.raw.flight_number = data2;
           break;
         case "FX":
-          ResultFormatter.freetext(decodeResult, data2);
+          ResultFormatter.text(decodeResult, data2);
           break;
         case "GA":
           ResultFormatter.groundAddress(decodeResult, data2);
@@ -4083,11 +4106,18 @@ var H1Helper = class _H1Helper {
         case "LR":
           processLandingReport(decodeResult, data2.split(","));
           break;
+        case "MR":
+          processMessageReference(decodeResult, data2.split(","));
+          break;
         case "PR":
-          ResultFormatter.unknown(decodeResult, fields[i], "/");
+          processPerformanceData(decodeResult, data2.split(","));
           break;
+        //case 'PR':
+        // TODO: decode /PR fields
+        // ResultFormatter.unknown(decodeResult, fields[i], '/');
+        // break;
         case "PS":
-          _H1Helper.processPS(decodeResult, data2.split(","));
+          _Arinc702Helper.processPS(decodeResult, data2.split(","));
           break;
         case "RF":
         case "RI":
@@ -4112,7 +4142,7 @@ var H1Helper = class _H1Helper {
           processTimeOfDeparture(decodeResult, data2.split(","));
           break;
         case "TS":
-          _H1Helper.processTimeStamp(decodeResult, data2.split(","));
+          _Arinc702Helper.processTimeStamp(decodeResult, data2.split(","));
           break;
         case "VR":
           ResultFormatter.version(decodeResult, parseInt(data2, 10) / 10);
@@ -4124,6 +4154,8 @@ var H1Helper = class _H1Helper {
           processWeatherQuery(decodeResult, data2.split(":"));
           break;
         default:
+          console.log(`Unknown IEI ${iei} in H1 message, data: ${data2}`);
+          console.log(`Remaing text: ${decodeResult.remaining.text}`);
           ResultFormatter.unknown(decodeResult, fields[i], "/");
       }
     }
@@ -4214,14 +4246,14 @@ function processAirField(decodeResult, data) {
 }
 function processTimeOfDeparture(decodeResult, data) {
   if (data.length === 2) {
-    decodeResult.raw.plannedDepartureTime = data[0];
+    decodeResult.raw.planned_departure_time = data[0];
     decodeResult.formatted.items.push({
       type: "ptd",
       code: "ptd",
       label: "Planned Departure Time",
       value: `YYYY-MM-${data[0].substring(0, 2)}T${data[0].substring(2, 4)}:${data[0].substring(4)}:00Z`
     });
-    decodeResult.raw.plannedDepartureTime = data[1];
+    decodeResult.raw.estimated_departure_time = data[1];
     decodeResult.formatted.items.push({
       type: "etd",
       code: "etd",
@@ -4314,12 +4346,15 @@ function parseMessageType(decodeResult, messagePart) {
   const messageParts = messagePart.split(",");
   const messageType = messageParts[0];
   if (messageType.startsWith("POS")) {
-    H1Helper.processPosition(decodeResult, messagePart.substring(3).split(","));
-    return processMessageType(decodeResult, "POS");
+    Arinc702Helper.processPosition(
+      decodeResult,
+      messagePart.substring(3).split(",")
+    );
+    return processIMI(decodeResult, "POS");
   } else if (messageType.length === 6) {
-    const part1 = processMessageType(decodeResult, messageType.substring(0, 3));
+    const part1 = processIMI(decodeResult, messageType.substring(0, 3));
     const description = decodeResult.formatted.description;
-    const part2 = processMessageType(decodeResult, messageType.substring(3, 6));
+    const part2 = processIMI(decodeResult, messageType.substring(3, 6));
     decodeResult.formatted.description = description + " for " + decodeResult.formatted.description;
     if (messageParts.length > 1) {
       ResultFormatter.unknown(
@@ -4333,9 +4368,9 @@ function parseMessageType(decodeResult, messagePart) {
   if (messageParts.length > 1) {
     ResultFormatter.unknown(decodeResult, messageParts.slice(1).join(","), "/");
   }
-  return processMessageType(decodeResult, messageType);
+  return processIMI(decodeResult, messageType);
 }
-function processMessageType(decodeResult, type) {
+function processIMI(decodeResult, type) {
   if (type === "FPN") {
     decodeResult.formatted.description = "Flight Plan";
   } else if (type === "FTX") {
@@ -4362,12 +4397,42 @@ function processMessageType(decodeResult, type) {
     decodeResult.formatted.description = "Request";
   } else if (type === "RES") {
     decodeResult.formatted.description = "Response";
+  } else if (type === "SUM") {
+    decodeResult.formatted.description = "Summary Report";
   } else {
     decodeResult.formatted.description = "Unknown H1 Message";
     return false;
   }
   return true;
 }
+function processPerformanceData(decodeResult, data) {
+  if (data.length < 3) {
+    ResultFormatter.unknownArr(decodeResult, data, ",");
+    return;
+  }
+  if (data[2] !== void 0 && data[2] !== "") {
+    const alt = Number(data[2]) * 100;
+    if (!isNaN(alt) && alt > 0) {
+      ResultFormatter.altitude(decodeResult, alt);
+    }
+  }
+  if (data.length > 8 && data[8] !== void 0 && data[8] !== "") {
+    ResultFormatter.temperature(decodeResult, data[8]);
+  }
+  const remaining = [];
+  for (let i = 0; i < data.length; i++) {
+    if (i === 2 && data[i] !== "" && !isNaN(Number(data[i])) && Number(data[i]) * 100 > 0) {
+      continue;
+    }
+    if (i === 8 && data[i] !== "" && (data[i].startsWith("M") || data[i].startsWith("P") || !isNaN(Number(data[i])))) {
+      continue;
+    }
+    remaining.push(data[i]);
+  }
+  if (remaining.length > 0 && remaining.some((r) => r !== "")) {
+    ResultFormatter.unknown(decodeResult, remaining.join(","), "/PR");
+  }
+}
 function processDateCode(decodeResult, data) {
   if (data.length === 1) {
   } else if (data.length === 2) {
@@ -4490,13 +4555,23 @@ function crc16Genibus(data) {
   }
   return (crc ^ 65535) & 65535;
 }
+function processMessageReference(decodeResult, data) {
+  if (data.length !== 2) {
+    ResultFormatter.unknown(decodeResult, data.join(","), "/MR");
+    return;
+  }
+  ResultFormatter.sequenceNumber(decodeResult, parseInt(data[0], 10));
+  if (data[1] !== "") {
+    ResultFormatter.sequenceResponse(decodeResult, parseInt(data[1], 10));
+  }
+}
 
-// lib/plugins/Label_H1.ts
-var Label_H1 = class extends DecoderPlugin {
-  name = "label-h1";
+// lib/plugins/ARINC_702.ts
+var Arinc702 = class extends DecoderPlugin {
+  name = "arinc-702";
   qualifiers() {
     return {
-      labels: ["1J", "2J", "2P", "4J", "80", "H1"]
+      labels: ["*"]
     };
   }
   decode(message, options = {}) {
@@ -4505,13 +4580,13 @@ var Label_H1 = class extends DecoderPlugin {
     decodeResult.message = message;
     const msg = message.text.replace(/\n|\r/g, "");
     let decoded = false;
-    decoded = H1Helper.decodeH1Message(decodeResult, msg);
+    decoded = Arinc702Helper.decodeH1Message(decodeResult, msg);
     if (decoded) {
       return this.processDecodeResult(decodeResult, decoded, options, message);
     }
     if (msg.startsWith("/")) {
       const headerData = msg.split(".");
-      decoded = H1Helper.decodeH1Message(
+      decoded = Arinc702Helper.decodeH1Message(
         decodeResult,
         headerData.slice(1).join(".")
       );
@@ -4528,7 +4603,7 @@ var Label_H1 = class extends DecoderPlugin {
     const hashParts = msg.split("#");
     if (hashParts.length == 2) {
       const offset = hashParts[0] === "- " || isNaN(parseInt(hashParts[1][1])) ? 3 : 4;
-      decoded = H1Helper.decodeH1Message(
+      decoded = Arinc702Helper.decodeH1Message(
         decodeResult,
         msg.slice(hashParts[0].length + offset)
       );
@@ -4547,7 +4622,7 @@ var Label_H1 = class extends DecoderPlugin {
     }
     const slashParts = msg.split("/");
     if (slashParts[0].length > 3) {
-      decoded = H1Helper.decodeH1Message(
+      decoded = Arinc702Helper.decodeH1Message(
         decodeResult,
         msg.slice(slashParts[0].length - 3)
       );
@@ -6174,6 +6249,7 @@ var MessageDecoder = class {
     this.plugins = [];
     this.debug = false;
     this.registerPlugin(new CBand(this));
+    this.registerPlugin(new Arinc702(this));
     this.registerPlugin(new Label_ColonComma(this));
     this.registerPlugin(new Label_5Z_Slash(this));
     this.registerPlugin(new Label_10_LDR(this));
@@ -6221,7 +6297,6 @@ var MessageDecoder = class {
     this.registerPlugin(new Label_H1_OHMA(this));
     this.registerPlugin(new Label_H1_Paren(this));
     this.registerPlugin(new Label_H1_WRN(this));
-    this.registerPlugin(new Label_H1(this));
     this.registerPlugin(new Label_H1_StarPOS(this));
     this.registerPlugin(new Label_HX(this));
     this.registerPlugin(new Label_58(this));