Class: NtripClient

Constructor

new NtripClient(eventEmitter, options)

Create a new NTRIP client

Parameters:

Name	Type	Description
`eventEmitter`	Object	Event emitter for communication
`options`	Object	Configuration options

Source: ntrip-client.js, line 5

Classes

NtripClient

Methods

(async) connect(config) → {Promise.<boolean>}

Connect to NTRIP caster using the configured method

Parameters:

Name	Type	Description
`config`	Object	Connection configuration

Source: ntrip-client.js, line 88

Returns:

Whether connection was successful

Type:: Promise.<boolean>

(async) connectDirect() → {Promise.<boolean>}

Connect directly to NTRIP caster

Source: ntrip-client.js, line 362

Returns:

Whether connection was successful

Type:: Promise.<boolean>

(async) connectProxy() → {Promise.<boolean>}

Connect to NTRIP caster via HTTP proxy

Source: ntrip-client.js, line 467

Returns:

Whether connection was successful

Type:: Promise.<boolean>

(async) connectWebSocket() → {Promise.<boolean>}

Connect to NTRIP caster using WebSocket to proxy

Source: ntrip-client.js, line 239

Returns:

Whether connection was successful

Type:: Promise.<boolean>

createGgaSentence(position) → {string}

Create NMEA GGA sentence from position data

Parameters:

Name	Type	Description
`position`	Object	Position data

Source: ntrip-client.js, line 1252

Returns:

GGA sentence

Type:: string

disconnect()

Disconnect from NTRIP caster

Source: ntrip-client.js, line 860

forwardRtcmToDevice(data)

Forward RTCM data to connected device

Parameters:

Name	Type	Description
`data`	ArrayBuffer	RTCM binary data to forward

Source: ntrip-client.js, line 803

getConnectionInfo() → {Object}

Get connection status information

Source: ntrip-client.js, line 1457

Returns:

Connection status

Type:: Object

getRtcmStats() → {Object}

Get RTCM statistics

Source: ntrip-client.js, line 1418

Returns:

RTCM statistics

Type:: Object

handleDisconnect(event)

Handle disconnection (either manual or due to error)

Parameters:

Name	Type	Description
`event`	Object	Disconnection event info

Source: ntrip-client.js, line 901

(async) handleRtcmData(data)

Handle binary RTCM data from WebSocket

Parameters:

Name	Type	Description
`data`	ArrayBuffer \| Blob	RTCM data

Source: ntrip-client.js, line 664

handleSocketClose(event)

Handle WebSocket close event

Parameters:

Name	Type	Description
`event`	CloseEvent	WebSocket close event

Source: ntrip-client.js, line 641

handleSocketError(event)

Handle WebSocket error event

Parameters:

Name	Type	Description
`event`	Event	WebSocket error event

Source: ntrip-client.js, line 652

handleSocketMessage(event)

Handle WebSocket message (for WebSocket mode)

Parameters:

Name	Type	Description
`event`	MessageEvent	WebSocket message event

Source: ntrip-client.js, line 593

isValidGga(sentence) → {boolean}

Validate if a GGA sentence is properly formatted

Parameters:

Name	Type	Description
`sentence`	string	GGA sentence to validate

Source: ntrip-client.js, line 1357

Returns:

Whether the sentence is valid

Type:: boolean

isValidRtcmData(data) → {boolean}

Validate if the data is in RTCM3 format

Parameters:

Name	Type	Description
`data`	ArrayBuffer	Binary data to validate

Source: ntrip-client.js, line 740

Returns:

Whether the data appears to be valid RTCM3

Type:: boolean

(async) processRtcmQueue()

Process the queue of RTCM messages

Source: ntrip-client.js, line 948

(async) readStream()

Read and process the response stream from the NTRIP caster (for direct/proxy mode)

Source: ntrip-client.js, line 548

resetRtcmStats()

Reset RTCM statistics

Source: ntrip-client.js, line 1433

scheduleReconnect()

Schedule a reconnection attempt

Source: ntrip-client.js, line 929

(async) sendGGA(gga) → {Promise.<boolean>}

Send NMEA GGA sentence to NTRIP caster

Parameters:

Name	Type	Description
`gga`	string	NMEA GGA sentence

Source: ntrip-client.js, line 1111

Returns:

Whether message was sent successfully

Type:: Promise.<boolean>

(async) sendGGADirect(gga) → {Promise.<boolean>}

Send GGA directly to NTRIP caster

Parameters:

Name	Type	Description
`gga`	string	NMEA GGA sentence

Source: ntrip-client.js, line 1164

Returns:

Whether message was sent successfully

Type:: Promise.<boolean>

(async) sendGGAProxy(gga) → {Promise.<boolean>}

Send GGA via proxy

Parameters:

Name	Type	Description
`gga`	string	NMEA GGA sentence

Source: ntrip-client.js, line 1202

Returns:

Whether message was sent successfully

Type:: Promise.<boolean>

(async) sendGGAWebSocket(gga) → {Promise.<boolean>}

Send GGA via WebSocket

Parameters:

Name	Type	Description
`gga`	string	NMEA GGA sentence

Source: ntrip-client.js, line 1141

Returns:

Whether message was sent successfully

Type:: Promise.<boolean>

setAutoReconnect(enabled, maxAttempts)

Enable/disable auto-reconnect

Parameters:

Name	Type	Default	Description
`enabled`	boolean		Whether auto-reconnect is enabled
`maxAttempts`	number	5	Maximum reconnection attempts

Source: ntrip-client.js, line 1448

setDeviceManager(deviceManager)

Set the device manager for sending corrections

Parameters:

Name	Type	Description
`deviceManager`	Object	ConnectionManager or BluetoothManager

Source: ntrip-client.js, line 74

setGgaUpdateInterval(seconds)

Set the GGA update interval

Parameters:

Name	Type	Description
`seconds`	number	Update interval in seconds

Source: ntrip-client.js, line 1074

startGgaUpdates()

Start periodically sending GGA updates to the NTRIP caster

Source: ntrip-client.js, line 985

stopGgaUpdates()

Stop sending GGA updates

Source: ntrip-client.js, line 1063

updateCorrectionAge()

Update correction age based on last message time

Source: ntrip-client.js, line 1407

updatePosition(position)

Update the device with the latest position

Parameters:

Name	Type	Description
`position`	Object	Position data

Source: ntrip-client.js, line 1096