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

The following fields are exposed in the node’s Properties panel in the UI. Types map to UI widgets (e.g. string → text input, number → numeric, boolean → toggle, select → dropdown, json → JSON editor).

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

Example node definition

A full node definition in config.json looks like the block below. Paste it under the sources key of your config, keyed by the node’s instance name (any identifier; it doesn’t have to match the node ID).

{
  "sources": {
    "gnss": {
      "outEndpoint": "inproc://gnss_data",
      "settings": {
        "baudrate": "auto",
        "dualGPS": false,
        "gnssOutputPeriodMS": 100,
        "initializeUnicore": true,
        "ntrip": {
          "enabled": false,
          "forwardGnss": true,
          "host": "192.168.1.1",
          "initialLatitude": 35.656948,
          "initialLongitude": 139.732025,
          "mountpoint": "mountpoint",
          "password": "password",
          "port": 2101,
          "user": "user",
          "userAgent": "LPVR-POS"
        },
        "port": "",
        "rtkTimeoutSec": 3,
        "verboseRtcmLogging": false
      }
    }
  }
}

Field reference

Field	Purpose
`outEndpoint`	ZMQ / inproc endpoint this source binds to publish its output. The runtime auto-generates one if omitted.
`settings`	All user-configurable fields — see the Properties table above.

Connections can also be declared at the top-level connections array when settings.explicitConnections is true, as an alternative to filling inputEndpoints on each node.

Loading documentation…