node-red-contrib-ntrip 0.2.8 → 0.2.10

package/.github/workflows/node.js.yml

@@ -19,7 +19,7 @@ jobs:
                 # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
         steps:
-            - uses: actions/checkout@v6
+            - uses: actions/checkout@v7
             - name: Use Node.js ${{ matrix.node-version }}
               uses: actions/setup-node@v6
               with:

package/.github/workflows/release.yml

@@ -23,7 +23,7 @@ jobs:
             matrix:
                 node-version: [18.x, 20.x, 22.x]
         steps:
-            - uses: actions/checkout@v6
+            - uses: actions/checkout@v7
             - name: Use Node.js ${{ matrix.node-version }}
               uses: actions/setup-node@v6
               with:
@@ -38,7 +38,7 @@ jobs:
         needs: test
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v6
+            - uses: actions/checkout@v7
             - uses: actions/setup-node@v6
               with:
                   node-version: 20
@@ -54,7 +54,7 @@ jobs:
         permissions:
             contents: write
         steps:
-            - uses: actions/checkout@v6
+            - uses: actions/checkout@v7
               with:
                   fetch-depth: 0
             - name: Create GitHub Release

package/CHANGELOG.md

@@ -1,6 +1,25 @@
 # 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.
+
+### Internal — dependency bumps (dev tree, no runtime changes)
+- `node-red` 4.1.11 → 5.0.1 (via the sigstore/node-red bundle).
+- `eslint` 10.4.1 → 10.6.0.
+- `prettier` 3.8.3 → 3.9.3.
+- `mocha` 11.7.5 → 11.7.6.
+- `globals` 17.6.0 → 17.7.0.
+- `actions/checkout` v6 → v7 in the CI + release workflows.
+
 ## [0.2.8]
 ### Added RTCM Encoder node
 - New `RtcmEncoder` node — inverse of `RtcmDecoder`. Accepts an `RtcmMessage` instance (or `msg.payload.message` from the decoder) and emits the encoded RTCM 3 frame as `msg.payload.rtcmMessage` (Buffer).

package/README.md

@@ -292,11 +292,18 @@ A few things that are easy to get wrong:
   interleaved with bytes received from the caster. Downstream nodes will see
   both streams on the same wire — distinguish them with a tag in a function
   node if you need to.
-- **NTRIP Client: status badge.** `Rx N Tx M` counts inbound and outbound
-  messages separately. Handshake replies do not bump the inbound count.
+- **NTRIP Client: status badge.** `<rate> Rx N Tx M` shows the inbound data
+  rate (sampled over a 1-second window; formatted as `bps`, `kbps`, or `Mbps`)
+  followed by the inbound and outbound message counts. Handshake replies do
+  not bump the inbound count.
 - **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;
@@ -343,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/99-ntrip.html

@@ -209,8 +209,11 @@
     <h3>Status</h3>
     <p>The node shows <code>connecting…</code> until the caster acknowledges the
        handshake with <code>ICY 200 OK</code>. After that it shows the running
-       <code>Rx</code> / <code>Tx</code> counters. A red badge indicates a rejected
-       connection, a missing mountpoint, or a write failure.</p>
+       <code>Rx</code> / <code>Tx</code> message counters plus the inbound data
+       rate in <code>bps</code> / <code>kbps</code> / <code>Mbps</code>, sampled
+       once per second over a 1-second window
+       (e.g. <code>2.4 kbps Rx 123 Tx 4</code>). A red badge indicates a
+       rejected connection, a missing mountpoint, or a write failure.</p>
 
     <h3>Details</h3>
     <p>The first <code>ICY 200 OK</code>, <code>ICY 406</code>, or

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/ntrip/nodes/ntrip-client-node.js

@@ -7,11 +7,23 @@ module.exports = function (RED) {
     const NtripServerMissingMountpoint = 'SOURCETABLE 200 OK';
     const HandshakePrefixBytes = 64;
 
+    function formatBps(bps) {
+        if (bps < 1000) {
+            return Math.round(bps) + ' bps';
+        }
+        if (bps < 1000000) {
+            return (bps / 1000).toFixed(1) + ' kbps';
+        }
+        return (bps / 1000000).toFixed(2) + ' Mbps';
+    }
+
     function NtripClientNode(config) {
         RED.nodes.createNode(this, config);
         let node = this;
         node.messagesReceived = 0;
         node.messagesSent = 0;
+        node.bytesAccum = 0;
+        node.currentBps = 0;
         node.passthrough = config.passthrough || false;
 
         let host = typeof config.host === 'string' ? config.host.trim() : '';
@@ -70,11 +82,21 @@ module.exports = function (RED) {
             node.status({
                 fill: 'green',
                 shape: 'ring',
-                text: 'Rx ' + node.messagesReceived + ' Tx ' + node.messagesSent,
+                text: formatBps(node.currentBps) + ' Rx ' + node.messagesReceived + ' Tx ' + node.messagesSent,
             });
         }
 
+        // Sample inbound byte counter once per second to compute the bps shown in the
+        // status badge. Counter is reset each tick — currentBps reflects the most
+        // recent 1-second window.
+        const bpsSampler = setInterval(() => {
+            node.currentBps = node.bytesAccum * 8;
+            node.bytesAccum = 0;
+            updateStatus();
+        }, 1000);
+
         client.on('data', (data) => {
+            node.bytesAccum += data.length;
             if (!connected) {
                 let prefix = data.toString('utf8', 0, Math.min(data.length, HandshakePrefixBytes));
                 if (prefix.startsWith(NtripServerOkReply)) {
@@ -163,6 +185,7 @@ module.exports = function (RED) {
         });
 
         this.on('close', function (done) {
+            clearInterval(bpsSampler);
             try {
                 client.removeAllListeners();
                 client.close();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-ntrip",
-    "version": "0.2.8",
+    "version": "0.2.10",
     "description": "Node for ntrip and rtcm handling.",
     "node-red": {
         "version": ">=0.1.0",
@@ -43,7 +43,7 @@
         "eslint-config-prettier": "^10.1.8",
         "globals": "^17.6.0",
         "mocha": "^11.7.5",
-        "node-red": "^4.1.10",
+        "node-red": "^5.0.1",
         "node-red-node-test-helper": "^0.3.6",
         "prettier": "^3.8.3"
     }