gnss-js 1.20.0 → 1.21.0

package/dist/sbf.d.cts

@@ -209,6 +209,178 @@ interface SbfGloNavResult {
  */
 declare function parseSbfGloNav(data: Uint8Array): SbfGloNavResult;
 
+/** 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;
+}
+
+/**
+ * Septentrio SBF GALRawCNAV (4024) blocks: one 492-bit Galileo E6-B
+ * C/NAV page per block (after deinterleaving and Viterbi decoding),
+ * feeding the receiver-independent HAS decoder in ../navbits/has.
+ *
+ * Block layout (mosaic-X5 reference guide §4.2): after the 8-byte SBF
+ * header, TOW u4 (ms) + WNc u2, SVID u1, CRCPassed u1, ViterbiCnt u1,
+ * Source u1, FreqNr u1, RxChannel u1, then NAVBits as u4[16] — the
+ * first received bit is the MSB of NAVBits[0] (each u4 little-endian
+ * in the stream, page bits MSB-first within the word), the unused 20
+ * bits of NAVBits[15] to be ignored.
+ *
+ * RTKLIB demo5 (rtklibexplorer) has no C/NAV decoder — GALRawCNAV is
+ * not handled by src/rcv/septentrio.c at all — so the block layout
+ * comes from the reference guide directly, and the page handling was
+ * cross-checked against FGI's HASlib reference decoder
+ * (github.com/nlsfi/HASlib, EUPL-1.2, galileo_has_decoder/sbf_reading.py).
+ *
+ * The receiver's own CRCPassed flag is ignored in favor of re-running
+ * CRC-24Q on the transported page, so `pagesBadCrc` counts exactly the
+ * pages this library rejected.
+ */
+
+/** A HAS message tagged with the SBF time stamp that completed it. */
+interface SbfHasMessage extends HasMessage {
+    /** Receiver time of week (s) of the completing GALRawCNAV block. */
+    tow: number;
+    /** Receiver week number (GPS weeks, no rollover) of that block. */
+    wnc: number;
+}
+interface SbfHasResult {
+    /** Completed HAS messages in stream order. */
+    messages: SbfHasMessage[];
+    /** GALRawCNAV blocks seen (with valid SBF framing and length). */
+    pagesSeen: number;
+    /** Pages dropped for a failed CRC-24Q re-check. */
+    pagesBadCrc: number;
+    /** Dummy pages (idle filler, no HAS content). */
+    pagesDummy: number;
+    /** Non-dummy HAS pages fed to the assembler. */
+    pagesHas: number;
+}
+/**
+ * Decode every GALRawCNAV block in an SBF byte stream and assemble the
+ * carried HAS pages — network-wide, across all satellites — into HAS
+ * messages. Pages must be fed as captured (chronological order) for
+ * the message-generation bookkeeping to work.
+ */
+declare function parseSbfHas(data: Uint8Array): SbfHasResult;
+
 /**
  * Septentrio SBF raw-measurement decoding (MeasEpoch + Meas3) — the
  * path from a receiver log to RINEX-grade observables.
@@ -272,4 +444,4 @@ interface SbfParseResult {
  */
 declare function parseSbfMeas(data: Uint8Array): SbfParseResult;
 
-export { CnavEphemeris, type SbfBdsNavResult, type SbfCnavEphemeris, type SbfCnavResult, type SbfGalEphemeris, type SbfGalNavResult, type SbfGloNavResult, type SbfIonoUtcResult, type SbfMeasEpoch, type SbfMeasurement, type SbfParseResult, parseSbfBdsNav, parseSbfCnav, parseSbfGalNav, parseSbfGloNav, parseSbfIonoUtc, parseSbfMeas, crc16 as sbfCrc16, scanSbfFrames };
+export { CnavEphemeris, type HasMessage, type SbfBdsNavResult, type SbfCnavEphemeris, type SbfCnavResult, type SbfGalEphemeris, type SbfGalNavResult, type SbfGloNavResult, type SbfHasMessage, type SbfHasResult, type SbfIonoUtcResult, type SbfMeasEpoch, type SbfMeasurement, type SbfParseResult, parseSbfBdsNav, parseSbfCnav, parseSbfGalNav, parseSbfGloNav, parseSbfHas, parseSbfIonoUtc, parseSbfMeas, crc16 as sbfCrc16, scanSbfFrames };

package/dist/sbf.d.ts

@@ -209,6 +209,178 @@ interface SbfGloNavResult {
  */
 declare function parseSbfGloNav(data: Uint8Array): SbfGloNavResult;
 
+/** 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;
+}
+
+/**
+ * Septentrio SBF GALRawCNAV (4024) blocks: one 492-bit Galileo E6-B
+ * C/NAV page per block (after deinterleaving and Viterbi decoding),
+ * feeding the receiver-independent HAS decoder in ../navbits/has.
+ *
+ * Block layout (mosaic-X5 reference guide §4.2): after the 8-byte SBF
+ * header, TOW u4 (ms) + WNc u2, SVID u1, CRCPassed u1, ViterbiCnt u1,
+ * Source u1, FreqNr u1, RxChannel u1, then NAVBits as u4[16] — the
+ * first received bit is the MSB of NAVBits[0] (each u4 little-endian
+ * in the stream, page bits MSB-first within the word), the unused 20
+ * bits of NAVBits[15] to be ignored.
+ *
+ * RTKLIB demo5 (rtklibexplorer) has no C/NAV decoder — GALRawCNAV is
+ * not handled by src/rcv/septentrio.c at all — so the block layout
+ * comes from the reference guide directly, and the page handling was
+ * cross-checked against FGI's HASlib reference decoder
+ * (github.com/nlsfi/HASlib, EUPL-1.2, galileo_has_decoder/sbf_reading.py).
+ *
+ * The receiver's own CRCPassed flag is ignored in favor of re-running
+ * CRC-24Q on the transported page, so `pagesBadCrc` counts exactly the
+ * pages this library rejected.
+ */
+
+/** A HAS message tagged with the SBF time stamp that completed it. */
+interface SbfHasMessage extends HasMessage {
+    /** Receiver time of week (s) of the completing GALRawCNAV block. */
+    tow: number;
+    /** Receiver week number (GPS weeks, no rollover) of that block. */
+    wnc: number;
+}
+interface SbfHasResult {
+    /** Completed HAS messages in stream order. */
+    messages: SbfHasMessage[];
+    /** GALRawCNAV blocks seen (with valid SBF framing and length). */
+    pagesSeen: number;
+    /** Pages dropped for a failed CRC-24Q re-check. */
+    pagesBadCrc: number;
+    /** Dummy pages (idle filler, no HAS content). */
+    pagesDummy: number;
+    /** Non-dummy HAS pages fed to the assembler. */
+    pagesHas: number;
+}
+/**
+ * Decode every GALRawCNAV block in an SBF byte stream and assemble the
+ * carried HAS pages — network-wide, across all satellites — into HAS
+ * messages. Pages must be fed as captured (chronological order) for
+ * the message-generation bookkeeping to work.
+ */
+declare function parseSbfHas(data: Uint8Array): SbfHasResult;
+
 /**
  * Septentrio SBF raw-measurement decoding (MeasEpoch + Meas3) — the
  * path from a receiver log to RINEX-grade observables.
@@ -272,4 +444,4 @@ interface SbfParseResult {
  */
 declare function parseSbfMeas(data: Uint8Array): SbfParseResult;
 
-export { CnavEphemeris, type SbfBdsNavResult, type SbfCnavEphemeris, type SbfCnavResult, type SbfGalEphemeris, type SbfGalNavResult, type SbfGloNavResult, type SbfIonoUtcResult, type SbfMeasEpoch, type SbfMeasurement, type SbfParseResult, parseSbfBdsNav, parseSbfCnav, parseSbfGalNav, parseSbfGloNav, parseSbfIonoUtc, parseSbfMeas, crc16 as sbfCrc16, scanSbfFrames };
+export { CnavEphemeris, type HasMessage, type SbfBdsNavResult, type SbfCnavEphemeris, type SbfCnavResult, type SbfGalEphemeris, type SbfGalNavResult, type SbfGloNavResult, type SbfHasMessage, type SbfHasResult, type SbfIonoUtcResult, type SbfMeasEpoch, type SbfMeasurement, type SbfParseResult, parseSbfBdsNav, parseSbfCnav, parseSbfGalNav, parseSbfGloNav, parseSbfHas, parseSbfIonoUtc, parseSbfMeas, crc16 as sbfCrc16, scanSbfFrames };

package/dist/sbf.js

@@ -5,11 +5,12 @@ import {
   parseSbfCnav,
   parseSbfGalNav,
   parseSbfGloNav,
+  parseSbfHas,
   parseSbfIonoUtc,
   parseSbfMeas,
   parseSbfNav,
   scanSbfFrames
-} from "./chunk-VJEPOC76.js";
+} from "./chunk-K3V3NHWL.js";
 import "./chunk-WZDFZ76K.js";
 import "./chunk-HVXYFUCB.js";
 import "./chunk-LEEU5OIO.js";
@@ -19,6 +20,7 @@ export {
   parseSbfCnav,
   parseSbfGalNav,
   parseSbfGloNav,
+  parseSbfHas,
   parseSbfIonoUtc,
   parseSbfMeas,
   parseSbfNav,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gnss-js",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "Comprehensive GNSS library for JavaScript — time scales, coordinates, RINEX parsing, RTCM3 decoding, orbit computation, and signal analysis",
   "type": "module",
   "sideEffects": false,