node-red-contrib-ntrip 0.2.8 → 0.2.9

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,18 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [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,8 +292,10 @@ 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.

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/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.9",
     "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"
     }