@blokcert/node-red-contrib-plate-crop 1.0.0

package/README.md

@@ -0,0 +1,50 @@
+# node-red-contrib-plate-crop
+
+Node-RED 節點：輸入車牌圖片的 **base64**，偵測並裁切車牌，輸出裁切圖的 **base64**。
+
+底層呼叫內附的 `yolo-plate` binary（Go + YOLO ONNX，binary 自帶 onnxruntime，目標機免安裝）。
+
+## 安裝
+
+```bash
+cd ~/.node-red
+npm install /path/to/yolo-plate/node-red-contrib-plate-crop
+# 重啟 Node-RED
+```
+
+安裝後在編輯器的 **function** 類別下會出現「車牌裁切」節點。
+
+> 模型檔（`plate.onnx`，約 272MB）**未**打包進節點，請自行放置並在節點設定填入路徑。
+
+## 使用
+
+1. 拉「車牌裁切」節點到流程。
+2. 雙擊設定 **模型路徑**（`.onnx`，必填）。
+3. 上游送入 `msg.payload = <base64 圖片字串>`（可含 `data:image/...;base64,` 前綴，支援 PNG/JPEG）。
+4. 節點輸出 `msg.payload`：
+   - 預設：分數最高車牌的 base64 **字串**
+   - 勾「全部車牌」：base64 **陣列**
+   - 未偵測到車牌：`null`
+
+### 設定項
+
+| 項目 | 對應 CLI | 說明 |
+|------|----------|------|
+| 模型路徑 | `-model` | 車牌偵測 `.onnx`（必填） |
+| 信心門檻 | `-conf` | 預設 0.25 |
+| 外擴像素 | `-pad` | 裁切外擴，預設 0 |
+| 全部車牌 | `-all` | 勾選輸出所有車牌 |
+| binary 路徑 | `-lib`/`-model` 的執行檔 | 留空＝自動依平台選內附 binary |
+
+## 支援平台
+
+內附 binary：`linux-x64`（一般 x86 伺服器/PC，Node-RED 部署用）、`darwin-arm64`（mac 本機開發/測試）。
+兩者皆自帶 onnxruntime 1.26，目標機免安裝。
+其他平台請自行編譯 `yolo-plate`（見上層專案），並在節點設定「binary 路徑」指定。
+
+## 測試
+
+```bash
+npm test        # 需要上層 plate.onnx 與一張範例圖，可用環境變數覆寫：
+PLATE_MODEL=/path/plate.onnx PLATE_IMG=/path/img.jpg npm test
+```

package/lib/crop.js

@@ -0,0 +1,68 @@
+"use strict";
+
+const { spawn } = require("child_process");
+const path = require("path");
+
+// 依執行平台挑選內附的 binary。
+function defaultBinPath() {
+  const key = `${process.platform}-${process.arch}`;
+  const map = {
+    "darwin-arm64": "yolo-plate-darwin-arm64",
+    "linux-x64": "yolo-plate-linux-amd64",
+  };
+  const name = map[key];
+  if (!name) {
+    throw new Error(`不支援的平台 ${key}，請在節點設定手動指定 binary 路徑`);
+  }
+  return path.join(__dirname, "..", "bin", name);
+}
+
+// runPlateCrop 以 stdin 傳入 base64 圖片，回傳裁切車牌的 base64 陣列（每個車牌一個）。
+// opts: { binPath?, modelPath, conf?, iou?, pad?, imgsz?, all? }
+function runPlateCrop(opts, base64) {
+  return new Promise((resolve, reject) => {
+    if (!opts.modelPath) {
+      reject(new Error("未設定模型路徑（modelPath）"));
+      return;
+    }
+    let bin;
+    try {
+      bin = opts.binPath || defaultBinPath();
+    } catch (e) {
+      reject(e);
+      return;
+    }
+
+    const args = ["-model", opts.modelPath, "-in", "-", "-b64"];
+    if (opts.conf != null) args.push("-conf", String(opts.conf));
+    if (opts.iou != null) args.push("-iou", String(opts.iou));
+    if (opts.pad != null) args.push("-pad", String(opts.pad));
+    if (opts.imgsz != null) args.push("-imgsz", String(opts.imgsz));
+    if (opts.all) args.push("-all");
+
+    const child = spawn(bin, args);
+    let out = "";
+    let err = "";
+    child.stdout.on("data", (d) => (out += d));
+    child.stderr.on("data", (d) => (err += d));
+    child.on("error", reject);
+    child.on("close", (code) => {
+      if (code === 0) {
+        const lines = out
+          .split("\n")
+          .map((s) => s.trim())
+          .filter(Boolean);
+        resolve(lines);
+      } else {
+        // 未偵測到車牌時 binary 以非 0 結束，訊息在 stderr
+        reject(new Error(err.trim() || `binary 結束碼 ${code}`));
+      }
+    });
+
+    child.stdin.on("error", () => {}); // 忽略 EPIPE（binary 提早結束時）
+    child.stdin.write(base64);
+    child.stdin.end();
+  });
+}
+
+module.exports = { runPlateCrop, defaultBinPath };

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@blokcert/node-red-contrib-plate-crop",
+  "version": "1.0.0",
+  "description": "Node-RED node：輸入車牌圖 base64，輸出裁切後車牌 base64（YOLO ONNX，自帶 onnxruntime）",
+  "keywords": ["node-red", "license-plate", "anpr", "yolo", "onnx"],
+  "license": "MIT",
+  "publishConfig": { "access": "public" },
+  "node-red": {
+    "nodes": {
+      "plate-crop": "plate-crop.js"
+    }
+  },
+  "scripts": {
+    "test": "node --test"
+  },
+  "files": [
+    "plate-crop.js",
+    "plate-crop.html",
+    "lib/",
+    "bin/"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}

package/plate-crop.html

@@ -0,0 +1,73 @@
+<script type="text/javascript">
+  RED.nodes.registerType("plate-crop", {
+    category: "function",
+    color: "#8fd694",
+    defaults: {
+      name: { value: "" },
+      modelPath: { value: "", required: true },
+      binPath: { value: "" },
+      conf: { value: "0.25", validate: RED.validators.number(true) },
+      pad: { value: "0", validate: RED.validators.number(true) },
+      all: { value: false },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-car",
+    label: function () {
+      return this.name || "車牌裁切";
+    },
+    paletteLabel: "車牌裁切",
+  });
+</script>
+
+<script type="text/html" data-template-name="plate-crop">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> 名稱</label>
+    <input type="text" id="node-input-name" placeholder="名稱" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-modelPath"><i class="fa fa-cube"></i> 模型路徑</label>
+    <input type="text" id="node-input-modelPath" placeholder="/path/to/plate.onnx" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-conf"><i class="fa fa-percent"></i> 信心門檻</label>
+    <input type="text" id="node-input-conf" placeholder="0.25" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-pad"><i class="fa fa-expand"></i> 外擴像素</label>
+    <input type="text" id="node-input-pad" placeholder="0" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-all"><i class="fa fa-clone"></i> 全部車牌</label>
+    <input type="checkbox" id="node-input-all" style="display:inline-block; width:auto; vertical-align:top;" />
+    <span>勾選輸出所有車牌（payload 為陣列）；否則只輸出分數最高的一個</span>
+  </div>
+  <div class="form-row">
+    <label for="node-input-binPath"><i class="fa fa-terminal"></i> binary 路徑</label>
+    <input type="text" id="node-input-binPath" placeholder="留空＝自動依平台選用內附 binary" />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="plate-crop">
+  <p>輸入車牌圖片的 base64，偵測並裁切出車牌，輸出裁切圖的 base64。</p>
+  <h3>輸入</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">string</span></dt>
+    <dd>車牌圖片的 base64（可含 <code>data:image/...;base64,</code> 前綴）。支援 PNG / JPEG。</dd>
+  </dl>
+  <h3>輸出</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">string | string[] | null</span></dt>
+    <dd>
+      預設輸出分數最高車牌的 base64 字串；勾選「全部車牌」時輸出 base64 陣列。
+      未偵測到車牌時輸出 <code>null</code>。
+    </dd>
+  </dl>
+  <h3>設定</h3>
+  <ul>
+    <li><b>模型路徑</b>：車牌偵測 <code>.onnx</code> 模型（必填）。</li>
+    <li><b>信心門檻</b>／<b>外擴像素</b>／<b>全部車牌</b>：對應 CLI 的 <code>-conf</code>／<code>-pad</code>／<code>-all</code>。</li>
+    <li><b>binary 路徑</b>：留空自動依平台（darwin-arm64 / linux-arm64）選用內附 binary。</li>
+  </ul>
+  <p>底層呼叫內附的 <code>yolo-plate</code> binary（自帶 onnxruntime，目標機免安裝）。</p>
+</script>

package/plate-crop.js

@@ -0,0 +1,66 @@
+"use strict";
+
+const { runPlateCrop } = require("./lib/crop");
+
+module.exports = function (RED) {
+  function PlateCropNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    node.modelPath = config.modelPath;
+    node.binPath = config.binPath || undefined;
+    node.conf = config.conf !== "" ? parseFloat(config.conf) : undefined;
+    node.pad = config.pad !== "" ? parseInt(config.pad, 10) : undefined;
+    node.all = !!config.all;
+
+    node.on("input", function (msg, send, done) {
+      // 相容舊版 Node-RED（無 send/done）
+      send = send || function () { node.send.apply(node, arguments); };
+      done = done || function (err) { if (err) node.error(err, msg); };
+
+      const payload = msg.payload;
+      if (typeof payload !== "string" || payload.length === 0) {
+        node.status({ fill: "red", shape: "ring", text: "payload 非 base64" });
+        done(new Error("msg.payload 必須是 base64 圖片字串"));
+        return;
+      }
+
+      node.status({ fill: "blue", shape: "dot", text: "偵測中" });
+      runPlateCrop(
+        {
+          binPath: node.binPath,
+          modelPath: node.modelPath,
+          conf: node.conf,
+          pad: node.pad,
+          all: node.all,
+        },
+        payload
+      )
+        .then((lines) => {
+          // 預設（best）輸出單一 base64 字串；-all 輸出 base64 陣列
+          msg.payload = node.all ? lines : lines[0] || null;
+          node.status({ fill: "green", shape: "dot", text: `${lines.length} 車牌` });
+          send(msg);
+          done();
+        })
+        .catch((e) => {
+          const noPlate = /未偵測到車牌/.test(e.message);
+          node.status({
+            fill: noPlate ? "yellow" : "red",
+            shape: "ring",
+            text: noPlate ? "無車牌" : "錯誤",
+          });
+          if (noPlate) {
+            // 無車牌不算錯誤：輸出 null，讓下游可判斷
+            msg.payload = null;
+            send(msg);
+            done();
+          } else {
+            done(e);
+          }
+        });
+    });
+  }
+
+  RED.nodes.registerType("plate-crop", PlateCropNode);
+};