GNSS Source

Node ID: gnss · Role: Source · Realtime config: no

Description

GNSS/GPS receiver source (NMEA). Outputs GnssData (lat/lon/height, quality, satellite count, HDOP, RTK status).

Inputs / Outputs

Inputs: (none)
Outputs: Gnss

Config aliases

GnssSource, gnssSource, gnss, NmeaSource, nmeaSource

Properties

Each row shows the setting’s label in the node’s Properties panel and, in code, its key in the node’s settings object in the config file. A setting omitted from the config file uses the default shown here.

Property	Type	Default	Description
Serial Port `port`	select	`""`	Serial port device (e.g. COM3, /dev/ttyUSB0). ‘auto’ probes for a GNSS receiver automatically. Options: ``.
Baud Rate `baudrate`	select	`auto`	Serial baud rate. 0 lets the driver auto-detect from common rates. Options: `auto`, `9600`, `19200`, `38400`, `57600`, `115200`, `230400`, `460800`, `921600`.
Dual GPS `dualGPS`	boolean	`false`	Enable dual-antenna GNSS mode. Required to produce heading measurements.
Initialize Unicore `initializeUnicore`	boolean	`true`	Send Unicore receiver initialization commands on startup. Disable for non-Unicore receivers.
Output Period (ms) `gnssOutputPeriodMS`	number	`100`	Desired GNSS output period in milliseconds (e.g. 100 = 10 Hz). Configured on the receiver at startup.
RTK GPS timeout (s) `rtkTimeoutSec`	number	`3`
Verbose RTCM Logging `verboseRtcmLogging`	boolean	`false`
Enable NTRIP `ntrip.enabled`	boolean	`false`	Enable the built-in NTRIP client to stream RTCM corrections to the receiver.
NTRIP Host `ntrip.host`	string	`192.168.1.1`	NTRIP caster hostname or IP.
NTRIP Port `ntrip.port`	number	`2101`	NTRIP caster TCP port (typically 2101).
NTRIP Mountpoint `ntrip.mountpoint`	string	`mountpoint`	NTRIP mountpoint providing the RTCM correction stream.
NTRIP User `ntrip.user`	string	`user`	Username for the NTRIP caster.
NTRIP Password `ntrip.password`	string	`password`	Password for the NTRIP caster.
NTRIP User Agent `ntrip.userAgent`	string	`LPVR-POS`	User-Agent header sent in the NTRIP request.
Forward GGA to Caster `ntrip.forwardGnss`	boolean	`true`	Forward GGA sentences from the receiver to the caster (required for VRS / network-RTK services).
Initial Latitude `ntrip.initialLatitude`	number	`35.656948`	Initial latitude sent as the first GGA before the receiver has a fix. Required by some VRS services.
Initial Longitude `ntrip.initialLongitude`	number	`139.732025`	Initial longitude sent as the first GGA before the receiver has a fix.

Example node definition

A minimal entry in config.json looks like the block below. Paste it under the sources key, keyed by an instance name of your choice. All settings are optional: anything not listed under settings uses the default from the Properties table above. See The configuration file for how the sections and endpoint wiring work.

{
  "sources": {
    "gnss": {
      "outEndpoint": "inproc://gnss_data",
      "settings": {}
    }
  }
}

Loading documentation…