smithtek-mako-rf 2.8.0 → 2.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smithtek-mako-rf",
-  "version": "2.8.0",
+  "version": "2.9.1",
   "description": "Smithtek dedicated node for communicating with the Mako PLC over RS485 or RF",
   "keywords": [
     "node-red",

package/smithtek-mako-rf.html

@@ -249,7 +249,14 @@
     $("#st-row-parity").toggle(!isRF);
     $("#st-row-stopBits").toggle(!isRF);
 
-    // Optional: force defaults for RF (still stored, just not user-adjustable)
+    // show RSSI options ONLY for RF
+    $("#st-rssi-wrap").toggle(isRF);
+
+    // Optional: if not RF, force RSSI off so it can't be accidentally enabled
+    if (!isRF) {
+      $("#node-config-input-appendRssi").prop("checked", false);
+    }
+
     if (isRF) {
       $("#node-config-input-baudRate").val(9600);
       $("#node-config-input-parity").val("none");
@@ -264,6 +271,9 @@
     category: "config",
     defaults: {
       busName: { value: "smithtek mako rf", required: true },
+      appendRssi: { value: false },
+      rssiGuardMs: { value: 10, validate: RED.validators.number() },
+      rssiTimeoutMs: { value: 100, validate: RED.validators.number() },
 
       // Dropdown only: RS485-1 (/dev/ttyAMA0), RS485-2 (/dev/ttyAMA1), RF (/dev/ttyAMA2)
       serialPort: { value: "/dev/ttyAMA2", required: true },
@@ -398,19 +408,57 @@
 
   <hr />
 
+  <div id="st-rssi-wrap">
+
+    <div class="form-row">
+      <label for="node-config-input-appendRssi"><i class="fa fa-signal"></i> RSSI</label>
+      <input type="checkbox" id="node-config-input-appendRssi" style="width:auto;">
+      <span style="margin-left:8px; font-size:12px; color:#888;">
+        (Tick on RSSI diagnostic in dBi, using this feeature slows down RF polling by 30%.)
+      </span>
+    </div>
+
+    <div class="form-row">
+      <label for="node-config-input-rssiGuardMs"><i class="fa fa-clock-o"></i> RSSI guard (ms)</label>
+      <input type="number" id="node-config-input-rssiGuardMs" min="0" style="width:140px;">
+      <span style="margin-left:8px; font-size:12px; color:#888;">
+        (The RSSI guard is the time between the Modbus poll and the RSSI read from the LoRa module 5 to 10ms is ideal)
+      </span>
+    </div>
+
+    <div class="form-row">
+      <label for="node-config-input-rssiTimeoutMs"><i class="fa fa-hourglass-end"></i> RSSI timeout (ms)</label>
+      <input type="number" id="node-config-input-rssiTimeoutMs" min="10" style="width:140px;">
+      <span style="margin-left:8px; font-size:12px; color:#888;">
+        (The RSSI timeout is how long the module will be givien to respond with the RSSI)
+      </span>
+    </div>
+
+  </div>
+
+
   <div class="form-row">
     <label for="node-config-input-timeout_s"><i class="fa fa-clock-o"></i> Timeout (seconds)</label>
     <input type="number" id="node-config-input-timeout_s" style="width:140px;">
+    <span style="margin-left:8px; font-size:12px; color:#888;">
+      (This is your modbus response timeout, set high to ensure you capture slow Mako responses)
+    </span>
   </div>
 
   <div class="form-row">
     <label for="node-config-input-retries"><i class="fa fa-repeat"></i> Retries</label>
     <input type="number" id="node-config-input-retries" style="width:140px;">
+    <span style="margin-left:8px; font-size:12px; color:#888;">
+      (Retry will attempt to poll the same device multiple times before it timesout. Ideal for modbus writes)
+    </span>
   </div>
 
   <div class="form-row">
     <label for="node-config-input-gap_s"><i class="fa fa-arrows-h"></i> Gap (seconds)</label>
     <input type="number" id="node-config-input-gap_s" step="0.1" min="0" style="width:140px;">
+    <span style="margin-left:8px; font-size:12px; color:#888;">
+      (The gap is the time between each poll, When a device has finished responded the gap will wait then start the next poll)
+    </span>
   </div>
   <div class="form-tips">
     Select a channel. RF is for the LoRa long range radio RTU coms.

package/smithtek-mako-rf.js

@@ -28,6 +28,124 @@ module.exports = function (RED) {
   function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
   }
+  function sanitizeKey(s) {
+    return String(s || "")
+      .trim()
+      .replace(/\s+/g, "_")
+      .replace(/[^\w]/g, "_")
+      .replace(/_+/g, "_");
+  }
+
+  function buildRssiCommandBuffer() {
+    // AF AF 00 00 AF 80 06 02 00 00 CS 0D 0A
+    const data = new Uint8Array(13);
+    data[0] = 0xAF; data[1] = 0xAF; data[2] = 0x00; data[3] = 0x00; data[4] = 0xAF;
+    data[5] = 0x80;
+    data[6] = 0x06; data[7] = 0x02; data[8] = 0x00; data[9] = 0x00;
+
+    let sum = 0;
+    for (let i = 0; i <= 9; i++) sum += data[i];
+    data[10] = sum & 0xFF;
+
+    data[11] = 0x0D; data[12] = 0x0A;
+    return Buffer.from(data);
+  }
+
+  function tryParseRssiAck(buf) {
+    // ACK is 12 bytes:
+    // AF AF 00 00 AF 00 06 01 XX CS 0D 0A
+    if (!Buffer.isBuffer(buf)) buf = Buffer.from(buf);
+
+    for (let i = 0; i <= buf.length - 12; i++) {
+      if (buf[i] === 0xAF && buf[i + 1] === 0xAF) {
+        const f = buf.slice(i, i + 12);
+
+        const ok =
+          f[0] === 0xAF && f[1] === 0xAF &&
+          f[2] === 0x00 && f[3] === 0x00 &&
+          f[4] === 0xAF &&
+          f[5] === 0x00 &&
+          f[6] === 0x06 &&
+          f[7] === 0x01 &&
+          f[10] === 0x0D && f[11] === 0x0A;
+
+        if (!ok) continue;
+
+        const xx = f[8];
+        const rssiDbm = -xx; // Manufacturer rule
+        return { rssiDbm, frame: f };
+      }
+    }
+    return null;
+  }
+
+  async function queryRssiOnSamePort(state, guardMs, timeoutMs) {
+    // modbus-serial keeps the underlying serialport here in most builds:
+    // state.client._port or state.client._client (varies by version)
+    const p0 = state?.client?._port;
+  const port =
+    (p0 && (p0._client || p0.port || p0._port)) ||   // unwrap common wrappers
+    state?.client?._client ||
+    p0;
+
+    if (!port || typeof port.write !== "function" || typeof port.on !== "function") {
+      throw new Error("No underlying serial port handle found (modbus-serial port not accessible)");
+    }
+
+    if (guardMs > 0) await sleep(guardMs);
+
+    const cmd = buildRssiCommandBuffer();
+
+    // Optional: flush any buffered junk (some serialport builds support this)
+  //  try { if (typeof port.flush === "function") port.flush(() => {}); } catch (_e) {}
+
+    let rx = Buffer.alloc(0);
+
+    return await new Promise((resolve, reject) => {
+      let finished = false;
+
+      const timer = setTimeout(() => {
+        cleanup();
+        reject(new Error("RSSI timeout"));
+      }, Math.max(10, timeoutMs | 0));
+
+      function cleanup() {
+        if (finished) return;
+        finished = true;
+        clearTimeout(timer);
+        try { port.off("data", onData); } catch (_e) {
+          // older serialport uses removeListener
+          try { port.removeListener("data", onData); } catch (_e2) {}
+        }
+      }
+
+      function onData(chunk) {
+        rx = Buffer.concat([rx, Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk)]);
+        const parsed = tryParseRssiAck(rx);
+        if (parsed) {
+          cleanup();
+          resolve(parsed.rssiDbm);
+        } else {
+          // keep rx from growing forever
+          if (rx.length > 512) rx = rx.slice(-128);
+        }
+      }
+
+      port.on("data", onData);
+
+      port.write(cmd, (err) => {
+        if (err) {
+          cleanup();
+          reject(err);
+          return;
+        }
+        // ensure bytes actually leave the building
+        try {
+          if (typeof port.drain === "function") port.drain(() => {});
+        } catch (_e) {}
+      });
+    });
+  }
 
   // Nested property setter using delimiter "=>"
   function setObjectProperty(obj, path, value, delimiter) {
@@ -470,12 +588,43 @@ module.exports = function (RED) {
           msg.payload = res;
         }
 
+        // ---- OPTIONAL RSSI APPEND (after successful Modbus) ----
+
+        try {
+          const appendRssi = !!cfg.appendRssi;
+          if (appendRssi && req.mode === "read" && cfg.serialPort === "/dev/ttyAMA2") {
+            const guardMs = toNum(cfg.rssiGuardMs, 10);
+            const timeoutMs = toNum(cfg.rssiTimeoutMs, 100);
+
+
+            const rssiDbm = await queryRssiOnSamePort(state, guardMs, timeoutMs);
+
+            const nodeKeyBase = sanitizeKey(node.name || busName || "mako_rf");
+            const key = `${nodeKeyBase}_rssi_dbm`;
+
+            if (msg.payload && typeof msg.payload === "object" && !Array.isArray(msg.payload)) {
+              msg.payload[key] = rssiDbm;
+            } else {
+              msg.rssi_dbm = rssiDbm;
+            }
+          }
+        } catch (e) {
+          msg.rssi_error = (e && e.message) ? e.message : String(e);
+        }
+        // -------------------------------------------------------
+
         send(msg);
         done();
+
       }
     })().finally(() => {
       state.busy = false;
+      // If something got queued right as we finished, kick the processor again
+      if (state.queue.length > 0) {
+        scheduleProcess(state, busId);
+      }
     });
+
   }
 
   // =========================
@@ -486,6 +635,11 @@ module.exports = function (RED) {
 
     this.busName = (n.busName || "mako rf").trim();
     this.serialPort = n.serialPort || "";
+// ADD THESE HERE:
+    this.appendRssi   = !!n.appendRssi;
+    this.rssiGuardMs  = toNum(n.rssiGuardMs, 10);
+    this.rssiTimeoutMs = toNum(n.rssiTimeoutMs, 100);
+
     this.baudRate = toNum(n.baudRate, 9600);
     this.stopBits = toNum(n.stopBits, 1);
     this.parity = n.parity || "none";
@@ -524,6 +678,10 @@ module.exports = function (RED) {
   function SmithtekMakoRfNode(config) {
     RED.nodes.createNode(this, config);
     const node = this;
+    // TEMP: until we add editor UI in the .html
+//    node._config_appendRssi = !!config.appendRssi;      // set true in flow JSON to enable
+  //  node._config_rssiGuardMs = toNum(config.rssiGuardMs, 3);
+//    node._config_rssiTimeoutMs = toNum(config.rssiTimeoutMs, 50);
 
     node.on("input", function (msg, send, done) {
       send = send || function () { node.send.apply(node, arguments); };
@@ -578,12 +736,30 @@ module.exports = function (RED) {
       const maxQ = clampInt(busCfg.maxQueue, 1, 1000, 50);
 
       // If queue is full, drop NEW requests (keeps fairness for the ones already queued)
+      const qItem = { node, msg, send, done, req, items };
+      const isWrite = (req.mode === "write");
+
+      // If queue is full:
+      // - NEVER drop writes
+      // - Drop one pending READ to make room
       if (state.queue.length >= maxQ) {
-        try { done(); } catch (_e) {}
-        return;
+        if (isWrite) {
+          const idx = state.queue.findIndex(it => it && it.req && it.req.mode === "read");
+          if (idx >= 0) state.queue.splice(idx, 1);
+          else {
+            try { done(); } catch (_e) {}
+            return;
+          }
+        } else {
+          try { done(); } catch (_e) {}
+          return;
+        }
       }
 
-      state.queue.push({ node, msg, send, done, req, items });
+      // PRIORITY: writes go to the FRONT
+      if (isWrite) state.queue.unshift(qItem);
+      else state.queue.push(qItem);
+
       scheduleProcess(state, busCfg.id);