node-red-contrib-ntrip 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.1.1]
+### MInor tweaks
+
 ## [0.1.0]
 ### Initial version
 

package/examples/tcp.json

@@ -0,0 +1 @@
+[{"id":"91bc83d1480be9ce","type":"RtcmDecoder","z":"95fe791a9c2e02fb","description":"","x":780,"y":100,"wires":[["86db72067d6de6eb"],["bcb4f78f38f73614"]]},{"id":"86db72067d6de6eb","type":"debug","z":"95fe791a9c2e02fb","name":"debug 42","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":1000,"y":80,"wires":[]},{"id":"bcb4f78f38f73614","type":"debug","z":"95fe791a9c2e02fb","name":"debug 44","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":1000,"y":120,"wires":[]},{"id":"fa8ecd8584cd2497","type":"NmeaDecoder","z":"95fe791a9c2e02fb","description":"","x":780,"y":220,"wires":[["ce248cbbb81fedc7"],["1e5f02ac026876e5"]]},{"id":"ce248cbbb81fedc7","type":"debug","z":"95fe791a9c2e02fb","name":"debug 45","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":1000,"y":200,"wires":[]},{"id":"1e5f02ac026876e5","type":"debug","z":"95fe791a9c2e02fb","name":"debug 46","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":1000,"y":240,"wires":[]},{"id":"381976b4de0e6794","type":"tcp in","z":"95fe791a9c2e02fb","name":"","server":"client","host":"rtkbase.fritz.box","port":"5016","datamode":"stream","datatype":"buffer","newline":"","topic":"","trim":false,"base64":false,"tls":"","x":530,"y":160,"wires":[["91bc83d1480be9ce","fa8ecd8584cd2497"]]},{"id":"cf03abb372a163fb","type":"comment","z":"95fe791a9c2e02fb","name":"","info":"This example demonstrates how to connect to \na TCP sever that streams RTCM messages.\n\nE.g. https://github.com/Stefal/rtkbase\n","x":480,"y":100,"wires":[]}]

package/ntrip/99-ntrip.html

@@ -5,13 +5,16 @@
 <script type="text/javascript">
     RED.nodes.registerType('NtripClient', {
         category: 'NTRIP',
-        color: '#DDDDDD',
+        color: '#C0DEED',
         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))) }},
+            xcoordinate: { value: 0, required: false, validate:function(v) { return ((v === "") || (RED.validators.number(v) )) }},
+            ycoordinate: { value: 0, required: false, validate:function(v) { return ((v === "") || (RED.validators.number(v) )) }},
+            zcoordinate: { value: 0, required: false, validate:function(v) { return ((v === "") || (RED.validators.number(v) )) }},
         },
         credentials: {
             username: { type: "text" },
@@ -62,6 +65,30 @@
         <input type="text" id="node-input-interval" placeholder="The interval in milliseconds or 0">
     </div> 
 
+    
+    <hr align="middle"/>
+
+    <div class="form-row" id="coordinates" style="background: var(--red-ui-tertiary-background)">
+        <label style="width: auto"><i class="fa fa-crosshairs"></i> Optional location (if set a NMEA GGA sentence is sent to the server)</label>
+        
+        <div class="form-row">
+            <label for="node-input-x"> X</label>
+            <input type="text" id="node-input-x" placeholder="The X position or 0 (optional)">
+        </div> 
+
+        <div class="form-row">
+            <label for="node-input-y"> Y</label>
+            <input type="text" id="node-input-y" placeholder="The Y position or 0 (optional)">
+        </div> 
+
+        <div class="form-row">
+            <label for="node-input-z"> Z</label>
+            <input type="text" id="node-input-z" placeholder="The Z position or 0 (optional)">
+        </div> 
+    </div>
+
+    <hr align="middle"/>
+
     <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)">
@@ -89,7 +116,7 @@
 <script type="text/javascript">
     RED.nodes.registerType('RtcmDecoder', {
         category: 'NTRIP',
-        color: '#DDDDDD',
+        color: '#C0DEED',
         defaults: {
 			description: { value:"" },
         },
@@ -134,7 +161,7 @@
 <script type="text/javascript">
     RED.nodes.registerType('NmeaDecoder', {
         category: 'NTRIP',
-        color: '#DDDDDD',
+        color: '#C0DEED',
         defaults: {
 			description: { value:"" },
         },
@@ -173,6 +200,3 @@
     <p>.</p>
     <p><code>msg.payload</code></p>
 </script>
-
-// TODO: ntrip server / caster
-// TODO: rtcm encoder

package/ntrip/99-ntrip.js

@@ -25,9 +25,18 @@ module.exports = function (RED) {
                 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
             };
 
+            let x = config.xcoordinate;
+            let y = config.ycoordinate;
+            let z = config.zcoordinate;
+            
+            if (x !== undefined && x !== 0 &&
+                y !== undefined && y !== 0 &&
+                z !== undefined && z !== 0) {
+                options.xyz = [x, y, z];
+            }
+
             const client = new NtripClient(options);
 
             client.on('data', (data) => {
@@ -87,28 +96,40 @@ module.exports = function (RED) {
             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++;
+                do {
+                    let message;
+                    let length;
+                    [message, length] = RtcmTransport.decode(buffer);     
+                    
+                    let messageType = message.constructor.name.replace('RtcmMessage', '');
+
+                    let msg = {
+                        payload : {
+                            rtcm : message.messageType,
+                            messageType : messageType,
+                            message : message,
+                            input : buffer,
+                            length : length
+                        }
+                    };
+
+                    node.send([msg, null]);
+                    node.rtcmMessagesReceived++;
+
+                    // find next message in buffer.
+                    buffer = buffer.slice(length);
+                    if(buffer.length == 0){
+                        done = true;
+                    }
+                } while(!done);
             }
             catch(ex)
             {
                 let msg = {
-                    payload : ex,
-                    buffer : buffer,
+                    payload : {
+                        error : ex,
+                        input : buffer,
+                    }
                 };
                 node.send([null, msg]);
                 node.invalidMessagesReceived++;
@@ -139,6 +160,10 @@ module.exports = function (RED) {
         this.on('input', function (msg) {
 
             let buffer = msg.payload;
+            if(Buffer.isBuffer(buffer)){
+                buffer = buffer.toString();
+            }
+            
             try
             {
                 let message = NmeaTransport.decode(buffer);   
@@ -147,9 +172,9 @@ module.exports = function (RED) {
                 let msg = {
                     payload : {
                         messageType : messageType,
-                        message : message,
+                        message : message,   
+                        input : buffer
                     },
-                    buffer : buffer,
                 };
 
                 node.send([msg, null]);
@@ -158,8 +183,10 @@ module.exports = function (RED) {
             catch(ex)
             {
                 let msg = {
-                    payload : ex,
-                    buffer : buffer,
+                    payload : {
+                        error : ex,
+                        input : buffer,
+                    }
                 };
                 node.send([null, msg]);
                 node.invalidMessagesReceived++;

package/package.json

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