node-red-contrib-ax25 1.0.0

package/nodes/ui-in.html

@@ -0,0 +1,64 @@
+<script type="text/javascript">
+RED.nodes.registerType("ui-in", {
+  category: "agwpe",
+  color: "#d4edda",
+  defaults: {
+    client: { value: "", type: "agwpe-client", required: true },
+    name: { value: "" },
+    payloadOutput: { value: "string" }
+  },
+  inputs: 0,
+  outputs: 1,
+  icon: "font-awesome/fa-rss",
+  oneditprepare: function () {
+    const mode = this.payloadOutput === "string" ? "string" : "buffer";
+    $("#node-input-payloadOutput").val(mode);
+  },
+  oneditsave: function () {
+    const mode = $("#node-input-payloadOutput").val();
+    this.payloadOutput = mode === "string" ? "string" : "buffer";
+  },
+  label: function () {
+    return this.name || "ui-in";
+  }
+});
+</script>
+
+<script type="text/html" data-template-name="ui-in">
+  <div class="form-row">
+    <label for="node-input-client"><i class="fa fa-server"></i> Client</label>
+    <input type="text" id="node-input-client" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-payloadOutput"><i class="fa fa-file-text-o"></i> Payload Output</label>
+    <select id="node-input-payloadOutput">
+      <option value="buffer">Buffer</option>
+      <option value="string">String (UTF-8)</option>
+    </select>
+  </div>
+</script>
+
+<script type="text/html" data-help-name="ui-in">
+  <p>Receives AGWPE K-frame traffic and decodes AX.25 UI frames only.</p>
+  <p>Requires raw mode enabled on the AGWPE client node.</p>
+
+  <h3>Output</h3>
+  <dl class="message-properties">
+    <dt>status <span class="property-type">string</span></dt>
+    <dd>Always <code>"ok"</code>. Non-UI frames are silently dropped.</dd>
+    <dt>event <span class="property-type">string</span></dt>
+    <dd>Always <code>"ui"</code>.</dd>
+    <dt>source <span class="property-type">string</span></dt>
+    <dd>Source callsign.</dd>
+    <dt>destination <span class="property-type">string</span></dt>
+    <dd>Destination callsign.</dd>
+    <dt class="optional">via <span class="property-type">array</span></dt>
+    <dd>Decoded digipeater objects, if present.</dd>
+    <dt>payload <span class="property-type">Buffer | string</span></dt>
+    <dd>Frame information field. Buffer or UTF-8 string depending on Payload Output setting.</dd>
+  </dl>
+</script>

package/nodes/ui-in.js

@@ -0,0 +1,68 @@
+"use strict";
+
+const codec = require("../lib/ax25-codec");
+const { okEnvelope } = require("../lib/message-utils");
+
+module.exports = function (RED) {
+  function UiInNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    node.payloadOutput = config.payloadOutput === "buffer" ? "buffer" : "string";
+
+    const cfg = RED.nodes.getNode(config.client);
+    const context = cfg ? cfg.instance : null;
+    if (!context) {
+      node.status({ fill: "red", shape: "ring", text: "client missing" });
+      return;
+    }
+
+    const onRawData = function (frame) {
+      if (!context.rawEnabled || !frame || !Buffer.isBuffer(frame.payload)) {
+        return;
+      }
+
+      // Some AGWPE implementations prepend a one-byte port prefix to K payloads.
+      const rawPayload =
+        frame.payload.length > 1 && frame.payload[0] === 0x00 && frame.payload[1] >= 0x60
+          ? frame.payload.subarray(1)
+          : frame.payload;
+
+      let decoded;
+      try {
+        decoded = codec.decodeWireAx25(rawPayload);
+      } catch (_error) {
+        return;
+      }
+
+      // UI frame control field: 0x03 with optional P/F bit (0x13).
+      if ((decoded.control & 0xef) !== 0x03) {
+        return;
+      }
+
+      const payload =
+        node.payloadOutput === "string" && Buffer.isBuffer(decoded.payload)
+          ? decoded.payload.toString("utf8")
+          : decoded.payload;
+
+      node.send(
+        okEnvelope({
+          instanceId: context.instanceId,
+          event: "ui",
+          source: decoded.source,
+          destination: decoded.destination,
+          via: decoded.via,
+          payload
+        })
+      );
+    };
+
+    context.bus.on("raw-data", onRawData);
+
+    node.on("close", function (removed, done) {
+      context.bus.off("raw-data", onRawData);
+      done();
+    });
+  }
+
+  RED.nodes.registerType("ui-in", UiInNode);
+};

package/nodes/ui-out.html

@@ -0,0 +1,80 @@
+<script type="text/javascript">
+RED.nodes.registerType("ui-out", {
+  category: "agwpe",
+  color: "#d4edda",
+  defaults: {
+    client: { value: "", type: "agwpe-client", required: true },
+    name: { value: "" },
+    source: { value: "" },
+    destination: { value: "" },
+    via: { value: "" },
+    payload: { value: "" }
+  },
+  inputs: 1,
+  outputs: 1,
+  icon: "font-awesome/fa-broadcast-tower",
+  label: function () {
+    return this.name || "ui-out";
+  }
+});
+</script>
+
+<script type="text/html" data-template-name="ui-out">
+  <div class="form-row">
+    <label for="node-input-client"><i class="fa fa-server"></i> Client</label>
+    <input type="text" id="node-input-client" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-source"><i class="fa fa-sign-in"></i> Source <span style="color:#d00">*</span></label>
+    <input type="text" id="node-input-source" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-destination"><i class="fa fa-sign-out"></i> Destination <span style="color:#d00">*</span></label>
+    <input type="text" id="node-input-destination" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-via"><i class="fa fa-random"></i> Via</label>
+    <input type="text" id="node-input-via" placeholder="WIDE1-1, WIDE2-1" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-payload"><i class="fa fa-file-text-o"></i> Payload <span style="color:#d00">*</span></label>
+    <input type="text" id="node-input-payload" />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="ui-out">
+  <p>Encodes AX.25 UI frames (control=0x03, pid=0xF0) and sends them via AGWPE K frames.</p>
+  <p>Requires raw mode enabled on the AGWPE client node.</p>
+
+  <h3>Input</h3>
+  <dl class="message-properties">
+    <dt>source <span class="property-type">string</span></dt>
+    <dd>Sending callsign (e.g. <code>"N0CALL-1"</code>). Overrides editor value.</dd>
+    <dt>destination <span class="property-type">string</span></dt>
+    <dd>Destination callsign (e.g. <code>"APRS"</code>). Overrides editor value.</dd>
+    <dt class="optional">via <span class="property-type">string | array</span></dt>
+    <dd>Digipeater path. Overrides editor value. A space- or comma-separated string
+    (e.g. <code>"WIDE1-1 WIDE2-1"</code>) or an array of callsign strings
+    (e.g. <code>["WIDE1-1", "WIDE2-1"]</code>). Omit or leave empty for no digipeating.</dd>
+    <dt>payload <span class="property-type">string | Buffer</span></dt>
+    <dd>Frame information field to transmit. A string is encoded as UTF-8 bytes before
+    being placed in the AX.25 information field. A Buffer is used as-is. Overrides editor value.</dd>
+  </dl>
+  <p><strong>Required:</strong> source, destination, and payload must each be set in the editor or provided in the input message.</p>
+
+  <h3>Output</h3>
+  <dl class="message-properties">
+    <dt>status <span class="property-type">string</span></dt>
+    <dd><code>"ok"</code> on success; <code>"error"</code> if the send fails. Check this field first.</dd>
+    <dt>event <span class="property-type">string</span></dt>
+    <dd>When <code>status</code> is <code>"ok"</code>: always <code>"ui-sent"</code>.</dd>
+    <dt class="optional">errorCode <span class="property-type">string</span></dt>
+    <dd>When <code>status</code> is <code>"error"</code>: <code>CLIENT_NOT_FOUND</code>, <code>RAW_MODE_DISABLED</code>, or <code>UI_SEND_INVALID</code>.</dd>
+    <dt class="optional">errorText <span class="property-type">string</span></dt>
+    <dd>When <code>status</code> is <code>"error"</code>: human-readable description of the error.</dd>
+  </dl>
+</script>

package/nodes/ui-out.js

@@ -0,0 +1,133 @@
+"use strict";
+
+const codec = require("../lib/ax25-codec");
+const { okEnvelope, errorEnvelope } = require("../lib/message-utils");
+
+function splitCallsignList(value) {
+  return String(value || "")
+    .split(/[\s,]+/)
+    .map(function (item) {
+      return item.trim();
+    })
+    .filter(Boolean);
+}
+
+function normalizeViaInput(value) {
+  if (value === undefined || value === null || value === "") {
+    return undefined;
+  }
+
+  if (typeof value === "string") {
+    return splitCallsignList(value);
+  }
+
+  if (!Array.isArray(value)) {
+    return value;
+  }
+
+  const expanded = [];
+  value.forEach(function (entry) {
+    if (typeof entry === "string") {
+      splitCallsignList(entry).forEach(function (callsign) {
+        expanded.push(callsign);
+      });
+      return;
+    }
+
+    if (entry && typeof entry === "object" && typeof entry.callsign === "string") {
+      splitCallsignList(entry.callsign).forEach(function (callsign) {
+        expanded.push({
+          callsign,
+          hasBeenRepeated: Boolean(entry.hasBeenRepeated)
+        });
+      });
+      return;
+    }
+
+    expanded.push(entry);
+  });
+
+  return expanded;
+}
+
+function pickValue(msgValue, configValue) {
+  return msgValue !== undefined ? msgValue : configValue;
+}
+
+module.exports = function (RED) {
+  function UiOutNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    const cfg = RED.nodes.getNode(config.client);
+    const context0 = cfg ? cfg.instance : null;
+
+    node.defaults = {
+      source: config.source !== undefined ? config.source : "",
+      destination: config.destination !== undefined ? config.destination : "",
+      via: config.via !== undefined ? config.via : "",
+      payload: config.payload !== undefined ? config.payload : ""
+    };
+
+    node.on("input", function (msg, send, done) {
+      const localSend = send || function (m) {
+        node.send(m);
+      };
+      const localDone = done || function () {};
+
+      const context = context0;
+      if (!context) {
+        localSend(errorEnvelope("CLIENT_NOT_FOUND", "AGWPE Client instance not found"));
+        localDone();
+        return;
+      }
+
+      if (!context.rawEnabled) {
+        localSend(errorEnvelope("RAW_MODE_DISABLED", "Raw mode is disabled"));
+        localDone();
+        return;
+      }
+
+      const source = pickValue(msg.source, node.defaults.source);
+      const destination = pickValue(msg.destination, node.defaults.destination);
+      const via = normalizeViaInput(pickValue(msg.via, node.defaults.via));
+      const payloadInput = pickValue(msg.payload, node.defaults.payload);
+
+      if (!source || !destination || payloadInput === undefined || payloadInput === null || source === "" || destination === "" || payloadInput === "") {
+        localSend(errorEnvelope("UI_SEND_INVALID", "ui-out requires source, destination, and payload (set in editor or input message)"));
+        localDone();
+        return;
+      }
+
+      let payload;
+      try {
+        payload = codec.encode({
+          source,
+          destination,
+          via,
+          control: 0x03,
+          pid: 0xf0,
+          payload: payloadInput
+        });
+      } catch (error) {
+        localSend(errorEnvelope("UI_SEND_INVALID", error.message));
+        localDone();
+        return;
+      }
+
+      context.bus.emit("raw-data", {
+        instanceId: context.instanceId,
+        direction: "tx",
+        source,
+        destination,
+        payload,
+        agwpePort: msg.agwpePort
+      });
+
+      localSend(okEnvelope({ instanceId: context.instanceId, event: "ui-sent" }));
+      localDone();
+    });
+  }
+
+  RED.nodes.registerType("ui-out", UiOutNode);
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "node-red-contrib-ax25",
+  "version": "1.0.0",
+  "description": "Node-RED nodes for AX.25 connectivity and tooling",
+  "main": "nodes/agwpe-client.js",
+  "license": "MIT",
+  "keywords": [
+    "node-red",
+    "agwpe",
+    "ax25",
+    "aprs",
+    "packet-radio"
+  ],
+    "author": {
+    "name": "Robert Ambrose",
+    "email": "npm@muttsoft.com",
+    "url": "https://github.com/n7get/node-red-contrib-ax25"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "test": "mocha --require test/setup.js 'test/**/*.spec.js'",
+    "lint": "node -e \"console.log('lint placeholder')\""
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "mocha": "^10.7.3",
+    "node-red": "^3.1.9",
+    "node-red-node-test-helper": "^0.3.3"
+  },
+  "node-red": {
+    "nodes": {
+      "agwpe-client": "nodes/agwpe-client.js",
+      "connect": "nodes/connect.js",
+      "send": "nodes/send.js",
+      "disconnect": "nodes/disconnect.js",
+      "ui-in": "nodes/ui-in.js",
+      "ui-out": "nodes/ui-out.js",
+      "monitor-in": "nodes/monitor-in.js",
+      "raw-in": "nodes/raw-in.js",
+      "raw-out": "nodes/raw-out.js",
+      "decode": "nodes/decode.js",
+      "encode": "nodes/encode.js"
+    }
+  }
+}