node-red-contrib-ntrip 0.2.3 → 0.2.7

package/doc/architecture/statistics.md

@@ -0,0 +1,118 @@
+# Statistics
+
+Snapshot taken at **v0.2.6** (commit `ecf02ba`).
+
+## Lines of code
+
+### Source
+
+| File | LOC |
+|------|----:|
+| [ntrip/99-ntrip.html](../../ntrip/99-ntrip.html) | 467 |
+| [ntrip/nodes/ntrip-client-node.js](../../ntrip/nodes/ntrip-client-node.js) | 182 |
+| [ntrip/nodes/nmea-encoder-node.js](../../ntrip/nodes/nmea-encoder-node.js) | 177 |
+| [ntrip/lib/ntrip-client.js](../../ntrip/lib/ntrip-client.js) | 114 |
+| [ntrip/nodes/nmea-decoder-node.js](../../ntrip/nodes/nmea-decoder-node.js) | 98 |
+| [ntrip/nodes/rtcm-decoder-node.js](../../ntrip/nodes/rtcm-decoder-node.js) | 91 |
+| [ntrip/99-ntrip.js](../../ntrip/99-ntrip.js) | 26 |
+| **Total** | **1155** |
+
+- JavaScript-only source: **688 LOC** across 6 files.
+- HTML editor UI: **467 LOC** in one file.
+
+### Tests
+
+| File | LOC | Tests |
+|------|----:|------:|
+| [test/nmea-decoder.spec.js](../../test/nmea-decoder.spec.js) | 134 | 6 |
+| [test/rtcm-decoder.spec.js](../../test/rtcm-decoder.spec.js) | 108 | 4 |
+| [test/nmea-encoder.spec.js](../../test/nmea-encoder.spec.js) | 96 | 4 |
+| **Total** | **338** | **14** |
+
+### Ratios
+
+| Metric | Value |
+|--------|------:|
+| Test LOC / JS source LOC | 49 % |
+| Tests per JS source file (4 of 6 covered by specs) | 3.5 avg |
+| Comments + blank lines (rough estimate) | ~20 % of source |
+
+## Test suite
+
+Run with `npm test`. Latest local run: **14 passing, 0 failing, ~500 ms**.
+
+Breakdown:
+
+- **NmeaDecoder** (6 specs) — golden GGA decode, multi-sentence split, Buffer
+  input, `payload.nmeaMessage` shape, Buffer preservation in error output, no
+  `node.error` flood (regression).
+- **NmeaEncoder** (4 specs) — `NmeaMessage` instance passthrough, unknown
+  `messageType` routed to error output, missing fields routed to error output,
+  empty payload handled.
+- **RtcmDecoder** (4 specs) — golden RTCM 1005 decode, two concatenated frames
+  fan out, frame split across two input events reassembled, no `node.error`
+  flood under garbage (regression).
+
+3 of the 14 specs are explicitly tagged `(regression: …)` and lock in
+previously-shipped bug fixes. Run them in isolation with
+`npx mocha test/**/*.spec.js -g regression`.
+
+NtripClient is *not* covered by the suite — it requires a fake TCP server.
+See [Future Improvements](future-improvements.md).
+
+## Coverage
+
+**Not measured.** No `c8` / `nyc` / Istanbul integration is configured. To
+enable, add `c8` as a dev dep and a `coverage` script (`c8 --reporter=text
+--reporter=html mocha test/**/*.spec.js`). Statement coverage of the three
+spec'd nodes should be ≥ 85 % at the current spec count; the missing 15 % is
+mostly edge-case branches inside `RtcmTransport.decode` failures.
+
+## Repository history
+
+Snapshot from `git log`:
+
+| Metric | Value |
+|--------|------:|
+| Total commits on `main` | 28 |
+| Commits matching `/fix/i` | 8 |
+| Releases tagged in [CHANGELOG.md](../../CHANGELOG.md) | 9 (0.1.0 → 0.2.6) |
+| Bug-fix-only releases (0.2.4 / 0.2.5 / 0.2.6) | 3 (last 14 days) |
+
+## Dependencies
+
+| Class | Count | Names |
+|-------|------:|-------|
+| Runtime | 3 | `@gnss/nmea`, `@gnss/rtcm`, `ntrip-client` |
+| Dev | 4 | `mocha`, `chai`, `node-red`, `node-red-node-test-helper` |
+| Transitive (dev tree) | ~600 | from `npm audit` |
+
+After installing dev deps: `6 vulnerabilities (1 low, 2 moderate, 3 high)` —
+all inside the `node-red` dev tree, none reachable from the published package
+because the runtime dep set is just three packages.
+
+## Quality Index
+
+A composite, intentionally rough — a way to track movement over time, not an
+absolute scale. Each criterion is scored 0–10; the index is the unweighted
+mean.
+
+| Criterion | Score | Reasoning |
+|-----------|------:|-----------|
+| Test coverage (proxy: spec count vs node count) | 7 | 14 specs over 3 of 4 nodes. `NtripClient` untested. |
+| Bug-fix cadence (lower is better, scored inversely) | 5 | 3 patch releases in 2 weeks indicates churn from recent rewrite — settling now. |
+| Documentation completeness | 8 | Per-node help text, README usage notes, this architecture doc. |
+| Type safety | 2 | No TypeScript or JSDoc-with-`@ts-check`. |
+| Lint / style enforcement | 1 | No `eslint` or `prettier`. Style is consistent by convention only. |
+| Dependency hygiene | 7 | 3 runtime deps, 0 known runtime vulns. Dev tree carries `node-red` itself. |
+| CI rigour | 6 | Builds + tests on three Node versions. No coverage gate, no lint gate. |
+| Bus factor | 4 | Single primary maintainer (`Karl-Heinz Wind`). 1 active contributor. |
+| **Overall** | **5.0** | Median: 5.5. Headroom in lint, types, and `NtripClient` coverage. |
+
+### How to improve the index quickly
+
+- **+1.0 each** — adopting `eslint` (covers Type safety bump via `@ts-check`
+  on JSDoc) and adding coverage reporting.
+- **+0.5** — writing one round of `NtripClient` integration specs against a
+  fake caster.
+- **+0.5** — pinning dev deps in `package.json` more strictly (`~` instead of `^`).

package/doc/architecture/structural-design.md

@@ -0,0 +1,141 @@
+# Structural Design
+
+## Repository layout
+
+```
+node-red-contrib-ntrip/
+├── ntrip/
+│   ├── 99-ntrip.js          # Node-RED registration entry point
+│   ├── 99-ntrip.html        # Editor UI for all four nodes (forms + help text)
+│   ├── nodes/
+│   │   ├── ntrip-client-node.js
+│   │   ├── rtcm-decoder-node.js
+│   │   ├── nmea-decoder-node.js
+│   │   └── nmea-encoder-node.js
+│   └── lib/
+│       └── ntrip-client.js  # Local extension of the upstream ntrip-client package
+├── examples/                # Sample flows (ntripclient.json, sapos.json, upload.json, …)
+├── test/                    # Mocha specs (one per node, suffixed .spec.js)
+├── images/                  # Screenshots referenced by README.md
+├── doc/architecture/        # This documentation tree
+├── package.json
+├── package-lock.json
+├── CHANGELOG.md
+├── CLAUDE.md
+└── README.md
+```
+
+## Module dependency graph
+
+```
+   ┌────────────────────────┐
+   │   ntrip/99-ntrip.js    │  (Node-RED entry, registerType x 4)
+   └─────────┬──────────────┘
+             │ require
+   ┌─────────┴────────────────────────────────────────────────────────┐
+   ▼              ▼                  ▼                   ▼            │
+ ntrip-client-  rtcm-decoder-      nmea-decoder-      nmea-encoder-   │
+ node.js        node.js            node.js            node.js         │
+   │              │                  │                   │            │
+   │ require      │ require          │ require           │ require    │
+   ▼              ▼                  ▼                   ▼            │
+ lib/ntrip-     @gnss/rtcm         @gnss/nmea          @gnss/nmea     │
+ client.js                                                            │
+   │                                                                  │
+   │ require                                                          │
+   ▼                                                                  │
+ ntrip-client  (npm package, upstream)                                │
+                                                                      │
+                                                                      ▼
+                                                       package.json reads
+                                                       version into log line
+```
+
+## File responsibilities
+
+### Entry layer
+
+| File | Responsibility |
+|------|----------------|
+| [ntrip/99-ntrip.js](../../ntrip/99-ntrip.js) | Imports each node implementation. Registers the four types with `RED.nodes.registerType`. Declares the `credentials` block for `NtripClient`. Reads the package version from `package.json` and logs it. |
+| [ntrip/99-ntrip.html](../../ntrip/99-ntrip.html) | Per-node `registerType` call (client side), the configuration `<template>`, and the help text shown in Node-RED's info sidebar. The credentials block is duplicated here — Node-RED requires both. |
+
+### Node implementations
+
+| File | Type | Inputs | Outputs |
+|------|------|--------|---------|
+| [ntrip/nodes/ntrip-client-node.js](../../ntrip/nodes/ntrip-client-node.js) | `NtripClient` | 1 | 1 (data from caster + optional pass-through of writes) |
+| [ntrip/nodes/rtcm-decoder-node.js](../../ntrip/nodes/rtcm-decoder-node.js) | `RtcmDecoder` | 1 | 2 (decoded, error) |
+| [ntrip/nodes/nmea-decoder-node.js](../../ntrip/nodes/nmea-decoder-node.js) | `NmeaDecoder` | 1 | 2 (decoded, error) |
+| [ntrip/nodes/nmea-encoder-node.js](../../ntrip/nodes/nmea-encoder-node.js) | `NmeaEncoder` | 1 | 2 (encoded, error) |
+
+All four follow the same skeleton:
+
+```javascript
+module.exports = function (RED) {
+    function Node(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+        node.<counter>Received = 0;
+        node.invalidMessagesReceived = 0;
+
+        // ... wire up the on('input') handler, possibly an external resource
+
+        this.on('close', function (done) {
+            // cleanup
+            node.status({});
+            done();
+        });
+    }
+    return Node;
+};
+```
+
+### Library layer
+
+[ntrip/lib/ntrip-client.js](../../ntrip/lib/ntrip-client.js) — a thin local
+adapter around the upstream `ntrip-client` npm package. Exposes two factories:
+
+- `createDownloader(options)` — returns the upstream `NtripClient` unchanged.
+- `createUploader(options)` — returns a subclass `NtripClientUploader` that
+  overrides `_connect()` to switch the handshake string by `authmode`
+  (`legacy`, `hybrid`, `ntripv1`, `ntripv2`). The constructor also rejects
+  CR/LF in `mountpoint`/`username`/`password` to prevent header injection.
+
+The override pattern is a full replacement of the parent's `_connect`, not a
+delegation — see [ADR-0002](adr/0002-ntrip-uploader-extension.md) for the
+rationale and trade-offs.
+
+## Class / type hierarchy
+
+```
+ntrip-client (npm)
+  └── NtripClient            # download
+        └── NtripClientUploader (lib/ntrip-client.js)   # upload
+```
+
+No other classes are defined in this package; every Node-RED node is a plain
+function passed to `registerType`, and decoder/encoder state lives on the node
+instance via simple property assignment (`node.pendingBuffer`, `node.messagesReceived`).
+
+## Coupling
+
+- **High cohesion within each node file.** A node's input handler, status
+  updates, and close handler are co-located. There is no shared mutable state
+  across node instances.
+- **No cross-node imports.** The decoders do not know about `NtripClient` and
+  vice versa; they communicate only through Node-RED wires at flow runtime.
+- **Two seams to the outside world:**
+  - The `ntrip-client` upstream package (via [lib/ntrip-client.js](../../ntrip/lib/ntrip-client.js)).
+  - `@gnss/rtcm` and `@gnss/nmea` for codec work.
+- **Implicit coupling between [99-ntrip.js](../../ntrip/99-ntrip.js) and [99-ntrip.html](../../ntrip/99-ntrip.html)** — both must declare the `credentials` block, and the registered node-type names must match exactly. The HTML form field IDs (`node-input-host`, `node-input-port`, …) must align with the property names read in the JS (`config.host`, `config.port`, …).
+
+## Distribution shape
+
+- `node-red.nodes` in [package.json](../../package.json) points only at
+  `ntrip/99-ntrip.js` — Node-RED loads that file, which transitively pulls in
+  everything else.
+- Runtime dependencies: `@gnss/nmea`, `@gnss/rtcm`, `ntrip-client`. No transient
+  runtime dependency on Node-RED itself.
+- Dev-only dependencies: `mocha`, `chai` (CJS v4), `node-red`,
+  `node-red-node-test-helper`.

package/eslint.config.js

@@ -0,0 +1,36 @@
+'use strict';
+
+const js = require('@eslint/js');
+const globals = require('globals');
+const prettierConfig = require('eslint-config-prettier');
+
+module.exports = [
+    {
+        ignores: ['node_modules/**', 'examples/**', 'doc/**', 'ntrip/99-ntrip.html'],
+    },
+    js.configs.recommended,
+    prettierConfig,
+    {
+        languageOptions: {
+            ecmaVersion: 2022,
+            sourceType: 'commonjs',
+            globals: {
+                ...globals.node,
+            },
+        },
+        rules: {
+            'no-unused-vars': ['warn', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
+            'no-console': 'off',
+            'no-prototype-builtins': 'off',
+        },
+    },
+    {
+        files: ['test/**/*.js'],
+        languageOptions: {
+            globals: {
+                ...globals.node,
+                ...globals.mocha,
+            },
+        },
+    },
+];

package/ntrip/99-ntrip.html

@@ -13,8 +13,8 @@
             passthrough: { value: false, required: false },
            
             port: { value: 2101, required: false, validate:function(v) { return ((v === "") || (RED.validators.number(v) && (v >= 0) && (v <= 65535))) }},
-            host: { value:"" },
-            mountpoint: { value:"" },
+            host: { value:"", required: true, validate: function(v) { return typeof v === "string" && v.trim().length > 0; } },
+            mountpoint: { value:"", required: true, validate: function(v) { return typeof v === "string" && v.trim().length > 0; } },
             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) )) }},
@@ -108,7 +108,7 @@
     </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)">
+        <input type="password" id="node-input-password" placeholder="Enter the password here">
     </div>
     
     <hr align="middle"/>
@@ -140,18 +140,83 @@
 </script>
 
 <script type="text/x-red" data-help-name="NtripClient">
-    <p>A node that connects to a NTRIP server.</p>
+    <p>Connects to an NTRIP caster as either a client (download) or a server (upload).
+       In download mode the node emits the bytes received from the caster (typically
+       RTCM correction data). In upload mode the node forwards bytes from its input
+       to the caster on the configured mountpoint.</p>
 
     <h3>Configuration</h3>
+    <dl class="message-properties">
+        <dt>Host <span class="property-type">string</span></dt>
+        <dd>Hostname or IP address of the NTRIP caster (e.g. <code>rtk2go.com</code>).</dd>
+
+        <dt>Port <span class="property-type">number</span></dt>
+        <dd>TCP port of the caster. Defaults to <code>2101</code>.</dd>
+
+        <dt>Mountpoint <span class="property-type">string</span></dt>
+        <dd>The stream name on the caster. Enter the name without a leading slash.</dd>
+
+        <dt>Mode <span class="property-type">"download" | "upload"</span></dt>
+        <dd><b>Download</b>: receive correction data from the caster.<br>
+            <b>Upload</b>: push correction data to a mountpoint on the caster.</dd>
+
+        <dt>Authentication Mode <span class="property-type">string</span></dt>
+        <dd>Upload only. Selects the handshake the caster expects:
+            <ul>
+                <li><b>Legacy (Plain Text)</b> — <code>SOURCE</code> with no auth header, accepted by rtk2go.</li>
+                <li><b>Legacy (Basic Auth)</b> — <code>SOURCE</code> plus an <code>Authorization: Basic</code> header, accepted by SNIP.</li>
+                <li><b>NTRIP V1</b> — <code>POST</code> over HTTP/1.0 with Basic Auth.</li>
+                <li><b>NTRIP V2</b> — <code>POST</code> over HTTP/1.1 with Basic Auth and <code>Ntrip-Version: Ntrip/2.0</code>.</li>
+            </ul>
+        </dd>
+
+        <dt>Pass through data <span class="property-type">boolean</span></dt>
+        <dd>Upload only. If enabled, bytes written to the caster are also re-emitted
+            on the node's output for downstream processing.</dd>
+
+        <dt>Username / Password <span class="property-type">credential</span></dt>
+        <dd>Caster credentials. Stored encrypted by Node-RED.</dd>
+
+        <dt>X / Y / Z <span class="property-type">number</span></dt>
+        <dd>Optional ECEF coordinate triple. If set (i.e. not all zero) the underlying
+            client generates and periodically sends a NMEA <code>GGA</code> sentence to
+            the caster — required by some VRS / network-RTK services.</dd>
+
+        <dt>Interval <span class="property-type">number (ms)</span></dt>
+        <dd>Period between <code>GGA</code> emissions when X/Y/Z are configured.</dd>
+    </dl>
 
-    <p>Description of the device.</p>
-    
     <h3>Inputs</h3>
-    <p>Content is directly passed to the ntrip server.</p>
-    
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">Buffer | string</span></dt>
+        <dd>Written verbatim to the caster (upload mode). In download mode the input
+            is typically only used to refresh the position via the form below.</dd>
+
+        <dt>payload <span class="property-type">number[]</span></dt>
+        <dd>An array <code>[x, y, z]</code> is interpreted as a coordinate update and
+            forwarded to <code>client.setXYZ()</code> rather than being written to the
+            caster. Useful for streaming position fixes into the GGA emitter.</dd>
+    </dl>
+
     <h3>Outputs</h3>
-    <p>Messages received from the ntrip server.</p>
-    <p><code>msg.payload</code></p>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">Buffer</span></dt>
+        <dd>Bytes received from the caster. In download mode this is the correction
+            stream (RTCM). In upload mode with <i>Pass through data</i> enabled, written
+            bytes are also re-emitted here.</dd>
+    </dl>
+
+    <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>
+
+    <h3>Details</h3>
+    <p>The first <code>ICY 200 OK</code>, <code>ICY 406</code>, or
+       <code>SOURCETABLE 200 OK</code> reply is consumed by the node to set its
+       status; any RTCM bytes that arrive in the same TCP segment as the
+       <code>ICY 200 OK</code> reply are forwarded on the output.</p>
 </script>
 
 
@@ -186,18 +251,52 @@
 </script>
 
 <script type="text/x-red" data-help-name="RtcmDecoder">
-    <p>A node that decodes RTCM messages.</p>
+    <p>Decodes binary RTCM (Radio Technical Commission for Maritime Services)
+       correction frames using the <code>@gnss/rtcm</code> library. One input
+       message may contain a single frame or several concatenated frames; each
+       decoded frame is emitted as its own output message.</p>
+    <p>The node keeps an internal buffer so frames that straddle TCP packet
+       boundaries are reassembled across consecutive input events.</p>
 
     <h3>Configuration</h3>
+    <dl class="message-properties">
+        <dt>Description <span class="property-type">string</span></dt>
+        <dd>Optional label shown in the flow editor.</dd>
+    </dl>
 
-    <p>Description of the device.</p>
-    
     <h3>Inputs</h3>
-    <p>.</p>
-    
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">Buffer</span></dt>
+        <dd>Raw RTCM bytes, typically produced by the upstream <i>NTRIP Client</i>
+            node. Strings are accepted but converted via <code>Buffer.from</code>.</dd>
+    </dl>
+
     <h3>Outputs</h3>
-    <p>.</p>
-    <p><code>msg.payload</code></p>
+    <p>Two outputs: successfully decoded frames go to the first; decode failures go to the second.</p>
+    <ol class="node-ports">
+        <li>Decoded
+            <dl class="message-properties">
+                <dt>payload.rtcm <span class="property-type">number</span></dt>
+                <dd>The RTCM message type identifier (e.g. <code>1005</code>, <code>1077</code>).</dd>
+                <dt>payload.messageType <span class="property-type">string</span></dt>
+                <dd>The constructor name of the decoded message (e.g. <code>1005</code> → <code>Stationary</code>).</dd>
+                <dt>payload.message <span class="property-type">object</span></dt>
+                <dd>The decoded message object with all fields.</dd>
+                <dt>payload.input <span class="property-type">Buffer</span></dt>
+                <dd>The bytes consumed for this frame.</dd>
+            </dl>
+        </li>
+        <li>Error
+            <dl class="message-properties">
+                <dt>payload.error <span class="property-type">Error</span></dt>
+                <dd>The exception thrown by the decoder.</dd>
+                <dt>payload.input <span class="property-type">Buffer</span></dt>
+                <dd>The remaining buffer at the point of failure.</dd>
+                <dt>payload.inputString <span class="property-type">string</span></dt>
+                <dd>A debug string representation of the buffer.</dd>
+            </dl>
+        </li>
+    </ol>
 </script>
 
 <!-- ------------------------------------------------------------------------------------------ -->
@@ -231,18 +330,52 @@
 </script>
 
 <script type="text/x-red" data-help-name="NmeaDecoder">
-    <p>A node that decodes NMEA messages.</p>
+    <p>Decodes NMEA 0183 sentences (<code>GGA</code>, <code>RMC</code>,
+       <code>GSV</code>, …) using the <code>@gnss/nmea</code> library. A single
+       input message may contain several <code>\r\n</code>-delimited sentences;
+       each is decoded individually and emitted as its own output message.</p>
 
     <h3>Configuration</h3>
+    <dl class="message-properties">
+        <dt>Description <span class="property-type">string</span></dt>
+        <dd>Optional label shown in the flow editor.</dd>
+    </dl>
 
-    <p>Description of the device.</p>
-    
     <h3>Inputs</h3>
-    <p>.</p>
-    
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">string | Buffer</span></dt>
+        <dd>A NMEA sentence or a chunk containing several sentences. Buffers are
+            decoded as UTF-8.</dd>
+        <dt>payload.nmeaMessage <span class="property-type">string | Buffer</span></dt>
+        <dd>Alternative location for the input. If <code>msg.payload</code> is an
+            object with an <code>nmeaMessage</code> property, that value is used
+            instead of <code>msg.payload</code> itself.</dd>
+    </dl>
+
     <h3>Outputs</h3>
-    <p>.</p>
-    <p><code>msg.payload</code></p>
+    <p>Two outputs: successfully decoded sentences go to the first; decode failures go to the second.</p>
+    <ol class="node-ports">
+        <li>Decoded
+            <dl class="message-properties">
+                <dt>payload.messageType <span class="property-type">string</span></dt>
+                <dd>Sentence type in upper case, e.g. <code>GGA</code>, <code>RMC</code>, <code>GSV</code>.</dd>
+                <dt>payload.nmeaMessage <span class="property-type">object</span></dt>
+                <dd>The decoded sentence object with all fields.</dd>
+                <dt>payload.input <span class="property-type">string</span></dt>
+                <dd>The raw sentence as it was parsed.</dd>
+            </dl>
+        </li>
+        <li>Error
+            <dl class="message-properties">
+                <dt>payload.error <span class="property-type">Error | string</span></dt>
+                <dd>The exception or reason for the decode failure.</dd>
+                <dt>payload.input <span class="property-type">string</span></dt>
+                <dd>The sentence that failed to decode.</dd>
+                <dt>payload.inputString <span class="property-type">string</span></dt>
+                <dd>String representation of the input for logging.</dd>
+            </dl>
+        </li>
+    </ol>
 </script>
 
 <!-- ------------------------------------------------------------------------------------------ -->
@@ -276,16 +409,59 @@
 </script>
 
 <script type="text/x-red" data-help-name="NmeaEncoder">
-    <p>A node that encodes NMEA messages.</p>
+    <p>Encodes a NMEA sentence object back to its textual form using the
+       <code>@gnss/nmea</code> library. The inverse of the <i>NMEA Decoder</i>
+       node — useful for round-tripping or for emitting handcrafted sentences
+       (e.g. a <code>GGA</code> fix into an NTRIP uploader).</p>
 
     <h3>Configuration</h3>
+    <dl class="message-properties">
+        <dt>Description <span class="property-type">string</span></dt>
+        <dd>Optional label shown in the flow editor.</dd>
+    </dl>
 
-    <p>Description of the device.</p>
-    
     <h3>Inputs</h3>
-    <p>.</p>
-    
+    <dl class="message-properties">
+        <dt>payload.messageType <span class="property-type">string</span></dt>
+        <dd>Sentence type, e.g. <code>GGA</code>, <code>RMC</code>, <code>VTG</code>,
+            <code>GSV</code>, <code>ZDA</code>. Case-insensitive. Supported types:
+            <code>DTM</code>, <code>GBS</code>, <code>GGA</code>, <code>GLL</code>,
+            <code>GNS</code>, <code>GRS</code>, <code>GSA</code>, <code>GST</code>,
+            <code>GSV</code>, <code>RMC</code>, <code>THS</code>, <code>TXT</code>,
+            <code>VHW</code>, <code>VLW</code>, <code>VPW</code>, <code>VTG</code>,
+            <code>ZDA</code>, plus <code>OBJECT</code> for the generic
+            <code>NmeaMessageUnknown</code> form.</dd>
+        <dt>payload.nmeaMessage <span class="property-type">object | NmeaMessage</span></dt>
+        <dd>The sentence content. Either a plain field object that matches the
+            target sentence schema, or an already-constructed <code>NmeaMessage</code>
+            instance (which is forwarded as-is to <code>NmeaTransport.encode</code>).</dd>
+    </dl>
+
     <h3>Outputs</h3>
-    <p>.</p>
-    <p><code>msg.payload</code></p>
+    <p>Two outputs: successfully encoded sentences go to the first; failures go to the second.</p>
+    <ol class="node-ports">
+        <li>Encoded
+            <dl class="message-properties">
+                <dt>payload.nmeaMessage <span class="property-type">string</span></dt>
+                <dd>The encoded NMEA sentence (including <code>$</code> prefix and
+                    checksum).</dd>
+                <dt>payload.messageType <span class="property-type">string</span></dt>
+                <dd>The sentence type, echoed back as it was supplied.</dd>
+                <dt>payload.input <span class="property-type">object</span></dt>
+                <dd>The original input object.</dd>
+            </dl>
+        </li>
+        <li>Error
+            <dl class="message-properties">
+                <dt>payload.error <span class="property-type">Error | string</span></dt>
+                <dd>The exception or reason for the failure. Unknown
+                    <code>messageType</code> values, missing input fields, and
+                    encoder errors all surface here.</dd>
+                <dt>payload.input <span class="property-type">any</span></dt>
+                <dd>The offending input.</dd>
+                <dt>payload.inputString <span class="property-type">string</span></dt>
+                <dd>String representation of the input for logging.</dd>
+            </dl>
+        </li>
+    </ol>
 </script>

package/ntrip/99-ntrip.js

@@ -1,27 +1,27 @@
 /**
-* Created by Karl-Heinz Wind
-**/
+ * Created by Karl-Heinz Wind
+ **/
 
 module.exports = function (RED) {
-    "use strict";
-    	
+    'use strict';
+
     const pkg = require('./../package.json');
     RED.log.info('node-red-contrib-ntrip version: v' + pkg.version);
 
     const NtripClientNode = require('./nodes/ntrip-client-node.js')(RED);
-    RED.nodes.registerType("NtripClient", NtripClientNode, {
+    RED.nodes.registerType('NtripClient', NtripClientNode, {
         credentials: {
-            username: { type: "text" },
-            password: { type: "password" },
-        }
+            username: { type: 'text' },
+            password: { type: 'password' },
+        },
     });
 
     const RtcmDecoderNode = require('./nodes/rtcm-decoder-node.js')(RED);
-    RED.nodes.registerType("RtcmDecoder", RtcmDecoderNode);
+    RED.nodes.registerType('RtcmDecoder', RtcmDecoderNode);
 
     const NmeaDecoderNode = require('./nodes/nmea-decoder-node.js')(RED);
-    RED.nodes.registerType("NmeaDecoder", NmeaDecoderNode);
+    RED.nodes.registerType('NmeaDecoder', NmeaDecoderNode);
 
     const NmeaEncoderNode = require('./nodes/nmea-encoder-node.js')(RED);
-    RED.nodes.registerType("NmeaEncoder", NmeaEncoderNode);
-}
+    RED.nodes.registerType('NmeaEncoder', NmeaEncoderNode);
+};