node-red-contrib-ntrip 0.2.9 → 0.2.10

package/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.2.10]
+### NtripClient
+- Reconnect attempts now use an exponential-ish backoff schedule (`1 s`, `2 s`, `5 s`, `10 s`, then capped at `10 s`) instead of the upstream library's fixed `2 s` interval. The schedule resets to `1 s` the moment the caster completes the `ICY 200 OK` handshake, so a brief outage restarts from the short end and a caster that stays down is no longer hammered.
+
+### Documentation
+- Added `examples/watchdog.json` — an example flow that alerts (via a built-in `trigger` node) when the NTRIP correction stream stops delivering data for more than 60 seconds. Closes [#4](https://github.com/windkh/node-red-contrib-ntrip/issues/4).
+
 ## [0.2.9]
 ### NtripClient
 - Status badge now shows the inbound data rate alongside the Rx/Tx message counters (e.g. `2.4 kbps Rx 123 Tx 4`). The rate is sampled once per second and formatted as `bps`, `kbps`, or `Mbps` depending on magnitude.

package/README.md

@@ -299,6 +299,11 @@ A few things that are easy to get wrong:
 - **NTRIP Client: CR/LF in credentials.** `mountpoint`, `username`, and
   `password` are interpolated into the handshake string. CR/LF in these fields
   is rejected at startup to prevent header injection.
+- **NTRIP Client: reconnect backoff.** When the socket to the caster drops the
+  client waits `1 s`, then `2 s`, `5 s`, `10 s` before each successive retry
+  (capped at `10 s`). The schedule resets to `1 s` as soon as the caster
+  completes the `ICY 200 OK` handshake again — so a brief outage restarts at
+  the low end, and a caster that stays down doesn't get hammered.
 - **NMEA Encoder input shape.** The encoder expects `msg.payload` to be an
   object with `messageType` and `nmeaMessage` properties — not a NMEA string.
   To re-encode the output of the NMEA Decoder you can pipe it straight in;
@@ -345,6 +350,16 @@ a local demo version of SNIP by creating a raw TCP input stream.
 (SNIP can be found here https://www.use-snip.com)
 See also example flow [**Upload flow**](examples/upload.json)
 
+## Detect a stalled correction stream
+NTRIP casters occasionally stop emitting data without closing the TCP socket
+— the NtripClient node stays "connected" but no new frames arrive, and any
+downstream rover eventually drops out of RTK-fixed mode without an obvious
+cause. This example wires the NtripClient output into a built-in `trigger`
+node configured to fire an alert message after 60 seconds of silence
+(configurable via the trigger's Duration field). Every incoming frame resets
+the timer, so the alert only fires when the stream is genuinely stalled.
+See also example flow [**Watchdog flow**](examples/watchdog.json)  (closes [#4](https://github.com/windkh/node-red-contrib-ntrip/issues/4))
+
 # License
 
 Author: Karl-Heinz Wind

package/examples/watchdog.json

@@ -0,0 +1 @@
+[{"id":"47bd8463328d83d3","type":"comment","z":"a604108643639054","name":"NTRIP stream stall watchdog — alert after 60s of silence","info":"Alerts when the NTRIP correction stream stops delivering data.\n\nHow it works:\n- Every message from the NTRIP Client resets the trigger node's timer.\n- If no message arrives within 60 seconds, the trigger fires and the STALL\n  debug pane shows an alert.\n- When data resumes, the next message resets the timer — no explicit\n  \"recovered\" notification is emitted (extend the flow with a function\n  node if you need that).\n\nAdjust the timeout in the trigger node's Duration field.\n","x":260,"y":80,"wires":[]},{"id":"9f622b9ab6a72772","type":"NtripClient","z":"a604108643639054","description":"RTK2Go","passthrough":false,"port":"2101","host":"rtk2go.com","mountpoint":"Foo","interval":1000,"xcoordinate":"","ycoordinate":"","zcoordinate":"","x":140,"y":180,"wires":[["5107785e11b2425a","eb42f2cd60fcdc8f"]]},{"id":"5107785e11b2425a","type":"debug","z":"a604108643639054","name":"data (each frame)","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":430,"y":140,"wires":[]},{"id":"eb42f2cd60fcdc8f","type":"trigger","z":"a604108643639054","name":"60s stall watchdog","op1":"","op2":"NTRIP stream stalled — no data for 60 s","op1type":"nul","op2type":"str","duration":"60","extend":true,"overrideDelay":false,"units":"s","reset":"","bytopic":"all","topic":"topic","outputs":1,"x":440,"y":220,"wires":[["25f028d01cad6b57"]]},{"id":"25f028d01cad6b57","type":"debug","z":"a604108643639054","name":"STALL","active":true,"tosidebar":true,"console":false,"tostatus":true,"complete":"payload","targetType":"msg","statusVal":"payload","statusType":"auto","x":660,"y":220,"wires":[]}]

package/ntrip/lib/ntrip-client.js

@@ -4,8 +4,43 @@
 const { NtripClient } = require('ntrip-client');
 const net = require('net');
 
+// Backoff schedule for reconnect attempts, in milliseconds. The upstream
+// client's default is a fixed 2000ms interval which flooded casters (and the
+// Node-RED error log) when a server was down for a while. See issue on repeated
+// error output during outages. The last entry acts as a cap for further retries.
+const RECONNECT_BACKOFF_MS = [1000, 2000, 5000, 10000];
+
+// Extends the upstream client with an exponential backoff on reconnect.
+// The schedule advances on each failed reconnect and resets to the first
+// entry as soon as the caster completes the handshake (`ICY 200 OK`).
+class NtripClientWithBackoff extends NtripClient {
+    constructor(options) {
+        super(options);
+        this._backoffIndex = 0;
+        this.reconnectInterval = RECONNECT_BACKOFF_MS[0];
+    }
+
+    _onData(data) {
+        const wasReady = this.isReady;
+        super._onData(data);
+        // Reset the backoff schedule the moment the handshake completes —
+        // subsequent connection failures start over at the first entry.
+        if (!wasReady && this.isReady) {
+            this._backoffIndex = 0;
+            this.reconnectInterval = RECONNECT_BACKOFF_MS[0];
+        }
+    }
+
+    async _reconnect() {
+        const step = Math.min(this._backoffIndex, RECONNECT_BACKOFF_MS.length - 1);
+        this.reconnectInterval = RECONNECT_BACKOFF_MS[step];
+        this._backoffIndex++;
+        return super._reconnect();
+    }
+}
+
 // Orginal class is extended to be able to send data to the caster.
-class NtripClientUploader extends NtripClient {
+class NtripClientUploader extends NtripClientWithBackoff {
     constructor(options) {
         super(options);
         this.authmode = options.authmode || 'legacy';
@@ -98,7 +133,7 @@ class NtripClientUploader extends NtripClient {
 }
 
 function createDownloader(options) {
-    return new NtripClient(options);
+    return new NtripClientWithBackoff(options);
 }
 
 function createUploader(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-ntrip",
-    "version": "0.2.9",
+    "version": "0.2.10",
     "description": "Node for ntrip and rtcm handling.",
     "node-red": {
         "version": ">=0.1.0",