node-red-contrib-i3x 0.0.1

package/nodes/i3x-write.html

@@ -0,0 +1,72 @@
+<script type="text/html" data-template-name="i3x-write">
+    <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="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-writeTarget"><i class="fa fa-bullseye"></i> Target</label>
+        <select id="node-input-writeTarget">
+            <option value="value">Current Value</option>
+            <option value="history">Historical Data</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-elementId"><i class="fa fa-crosshairs"></i> Element ID</label>
+        <input type="text" id="node-input-elementId" placeholder="target element ID">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="i3x-write">
+    <p>Writes a current value or historical data to an i3X object.</p>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">any</span></dt>
+        <dd>The value to write. Format depends on the element type schema.</dd>
+        <dt class="optional">elementId <span class="property-type">string</span></dt>
+        <dd>Target element ID. Overrides the configured value. Also accepts <code>msg.nodeId</code>.</dd>
+        <dt class="optional">writeTarget <span class="property-type">string</span></dt>
+        <dd><code>"value"</code> (default) or <code>"history"</code>. Overrides the configured target.</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">object</span></dt>
+        <dd>Write confirmation response from the API.</dd>
+        <dt>elementId <span class="property-type">string</span></dt>
+        <dd>The element ID that was written to.</dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>When <b>Target</b> is set to <i>Current Value</i>, uses <code>PUT /objects/{elementId}/value</code>
+    to update the current value of the object.</p>
+    <p>When <b>Target</b> is set to <i>Historical Data</i>, uses <code>PUT /objects/{elementId}/history</code>
+    to write historical time-series records.</p>
+    <p>The payload format must match the element's type schema (e.g. a plain number for
+    <code>measurement-value-type</code>, or a state object for <code>state-type</code>).</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType("i3x-write", {
+        category: "i3x",
+        color: "#5DB87C",
+        defaults: {
+            name: { value: "" },
+            server: { value: "", type: "i3x-server", required: true },
+            writeTarget: { value: "value" },
+            elementId: { value: "" },
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "i3x-icon.svg",
+        paletteLabel: "i3x write",
+        label: function () {
+            return this.name || this.elementId || "i3x write";
+        },
+        align: "right",
+    });
+</script>

package/nodes/i3x-write.js

@@ -0,0 +1,56 @@
+/**
+ * i3x-write – Write a value or historical data to an i3X object.
+ */
+"use strict";
+
+const { bindServer, safeSend } = require("../lib/node-utils");
+
+module.exports = function (RED) {
+    function I3XWriteNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        node.elementId = config.elementId || "";
+        node.writeTarget = config.writeTarget || "value";
+
+        if (!bindServer(node, RED, config.server)) return;
+
+        node.on("input", async function (msg, send, done) {
+            send = safeSend(node, send);
+            const client = node.server.client;
+
+            const elementId = msg.elementId || msg.nodeId || node.elementId;
+            if (!elementId) {
+                const err = new Error("elementId is required");
+                if (done) done(err); else node.error(err, msg);
+                return;
+            }
+
+            const value = msg.payload;
+            if (value === undefined) {
+                const err = new Error("msg.payload (value to write) is required");
+                if (done) done(err); else node.error(err, msg);
+                return;
+            }
+
+            const target = msg.writeTarget || node.writeTarget;
+            node.status({ fill: "blue", shape: "dot", text: "writing..." });
+
+            try {
+                const result = target === "history"
+                    ? await client.writeHistory(elementId, value)
+                    : await client.writeValue(elementId, value);
+                msg.payload = result;
+                msg.elementId = elementId;
+                node.status({ fill: "green", shape: "dot", text: "ok" });
+                send(msg);
+                if (done) done();
+            } catch (err) {
+                node.status({ fill: "red", shape: "ring", text: err.message.substring(0, 32) });
+                if (done) done(err); else node.error(err, msg);
+            }
+        });
+    }
+
+    RED.nodes.registerType("i3x-write", I3XWriteNode);
+};

package/nodes/icons/i3x-icon.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40" width="40" height="40">
+  <rect width="40" height="40" rx="4" fill="#2E8B57"/>
+  <text x="20" y="16" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" font-weight="bold" fill="white">i3X</text>
+  <line x1="8" y1="22" x2="32" y2="22" stroke="white" stroke-width="1.5" stroke-linecap="round"/>
+  <circle cx="12" cy="30" r="3" fill="none" stroke="white" stroke-width="1.5"/>
+  <circle cx="20" cy="30" r="3" fill="none" stroke="white" stroke-width="1.5"/>
+  <circle cx="28" cy="30" r="3" fill="none" stroke="white" stroke-width="1.5"/>
+  <line x1="12" y1="27" x2="12" y2="22" stroke="white" stroke-width="1.5"/>
+  <line x1="20" y1="27" x2="20" y2="22" stroke="white" stroke-width="1.5"/>
+  <line x1="28" y1="27" x2="28" y2="22" stroke="white" stroke-width="1.5"/>
+</svg>

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "node-red-contrib-i3x",
+  "version": "0.0.1",
+  "description": "Node-RED nodes for the i3X (Industrial Information Interoperability eXchange) API by CESMII",
+  "keywords": [
+    "node-red",
+    "i3x",
+    "cesmii",
+    "industrial",
+    "manufacturing",
+    "iiot",
+    "historian",
+    "mes",
+    "mom",
+    "opc-ua",
+    "smart-manufacturing"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cesmii/node-red-contrib-i3x"
+  },
+  "scripts": {
+    "test": "mocha --exit --timeout 15000 'test/**/*_spec.js'",
+    "test:unit": "mocha --exit --timeout 10000 'test/unit/**/*_spec.js'",
+    "test:integration": "mocha --exit --timeout 30000 'test/integration/**/*_spec.js'",
+    "test:docker": "docker compose run --rm test"
+  },
+  "dependencies": {
+    "axios": "^1.7.0"
+  },
+  "devDependencies": {
+    "mocha": "^10.0.0",
+    "chai": "^4.0.0",
+    "sinon": "^17.0.0",
+    "nock": "^13.0.0",
+    "node-red": "^3.0.0",
+    "node-red-node-test-helper": "^0.3.0"
+  },
+  "node-red": {
+    "version": ">=2.0.0",
+    "nodes": {
+      "i3x-server": "nodes/i3x-server.js",
+      "i3x-browse": "nodes/i3x-browse.js",
+      "i3x-read": "nodes/i3x-read.js",
+      "i3x-write": "nodes/i3x-write.js",
+      "i3x-history": "nodes/i3x-history.js",
+      "i3x-subscribe": "nodes/i3x-subscribe.js"
+    },
+    "examples": [
+      { "name": "i3x-complete-demo", "path": "examples/i3x-complete-demo.json" }
+    ]
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "author": "CESMII",
+  "homepage": "https://www.i3x.dev"
+}