node-red-contrib-ax25 1.0.1 → 1.1.0

package/nodes/agwpe-client.js

@@ -608,7 +608,7 @@ function cleanupActiveSessions(context) {
 }
 
 function scheduleReconnect(node, context) {
-  if (context._closing || !context.reconnect || context._testTransport) {
+  if (context._closing || context._manualClose || !context.reconnect || context._testTransport) {
     return;
   }
   if (context._reconnectTimer) {
@@ -738,8 +738,76 @@ module.exports = function (RED) {
     context.reconnectDelay = Number(config.reconnectDelay) || DEFAULT_RECONNECT_DELAY;
     context._testTransport = config._testTransport || null;
     context._closing = false;
+    context._manualClose = false;
     context._reconnectTimer = null;
 
+    node.instance.control = {
+      connect: function () {
+        if (context._reconnectTimer) {
+          clearTimeout(context._reconnectTimer);
+          context._reconnectTimer = null;
+        }
+        connectToTnc(node, context);
+      },
+      disconnect: function (cb) {
+        context._manualClose = true;
+        if (context._reconnectTimer) {
+          clearTimeout(context._reconnectTimer);
+          context._reconnectTimer = null;
+        }
+        cleanupActiveSessions(context);
+        if (context.transport && typeof context.transport.close === "function") {
+          context.transport.close(function () {
+            context.transport = null;
+            context.state = "disconnected";
+            node.status({ fill: "grey", shape: "ring", text: "disconnected" });
+            context.bus.emit("conn-lifecycle", { event: "transport-closed" });
+            context._manualClose = false;
+            if (typeof cb === "function") cb();
+          });
+        } else {
+          context.state = "disconnected";
+          node.status({ fill: "grey", shape: "ring", text: "disconnected" });
+          context._manualClose = false;
+          if (typeof cb === "function") cb();
+        }
+      },
+      setConfig: function (fields) {
+        if (fields.host !== undefined) context.host = String(fields.host);
+        if (fields.port !== undefined) context.port = Number(fields.port);
+        if (fields.callsigns !== undefined) context.callsigns = normalizeCallsigns(fields.callsigns);
+        if (fields.username !== undefined || fields.password !== undefined) {
+          const username = fields.username !== undefined ? fields.username : (context.auth ? context.auth.username : "");
+          const password = fields.password !== undefined ? fields.password : (context.auth ? context.auth.password : "");
+          context.auth = (username && password) ? { username, password } : null;
+        }
+      },
+      getConfig: function () {
+        return {
+          host: context.host,
+          port: context.port,
+          callsigns: context.callsigns.slice(),
+          username: context.auth ? context.auth.username : "",
+          state: context.state
+        };
+      },
+      getStatus: function () {
+        return {
+          state: context.state,
+          monitorEnabled: Boolean(context.monitorEnabled),
+          rawEnabled: Boolean(context.rawEnabled),
+          sessions: context.registry.list(context.instanceId).map(function (s) {
+            return {
+              sessionId: s.sessionId,
+              source: s.sourceCallsign,
+              destination: s.destinationCallsign,
+              state: s.state
+            };
+          })
+        };
+      }
+    };
+
     node.status({ fill: "grey", shape: "ring", text: "disconnected" });
 
     connectToTnc(node, context);

package/nodes/agwpe-control.html

@@ -0,0 +1,80 @@
+<script type="text/javascript">
+RED.nodes.registerType("agwpe-control", {
+  category: "ax25",
+  color: "#d4edda",
+  defaults: {
+    client: { value: "", type: "agwpe-client", required: true },
+    name: { value: "" }
+  },
+  inputs: 1,
+  outputs: 1,
+  outputLabels: ["result"],
+  icon: "font-awesome/fa-cogs",
+  label: function () {
+    return this.name || "agwpe-control";
+  }
+});
+</script>
+
+<script type="text/html" data-template-name="agwpe-control">
+  <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>
+</script>
+
+<script type="text/html" data-help-name="agwpe-control">
+  <p>Sends control commands to an <b>agwpe-client</b> config node at runtime.</p>
+
+  <h3>Input</h3>
+  <dl class="message-properties">
+    <dt>command <span class="property-type">string</span></dt>
+    <dd>
+      One of:
+      <ul>
+        <li><code>"disconnect"</code> — disconnect all active sessions and close the connection to the AGWPE server.</li>
+        <li><code>"connect"</code> — connect to the AGWPE server using the current configuration.</li>
+        <li><code>"set-config"</code> — update one or more configuration fields. Supply any combination of <code>msg.host</code>, <code>msg.port</code>, <code>msg.callsigns</code>, <code>msg.username</code>, <code>msg.password</code>.</li>
+        <li><code>"get-config"</code> — retrieve the current configuration.</li>
+        <li><code>"get-status"</code> — retrieve the current runtime status (connection state, mode flags, active sessions).</li>
+      </ul>
+    </dd>
+    <dt class="optional">host <span class="property-type">string</span></dt>
+    <dd>Used with <code>set-config</code>. New AGWPE server host.</dd>
+    <dt class="optional">port <span class="property-type">number</span></dt>
+    <dd>Used with <code>set-config</code>. New AGWPE server port.</dd>
+    <dt class="optional">callsigns <span class="property-type">string | array</span></dt>
+    <dd>Used with <code>set-config</code>. Callsigns to register. Comma-separated string or array of strings.</dd>
+    <dt class="optional">username <span class="property-type">string</span></dt>
+    <dd>Used with <code>set-config</code>. AGWPE authentication username.</dd>
+    <dt class="optional">password <span class="property-type">string</span></dt>
+    <dd>Used with <code>set-config</code>. AGWPE authentication password.</dd>
+  </dl>
+
+  <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> on failure.</dd>
+    <dt>command <span class="property-type">string</span></dt>
+    <dd>Echoes the command that was processed.</dd>
+    <dt class="optional">event <span class="property-type">string</span></dt>
+    <dd>For <code>disconnect</code>: <code>"disconnected"</code>. For <code>connect</code>: <code>"connecting"</code>.</dd>
+    <dt class="optional">config <span class="property-type">object</span></dt>
+    <dd>For <code>get-config</code> and <code>set-config</code>: the current configuration object containing <code>host</code>, <code>port</code>, <code>callsigns</code>, <code>username</code>, and <code>state</code>.</dd>
+    <dt class="optional">payload <span class="property-type">object</span></dt>
+    <dd>For <code>get-status</code>: an object containing <code>state</code> (string), <code>monitorEnabled</code> (boolean), <code>rawEnabled</code> (boolean), and <code>sessions</code> (array of <code>{sessionId, source, destination, state}</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> or <code>UNKNOWN_COMMAND</code>.</dd>
+    <dt class="optional">errorText <span class="property-type">string</span></dt>
+    <dd>When <code>status</code> is <code>"error"</code>: human-readable error description.</dd>
+  </dl>
+
+  <h3>Details</h3>
+  <p>The <code>connect</code> command triggers an immediate connection attempt; auto-reconnect behaviour is unaffected.</p>
+  <p>The <code>disconnect</code> command closes all active sessions and the transport without triggering an auto-reconnect. Use <code>connect</code> to reconnect manually afterwards.</p>
+  <p>The <code>set-config</code> command updates runtime configuration only. Changes take effect on the next <code>connect</code>; they are not persisted to the Node-RED flow.</p>
+</script>

package/nodes/agwpe-control.js

@@ -0,0 +1,72 @@
+"use strict";
+
+const { okEnvelope, errorEnvelope } = require("../lib/message-utils");
+
+module.exports = function (RED) {
+  function AgwpeControlNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    node.status({});
+
+    node.on("input", function (msg, send, done) {
+      const localSend = send || function (m) { node.send(m); };
+      const localDone = done || function () {};
+
+      const configNode = RED.nodes.getNode(config.client);
+      if (!configNode || !configNode.instance || !configNode.instance.control) {
+        localSend(errorEnvelope("CLIENT_NOT_FOUND", "agwpe-client config node not found", { command: msg.command }));
+        localDone();
+        return;
+      }
+
+      const control = configNode.instance.control;
+      const command = msg.command;
+
+      if (command === "disconnect") {
+        control.disconnect(function () {
+          localSend(okEnvelope({ command: "disconnect", event: "disconnected" }));
+          localDone();
+        });
+        return;
+      }
+
+      if (command === "set-config") {
+        const fields = {};
+        if (msg.host !== undefined) fields.host = msg.host;
+        if (msg.port !== undefined) fields.port = msg.port;
+        if (msg.callsigns !== undefined) fields.callsigns = msg.callsigns;
+        if (msg.username !== undefined) fields.username = msg.username;
+        if (msg.password !== undefined) fields.password = msg.password;
+        control.setConfig(fields);
+        localSend(okEnvelope({ command: "set-config", config: control.getConfig() }));
+        localDone();
+        return;
+      }
+
+      if (command === "connect") {
+        control.connect();
+        localSend(okEnvelope({ command: "connect", event: "connecting" }));
+        localDone();
+        return;
+      }
+
+      if (command === "get-config") {
+        localSend(okEnvelope({ command: "get-config", config: control.getConfig() }));
+        localDone();
+        return;
+      }
+
+      if (command === "get-status") {
+        localSend(okEnvelope({ command: "get-status", payload: control.getStatus() }));
+        localDone();
+        return;
+      }
+
+      localSend(errorEnvelope("UNKNOWN_COMMAND", "Unknown command: " + command, { command }));
+      localDone();
+    });
+  }
+
+  RED.nodes.registerType("agwpe-control", AgwpeControlNode);
+};

package/nodes/connect.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("connect", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     client: { value: "", type: "agwpe-client", required: true },

package/nodes/decode.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("decode", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     name: { value: "" },

package/nodes/disconnect.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("disconnect", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     name: { value: "" }

package/nodes/encode.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("encode", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     name: { value: "" },

package/nodes/monitor-in.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("monitor-in", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     client: { value: "", type: "agwpe-client", required: true },

package/nodes/raw-in.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("raw-in", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     client: { value: "", type: "agwpe-client", required: true },

package/nodes/raw-out.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("raw-out", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     client: { value: "", type: "agwpe-client", required: true },

package/nodes/send.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("send", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     name: { value: "" },

package/nodes/ui-in.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("ui-in", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     client: { value: "", type: "agwpe-client", required: true },

package/nodes/ui-out.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
 RED.nodes.registerType("ui-out", {
-  category: "agwpe",
+  category: "ax25",
   color: "#d4edda",
   defaults: {
     client: { value: "", type: "agwpe-client", required: true },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-ax25",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Node-RED nodes for AX.25 connectivity and tooling",
   "main": "nodes/agwpe-client.js",
   "license": "MIT",
@@ -49,7 +49,8 @@
       "raw-in": "nodes/raw-in.js",
       "raw-out": "nodes/raw-out.js",
       "decode": "nodes/decode.js",
-      "encode": "nodes/encode.js"
+      "encode": "nodes/encode.js",
+      "agwpe-control": "nodes/agwpe-control.js"
     }
   }
 }

package/local/buffer_compare.json

@@ -1,135 +0,0 @@
-[
-    {
-        "id": "5b244fa604fea472",
-        "type": "debug",
-        "z": "efec118fdfbb44e1",
-        "name": "debug 4",
-        "active": false,
-        "tosidebar": true,
-        "console": false,
-        "tostatus": false,
-        "complete": "true",
-        "targetType": "full",
-        "statusVal": "",
-        "statusType": "auto",
-        "x": 380,
-        "y": 480,
-        "wires": []
-    },
-    {
-        "id": "21825cd2b6399cdb",
-        "type": "raw-in",
-        "z": "efec118fdfbb44e1",
-        "name": "",
-        "x": 170,
-        "y": 480,
-        "wires": [
-            [
-                "5b244fa604fea472",
-                "7c55133426e0bf75",
-                "fa0970eb0abcbd27"
-            ]
-        ]
-    },
-    {
-        "id": "7c55133426e0bf75",
-        "type": "decode",
-        "z": "efec118fdfbb44e1",
-        "name": "",
-        "x": 380,
-        "y": 540,
-        "wires": [
-            [
-                "716c85ad8fa5ab9e",
-                "16f45c05ab12108d"
-            ]
-        ]
-    },
-    {
-        "id": "665950798e589835",
-        "type": "debug",
-        "z": "efec118fdfbb44e1",
-        "name": "debug 5",
-        "active": false,
-        "tosidebar": true,
-        "console": false,
-        "tostatus": false,
-        "complete": "true",
-        "targetType": "full",
-        "statusVal": "",
-        "statusType": "auto",
-        "x": 740,
-        "y": 540,
-        "wires": []
-    },
-    {
-        "id": "716c85ad8fa5ab9e",
-        "type": "function",
-        "z": "efec118fdfbb44e1",
-        "name": "function 2",
-        "func": "msg.data = String.fromCharCode(...msg.payload);\nreturn msg;",
-        "outputs": 1,
-        "timeout": 0,
-        "noerr": 0,
-        "initialize": "",
-        "finalize": "",
-        "libs": [],
-        "x": 560,
-        "y": 540,
-        "wires": [
-            [
-                "665950798e589835"
-            ]
-        ]
-    },
-    {
-        "id": "16f45c05ab12108d",
-        "type": "encode",
-        "z": "efec118fdfbb44e1",
-        "name": "",
-        "x": 560,
-        "y": 600,
-        "wires": [
-            [
-                "fa0970eb0abcbd27"
-            ]
-        ]
-    },
-    {
-        "id": "d12d061e1569391f",
-        "type": "debug",
-        "z": "efec118fdfbb44e1",
-        "name": "debug 6",
-        "active": true,
-        "tosidebar": true,
-        "console": false,
-        "tostatus": false,
-        "complete": "true",
-        "targetType": "full",
-        "statusVal": "",
-        "statusType": "auto",
-        "x": 760,
-        "y": 680,
-        "wires": []
-    },
-    {
-        "id": "fa0970eb0abcbd27",
-        "type": "function",
-        "z": "efec118fdfbb44e1",
-        "name": "function 3",
-        "func": "if (msg.event === 'raw') {\n    flow.set('raw', msg.payload);\n}\n\nif (msg.event === 'encoded') {\n    const raw = flow.get('raw');\n    const encoded = msg.payload;\n\n    // Find differing indices\n    const maxLen = Math.max(raw.length, encoded.length);\n    const diffs = [];\n    for (let i = 0; i < maxLen; i++) {\n        if (raw[i] !== encoded[i]) {\n            diffs.push({ index: i, raw: raw[i], encoded: encoded[i] });\n        }\n    }\n\n    if (diffs.length > 0) {\n        node.warn(`Buffer mismatch!`);\n        node.warn(`raw:     ${JSON.stringify(raw)}`);\n        node.warn(`encoded: ${JSON.stringify(encoded)}`);\n        node.warn(`diffs:   ${JSON.stringify(diffs)}`);\n\n        msg.payload = {\n            raw,\n            encoded,\n            diffs\n        };\n        return msg;\n    }\n}",
-        "outputs": 1,
-        "timeout": 0,
-        "noerr": 0,
-        "initialize": "",
-        "finalize": "",
-        "libs": [],
-        "x": 580,
-        "y": 680,
-        "wires": [
-            [
-                "d12d061e1569391f"
-            ]
-        ]
-    }
-]

package/local/debug-d-frame.js

@@ -1,84 +0,0 @@
-"use strict";
-const { makeDataFrame } = require("../lib/agwpe-frame-builder");
-const agwpeClientModule = require("../nodes/agwpe-client");
-const connInModule = require("../nodes/conn-in");
-const store = require("../lib/runtime-store");
-const EventEmitter = require("events");
-
-const flowData = {};
-function makeRED() {
-  const types = {};
-  const RED = {
-    nodes: {
-      createNode(node, config) {
-        const ee = new EventEmitter();
-        node.on = ee.on.bind(ee);
-        node.emit = ee.emit.bind(ee);
-        node.status = () => {};
-        node._sent = [];
-        node._errors = [];
-        node.send = m => node._sent.push(m);
-        node.error = () => {};
-        node.warn = m => console.log("WARN:", m);
-        node.log = m => console.log("LOG:", m);
-        node.context = () => ({
-          flow: {
-            get: k => flowData[k] || null,
-            set: (k, v) => { flowData[k] = v; }
-          }
-        });
-      },
-      registerType(t, ctor) { types[t] = ctor; }
-    },
-    _instantiate(type, config) {
-      const n = { id: config.id || type, _flowId: config._flowId || "flow-1", _sent: [], _errors: [] };
-      types[type].call(n, config);
-      return n;
-    }
-  };
-  return RED;
-}
-
-const RED = makeRED();
-agwpeClientModule(RED);
-connInModule(RED);
-
-const mockTransport = new EventEmitter();
-mockTransport.sendFrame = (f, cb) => { if (cb) cb(); };
-
-const flowId = "flow-1";
-const client = RED._instantiate("agwpe-client", { id: "client-1", _flowId: flowId });
-const connIn  = RED._instantiate("conn-in",      { id: "conn-in-1", _flowId: flowId });
-
-// Open
-client.emit("input", { command: "open", host: "127.0.0.1", port: 8000, callsigns: ["N1CALL"], _testTransport: mockTransport });
-console.log("client sent after open:", JSON.stringify(client._sent.map(m => m.event)));
-
-// Connect  
-client.emit("input", { command: "connect", source: "N1CALL", destination: "N1CALL-1", sessionId: "s1" });
-console.log("client sent after connect:", JSON.stringify(client._sent.map(m => m.event)));
-console.log("connIn  sent after connect:", JSON.stringify(connIn._sent.map(m => m.event)));
-
-// Check session in registry
-const ctx = store.getInstance("client-1");
-if (ctx) {
-  const sessions = ctx.registry.list("client-1");
-  console.log("sessions in registry:", JSON.stringify(sessions.map(s => ({
-    sessionId: s.sessionId, state: s.state,
-    src: s.sourceCallsign, dst: s.destinationCallsign
-  }))));
-  console.log("router instances:", Array.from(ctx.router.instances.keys()));
-  console.log("bus listeners conn-data:", ctx.bus.listenerCount("conn-data"));
-  console.log("bus listeners conn-lifecycle:", ctx.bus.listenerCount("conn-lifecycle"));
-} else {
-  console.log("ERROR: no context in store for client-1");
-}
-
-// Fire a D frame
-const dFrame = makeDataFrame("N1CALL-1", "N1CALL", Buffer.from("BBS READY>"));
-console.log("\nEmitting D frame on mockTransport...");
-mockTransport.emit("frame", dFrame);
-
-console.log("connIn sent after D frame:", JSON.stringify(connIn._sent.map(m => ({
-  event: m.event, hasPayload: m.payload != null, payloadType: m.payload ? typeof m.payload : "none"
-}))));

package/local/raw-out-test.json

@@ -1,128 +0,0 @@
-[
-    {
-        "id": "1faf64b0a23c2b10",
-        "type": "inject",
-        "z": "efec118fdfbb44e1",
-        "name": "",
-        "props": [
-            {
-                "p": "payload"
-            }
-        ],
-        "repeat": "",
-        "crontab": "",
-        "once": false,
-        "onceDelay": 0.1,
-        "topic": "",
-        "payload": "Test Frame",
-        "payloadType": "str",
-        "x": 165,
-        "y": 540,
-        "wires": [
-            [
-                "e70c9de10439d31f"
-            ]
-        ],
-        "l": false
-    },
-    {
-        "id": "e70c9de10439d31f",
-        "type": "encode",
-        "z": "efec118fdfbb44e1",
-        "name": "",
-        "source": "N1CALL-7",
-        "destination": "TEST",
-        "digipeaters": "",
-        "control": 3,
-        "pid": 240,
-        "frameType": "U",
-        "payload": "",
-        "x": 320,
-        "y": 540,
-        "wires": [
-            [
-                "c3cecbe84e55b30f",
-                "e8d5bbd844110be9",
-                "b304e6d9f1e00d48"
-            ]
-        ]
-    },
-    {
-        "id": "c3cecbe84e55b30f",
-        "type": "raw-out",
-        "z": "efec118fdfbb44e1",
-        "name": "",
-        "x": 500,
-        "y": 540,
-        "wires": [
-            [
-                "15ab7cb28d409d6e"
-            ]
-        ]
-    },
-    {
-        "id": "15ab7cb28d409d6e",
-        "type": "debug",
-        "z": "efec118fdfbb44e1",
-        "name": "debug 4",
-        "active": true,
-        "tosidebar": true,
-        "console": false,
-        "tostatus": false,
-        "complete": "true",
-        "targetType": "full",
-        "statusVal": "",
-        "statusType": "auto",
-        "x": 680,
-        "y": 540,
-        "wires": []
-    },
-    {
-        "id": "e8d5bbd844110be9",
-        "type": "debug",
-        "z": "efec118fdfbb44e1",
-        "name": "debug 5",
-        "active": false,
-        "tosidebar": true,
-        "console": false,
-        "tostatus": false,
-        "complete": "true",
-        "targetType": "full",
-        "statusVal": "",
-        "statusType": "auto",
-        "x": 500,
-        "y": 480,
-        "wires": []
-    },
-    {
-        "id": "b304e6d9f1e00d48",
-        "type": "decode",
-        "z": "efec118fdfbb44e1",
-        "name": "",
-        "payloadOutput": "string",
-        "x": 500,
-        "y": 600,
-        "wires": [
-            [
-                "b4244f4d5601b40f"
-            ]
-        ]
-    },
-    {
-        "id": "b4244f4d5601b40f",
-        "type": "debug",
-        "z": "efec118fdfbb44e1",
-        "name": "debug 6",
-        "active": true,
-        "tosidebar": true,
-        "console": false,
-        "tostatus": false,
-        "complete": "true",
-        "targetType": "full",
-        "statusVal": "",
-        "statusType": "auto",
-        "x": 680,
-        "y": 600,
-        "wires": []
-    }
-]