smithtek-mako-rf 0.0.1

package/smithtek-mako-rf.html

@@ -0,0 +1,552 @@
+<script type="text/javascript">
+(function () {
+
+  const TYPE_OPTIONS = [
+    "16 bit integer",
+    "16 bit unsigned",
+    "32 bit integer",
+    "32 bit unsigned",
+    "32 bit float",
+    "digital to unsigned binary encoder"
+  ];
+
+  function is32BitType(t) {
+    t = String(t || "").toLowerCase();
+    return (t === "32 bit integer" || t === "32 bit unsigned" || t === "32 bit float");
+  }
+
+  function isDigitalUnsigned(t) {
+    return String(t || "").toLowerCase() === "digital to unsigned binary encoder";
+  }
+
+  function defaultItemRow() {
+    return {
+      name: "",
+      type: "16 bit integer",
+      offset: 0,      // BYTES stored in config (legacy decoder compatibility)
+      length: 1,      // stored but hidden (1=16-bit, 2=32-bit)
+      scale: "",
+      offsetbit: 0
+    };
+  }
+
+  function buildTypeSelect(value) {
+    const $sel = $("<select></select>")
+      .addClass("st-item-type")
+      .css("width", "100%");
+    TYPE_OPTIONS.forEach(t => {
+      $sel.append($("<option></option>").attr("value", t).text(t));
+    });
+    $sel.val(String(value || "16 bit integer"));
+    return $sel;
+  }
+
+  function applyTypeRules($tr) {
+    const t = String($tr.find(".st-item-type").val() || "");
+    const $lenHidden = $tr.find(".st-item-length"); // hidden
+    const $bit = $tr.find(".st-item-offsetbit");
+    const $bitCol = $tr.find(".st-bit-col");
+
+    // auto length (hidden but saved)
+    if (is32BitType(t)) $lenHidden.val(2);
+    else $lenHidden.val(1);
+
+    // bit only for digital unsigned
+    if (isDigitalUnsigned(t)) {
+      $bit.prop("disabled", false).show();
+      $bitCol.show();
+    } else {
+      $bit.val(0);
+      $bit.prop("disabled", true).hide();
+      $bitCol.hide();
+    }
+  }
+
+  // Determine next row behaviour based on the last row (REGS visible)
+  function nextRowFromLast($tbody) {
+    const $last = $tbody.find("tr").last();
+    if (!$last.length) {
+      return { offsetRegs: 0, type: "16 bit integer", offsetbit: 0 };
+    }
+
+    const lastRegs = Number($last.find(".st-item-offset-regs").val());
+    const lastType = String($last.find(".st-item-type").val() || "");
+    const lastBit = Number($last.find(".st-item-offsetbit").val());
+
+    const safeRegs = Number.isFinite(lastRegs) ? lastRegs : 0;
+    const safeBit = Number.isFinite(lastBit) ? lastBit : 0;
+
+    // DIGITAL BIT-LADDER (same register, bit++, then next register)
+    if (isDigitalUnsigned(lastType)) {
+      if (safeBit < 15) {
+        return { offsetRegs: safeRegs, type: lastType, offsetbit: safeBit + 1 };
+      }
+      return { offsetRegs: safeRegs + 1, type: lastType, offsetbit: 0 };
+    }
+
+    // Normal stepping (REGS)
+    const stepRegs = is32BitType(lastType) ? 2 : 1;
+    return { offsetRegs: safeRegs + stepRegs, type: lastType, offsetbit: 0 };
+  }
+
+  function addItemRow($tbody, item, isNew) {
+    const it = item || defaultItemRow();
+    const $tr = $("<tr></tr>");
+    const rowIndex = $tbody.find("tr").length + 1;
+
+    const $name = $("<input/>")
+      .attr("type", "text")
+      .addClass("st-item-name")
+      .css("width", "100%")
+      .val(it.name ?? (isNew ? `item${rowIndex}` : ""));
+
+    const $type = buildTypeSelect(it.type);
+
+    // Visible: regs
+    const existingBytes = Number(it.offset ?? 0);
+    const existingRegs = Number.isFinite(existingBytes) ? (existingBytes / 2) : 0;
+
+    const $offsetRegs = $("<input/>")
+      .attr("type", "number")
+      .addClass("st-item-offset-regs")
+      .css("width", "100%")
+      .val(existingRegs);
+
+    // Hidden: bytes (this is what the JS runtime expects)
+    const $offsetBytes = $("<input/>")
+      .attr("type", "hidden")
+      .addClass("st-item-offset")
+      .val(Number.isFinite(existingBytes) ? existingBytes : 0);
+
+    // keep hidden bytes synced when user edits regs
+    $offsetRegs.on("input", function () {
+      const r = Number($offsetRegs.val());
+      const regs = Number.isFinite(r) ? r : 0;
+      $offsetBytes.val(regs * 2);
+    });
+
+    // hidden length field (kept in config, not shown)
+    const $lengthHidden = $("<input/>")
+      .attr("type", "hidden")
+      .addClass("st-item-length")
+      .val(it.length ?? 1);
+
+    const $scale = $("<input/>")
+      .attr("type", "text")
+      .addClass("st-item-scale")
+      .css("width", "100%")
+      .val(it.scale ?? "");
+
+    const $offsetbit = $("<input/>")
+      .attr("type", "number")
+      .addClass("st-item-offsetbit")
+      .css("width", "100%")
+      .val(it.offsetbit ?? 0);
+
+    if (isNew) {
+      const next = nextRowFromLast($tbody);
+
+      $type.val(next.type);
+
+      // set regs, hidden bytes follows
+      $offsetRegs.val(next.offsetRegs).trigger("input");
+
+      // set bit for digital ladder
+      $offsetbit.val(next.offsetbit);
+    } else {
+      // ensure hidden offset is correct for existing rows
+      $offsetRegs.trigger("input");
+    }
+
+    const $del = $("<a href='#' style='color:#c00;'>Remove</a>").on("click", function (e) {
+      e.preventDefault();
+      $tr.remove();
+    });
+
+    $tr.append($("<td></td>").append($name));
+    $tr.append($("<td></td>").append($type));
+    $tr.append($("<td></td>").append($offsetRegs).append($offsetBytes));
+    $tr.append($("<td></td>").append($scale));
+
+    const $bitTd = $("<td></td>").addClass("st-bit-col").append($offsetbit);
+    $tr.append($bitTd);
+
+    // attach hidden length to the row so it saves
+    $tr.append($("<td style='display:none;'></td>").append($lengthHidden));
+
+    $tr.append($("<td></td>").append($del));
+
+    $tbody.append($tr);
+
+    applyTypeRules($tr);
+    $type.on("change", function () {
+      applyTypeRules($tr);
+    });
+  }
+
+  function readItemsFromTable($tbody) {
+    const items = [];
+    $tbody.find("tr").each(function () {
+      const $tr = $(this);
+      items.push({
+        name: String($tr.find(".st-item-name").val() ?? "").trim(),
+        type: String($tr.find(".st-item-type").val() ?? "16 bit integer").trim(),
+        offset: Number($tr.find(".st-item-offset").val()) || 0,      // BYTES saved
+        length: Number($tr.find(".st-item-length").val()) || 1,      // hidden but saved
+        scale: String($tr.find(".st-item-scale").val() ?? "").trim(),
+        offsetbit: Number($tr.find(".st-item-offsetbit").val()) || 0
+      });
+    });
+    return items;
+  }
+
+  function buildFcList(mode, $fc, preferred) {
+    const isRead = mode === "read";
+    const keep = (preferred !== undefined && preferred !== null && preferred !== "")
+      ? String(preferred)
+      : String($fc.val() || "");
+
+    $fc.empty();
+
+    const readFcs = [
+      { v: 1, t: "1 - Read Coils" },
+      { v: 2, t: "2 - Read Digital Inputs" },
+      { v: 3, t: "3 - Read Holding Registers" },
+      { v: 4, t: "4 - Read Input Registers" }
+    ];
+
+    const writeFcs = [
+      { v: 5, t: "5 - Write Single Coil" },
+      { v: 6, t: "6 - Write Single Register" },
+      { v: 15, t: "15 - Write Multiple Coils" },
+      { v: 16, t: "16 - Write Multiple Registers" }
+    ];
+
+    const list = isRead ? readFcs : writeFcs;
+    list.forEach(o => $fc.append($("<option></option>").attr("value", o.v).text(o.t)));
+
+    if (list.some(o => String(o.v) === keep)) $fc.val(keep);
+    else $fc.val(String(list[0].v));
+  }
+
+  function toggleRuntimeUi(mode) {
+    const isRead = mode === "read";
+    $("#st-rf-write").toggle(!isRead);
+    $("#st-rf-decode-wrap").toggle(isRead);
+  }
+
+  function toggleValueUi(valueSource) {
+    const fixed = (valueSource || "msg.payload") === "fixed";
+    $("#st-rf-fixedwrap").toggle(fixed);
+  }
+
+  // Bus UI: hide serial settings when RF channel selected
+  function updateSerialUiForChannel() {
+    const ch = $("#node-config-input-serialPort").val();
+    const isRF = (ch === "/dev/ttyAMA2");
+
+    $("#st-row-baudRate").toggle(!isRF);
+    $("#st-row-parity").toggle(!isRF);
+    $("#st-row-stopBits").toggle(!isRF);
+
+    // Optional: force defaults for RF (still stored, just not user-adjustable)
+    if (isRF) {
+      $("#node-config-input-baudRate").val(9600);
+      $("#node-config-input-parity").val("none");
+      $("#node-config-input-stopBits").val(1);
+    }
+  }
+
+  // =========================
+  // Config node: smithtek-mako-rf-bus
+  // =========================
+  RED.nodes.registerType("smithtek-mako-rf-bus", {
+    category: "config",
+    defaults: {
+      busName: { value: "smithtek mako rf", required: true },
+
+      // Dropdown only: RS485-1 (/dev/ttyAMA0), RS485-2 (/dev/ttyAMA1), RF (/dev/ttyAMA2)
+      serialPort: { value: "/dev/ttyAMA2", required: true },
+
+      baudRate: { value: 9600, required: true, validate: RED.validators.number() },
+      stopBits: { value: 1, required: true, validate: RED.validators.number() },
+      parity: { value: "none", required: true },
+
+      timeout_s: { value: 8, required: true, validate: RED.validators.number() },
+      retries: { value: 2, required: true, validate: RED.validators.number() },
+      gap_s: { value: 0, required: true, validate: RED.validators.number() }
+    },
+    label: function () {
+      return this.busName || "smithtek mako rf";
+    },
+    oneditprepare: function () {
+      updateSerialUiForChannel();
+      $("#node-config-input-serialPort").on("change", updateSerialUiForChannel);
+    }
+  });
+
+  // =========================
+  // Main node: smithtek-mako-rf
+  // =========================
+  RED.nodes.registerType("smithtek-mako-rf", {
+    category: "Smithtek",
+    color: "#B9B6B8",
+    defaults: {
+      name: { value: "" },
+      bus: { type: "smithtek-mako-rf-bus", required: true },
+
+      mode: { value: "read" },
+      fc: { value: 3, required: true, validate: RED.validators.number() },
+      unitid: { value: 1, required: true, validate: RED.validators.number() },
+      address: { value: 0, required: true, validate: RED.validators.number() },
+      quantity: { value: 1, required: true, validate: RED.validators.number() },
+
+      valueSource: { value: "msg.payload" },
+      valueType: { value: "bool" },
+      valueText: { value: "" },
+      includeWriteQuantity: { value: false },
+
+      items: { value: [ defaultItemRow() ] }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "bridge.svg",
+    label: function () { return this.name || "Smithtek Mako RF"; },
+
+    oneditprepare: function () {
+      buildFcList(this.mode, $("#node-input-fc"), this.fc);
+      toggleRuntimeUi(this.mode);
+      toggleValueUi(this.valueSource);
+
+      $("#node-input-mode").on("change", () => {
+        const mode = $("#node-input-mode").val();
+        buildFcList(mode, $("#node-input-fc"), $("#node-input-fc").val());
+        toggleRuntimeUi(mode);
+      });
+
+      $("#node-input-valueSource").on("change", () => {
+        toggleValueUi($("#node-input-valueSource").val());
+      });
+
+      const $tbody = $("#st-items-tbody");
+      $tbody.empty();
+
+      let items = Array.isArray(this.items) ? this.items : [];
+      if (!items.length) items = [defaultItemRow()];
+      items.forEach(it => addItemRow($tbody, it, false));
+
+      $("#st-add-item").on("click", function (e) {
+        e.preventDefault();
+        addItemRow($tbody, defaultItemRow(), true);
+      });
+
+      $("#st-clear-items").on("click", function (e) {
+        e.preventDefault();
+        $tbody.empty();
+        addItemRow($tbody, defaultItemRow(), false);
+      });
+    },
+
+    oneditsave: function () {
+      this.items = readItemsFromTable($("#st-items-tbody"));
+    }
+  });
+
+})();
+</script>
+
+<!-- =========================
+     BUS CONFIG TEMPLATE
+     ========================= -->
+<script type="text/html" data-template-name="smithtek-mako-rf-bus">
+  <div class="form-row">
+    <label for="node-config-input-busName"><i class="fa fa-tag"></i> Bus name</label>
+    <input type="text" id="node-config-input-busName" placeholder="smithtek mako rf">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-serialPort"><i class="fa fa-plug"></i> Channel</label>
+    <select id="node-config-input-serialPort" style="width:260px;">
+      <option value="/dev/ttyAMA0">RS485-1</option>
+      <option value="/dev/ttyAMA1">RS485-2</option>
+      <option value="/dev/ttyAMA2">RF</option>
+    </select>
+  </div>
+
+  <div class="form-row" id="st-row-baudRate">
+    <label for="node-config-input-baudRate"><i class="fa fa-cog"></i> Baud</label>
+    <input type="number" id="node-config-input-baudRate" style="width:140px;">
+  </div>
+
+  <div class="form-row" id="st-row-parity">
+    <label for="node-config-input-parity"><i class="fa fa-adjust"></i> Parity</label>
+    <select id="node-config-input-parity" style="width:160px;">
+      <option value="none">none</option>
+      <option value="even">even</option>
+      <option value="odd">odd</option>
+      <option value="mark">mark</option>
+      <option value="space">space</option>
+    </select>
+  </div>
+
+  <div class="form-row" id="st-row-stopBits">
+    <label for="node-config-input-stopBits"><i class="fa fa-pause"></i> Stop bits</label>
+    <input type="number" id="node-config-input-stopBits" style="width:140px;">
+  </div>
+
+  <hr />
+
+  <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;">
+  </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;">
+  </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" style="width:140px;">
+  </div>
+
+  <div class="form-tips">
+    Select a channel. RF is for the LoRa long range radio RTU coms.
+  </div>
+</script>
+
+<!-- =========================
+     MAIN NODE TEMPLATE
+     ========================= -->
+<script type="text/html" data-template-name="smithtek-mako-rf">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-bus"><i class="fa fa-sitemap"></i> Bus</label>
+    <input type="text" id="node-input-bus" style="width: 25%;">
+    <span style="margin-left:8px; font-size:12px; color:#888;">
+      (Add or edit your Modbus channel here, RF is for the long range radio Coms (LoRa) )
+    </span>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-mode"><i class="fa fa-random"></i> Mode</label>
+    <select id="node-input-mode" style="width: 20%;">
+      <option value="read">Read</option>
+      <option value="write">Write</option>
+    </select>
+    <span style="margin-left:8px; font-size:12px; color:#888;">
+      (Read will poll the Mako's modbus, Write will send commands to it, digital BOOLS, values etc. )
+    </span>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-unitid"><i class="fa fa-hashtag"></i> Device ID</label>
+    <input type="number" id="node-input-unitid" min="1" max="247" style="width: 140px;">
+    <span style="margin-left:8px; font-size:12px; color:#888;">
+      (The ID of your Mako Device, via RF or RS485)
+    </span>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-fc"><i class="fa fa-code"></i> Function</label>
+    <select id="node-input-fc" style="width: 25%;"></select>
+    <span style="margin-left:8px; font-size:12px; color:#888;">
+      (Match the function code with your V-NET program, Input register, holding register and so on.)
+    </span>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-address"><i class="fa fa-crosshairs"></i> Address</label>
+    <input type="number" id="node-input-address" min="0" style="width: 140px;">
+    <span style="margin-left:8px; font-size:12px; color:#888;">
+      (The address of the first register you want to read,)
+    </span>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-quantity"><i class="fa fa-list-ol"></i> Quantity</label>
+    <input type="number" id="node-input-quantity" min="1" style="width: 100px;">
+    <span style="margin-left:8px; font-size:12px; color:#888;">
+      (Qty of registers to read. 16bit = 1 register, 32bit = 2 registers. example, 3* floats would = 6 registers)
+    </span>
+  </div>
+
+  <div id="st-rf-write" style="margin-top:10px; display:none;">
+    <div class="form-row">
+      <label for="node-input-valueSource"><i class="fa fa-pencil"></i> Value source</label>
+      <select id="node-input-valueSource" style="width: 70%;">
+        <option value="msg.payload">From msg.payload</option>
+        <option value="fixed">Fixed</option>
+      </select>
+    </div>
+
+    <div id="st-rf-fixedwrap" style="margin-top:6px;">
+      <div class="form-row">
+        <label for="node-input-valueType"><i class="fa fa-sliders"></i> Fixed type</label>
+        <select id="node-input-valueType" style="width: 70%;">
+          <option value="bool">Boolean (true/false)</option>
+          <option value="number">Number</option>
+          <option value="json">JSON (array/object)</option>
+          <option value="string">String</option>
+        </select>
+      </div>
+
+      <div class="form-row">
+        <label for="node-input-valueText"><i class="fa fa-edit"></i> Fixed value</label>
+        <input type="text" id="node-input-valueText" placeholder='e.g. true | 123 | [1,0,1] | [100,200]'>
+      </div>
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-includeWriteQuantity"><i class="fa fa-check-square-o"></i> Include quantity</label>
+      <input type="checkbox" id="node-input-includeWriteQuantity" style="width:auto;">
+    </div>
+  </div>
+
+  <hr />
+
+  <div id="st-rf-decode-wrap">
+    <div class="form-row" style="margin-bottom:6px;">
+      <b>Decoder map</b>
+      <span style="margin-left:8px; font-size:12px; color:#888;">
+        (Build your register table in the exact same order as your Mako V-NET program, Add new rows and change the register data type to match)
+      </span>
+      <div style="margin-top:6px;">
+        <a href="#" class="editor-button" id="st-add-item"><i class="fa fa-plus"></i> Add row</a>
+        <a href="#" class="editor-button" id="st-clear-items" style="margin-left:8px;"><i class="fa fa-trash"></i> Reset</a>
+      </div>
+    </div>
+
+    <div class="form-row">
+      <table class="table table-condensed" style="width:100%;">
+        <thead>
+          <tr>
+            <th style="width:28%;">Name </th>
+            <th style="width:26%;">Register data Type</th>
+            <th style="width:14%;">Offset (regs)</th>
+            <th style="width:22%;">Scale</th>
+            <th style="width:6%;">Bit</th>
+            <th style="width:4%;">Action</th>
+          </tr>
+        </thead>
+        <tbody id="st-items-tbody"></tbody>
+      </table>
+    </div>
+
+    <div style="font-size:12px; color:#666; margin-top:6px;">
+  (Register Offsets numbers should match the modbus table you have built in V-NET!, if you add a digital it will automatically increase the bit number. Bit 1 = digital 1 and so on.
+    </div>
+  </div>
+</script>
+
+<script type="text/markdown" data-help-name="smithtek-mako-rf">
+Smithtek Mako RF (RS-485 only).
+
+Read mode outputs decoded JSON in msg.payload using the Decoder map rows.
+Raw modbus response is kept in msg.modbus.raw.
+</script>