gnss-js 1.66.0 → 2.0.0

package/README.md

@@ -1,6 +1,8 @@
 # gnss-js
 
-Comprehensive GNSS library for JavaScript and TypeScript. Zero dependencies. Works in Node.js, browsers, Deno, Bun, and Workers.
+A comprehensive, dependency-free GNSS toolkit for JavaScript and TypeScript — from raw receiver bytes to a positioning solution, and everything between. Runs in Node.js, browsers, Deno, Bun, and Workers.
+
+It decodes the formats a GNSS workflow actually meets in the wild (RINEX, RTCM 2/3, and the Septentrio/u-blox/NovAtel/Trimble/BINEX binary logs), reconstructs broadcast navigation down to the raw subframe, and solves positions from single-point all the way to PPP with integer ambiguity resolution — with consistent units and explicit JSDoc throughout.
 
 ## Install
 
@@ -8,169 +10,192 @@ Comprehensive GNSS library for JavaScript and TypeScript. Zero dependencies. Wor
 npm install gnss-js
 ```
 
-## Modules
+Everything is exposed through subpath exports (`gnss-js/rinex`, `gnss-js/positioning`, …), so bundlers only pull in what you import.
 
-Import only what you need via subpath exports:
+## What's inside
 
-### Time scales
+- **Formats in** — RINEX 2/3/4 obs + nav (plain, Hatanaka `.crx`, `.gz`), SP3, RINEX CLK, IONEX, SINEX bias; RTCM3 (MSM + legacy obs, ephemeris, SSR/IGS-SSR, station); RTCM 2.x; and the receiver binaries SBF, UBX, NovAtel OEM4, Trimble, BINEX.
+- **Formats out** — RINEX 2/3/4 observation + navigation writers and Hatanaka (CRINEX) compression.
+- **Navigation** — Keplerian/GLONASS ephemeris handling plus raw-frame decoding of GPS LNAV/CNAV, Galileo I/NAV + F/NAV, BeiDou D1/D2, GLONASS strings, and Galileo HAS (E6 C/NAV) corrections.
+- **Orbits** — satellite position/velocity, Doppler, DOP, azimuth/elevation, pass prediction and almanac propagation.
+- **Positioning** — SPP, static and kinematic float PPP, PPP-AR (LAMBDA + wide-/narrow-lane FCB estimation), post-processed RTK, DGNSS, and SBAS/DFMC augmentation.
+- **Quality** — multipath, cycle slips, completeness and slant-TEC ionosphere analysis, with SINEX-DCB calibration.
+- **Live** — NTRIP client and a self-detecting RTCM/receiver stream stats accumulator.
+- **Foundations** — GNSS time scales, ECEF/geodetic coordinates, 14-parameter reference-frame transforms, signal/frequency definitions and physical constants.
 
-```ts
-import {
-  getGpsTime,
-  getTimeOfWeek,
-  getWeekNumber,
-  getDateFromGpsData,
-} from 'gnss-js/time';
-import { getGalTime, getBdsTime, getUnixTime } from 'gnss-js/time';
-import { getJulianDate, getMJD } from 'gnss-js/time';
-import { getLeap, getGpsLeap, getUtcDate } from 'gnss-js/time';
-
-const date = new Date('2024-01-15T12:00:00Z');
-const gpsTime = getGpsTime(date); // milliseconds since GPS epoch
-const tow = getTimeOfWeek(date); // milliseconds into current GPS week
-const week = getWeekNumber(date); // GPS week number
-```
+## Usage
 
-### Coordinates
+### Time, coordinates & reference frames
 
 ```ts
+import { getGpsTime, getTimeOfWeek, getWeekNumber } from 'gnss-js/time';
 import {
   geodeticToEcef,
   ecefToGeodetic,
   vincenty,
   deg2rad,
 } from 'gnss-js/coordinates';
+import { transformFrame } from 'gnss-js/frames';
 
+const gpsTime = getGpsTime(new Date()); // ms since GPS epoch
 const [x, y, z] = geodeticToEcef(deg2rad(48.8566), deg2rad(2.3522), 35);
-const { distance } = vincenty(
-  deg2rad(51.5),
-  deg2rad(-0.1),
-  deg2rad(48.9),
-  deg2rad(2.4)
-);
-// distance in meters, angles in radians
-```
-
-### Visibility / pass prediction
 
-```ts
-import { computeVisibility } from 'gnss-js/orbit';
-
-const vis = computeVisibility(ephemerides, rxEcef, startMs, endMs, 300, 10);
-// vis.passes: rise/peak/set per satellite; vis.pdop / vis.visibleCount
-// per epoch; vis.elevation[prn]: elevation timeline for plotting.
-```
-
-### Single-point positioning
-
-```ts
-import { solveSpp, ionoFree } from 'gnss-js/positioning';
-
-const sol = solveSpp(pseudoranges, ephemerides, epochMs);
-// sol.position (ECEF m), per-system clock biases, DOP, residuals,
-// rejected outliers. ~10 m single-frequency; use ionoFree(p1, p2, f1, f2)
-// pseudoranges for metre-level.
-```
-
-### Reference frame transformations
-
-```ts
-import { transformFrame, dateToEpoch } from 'gnss-js/frames';
-
-// ETRS89 (ETRF2000) station coordinates → ITRF2020 at epoch 2010.5
+// Time-dependent 14-parameter Helmert (IERS/EPSG): ITRF88–ITRF2020,
+// ETRF2000/2014/2020, NAD83(2011). 'WGS84' aliases ITRF2020.
 const itrf = transformFrame(
-  [3924687.7039, 301132.7618, 5001910.7712],
+  [3924687.7, 301132.8, 5001910.8],
   'ETRF2000',
   'ITRF2020',
   2010.5
 );
-// Time-dependent 14-parameter Helmert (IERS/EPSG parameters);
-// supports ITRF88–ITRF2020, ETRF2000/2014/2020, NAD83(2011).
-// 'WGS84' is treated as an ITRF2020 alias (standard GNSS practice).
 ```
 
-### RINEX parsing
+### RINEX — read, write & products
 
 ```ts
-import { parseRinexStream, parseNavFile } from 'gnss-js/rinex';
-
-// Streaming observation parser (positional arguments)
-const result = await parseRinexStream(
-  file, // File (plain, Hatanaka .crx, or .gz)
-  (percent) => {}, // optional progress callback
+import {
+  parseRinexStream,
+  parseNavFile,
+  parseSp3,
+  parseClk,
+  parseIonex,
+  writeRinexObsBlob,
+  writeRinexNav,
+  writeCrx,
+} from 'gnss-js/rinex';
+
+// Streaming observation parser — plain, Hatanaka .crx, or .gz
+const { header } = await parseRinexStream(
+  file,
+  (pct) => {}, // optional progress
   undefined, // optional AbortSignal
   (time, prn, codes, values) => {
-    // per-satellite observation callback
+    /* per-satellite obs callback */
   }
 );
-// result.header: RinexHeader
 
-// Navigation file parser
-const nav = parseNavFile(navFileText);
-// nav.ephemerides: KeplerEphemeris[] | GlonassEphemeris[]
+const nav = parseNavFile(navText); // KeplerEphemeris[] | GlonassEphemeris[]
+const sp3 = parseSp3(sp3Text); // precise orbits
+const clk = parseClk(clkText); // precise clocks
+
+// Writers: RINEX 2/3/4 obs + nav, and Hatanaka compression
+const rnx = writeRinexObsBlob(header, epochs);
+const crx = writeCrx(rnx); // → CRINEX
+```
+
+### Receiver binary formats
+
+One decoder per receiver family; each returns measurement epochs, and a companion nav parser reconstructs broadcast ephemeris from the raw frames.
+
+```ts
+import { parseSbfMeas, parseSbfNav, parseSbfHas } from 'gnss-js/sbf'; // Septentrio
+import { parseUbxRawx, parseUbxRawNav } from 'gnss-js/ubx'; // u-blox
+import { parseNovatelRange, parseNovatelNav } from 'gnss-js/novatel'; // NovAtel OEM4
+import { parseTrimble, parseTrimbleNav } from 'gnss-js/trimble'; // Trimble
+import { parseBinex } from 'gnss-js/binex'; // BINEX
+
+const sbf = parseSbfMeas(bytes); // measurement epochs + counts
+const nav = parseSbfNav(bytes); // GPS/GAL/BDS/GLO ephemeris from raw blocks
+const has = parseSbfHas(bytes); // Galileo HAS (E6 C/NAV) SSR corrections
 ```
 
-### RTCM3 decoding
+### RTCM (RTCM3, RTCM2, SSR)
 
 ```ts
-import { Rtcm3Decoder, decodeMsmFull, decodeEphemeris } from 'gnss-js/rtcm3';
+import {
+  Rtcm3Decoder,
+  decodeObs,
+  decodeEphemeris,
+  decodeSsr,
+  decodeIgsSsr,
+  updateStreamStats,
+  createStreamStats,
+} from 'gnss-js/rtcm3';
 
 const decoder = new Rtcm3Decoder();
-decoder.addData(chunk); // Uint8Array from NTRIP stream
+decoder.addData(chunk); // Uint8Array from an NTRIP stream
 for (const frame of decoder) {
-  const msm = decodeMsmFull(frame); // MSM4-7 observations
-  const eph = decodeEphemeris(frame); // broadcast ephemeris
+  const obs = decodeObs(frame); // ObsEpoch | null — MSM4-7 or legacy 1001-1012
+  const eph = decodeEphemeris(frame); // broadcast ephemeris (all constellations)
+  const ssr = decodeSsr(frame); // orbit/clock/bias corrections (1057-1068)
+  const igs = decodeIgsSsr(frame); // IGS-SSR 4076 (multi-GNSS + phase bias + iono)
 }
 ```
 
-### Orbit computation
-
 ```ts
-import { computeAllPositions, computeDop } from 'gnss-js/orbit';
+import { Rtcm2Decoder, rtcm2Observation, rtcm2Station } from 'gnss-js/rtcm2';
 
-const positions = computeAllPositions(ephemerides, times, receiverPosition);
-// positions.prns: string[], positions.times: number[]
-// positions.positions[prn][epochIdx]: { lat, lon, az, el } | null
+// Legacy RTCM 2.x — a wholly different wire format (30-bit words, 6-of-8)
+const frames = new Rtcm2Decoder().decode(bytes);
 ```
 
-### Signal analysis
+### Orbits, visibility & Doppler
 
 ```ts
-import { analyzeQuality } from 'gnss-js/analysis';
+import {
+  computeAllPositions,
+  computeVisibility,
+  computeDop,
+  dopplerHz,
+} from 'gnss-js/orbit';
 
-// One re-parse pass: multipath (per code band, Anubis-style), cycle
-// slips, completeness, and slant-TEC ionosphere series.
-const q = await analyzeQuality(file, header);
-// q.multipath, q.cycleSlips, q.completeness, q.iono
+const positions = computeAllPositions(ephemerides, times, rxEcef);
+const vis = computeVisibility(ephemerides, rxEcef, startMs, endMs, 300, 10);
+// vis.passes: rise/peak/set; vis.pdop / vis.visibleCount per epoch;
+// vis.elevation[prn]: elevation timeline for plotting.
+```
 
-// The accumulators (MultipathAccumulator, CycleSlipAccumulator,
-// CompletenessAccumulator, IonoAccumulator) are also exported for
-// wiring into a custom parseRinexStream pass.
+### Positioning — SPP → PPP → PPP-AR / RTK
+
+```ts
+import {
+  solveSpp,
+  ionoFree, // single-point
+  solvePpp, // static/kinematic float PPP + optional AR
+  postProcessRtk, // rnx2rtkp-style relative positioning
+  solveDgnss, // code-differential
+  SbasProcessor, // SBAS / DFMC augmentation
+} from 'gnss-js/positioning';
+
+// Single-point: ~10 m single-frequency; ionoFree(p1,p2,f1,f2) for metre-level.
+const spp = solveSpp(pseudoranges, ephemerides, epochMs);
+
+// Precise point positioning against SP3/CLK products (dm→cm; AR to cm).
+const ppp = solvePpp(pppEpochs, sp3, pppOptions);
+
+// Post-processed RTK: base + rover obs, ephemeris, base ECEF → fixed track.
+const rtk = postProcessRtk(baseObs, roverObs, ephemerides, baseEcef);
 ```
 
-### Ionosphere and DCBs
+### Signal quality & ionosphere
 
 ```ts
-import { parseSinexBiasDcb, applyIonoDcb } from 'gnss-js/analysis';
-
-// q.iono: slant TEC per satellite from the geometry-free phase
-// levelled to the code — DCB-biased until calibrated:
-const satDcb = parseSinexBiasDcb(sinexBiasText, obsEpochMs); // ESA .BIA / CAS .BSX
-const { result, receiverDcbTecu } = applyIonoDcb(q.iono, satDcb);
-// result.series[n].points: calibrated STEC (TECU); receiver bias
-// estimated from the night-time floor per system/signal pair.
+import {
+  analyzeQuality,
+  parseSinexBiasDcb,
+  applyIonoDcb,
+} from 'gnss-js/analysis';
+
+// One re-parse pass: multipath (per band, Anubis-style), cycle slips,
+// completeness, and slant-TEC series.
+const q = await analyzeQuality(file, header);
+
+// Calibrate STEC with satellite DCBs (ESA .BIA / CAS .BSX); receiver bias
+// from the night-time floor.
+const { result, receiverDcbTecu } = applyIonoDcb(
+  q.iono,
+  parseSinexBiasDcb(biasText, epochMs)
+);
 ```
 
-### NTRIP client
+The individual accumulators (`MultipathAccumulator`, `CycleSlipAccumulator`, `CompletenessAccumulator`, `IonoAccumulator`) are exported too, for a custom `parseRinexStream` pass.
+
+### NTRIP, NMEA & ANTEX
 
 ```ts
 import { fetchSourcetable, connectToMountpoint } from 'gnss-js/ntrip';
-
-const table = await fetchSourcetable('https://proxy.example.com', {
-  host: 'caster.example.com',
-  port: 2101,
-  version: '2.0',
-});
+import { parseNmeaFile, computeStats } from 'gnss-js/nmea';
+import { parseAntex } from 'gnss-js/antex';
 
 const { reader, abort } = await connectToMountpoint(
   'https://proxy.example.com',
@@ -183,28 +208,16 @@ const { reader, abort } = await connectToMountpoint(
     version: '2.0',
   }
 );
-```
-
-### NMEA and ANTEX
-
-```ts
-import { parseNmeaFile, computeStats } from 'gnss-js/nmea';
-import { parseAntex } from 'gnss-js/antex';
 
 const track = parseNmeaFile(nmeaText); // fixes, satellites, per-sentence records
-const stats = computeStats(track.fixes); // position/HDOP/speed statistics
 const antex = parseAntex(antexText); // antenna PCO/PCV calibrations
 ```
 
-### Constants
+### Constants & signals
 
 ```ts
-import {
-  C_LIGHT,
-  FREQ,
-  SYSTEM_NAMES,
-  DUAL_FREQ_PAIRS,
-} from 'gnss-js/constants';
+import { C_LIGHT, FREQ, SYSTEM_NAMES } from 'gnss-js/constants';
+import { CONSTELLATIONS, computePsdDb } from 'gnss-js/signals';
 
 FREQ['G']['1']; // 1575.42e6 Hz (GPS L1)
 SYSTEM_NAMES['E']; // "Galileo"
@@ -212,7 +225,7 @@ SYSTEM_NAMES['E']; // "Galileo"
 
 ## Unit conventions
 
-All functions use consistent units:
+All functions use consistent units, with explicit `@param`/`@returns` JSDoc:
 
 | Quantity    | Unit             |
 | ----------- | ---------------- |
@@ -221,12 +234,11 @@ All functions use consistent units:
 | Distances   | **meters**       |
 | Frequencies | **Hz**           |
 
-Every exported function has JSDoc with `@param` and `@returns` annotations including explicit units.
-
 ## Roadmap
 
-- **Class-based API** — Ergonomic wrappers like `GnssTime.fromUtc(date).gps` and `Position.fromGeodetic(lat, lon, h).utm` on top of the existing functional core
-- **RINEX observation writers** (RINEX 2/3/4 with gzip compression)
+- **Class-based API** — ergonomic wrappers (`GnssTime.fromUtc(date).gps`, `Position.fromGeodetic(...).utm`) over the functional core.
+- **RTCM3 MSM1–3** and NavIC 1041 ephemeris decoding.
+- **Real-time SSR/HAS application** — feeding decoded corrections into a live PPP solve.
 
 ## Development
 
@@ -238,9 +250,9 @@ pnpm run lint
 pnpm run build
 ```
 
-Without the fixtures, the nav-file test suites are skipped silently (`describe.skipIf`), so run the fetch script before trusting a green test run.
+Without the fixtures, the data-backed suites skip silently (`describe.skipIf`), so run the fetch script before trusting a green run.
 
-**Releasing**: bump the version and push the tag — CI publishes to npm via Trusted Publishing (one-time setup: npm package settings → Trusted Publisher → this repo + publish.yml) and creates the GitHub Release:
+**Releasing**: bump the version and push the tag — CI publishes to npm via Trusted Publishing and creates the GitHub Release:
 
 ```bash
 npm version patch   # or minor/major; updates package.json + creates the tag
@@ -258,5 +270,5 @@ cd ../gnsscalc && pnpm link ../gnss-js   # then `pnpm run build --watch` here
 
 This project is dual-licensed:
 
-- **AGPL-3.0** — Free for open-source projects. Any software that uses gnss-js must also be open-sourced under a compatible license.
-- **Commercial license** — For proprietary/closed-source use. Contact [work@miguel.es](mailto:work@miguel.es) for terms.
+- **AGPL-3.0** — free for open-source projects. Any software that uses gnss-js must also be open-sourced under a compatible license.
+- **Commercial license** — for proprietary/closed-source use. Contact [work@miguel.es](mailto:work@miguel.es) for terms.