@squawk/mode-s 0.1.0

package/dist/types/message.d.ts

@@ -0,0 +1,235 @@
+import type { AcasResolutionAdvisoryReport } from './acas.js';
+import type { CommBRegister } from './comm-b.js';
+import type { EmergencyState } from './emergency-status.js';
+import type { AircraftIdentification } from './identification.js';
+import type { AircraftOperationalStatus } from './operational-status.js';
+import type { TargetStateAndStatus } from './target-state-status.js';
+import type { AirborneVelocity } from './velocity.js';
+/**
+ * Where a DF17/18 extended squitter's address and data actually came from.
+ * DF17 is always `icaoDirect` - it carries no control field, and a DF17
+ * transponder is, by protocol definition, always ICAO-addressed and
+ * broadcasting its own state directly. For DF18, this is derived from the
+ * control field (CF):
+ * - `icaoDirect` (CF=0): ICAO-addressed, direct from the aircraft - same as DF17.
+ * - `anonymousDirect` (CF=1): a self-assigned or anonymous address (e.g. a
+ *   ground vehicle's ADS-B-out unit with no Mode-S allocation), direct from
+ *   the transmitting participant - `icaoHex` is not a registered ICAO address.
+ * - `icaoTisb` (CF=2): ICAO-addressed, but ground-station-derived (TIS-B,
+ *   fine format) rather than heard directly from the aircraft's own transponder.
+ * - `anonymousTisb` (CF=5): a ground-assigned track-file address (TIS-B, fine
+ *   format, non-ICAO) - `icaoHex` is not a registered ICAO address.
+ * - `adsr` (CF=6): ICAO-addressed, relayed from another data link (e.g. UAT)
+ *   by a ground station (ADS-B Rebroadcast).
+ */
+export type MessageSource = 'icaoDirect' | 'anonymousDirect' | 'icaoTisb' | 'anonymousTisb' | 'adsr';
+/** Fields common to every decoded DF17/18 extended squitter message. */
+export interface ExtendedSquitterCommon {
+    /**
+     * 24-bit hex address from the message's AA field. A real, registered ICAO
+     * Mode-S address when `messageSource` is `icaoDirect`/`icaoTisb`/`adsr` -
+     * an anonymous or ground-assigned identifier, not a registered ICAO
+     * address, when `messageSource` is `anonymousDirect`/`anonymousTisb`.
+     */
+    icaoHex: string;
+    /** Where this message's address and data actually came from - see {@link MessageSource}. */
+    messageSource: MessageSource;
+}
+/** A DF17/18 extended squitter airborne or surface position message. */
+export interface ExtendedSquitterPosition extends ExtendedSquitterCommon {
+    /** Discriminant tag identifying this as a decoded airborne or surface position message. */
+    kind: 'extendedSquitterPosition';
+    /** Whether this is a surface (on-ground) or airborne position message. */
+    surface: boolean;
+    /** Whether the CPR fields use the even or odd format. */
+    cprFormat: 'even' | 'odd';
+    /** Raw 17-bit CPR-encoded latitude field, or undefined for a type-code-0 airborne position message (no position information available - altitude may still be valid). */
+    latCpr: number | undefined;
+    /** Raw 17-bit CPR-encoded longitude field, or undefined for a type-code-0 airborne position message (no position information available - altitude may still be valid). */
+    lonCpr: number | undefined;
+    /** Decoded altitude in feet. Always undefined for a surface position - surface messages carry ground movement/track in place of altitude. */
+    altitudeFt: number | undefined;
+    /** Ground speed in knots, decoded from the movement field. Always undefined for an airborne position - airborne messages carry altitude in the same bits instead. */
+    groundSpeedKt: number | undefined;
+    /** Track over ground in degrees true. Always undefined for an airborne position, and for a surface position whose track status bit is unset (no valid track available). */
+    trueTrackDeg: number | undefined;
+}
+/** A DF17/18 extended squitter airborne velocity message. */
+export interface ExtendedSquitterVelocity extends ExtendedSquitterCommon {
+    /** Discriminant tag identifying this as a decoded airborne velocity message. */
+    kind: 'extendedSquitterVelocity';
+    /** The decoded velocity. */
+    velocity: AirborneVelocity;
+}
+/** A DF17/18 extended squitter aircraft identification message. */
+export interface ExtendedSquitterIdentification extends ExtendedSquitterCommon {
+    /** Discriminant tag identifying this as a decoded aircraft identification message. */
+    kind: 'extendedSquitterIdentification';
+    /** The decoded callsign and category. */
+    identification: AircraftIdentification;
+}
+/** A DF17/18 extended squitter Target State and Status message (type code 29). */
+export interface ExtendedSquitterTargetStateAndStatus extends ExtendedSquitterCommon {
+    /** Discriminant tag identifying this as a decoded Target State and Status message. */
+    kind: 'extendedSquitterTargetStateAndStatus';
+    /** The decoded target state and status. */
+    targetStateAndStatus: TargetStateAndStatus;
+}
+/** A DF17/18 extended squitter Aircraft Operational Status message (type code 31). */
+export interface ExtendedSquitterOperationalStatus extends ExtendedSquitterCommon {
+    /** Discriminant tag identifying this as a decoded Aircraft Operational Status message. */
+    kind: 'extendedSquitterOperationalStatus';
+    /** The decoded operational status. */
+    operationalStatus: AircraftOperationalStatus;
+}
+/** A DF11 all-call reply - confirms an aircraft's ICAO address, carries no other data. */
+export interface AllCallReply {
+    /** Discriminant tag identifying this as a decoded DF11 all-call reply. */
+    kind: 'allCallReply';
+    /** 24-bit ICAO hex address of the transmitting aircraft. */
+    icaoHex: string;
+}
+/**
+ * A DF0 short air-air surveillance reply (ACAS/TCAS interrogation reply
+ * from an aircraft with no resolution advisory currently active - an
+ * aircraft replying while an RA is active sends the longer DF16 instead).
+ * Like {@link SurveillanceAltitudeReply}, this is a targeted response whose
+ * CRC is XORed with the responding aircraft's ICAO address rather than
+ * being a plain checksum - `candidateIcaoHex` needs cross-checking against
+ * known traffic before it can be trusted.
+ */
+export interface ShortAirAirSurveillanceReply {
+    /** Discriminant tag identifying this as a decoded DF0 short air-air surveillance reply. */
+    kind: 'shortAirAirSurveillanceReply';
+    /** Candidate 24-bit ICAO hex address, recovered from the CRC field - verify against known traffic before trusting it. */
+    candidateIcaoHex: string;
+    /** Whether the replying aircraft is on the ground, from the vertical status bit. */
+    surface: boolean;
+    /** Decoded altitude in feet, or undefined if the AC field is empty or invalid. */
+    altitudeFt: number | undefined;
+}
+/**
+ * A DF16 long air-air surveillance reply - an ACAS/TCAS interrogation reply
+ * from an aircraft with a Resolution Advisory currently active. Like
+ * {@link SurveillanceAltitudeReply}, this is a targeted response whose CRC
+ * is XORed with the responding aircraft's ICAO address rather than being a
+ * plain checksum - `candidateIcaoHex` needs cross-checking against known
+ * traffic before it can be trusted.
+ */
+export interface LongAirAirSurveillanceReply {
+    /** Discriminant tag identifying this as a decoded DF16 long air-air surveillance reply. */
+    kind: 'longAirAirSurveillanceReply';
+    /** Candidate 24-bit ICAO hex address, recovered from the CRC field - verify against known traffic before trusting it. */
+    candidateIcaoHex: string;
+    /** Whether the replying aircraft is on the ground, from the vertical status bit. */
+    surface: boolean;
+    /** Decoded altitude in feet, or undefined if the AC field is empty or invalid. */
+    altitudeFt: number | undefined;
+    /** The active Resolution Advisory report, or undefined if its Threat Type Indicator was the reserved value. Altitude and address above remain independently valid even when this is undefined. */
+    resolutionAdvisory: AcasResolutionAdvisoryReport | undefined;
+}
+/**
+ * A DF4/20 Mode-S surveillance altitude reply. Unlike a squitter, this is
+ * a targeted response to an interrogation - its CRC is XORed with the
+ * responding aircraft's ICAO address rather than being a plain checksum,
+ * so `candidateIcaoHex` is only trustworthy once cross-checked against an
+ * address already known from squitter traffic (this package does not
+ * perform that cross-check itself; see {@link ModeSMessageEnvelope.crcRemainder}).
+ */
+export interface SurveillanceAltitudeReply {
+    /** Discriminant tag identifying this as a decoded DF4 surveillance altitude reply. */
+    kind: 'surveillanceAltitudeReply';
+    /** Candidate 24-bit ICAO hex address, recovered from the CRC field - verify against known traffic before trusting it. */
+    candidateIcaoHex: string;
+    /** Decoded altitude in feet, or undefined if the AC field is empty or invalid. */
+    altitudeFt: number | undefined;
+}
+/**
+ * A DF20 Comm-B altitude reply - the same altitude payload as
+ * {@link SurveillanceAltitudeReply} (DF4), extended with a 56-bit MB field
+ * carrying an Enhanced Surveillance Comm-B register. Like
+ * {@link SurveillanceAltitudeReply}, this is a targeted response whose CRC
+ * is XORed with the responding aircraft's ICAO address rather than being a
+ * plain checksum - `candidateIcaoHex` needs cross-checking against known
+ * traffic before it can be trusted.
+ */
+export interface CommBAltitudeReply {
+    /** Discriminant tag identifying this as a decoded DF20 Comm-B altitude reply. */
+    kind: 'commBAltitudeReply';
+    /** Candidate 24-bit ICAO hex address, recovered from the CRC field - verify against known traffic before trusting it. */
+    candidateIcaoHex: string;
+    /** Decoded altitude in feet, or undefined if the AC field is empty or invalid. */
+    altitudeFt: number | undefined;
+    /** Every Enhanced Surveillance Comm-B register the MB field plausibly holds - see {@link inferCommBRegisters}. Empty if none matched. */
+    commBRegisters: CommBRegister[];
+}
+/**
+ * A DF5/21 Mode-S surveillance identity (squawk) reply. Like
+ * {@link SurveillanceAltitudeReply}, this is a targeted response whose CRC
+ * is XORed with the responding aircraft's ICAO address rather than being a
+ * plain checksum - `candidateIcaoHex` needs cross-checking against known
+ * traffic before it can be trusted.
+ */
+export interface SurveillanceIdentityReply {
+    /** Discriminant tag identifying this as a decoded DF5 surveillance identity reply. */
+    kind: 'surveillanceIdentityReply';
+    /** Candidate 24-bit ICAO hex address, recovered from the CRC field - verify against known traffic before trusting it. */
+    candidateIcaoHex: string;
+    /** The decoded 4-digit octal squawk code. */
+    squawk: string;
+}
+/**
+ * A DF21 Comm-B identity reply - the same squawk payload as
+ * {@link SurveillanceIdentityReply} (DF5), extended with a 56-bit MB field
+ * carrying an Enhanced Surveillance Comm-B register. Like
+ * {@link SurveillanceAltitudeReply}, this is a targeted response whose CRC
+ * is XORed with the responding aircraft's ICAO address rather than being a
+ * plain checksum - `candidateIcaoHex` needs cross-checking against known
+ * traffic before it can be trusted.
+ */
+export interface CommBIdentityReply {
+    /** Discriminant tag identifying this as a decoded DF21 Comm-B identity reply. */
+    kind: 'commBIdentityReply';
+    /** Candidate 24-bit ICAO hex address, recovered from the CRC field - verify against known traffic before trusting it. */
+    candidateIcaoHex: string;
+    /** The decoded 4-digit octal squawk code. */
+    squawk: string;
+    /** Every Enhanced Surveillance Comm-B register the MB field plausibly holds - see {@link inferCommBRegisters}. Empty if none matched. */
+    commBRegisters: CommBRegister[];
+}
+/**
+ * A DF17/18 extended squitter aircraft status message (type code 28,
+ * subtype 1 - emergency/priority status). Subtype 2 (TCAS/ACAS resolution
+ * advisory broadcast) decodes to {@link ExtendedSquitterAcasRaBroadcast}
+ * instead.
+ */
+export interface ExtendedSquitterEmergencyStatus extends ExtendedSquitterCommon {
+    /** Discriminant tag identifying this as a decoded type-code-28 subtype-1 emergency/priority status message. */
+    kind: 'extendedSquitterEmergencyStatus';
+    /** The declared emergency/priority state. */
+    emergencyState: EmergencyState;
+    /** The squawk code broadcast alongside the emergency state - the same code the aircraft would transmit via a DF5/21 Mode-S reply, sent here natively over ADS-B. */
+    squawk: string;
+}
+/**
+ * A DF17/18 extended squitter aircraft status message (type code 28,
+ * subtype 2 - ACAS/TCAS Resolution Advisory broadcast). Lets aircraft
+ * without interrogation capability see that a nearby aircraft has an active
+ * RA. Carries the same BDS 3,0 content as a DF16 reply's `resolutionAdvisory`.
+ */
+export interface ExtendedSquitterAcasRaBroadcast extends ExtendedSquitterCommon {
+    /** Discriminant tag identifying this as a decoded type-code-28 subtype-2 ACAS Resolution Advisory broadcast. */
+    kind: 'extendedSquitterAcasRaBroadcast';
+    /** The active Resolution Advisory report. */
+    resolutionAdvisory: AcasResolutionAdvisoryReport;
+}
+/**
+ * A decoded Mode-S message. Discriminated by `kind`. DF24 (Comm-D) is
+ * recognized at the envelope level but not decoded by this package -
+ * {@link decodeModeSMessage} returns undefined for it, the same as a
+ * genuinely unsupported or invalid message. DF19 (military extended
+ * squitter) and DF22 (military use) are reserved formats with no publicly
+ * documented payload and are not decoded, for the same reason.
+ */
+export type DecodedModeSMessage = ExtendedSquitterPosition | ExtendedSquitterVelocity | ExtendedSquitterIdentification | ExtendedSquitterTargetStateAndStatus | ExtendedSquitterOperationalStatus | ExtendedSquitterEmergencyStatus | ExtendedSquitterAcasRaBroadcast | AllCallReply | ShortAirAirSurveillanceReply | LongAirAirSurveillanceReply | SurveillanceAltitudeReply | CommBAltitudeReply | SurveillanceIdentityReply | CommBIdentityReply;
+//# sourceMappingURL=message.d.ts.map

package/dist/types/message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../src/types/message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEtD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,aAAa,GACvB,YAAY,GAAG,iBAAiB,GAAG,UAAU,GAAG,eAAe,GAAG,MAAM,CAAC;AAE3E,wEAAwE;AACxE,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,4FAA4F;IAC5F,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,wEAAwE;AACxE,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB;IACtE,2FAA2F;IAC3F,IAAI,EAAE,0BAA0B,CAAC;IACjC,0EAA0E;IAC1E,OAAO,EAAE,OAAO,CAAC;IACjB,yDAAyD;IACzD,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC;IAC1B,yKAAyK;IACzK,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,0KAA0K;IAC1K,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,6IAA6I;IAC7I,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,qKAAqK;IACrK,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,2KAA2K;IAC3K,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED,6DAA6D;AAC7D,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB;IACtE,gFAAgF;IAChF,IAAI,EAAE,0BAA0B,CAAC;IACjC,4BAA4B;IAC5B,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AAED,mEAAmE;AACnE,MAAM,WAAW,8BAA+B,SAAQ,sBAAsB;IAC5E,sFAAsF;IACtF,IAAI,EAAE,gCAAgC,CAAC;IACvC,yCAAyC;IACzC,cAAc,EAAE,sBAAsB,CAAC;CACxC;AAED,kFAAkF;AAClF,MAAM,WAAW,oCAAqC,SAAQ,sBAAsB;IAClF,sFAAsF;IACtF,IAAI,EAAE,sCAAsC,CAAC;IAC7C,2CAA2C;IAC3C,oBAAoB,EAAE,oBAAoB,CAAC;CAC5C;AAED,sFAAsF;AACtF,MAAM,WAAW,iCAAkC,SAAQ,sBAAsB;IAC/E,0FAA0F;IAC1F,IAAI,EAAE,mCAAmC,CAAC;IAC1C,sCAAsC;IACtC,iBAAiB,EAAE,yBAAyB,CAAC;CAC9C;AAED,0FAA0F;AAC1F,MAAM,WAAW,YAAY;IAC3B,0EAA0E;IAC1E,IAAI,EAAE,cAAc,CAAC;IACrB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,4BAA4B;IAC3C,2FAA2F;IAC3F,IAAI,EAAE,8BAA8B,CAAC;IACrC,yHAAyH;IACzH,gBAAgB,EAAE,MAAM,CAAC;IACzB,oFAAoF;IACpF,OAAO,EAAE,OAAO,CAAC;IACjB,kFAAkF;IAClF,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C,2FAA2F;IAC3F,IAAI,EAAE,6BAA6B,CAAC;IACpC,yHAAyH;IACzH,gBAAgB,EAAE,MAAM,CAAC;IACzB,oFAAoF;IACpF,OAAO,EAAE,OAAO,CAAC;IACjB,kFAAkF;IAClF,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,kMAAkM;IAClM,kBAAkB,EAAE,4BAA4B,GAAG,SAAS,CAAC;CAC9D;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC,sFAAsF;IACtF,IAAI,EAAE,2BAA2B,CAAC;IAClC,yHAAyH;IACzH,gBAAgB,EAAE,MAAM,CAAC;IACzB,kFAAkF;IAClF,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,iFAAiF;IACjF,IAAI,EAAE,oBAAoB,CAAC;IAC3B,yHAAyH;IACzH,gBAAgB,EAAE,MAAM,CAAC;IACzB,kFAAkF;IAClF,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,yIAAyI;IACzI,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC,sFAAsF;IACtF,IAAI,EAAE,2BAA2B,CAAC;IAClC,yHAAyH;IACzH,gBAAgB,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,iFAAiF;IACjF,IAAI,EAAE,oBAAoB,CAAC;IAC3B,yHAAyH;IACzH,gBAAgB,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,yIAAyI;IACzI,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,+BAAgC,SAAQ,sBAAsB;IAC7E,+GAA+G;IAC/G,IAAI,EAAE,iCAAiC,CAAC;IACxC,6CAA6C;IAC7C,cAAc,EAAE,cAAc,CAAC;IAC/B,oKAAoK;IACpK,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+BAAgC,SAAQ,sBAAsB;IAC7E,gHAAgH;IAChH,IAAI,EAAE,iCAAiC,CAAC;IACxC,6CAA6C;IAC7C,kBAAkB,EAAE,4BAA4B,CAAC;CAClD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAC3B,wBAAwB,GACxB,wBAAwB,GACxB,8BAA8B,GAC9B,oCAAoC,GACpC,iCAAiC,GACjC,+BAA+B,GAC/B,+BAA+B,GAC/B,YAAY,GACZ,4BAA4B,GAC5B,2BAA2B,GAC3B,yBAAyB,GACzB,kBAAkB,GAClB,yBAAyB,GACzB,kBAAkB,CAAC"}

package/dist/types/message.js

@@ -0,0 +1 @@
+export {};

package/dist/types/mode-ac.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Decoded Mode A/C reply. Mode A/C predates Mode-S and carries no ICAO
+ * address - there is nothing here that identifies which aircraft sent it,
+ * only the squawk code and (if the reply looks like a valid altitude
+ * report) an altitude.
+ */
+export interface ModeAcReply {
+    kind: 'modeAc';
+    /** 4-digit octal squawk code, e.g. "1200". */
+    squawk: string;
+    /** True if the Ident (SPI - Special Position Identification) pulse is set. */
+    identActive: boolean;
+    /** Altitude in feet, if the reply decodes as a valid Mode C altitude report. Undefined for a Mode A (identity-only) reply or an invalid code. */
+    altitudeFt: number | undefined;
+}
+//# sourceMappingURL=mode-ac.d.ts.map

package/dist/types/mode-ac.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mode-ac.d.ts","sourceRoot":"","sources":["../../src/types/mode-ac.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,8CAA8C;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,8EAA8E;IAC9E,WAAW,EAAE,OAAO,CAAC;IACrB,iJAAiJ;IACjJ,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC"}

package/dist/types/mode-ac.js

@@ -0,0 +1 @@
+export {};

package/dist/types/operational-status.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Decoded ADS-B Aircraft Operational Status (BDS 6,5, type code 31) -
+ * capability/operational mode codes, ADS-B version, and navigation
+ * integrity/accuracy fields, per RTCA DO-260B section 2.2.3.2.7.2.
+ */
+export interface AircraftOperationalStatus {
+    /** Whether this report describes a surface (on-ground) aircraft, from the 3-bit subtype field (1 = surface; only 0 and 1 are defined, so anything else reports as `false`). */
+    surface: boolean;
+    /** The ADS-B version this message was encoded to (0, 1, or 2 in practice). Gates whether `nicBaro`/`silSupplementPerHour` are populated, and how `capabilityClassCode`/`operationalModeCode` should be interpreted. */
+    adsbVersion: number;
+    /** Raw 16-bit Capability Class Code field. Its sub-field breakdown depends on both `surface` and `adsbVersion`; not decoded further by this package - see RTCA DO-260B section 2.2.3.2.7.2.1 (or DO-260/DO-260A for earlier versions). */
+    capabilityClassCode: number;
+    /** Raw 16-bit Operational Mode Code field. Its sub-field breakdown depends on both `surface` and `adsbVersion`; not decoded further by this package - see RTCA DO-260B section 2.2.3.2.7.2.2 (or DO-260/DO-260A for earlier versions). */
+    operationalModeCode: number;
+    /** Navigation Integrity Category Supplement-A. */
+    nicSupplementA: boolean;
+    /** Navigation Accuracy Category for Position, 0-15 (higher is more accurate). */
+    navAccuracyCategoryPosition: number;
+    /** Source Integrity Level, 0-3 (higher is more reliable). */
+    sourceIntegrityLevel: number;
+    /** Whether the reported altitude source meets the Navigation Integrity Category barometric requirement. Only populated for an airborne report on ADS-B version 1 or 2 - undefined otherwise (version 0 has no defined meaning for this bit, and surface reports do not carry it). */
+    nicBaro: boolean | undefined;
+    /** Heading/track reference direction. */
+    headingReference: 'true' | 'magnetic';
+    /** Whether the Source Integrity Level is based on a per-hour probability (true) rather than a per-sample probability (false). Only populated on ADS-B version 2 - undefined otherwise. */
+    silSupplementPerHour: boolean | undefined;
+}
+//# sourceMappingURL=operational-status.d.ts.map

package/dist/types/operational-status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operational-status.d.ts","sourceRoot":"","sources":["../../src/types/operational-status.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,+KAA+K;IAC/K,OAAO,EAAE,OAAO,CAAC;IACjB,uNAAuN;IACvN,WAAW,EAAE,MAAM,CAAC;IACpB,0OAA0O;IAC1O,mBAAmB,EAAE,MAAM,CAAC;IAC5B,0OAA0O;IAC1O,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kDAAkD;IAClD,cAAc,EAAE,OAAO,CAAC;IACxB,iFAAiF;IACjF,2BAA2B,EAAE,MAAM,CAAC;IACpC,6DAA6D;IAC7D,oBAAoB,EAAE,MAAM,CAAC;IAC7B,qRAAqR;IACrR,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,GAAG,UAAU,CAAC;IACtC,0LAA0L;IAC1L,oBAAoB,EAAE,OAAO,GAAG,SAAS,CAAC;CAC3C"}

package/dist/types/operational-status.js

@@ -0,0 +1 @@
+export {};

package/dist/types/target-state-status.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Decoded ADS-B Target State and Status (BDS 6,2, type code 29) - the
+ * pilot's selected altitude/heading targets, altimeter setting, and
+ * active autopilot/nav modes, per RTCA DO-260B section 2.2.3.2.7.1.
+ */
+export interface TargetStateAndStatus {
+    /** Source of the selected altitude target - undefined when `selectedAltitudeFt` is unavailable. */
+    selectedAltitudeSource: 'mcpFcu' | 'fms' | undefined;
+    /** MCP/FCU or FMS selected altitude target, in feet. Undefined if not available. */
+    selectedAltitudeFt: number | undefined;
+    /** Barometric pressure (altimeter) setting, in millibars/hectopascals. Undefined if not available. */
+    baroPressureSettingMb: number | undefined;
+    /** Selected heading/track angle, in degrees. Undefined if not available. */
+    selectedHeadingDeg: number | undefined;
+    /** Navigation Accuracy Category for Position, 0-15 (higher is more accurate). */
+    navAccuracyCategoryPosition: number;
+    /** Whether the reported altitude source meets the Navigation Integrity Category barometric requirement. */
+    nicBaro: boolean;
+    /** Source Integrity Level, 0-3 (higher is more reliable). */
+    sourceIntegrityLevel: number;
+    /** Whether the autopilot is engaged. Undefined when mode status is not reported. */
+    autopilotEngaged: boolean | undefined;
+    /** Whether VNAV mode is active. Undefined when mode status is not reported. */
+    vnavModeActive: boolean | undefined;
+    /** Whether altitude-hold mode is active. Undefined when mode status is not reported. */
+    altitudeHoldModeActive: boolean | undefined;
+    /** Whether approach mode is active. Undefined when mode status is not reported. */
+    approachModeActive: boolean | undefined;
+    /** Whether LNAV mode is active. Undefined when mode status is not reported. */
+    lnavModeActive: boolean | undefined;
+    /** Whether ACAS/TCAS is operational (not inhibited or failed). Always reported, regardless of mode status. */
+    tcasOperational: boolean;
+}
+//# sourceMappingURL=target-state-status.d.ts.map

package/dist/types/target-state-status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"target-state-status.d.ts","sourceRoot":"","sources":["../../src/types/target-state-status.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,mGAAmG;IACnG,sBAAsB,EAAE,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAC;IACrD,oFAAoF;IACpF,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,sGAAsG;IACtG,qBAAqB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,4EAA4E;IAC5E,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,iFAAiF;IACjF,2BAA2B,EAAE,MAAM,CAAC;IACpC,2GAA2G;IAC3G,OAAO,EAAE,OAAO,CAAC;IACjB,6DAA6D;IAC7D,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oFAAoF;IACpF,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,+EAA+E;IAC/E,cAAc,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC,wFAAwF;IACxF,sBAAsB,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5C,mFAAmF;IACnF,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC,+EAA+E;IAC/E,cAAc,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC,8GAA8G;IAC9G,eAAe,EAAE,OAAO,CAAC;CAC1B"}

package/dist/types/target-state-status.js

@@ -0,0 +1 @@
+export {};

package/dist/types/velocity.d.ts

@@ -0,0 +1,35 @@
+/** Fields common to both airborne velocity subtypes (ADS-B BDS 0,9). */
+export interface AirborneVelocityCommon {
+    /** Vertical rate in feet per minute, positive for climbing. Undefined if not available. */
+    verticalRateFtPerMin: number | undefined;
+    /** Source of the vertical rate measurement. */
+    verticalRateSource: 'gnss' | 'barometric';
+    /** Geometric altitude minus barometric altitude, in feet. Undefined if not available. */
+    geoMinusBaroAltitudeFt: number | undefined;
+}
+/** Airborne velocity decoded from a ground-speed subtype (1 or 2) message. */
+export interface GroundSpeedVelocity extends AirborneVelocityCommon {
+    subtype: 'groundSpeed';
+    /** Ground speed in knots. Undefined if not available. */
+    groundSpeedKt: number | undefined;
+    /** Track over ground in degrees true. Undefined if not available. */
+    trueTrackDeg: number | undefined;
+}
+/** Airborne velocity decoded from an airspeed subtype (3 or 4) message. */
+export interface AirSpeedVelocity extends AirborneVelocityCommon {
+    subtype: 'airSpeed';
+    /** Indicated airspeed in knots. Undefined if not available or the message reports true airspeed instead. */
+    indicatedAirspeedKt: number | undefined;
+    /** True airspeed in knots. Undefined if not available or the message reports indicated airspeed instead. */
+    trueAirspeedKt: number | undefined;
+    /** Magnetic heading in degrees. Undefined if not available. */
+    magneticHeadingDeg: number | undefined;
+}
+/**
+ * Decoded ADS-B airborne velocity (BDS 0,9, type code 19). Ground-speed
+ * subtypes report true track; airspeed subtypes report magnetic heading -
+ * airspeed messages are transmitted when the aircraft lacks a good
+ * GPS-derived track and falls back to its compass heading instead.
+ */
+export type AirborneVelocity = GroundSpeedVelocity | AirSpeedVelocity;
+//# sourceMappingURL=velocity.d.ts.map

package/dist/types/velocity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"velocity.d.ts","sourceRoot":"","sources":["../../src/types/velocity.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,MAAM,WAAW,sBAAsB;IACrC,2FAA2F;IAC3F,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,+CAA+C;IAC/C,kBAAkB,EAAE,MAAM,GAAG,YAAY,CAAC;IAC1C,yFAAyF;IACzF,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5C;AAED,8EAA8E;AAC9E,MAAM,WAAW,mBAAoB,SAAQ,sBAAsB;IACjE,OAAO,EAAE,aAAa,CAAC;IACvB,yDAAyD;IACzD,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,qEAAqE;IACrE,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED,2EAA2E;AAC3E,MAAM,WAAW,gBAAiB,SAAQ,sBAAsB;IAC9D,OAAO,EAAE,UAAU,CAAC;IACpB,4GAA4G;IAC5G,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,4GAA4G;IAC5G,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,+DAA+D;IAC/D,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG,gBAAgB,CAAC"}

package/dist/types/velocity.js

@@ -0,0 +1 @@
+export {};

package/dist/velocity.d.ts

@@ -0,0 +1,9 @@
+import type { AirborneVelocity } from './types/index.js';
+/**
+ * Decodes an ADS-B airborne velocity message (BDS 0,9, type code 19).
+ *
+ * @param me - The 7-byte ME field of a DF17/18 message whose type code is 19.
+ * @returns The decoded velocity, or undefined if the subtype field is not one of the four defined values (1-4).
+ */
+export declare function decodeAirborneVelocity(me: Uint8Array): AirborneVelocity | undefined;
+//# sourceMappingURL=velocity.d.ts.map

package/dist/velocity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"velocity.d.ts","sourceRoot":"","sources":["../src/velocity.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,gBAAgB,EAIjB,MAAM,kBAAkB,CAAC;AAgF1B;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,EAAE,EAAE,UAAU,GAAG,gBAAgB,GAAG,SAAS,CAWnF"}

package/dist/velocity.js

@@ -0,0 +1,73 @@
+import { extractBits } from './bits.js';
+/**
+ * Decodes the vertical-rate and geometric/barometric altitude-difference
+ * fields shared by both airborne velocity subtypes.
+ */
+function decodeCommonTrailer(me) {
+    const verticalRateSource = extractBits(me, 35, 1) === 1 ? 'barometric' : 'gnss';
+    const verticalRateSign = extractBits(me, 36, 1);
+    const verticalRateMagnitude = extractBits(me, 37, 9);
+    const verticalRateFtPerMin = verticalRateMagnitude === 0
+        ? undefined
+        : (verticalRateSign === 1 ? -1 : 1) * (verticalRateMagnitude - 1) * 64;
+    const diffSign = extractBits(me, 48, 1);
+    const diffMagnitude = extractBits(me, 49, 7);
+    const geoMinusBaroAltitudeFt = diffMagnitude === 0 || diffMagnitude === 127
+        ? undefined
+        : (diffSign === 1 ? -1 : 1) * (diffMagnitude - 1) * 25;
+    return { verticalRateFtPerMin, verticalRateSource, geoMinusBaroAltitudeFt };
+}
+function decodeGroundSpeed(me, subtype, common) {
+    const eastWestSign = extractBits(me, 13, 1);
+    const eastWestMagnitude = extractBits(me, 14, 10);
+    const northSouthSign = extractBits(me, 24, 1);
+    const northSouthMagnitude = extractBits(me, 25, 10);
+    if (eastWestMagnitude === 0 || northSouthMagnitude === 0) {
+        return { subtype: 'groundSpeed', groundSpeedKt: undefined, trueTrackDeg: undefined, ...common };
+    }
+    const scale = subtype === 2 ? 4 : 1;
+    const eastWest = (eastWestMagnitude - 1) * scale;
+    const northSouth = (northSouthMagnitude - 1) * scale;
+    const velocityEast = eastWestSign === 1 ? -eastWest : eastWest;
+    const velocityNorth = northSouthSign === 1 ? -northSouth : northSouth;
+    const groundSpeedKt = Math.sqrt(velocityEast * velocityEast + velocityNorth * velocityNorth);
+    let trueTrackDeg = (Math.atan2(velocityEast, velocityNorth) * 180) / Math.PI;
+    if (trueTrackDeg < 0) {
+        trueTrackDeg += 360;
+    }
+    return { subtype: 'groundSpeed', groundSpeedKt, trueTrackDeg, ...common };
+}
+function decodeAirSpeed(me, subtype, common) {
+    const headingStatus = extractBits(me, 13, 1);
+    const headingRaw = extractBits(me, 14, 10);
+    const airspeedType = extractBits(me, 24, 1);
+    const airspeedMagnitude = extractBits(me, 25, 10);
+    const magneticHeadingDeg = headingStatus === 0 ? undefined : (headingRaw / 1024) * 360;
+    const scale = subtype === 4 ? 4 : 1;
+    const airspeedKt = airspeedMagnitude === 0 ? undefined : (airspeedMagnitude - 1) * scale;
+    const isTrueAirspeed = airspeedType === 1;
+    return {
+        subtype: 'airSpeed',
+        indicatedAirspeedKt: isTrueAirspeed ? undefined : airspeedKt,
+        trueAirspeedKt: isTrueAirspeed ? airspeedKt : undefined,
+        magneticHeadingDeg,
+        ...common,
+    };
+}
+/**
+ * Decodes an ADS-B airborne velocity message (BDS 0,9, type code 19).
+ *
+ * @param me - The 7-byte ME field of a DF17/18 message whose type code is 19.
+ * @returns The decoded velocity, or undefined if the subtype field is not one of the four defined values (1-4).
+ */
+export function decodeAirborneVelocity(me) {
+    const subtype = extractBits(me, 5, 3);
+    const common = decodeCommonTrailer(me);
+    if (subtype === 1 || subtype === 2) {
+        return decodeGroundSpeed(me, subtype, common);
+    }
+    if (subtype === 3 || subtype === 4) {
+        return decodeAirSpeed(me, subtype, common);
+    }
+    return undefined;
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@squawk/mode-s",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Decode raw Mode-S/ADS-B messages: DF/CRC parsing, CPR position, velocity, identification, and altitude",
+  "author": "Neil Cochran",
+  "license": "MIT",
+  "homepage": "https://github.com/neilcochran/squawk",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/neilcochran/squawk.git",
+    "directory": "packages/libs/mode-s"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "typedocMain": "src/index.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./browser": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.spec.*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "tsc --noEmit && eslint src",
+    "lint:pack": "publint && attw --pack . --profile esm-only",
+    "api:check": "api-extractor run --verbose",
+    "api:report": "api-extractor run --local --verbose"
+  },
+  "dependencies": {
+    "@squawk/types": "^0.8.6"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.3"
+  },
+  "keywords": [
+    "aviation",
+    "typescript",
+    "mode-s",
+    "adsb",
+    "ads-b",
+    "transponder",
+    "decoder"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}