gnss-js 2.0.0 → 2.1.0

package/dist/has-BaXnQarR.d.cts

@@ -0,0 +1,123 @@
+/** Constellations HAS corrects: GPS (GNSS ID 0), Galileo (GNSS ID 2). */
+type HasSystem = 'G' | 'E';
+/** One system's satellite/signal mask (ICD §6.4.3). */
+interface HasSystemMask {
+    /** GNSS ID as broadcast: 0 GPS, 2 Galileo. */
+    gnssId: number;
+    system: HasSystem;
+    /** Masked satellites in mask order, e.g. ["E03", "E05", ...]. */
+    prns: string[];
+    /** Set bits of the 16-bit signal mask, ascending. */
+    signalIndices: number[];
+    /** ICD names for `signalIndices`. */
+    signals: string[];
+    /**
+     * Cell mask, [satellite][signal] in mask order — true when the
+     * sat×signal combination carries biases. Null when the cell-mask
+     * availability flag is 0 (all combinations available).
+     */
+    cellMask: boolean[][] | null;
+    /** Nav-message index the corrections refer to (0 = LNAV / I/NAV). */
+    navMessage: number;
+}
+/** The satellite/signal mask block of one mask ID. */
+interface HasMasks {
+    maskId: number;
+    systems: HasSystemMask[];
+}
+/** Orbit correction for one satellite (ICD §6.5). */
+interface HasOrbitCorrection {
+    system: HasSystem;
+    prn: string;
+    /** Broadcast issue of data the deltas refer to (IODE / IODNav). */
+    gnssIod: number;
+    /** Delta radial in m (LSB 0.0025), null = data not available. */
+    deltaRadial: number | null;
+    /** Delta in-track in m (LSB 0.008), null = data not available. */
+    deltaInTrack: number | null;
+    /** Delta cross-track in m (LSB 0.008), null = data not available. */
+    deltaCrossTrack: number | null;
+}
+interface HasOrbitBlock {
+    validityIndex: number;
+    /** Validity interval in s (null = reserved index 15). */
+    validitySeconds: number | null;
+    corrections: HasOrbitCorrection[];
+}
+/** Clock correction for one satellite (ICD §6.6-6.7). */
+interface HasClockCorrection {
+    system: HasSystem;
+    prn: string;
+    /**
+     * Delta clock C0 in m, multiplier folded in; positive means the
+     * satellite clock offset grows (add Δclock/c to the broadcast
+     * clock). Null when data not available or the satellite is flagged
+     * "shall not be used" (see `notUsable`).
+     */
+    deltaClock: number | null;
+    /** True for the reserved "insufficient accuracy, do not use" value. */
+    notUsable: boolean;
+}
+interface HasClockBlock {
+    validityIndex: number;
+    validitySeconds: number | null;
+    /** Delta-clock C0 multiplier per system (1-4), in mask order. */
+    multipliers: {
+        system: HasSystem;
+        multiplier: number;
+    }[];
+    corrections: HasClockCorrection[];
+}
+/** Code or phase bias of one satellite × signal cell (ICD §6.8-6.9). */
+interface HasSignalBias {
+    system: HasSystem;
+    prn: string;
+    signalIndex: number;
+    signal: string;
+    /** Bias in m (code, LSB 0.02) or cycles (phase, LSB 0.01); null = N/A. */
+    bias: number | null;
+    /** Phase-discontinuity indicator (phase biases only). */
+    discontinuity?: number;
+}
+interface HasBiasBlock {
+    validityIndex: number;
+    validitySeconds: number | null;
+    biases: HasSignalBias[];
+}
+/** Which sub-blocks the MT1 header flags as present (ICD §6.2). */
+interface HasContentFlags {
+    mask: boolean;
+    orbit: boolean;
+    clockFullSet: boolean;
+    clockSubset: boolean;
+    codeBias: boolean;
+    phaseBias: boolean;
+}
+/** One decoded HAS MT1 message. */
+interface HasMessage {
+    /** Receiver time of week (s) of the page completing the message. */
+    tow?: number;
+    /** HAS status of the carrying pages (0 test, 1 operational). */
+    status: number;
+    messageId: number;
+    /** Message size in pages (= pages used for the RS decode). */
+    messageSize: number;
+    /** Time of hour of the corrections, s (0-3599, ICD §6.2). */
+    toh: number;
+    maskId: number;
+    iodSetId: number;
+    flags: HasContentFlags;
+    /** The mask block in force (own or cached, see `maskFromCache`). */
+    masks?: HasMasks;
+    /** True when `masks` came from an earlier message with this mask ID. */
+    maskFromCache: boolean;
+    orbit?: HasOrbitBlock;
+    clockFullSet?: HasClockBlock;
+    clockSubset?: HasClockBlock;
+    codeBias?: HasBiasBlock;
+    phaseBias?: HasBiasBlock;
+    /** Null when fully parsed, else why the sub-blocks are missing. */
+    parseError: string | null;
+}
+
+export type { HasMessage as H, HasOrbitCorrection as a, HasClockCorrection as b };

package/dist/has-BaXnQarR.d.ts

@@ -0,0 +1,123 @@
+/** Constellations HAS corrects: GPS (GNSS ID 0), Galileo (GNSS ID 2). */
+type HasSystem = 'G' | 'E';
+/** One system's satellite/signal mask (ICD §6.4.3). */
+interface HasSystemMask {
+    /** GNSS ID as broadcast: 0 GPS, 2 Galileo. */
+    gnssId: number;
+    system: HasSystem;
+    /** Masked satellites in mask order, e.g. ["E03", "E05", ...]. */
+    prns: string[];
+    /** Set bits of the 16-bit signal mask, ascending. */
+    signalIndices: number[];
+    /** ICD names for `signalIndices`. */
+    signals: string[];
+    /**
+     * Cell mask, [satellite][signal] in mask order — true when the
+     * sat×signal combination carries biases. Null when the cell-mask
+     * availability flag is 0 (all combinations available).
+     */
+    cellMask: boolean[][] | null;
+    /** Nav-message index the corrections refer to (0 = LNAV / I/NAV). */
+    navMessage: number;
+}
+/** The satellite/signal mask block of one mask ID. */
+interface HasMasks {
+    maskId: number;
+    systems: HasSystemMask[];
+}
+/** Orbit correction for one satellite (ICD §6.5). */
+interface HasOrbitCorrection {
+    system: HasSystem;
+    prn: string;
+    /** Broadcast issue of data the deltas refer to (IODE / IODNav). */
+    gnssIod: number;
+    /** Delta radial in m (LSB 0.0025), null = data not available. */
+    deltaRadial: number | null;
+    /** Delta in-track in m (LSB 0.008), null = data not available. */
+    deltaInTrack: number | null;
+    /** Delta cross-track in m (LSB 0.008), null = data not available. */
+    deltaCrossTrack: number | null;
+}
+interface HasOrbitBlock {
+    validityIndex: number;
+    /** Validity interval in s (null = reserved index 15). */
+    validitySeconds: number | null;
+    corrections: HasOrbitCorrection[];
+}
+/** Clock correction for one satellite (ICD §6.6-6.7). */
+interface HasClockCorrection {
+    system: HasSystem;
+    prn: string;
+    /**
+     * Delta clock C0 in m, multiplier folded in; positive means the
+     * satellite clock offset grows (add Δclock/c to the broadcast
+     * clock). Null when data not available or the satellite is flagged
+     * "shall not be used" (see `notUsable`).
+     */
+    deltaClock: number | null;
+    /** True for the reserved "insufficient accuracy, do not use" value. */
+    notUsable: boolean;
+}
+interface HasClockBlock {
+    validityIndex: number;
+    validitySeconds: number | null;
+    /** Delta-clock C0 multiplier per system (1-4), in mask order. */
+    multipliers: {
+        system: HasSystem;
+        multiplier: number;
+    }[];
+    corrections: HasClockCorrection[];
+}
+/** Code or phase bias of one satellite × signal cell (ICD §6.8-6.9). */
+interface HasSignalBias {
+    system: HasSystem;
+    prn: string;
+    signalIndex: number;
+    signal: string;
+    /** Bias in m (code, LSB 0.02) or cycles (phase, LSB 0.01); null = N/A. */
+    bias: number | null;
+    /** Phase-discontinuity indicator (phase biases only). */
+    discontinuity?: number;
+}
+interface HasBiasBlock {
+    validityIndex: number;
+    validitySeconds: number | null;
+    biases: HasSignalBias[];
+}
+/** Which sub-blocks the MT1 header flags as present (ICD §6.2). */
+interface HasContentFlags {
+    mask: boolean;
+    orbit: boolean;
+    clockFullSet: boolean;
+    clockSubset: boolean;
+    codeBias: boolean;
+    phaseBias: boolean;
+}
+/** One decoded HAS MT1 message. */
+interface HasMessage {
+    /** Receiver time of week (s) of the page completing the message. */
+    tow?: number;
+    /** HAS status of the carrying pages (0 test, 1 operational). */
+    status: number;
+    messageId: number;
+    /** Message size in pages (= pages used for the RS decode). */
+    messageSize: number;
+    /** Time of hour of the corrections, s (0-3599, ICD §6.2). */
+    toh: number;
+    maskId: number;
+    iodSetId: number;
+    flags: HasContentFlags;
+    /** The mask block in force (own or cached, see `maskFromCache`). */
+    masks?: HasMasks;
+    /** True when `masks` came from an earlier message with this mask ID. */
+    maskFromCache: boolean;
+    orbit?: HasOrbitBlock;
+    clockFullSet?: HasClockBlock;
+    clockSubset?: HasClockBlock;
+    codeBias?: HasBiasBlock;
+    phaseBias?: HasBiasBlock;
+    /** Null when fully parsed, else why the sub-blocks are missing. */
+    parseError: string | null;
+}
+
+export type { HasMessage as H, HasOrbitCorrection as a, HasClockCorrection as b };