node-red-contrib-ntrip 0.1.0

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

@@ -0,0 +1,31 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    #- run: npm test

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+#      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [0.1.0]
+### Initial version
+
+**Note:** The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Karl-Heinz Wind
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# Vallox nodes for node-red
+[![Platform](https://img.shields.io/badge/platform-Node--RED-red)](https://nodered.org)
+![License](https://img.shields.io/github/license/windkh/node-red-contrib-ntrip.svg)
+[![NPM](https://img.shields.io/npm/v/node-red-contrib-ntrip?logo=npm)](https://www.npmjs.org/package/node-red-contrib-ntrip)
+[![Known Vulnerabilities](https://snyk.io/test/npm/node-red-contrib-ntrip/badge.svg)](https://snyk.io/test/npm/node-red-contrib-ntrip)
+[![Downloads](https://img.shields.io/npm/dm/node-red-contrib-ntrip.svg)](https://www.npmjs.com/package/node-red-contrib-ntrip)
+[![Total Downloads](https://img.shields.io/npm/dt/node-red-contrib-ntrip.svg)](https://www.npmjs.com/package/node-red-contrib-ntrip)
+[![Package Quality](http://npm.packagequality.com/shield/node-red-contrib-ntrip.png)](http://packagequality.com/#?package=node-red-contrib-ntrip)
+[![Open Issues](https://img.shields.io/github/issues-raw/windkh/node-red-contrib-ntrip.svg)](https://github.com/windkh/node-red-contrib-ntrip/issues)
+[![Closed Issues](https://img.shields.io/github/issues-closed-raw/windkh/node-red-contrib-ntrip.svg)](https://github.com/windkh/node-red-contrib-ntrip/issues?q=is%3Aissue+is%3Aclosed)
+...
+
+This package contains nodes for connecting to a NTRIP server. 
+
+# Dependencies
+This package depends on the following libraries
+@gnss/nmea
+@gnss/rtcm
+ntrip-client
+
+
+# Thanks for your donation
+If you want to support this free project. Any help is welcome. You can donate by clicking one of the following links:
+
+<a target="blank" href="https://blockchain.com/btc/payment_request?address=1PBi7BoZ1mBLQx4ePbwh1MVoK2RaoiDsp5"><img src="https://img.shields.io/badge/Donate-Bitcoin-green.svg"/></a>
+<a target="blank" href="https://www.paypal.me/windkh"><img src="https://img.shields.io/badge/Donate-PayPal-blue.svg"/></a>
+
+<a href="https://www.buymeacoffee.com/windka" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+
+
+# Credits
+
+
+# Changelog
+Changes can be followed [here](/CHANGELOG.md)
+
+
+# NTRIP Client Node
+...
+
+
+# RTCM Decoder Node
+
+
+# NMEA Decoder Node
+
+
+# License
+
+Author: Karl-Heinz Wind
+
+The MIT License (MIT)
+Copyright (c) 2025 by Karl-Heinz Wind
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/ntrip/99-ntrip.html

@@ -0,0 +1,178 @@
+<!-- Created by Karl-Heinz Wind -->
+
+<!-- ------------------------------------------------------------------------------------------ -->
+
+<script type="text/javascript">
+    RED.nodes.registerType('NtripClient', {
+        category: 'NTRIP',
+        color: '#DDDDDD',
+        defaults: {
+			description: { value:"" },
+            port: { value: 2101, required: false, validate:function(v) { return ((v === "") || (RED.validators.number(v) && (v >= 0) && (v <= 65535))) }},
+            host: { value:"" },
+            mountpoint: { value:"" },
+            interval: { value: 1000, required: false, validate:function(v) { return ((v === "") || (RED.validators.number(v) && (v >= 0) && (v <= 100000))) }},
+        },
+        credentials: {
+            username: { type: "text" },
+            password: { type: "password" },
+        },
+        inputs: 0,
+        outputs: 1,
+        icon: "bridge.png",
+        paletteLabel: "NTRIP Client",
+        label: function () {
+            return this.description || "NTRIP Client";
+        },
+        labelStyle: function() {
+            return this.description?"node_label_italic":"";
+        }
+    });
+
+</script>
+
+<script type="text/x-red" data-template-name="NtripClient">
+
+    <div class="form-row">
+        <label for="node-input-host"><i class="fa fa-tag"></i> NTRIP Server</label>
+        <input type="text" id="node-input-host" placeholder="The hostname or the IP address of the NTRIP server">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-port"><i class="fa fa-phone"></i> Port</label>
+        <input type="text" id="node-input-port" placeholder="The network port to open e.g. 2101">
+    </div> 
+
+    <div class="form-row">
+        <label for="node-input-mountpoint"><i class="fa fa-comment"></i> Mountpoint</label>
+        <input type="text" id="node-input-mountpoint" placeholder="The mountpoint of the stream">
+    </div> 
+
+    <div class="form-row">
+        <label for="node-input-username"><i class="fa fa-user"></i> Username</label>
+        <input type="text" id="node-input-username" placeholder="Enter the username here">
+    </div>
+    <div class="form-row">
+        <label for="node-input-password"><i class="fa fa-key"></i> Password</label>
+        <input type="text" id="node-input-password" placeholder="Enter the password here)">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-interval"><i class="fa fa-comment"></i> Interval (ms)</label>
+        <input type="text" id="node-input-interval" placeholder="The interval in milliseconds or 0">
+    </div> 
+
+    <div class="form-row">
+        <label for="node-input-description"><i class="fa fa-comment"></i> Description</label>
+        <input type="text" id="node-input-description" placeholder="The description of the node (optional)">
+    </div> 
+</script>
+
+<script type="text/x-red" data-help-name="NtripClient">
+    <p>A node that connects to a NTRIP server.</p>
+
+    <h3>Configuration</h3>
+
+    <p>Description of the device.</p>
+    
+    <h3>Inputs</h3>
+    <p>.</p>
+    
+    <h3>Outputs</h3>
+    <p>.</p>
+    <p><code>msg.payload</code></p>
+</script>
+
+
+<!-- ------------------------------------------------------------------------------------------ -->
+
+<script type="text/javascript">
+    RED.nodes.registerType('RtcmDecoder', {
+        category: 'NTRIP',
+        color: '#DDDDDD',
+        defaults: {
+			description: { value:"" },
+        },
+        inputs: 1,
+        outputs: 2,
+        icon: "function.png",
+        paletteLabel: "RTCM Decoder",
+        label: function () {
+            return this.description || "RTCM Decoder";
+        },
+        labelStyle: function() {
+            return this.description?"node_label_italic":"";
+        }
+    });
+
+</script>
+
+<script type="text/x-red" data-template-name="RtcmDecoder">
+    <div class="form-row">
+        <label for="node-input-description"><i class="fa fa-comment"></i> Description</label>
+        <input type="text" id="node-input-description" placeholder="The description of the node (optional)">
+    </div>  
+</script>
+
+<script type="text/x-red" data-help-name="RtcmDecoder">
+    <p>A node that decodes RTCM messages.</p>
+
+    <h3>Configuration</h3>
+
+    <p>Description of the device.</p>
+    
+    <h3>Inputs</h3>
+    <p>.</p>
+    
+    <h3>Outputs</h3>
+    <p>.</p>
+    <p><code>msg.payload</code></p>
+</script>
+
+<!-- ------------------------------------------------------------------------------------------ -->
+
+<script type="text/javascript">
+    RED.nodes.registerType('NmeaDecoder', {
+        category: 'NTRIP',
+        color: '#DDDDDD',
+        defaults: {
+			description: { value:"" },
+        },
+        inputs: 1,
+        outputs: 2,
+        icon: "function.png",
+        paletteLabel: "NMEA Decoder",
+        label: function () {
+            return this.description || "NMEA Decoder";
+        },
+        labelStyle: function() {
+            return this.description?"node_label_italic":"";
+        }
+    });
+
+</script>
+
+<script type="text/x-red" data-template-name="NmeaDecoder">
+    <div class="form-row">
+        <label for="node-input-description"><i class="fa fa-comment"></i> Description</label>
+        <input type="text" id="node-input-description" placeholder="The description of the node (optional)">
+    </div>  
+</script>
+
+<script type="text/x-red" data-help-name="NmeaDecoder">
+    <p>A node that decodes NMEA messages.</p>
+
+    <h3>Configuration</h3>
+
+    <p>Description of the device.</p>
+    
+    <h3>Inputs</h3>
+    <p>.</p>
+    
+    <h3>Outputs</h3>
+    <p>.</p>
+    <p><code>msg.payload</code></p>
+</script>
+
+// TODO: ntrip server / caster
+// TODO: rtcm encoder

package/ntrip/99-ntrip.js

@@ -0,0 +1,181 @@
+/**
+* Created by Karl-Heinz Wind
+**/
+
+module.exports = function (RED) {
+    "use strict";
+    	
+    const { RtcmTransport, RtcmMessage, RtcmMessageType } = require('@gnss/rtcm');
+    const { NmeaTransport, NmeaMessageUnknown } = require('@gnss/nmea');
+    const { NtripClient } = require('ntrip-client');
+
+    // --------------------------------------------------------------------------------------------
+    // NTRIP client node.
+    function NtripClientNode(config) {
+        RED.nodes.createNode(this, config);
+        let node = this;
+        node.messagesReceived = 0;
+
+        if(config.host !== undefined ) {
+
+            let options = {
+                host: config.host,
+                port: config.port || 2101,
+                mountpoint: config.mountpoint,
+                username: node.credentials.username,
+                password: node.credentials.password,
+                interval: config.interval,
+                // TODO: xyz, ... see https://github.com/dxhbiz/ntrip-client/blob/master/lib/client.js
+            };
+
+            const client = new NtripClient(options);
+
+            client.on('data', (data) => {
+                node.messagesReceived++;
+                node.status({
+                    fill: 'green',
+                    shape: 'ring',
+                    text: 'Messages ' + node.messagesReceived,
+                });
+
+                let msg = {
+                    payload : data
+                }
+                node.send(msg);
+            });
+
+            client.on('close', () => {
+                node.log('Closed NTRIP connection.');
+            });
+
+            client.on('error', (err) => {
+                node.log(err);
+            });
+
+            client.run();
+            node.status({
+                fill: 'green',
+                shape: 'ring',
+                text: 'ok',
+            });
+
+            this.on('close', function(done) {
+                client.close();
+                node.status({});
+                done();
+            });
+        }
+    }
+    RED.nodes.registerType("NtripClient", NtripClientNode, {
+        credentials: {
+            username: { type: "text" },
+            password: { type: "password" },
+        }
+    });
+
+
+    // --------------------------------------------------------------------------------------------
+    // RTCM decoder node.
+    function RtcmDecoderNode(config) {
+        RED.nodes.createNode(this, config);
+        let node = this;
+        node.rtcmMessagesReceived = 0;
+        node.invalidMessagesReceived = 0;
+
+        this.on('input', function (msg) {
+
+            let buffer = msg.payload;
+            try
+            {
+                let message;
+                let length;
+                [message, length] = RtcmTransport.decode(buffer);        
+                let msg = {
+                    payload : {
+                        messageType : message.messageType,
+                        message : message,
+                        info : message.info,
+                    },
+                    length : length,
+                    buffer : buffer,
+                };
+
+                // TODO: slice buffer and iterate.
+                node.send([msg, null]);
+                node.rtcmMessagesReceived++;
+            }
+            catch(ex)
+            {
+                let msg = {
+                    payload : ex,
+                    buffer : buffer,
+                };
+                node.send([null, msg]);
+                node.invalidMessagesReceived++;
+            }
+
+            node.status({
+                fill: 'green',
+                    shape: 'ring',
+                    text: 'RTCM: ' + node.rtcmMessagesReceived + ' Invalid: ' + node.invalidMessagesReceived,
+                });
+        });
+
+        this.on('close', function(done) {
+            node.status({});
+            done();
+        });
+    }
+    RED.nodes.registerType("RtcmDecoder", RtcmDecoderNode);
+
+        // --------------------------------------------------------------------------------------------
+    // NMEA decoder node.
+    function NmeaDecoderNode(config) {
+        RED.nodes.createNode(this, config);
+        let node = this;
+        node.nmeaMessagesReceived = 0;
+        node.invalidMessagesReceived = 0;
+
+        this.on('input', function (msg) {
+
+            let buffer = msg.payload;
+            try
+            {
+                let message = NmeaTransport.decode(buffer);   
+                let messageType = message.constructor.name.replace('NmeaMessage', '').toUpperCase();
+
+                let msg = {
+                    payload : {
+                        messageType : messageType,
+                        message : message,
+                    },
+                    buffer : buffer,
+                };
+
+                node.send([msg, null]);
+                node.nmeaMessagesReceived++;
+            }
+            catch(ex)
+            {
+                let msg = {
+                    payload : ex,
+                    buffer : buffer,
+                };
+                node.send([null, msg]);
+                node.invalidMessagesReceived++;
+            }
+
+            node.status({
+                fill: 'green',
+                    shape: 'ring',
+                    text: 'NMEA: ' + node.nmeaMessagesReceived + ' Invalid: ' + node.invalidMessagesReceived,
+                });
+        });
+
+        this.on('close', function(done) {
+            node.status({});
+            done();
+        });
+    }
+    RED.nodes.registerType("NmeaDecoder", NmeaDecoderNode);
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+    "name": "node-red-contrib-ntrip",
+    "version": "0.1.0",
+    "description": "Node for ntrip and rtcm handling.",
+    "node-red": {
+        "version": ">=0.1.0",
+        "nodes": {
+            "ntrip": "ntrip/99-ntrip.js"
+        }
+    },
+    "engines": {
+        "node": ">=7.6.0"
+    },
+    "keywords": [
+        "node-red",
+        "rtcm",
+        "ntrip",
+        "gnss"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/windkh/node-red-contrib-ntrip"
+    },
+    "author": "Karl-Heinz Wind",
+    "license": "MIT",
+    "dependencies": {
+        "@gnss/nmea": "^0.1.2",
+        "@gnss/rtcm": "^0.1.5",
+        "ntrip-client": "^1.1.1"
+    }
+}