node-red-contrib-3dm-space 1.1.0 → 2.1.0

package/3dm-cloud-join.html

@@ -0,0 +1,80 @@
+<script type="text/javascript">
+    RED.nodes.registerType('3dm-cloud-join', {
+        category: '3DM.space',
+        color: '#6D6D6D',
+        defaults: {
+            timeout: {
+                value: 5,
+                required: true,
+                validate: RED.validators.number()
+            }
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: 'font-awesome/fa-compress',
+        paletteLabel: '3DM Join',
+        label: function () {
+            return '3DM Join';
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="3dm-cloud-join">
+    <div class="form-row">
+        <label for="node-input-timeout">
+            <i class="fa fa-clock-o"></i> Timeout
+        </label>
+        <input
+            type="number"
+            id="node-input-timeout"
+            min="1"
+            step="1"
+            placeholder="5"
+            style="width: 120px;"
+        >
+        <span style="margin-left: 6px;">seconds</span>
+    </div>
+</script>
+
+<script type="text/html" data-help-name="3dm-cloud-join">
+    <p>
+        The <b>3DM Join</b> node collects JSON object payloads, merges all keys together,
+        then sends one combined payload after the configured timeout.
+    </p>
+
+    <h3>Input</h3>
+    <p>
+        The node expects <code>msg.payload</code> to be a JSON object.
+    </p>
+
+    <pre>{
+  "tank_level": 65
+}</pre>
+
+    <h3>Output</h3>
+    <p>
+        When the timeout expires, the node outputs one message containing all collected keys.
+    </p>
+
+    <pre>{
+  "tank_level": 65,
+  "pump_run": true,
+  "dc_voltage": 24.4
+}</pre>
+
+    <h3>Timeout</h3>
+    <p>
+        The timeout starts from the first valid message received. The timer does not restart
+        when more messages arrive.
+    </p>
+
+    <h3>Duplicate Keys</h3>
+    <p>
+        If the same key arrives more than once during the collection window, the latest value is used.
+    </p>
+
+    <h3>Invalid Payloads</h3>
+    <p>
+        Payloads that are not JSON objects are ignored.
+    </p>
+</script>

package/3dm-cloud-join.js

@@ -0,0 +1,155 @@
+module.exports = function (RED) {
+    "use strict";
+
+    function isPlainObject(value) {
+        return value &&
+            typeof value === "object" &&
+            !Array.isArray(value) &&
+            !Buffer.isBuffer(value);
+    }
+
+    function cleanTimeoutSeconds(value) {
+        var seconds = Number(value);
+
+        if (!isFinite(seconds) || seconds < 1) {
+            seconds = 5;
+        }
+
+        seconds = Math.floor(seconds);
+
+        if (seconds > 86400) {
+            seconds = 86400;
+        }
+
+        return seconds;
+    }
+
+    function clonePayloadObject(obj) {
+        var out = {};
+
+        Object.keys(obj).forEach(function (key) {
+            out[key] = obj[key];
+        });
+
+        return out;
+    }
+
+    function ThreeDMCloudJoinNode(config) {
+        RED.nodes.createNode(this, config);
+
+        var node = this;
+
+        node.timeoutSeconds = cleanTimeoutSeconds(config.timeout);
+        node.timeoutMs = node.timeoutSeconds * 1000;
+
+        node.timer = null;
+        node.buffer = {};
+        node.messageCount = 0;
+        node.firstMsg = null;
+
+        function setStatus(fill, shape, text) {
+            node.status({
+                fill: fill,
+                shape: shape,
+                text: text
+            });
+        }
+
+        function clearTimer() {
+            if (node.timer) {
+                clearTimeout(node.timer);
+                node.timer = null;
+            }
+        }
+
+        function resetBatch() {
+            clearTimer();
+            node.buffer = {};
+            node.messageCount = 0;
+            node.firstMsg = null;
+            setStatus("grey", "ring", "waiting");
+        }
+
+        function flushBatch() {
+            clearTimer();
+
+            if (node.messageCount < 1) {
+                resetBatch();
+                return;
+            }
+
+            var outMsg = node.firstMsg || {};
+            outMsg.payload = clonePayloadObject(node.buffer);
+
+            node.send(outMsg);
+
+            setStatus(
+                "green",
+                "dot",
+                "sent " + Object.keys(node.buffer).length + " keys"
+            );
+
+            node.buffer = {};
+            node.messageCount = 0;
+            node.firstMsg = null;
+        }
+
+        function startBatch(msg) {
+            node.buffer = {};
+            node.messageCount = 0;
+            node.firstMsg = RED.util.cloneMessage(msg);
+
+            node.timer = setTimeout(function () {
+                flushBatch();
+            }, node.timeoutMs);
+        }
+
+        node.on("input", function (msg, send, done) {
+            var payload = msg.payload;
+
+            if (!isPlainObject(payload)) {
+                setStatus("red", "ring", "bad payload");
+                if (done) {
+                    done();
+                }
+                return;
+            }
+
+            if (!node.timer) {
+                startBatch(msg);
+            }
+
+            Object.keys(payload).forEach(function (key) {
+                node.buffer[key] = payload[key];
+            });
+
+            node.messageCount += 1;
+
+            setStatus(
+                "blue",
+                "dot",
+                "collecting " + Object.keys(node.buffer).length + " keys"
+            );
+
+            if (done) {
+                done();
+            }
+        });
+
+        node.on("close", function (removed, done) {
+            if (typeof removed === "function") {
+                done = removed;
+            }
+
+            resetBatch();
+
+            if (done) {
+                done();
+            }
+        });
+
+        resetBatch();
+    }
+
+    RED.nodes.registerType("3dm-cloud-join", ThreeDMCloudJoinNode);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-3dm-space",
-  "version": "1.1.0",
+  "version": "2.1.0",
   "description": "Node-RED nodes for 3DM.space SCADA Cloud telemetry, attributes, and local config storage",
   "main": "3dm-cloud-config.js",
   "license": "GPL-3.0-or-later",
@@ -21,7 +21,8 @@
       "3dm-cloud-config": "3dm-cloud-config.js",
       "3dm-cloud-out": "3dm-cloud-out.js",
       "3dm-cloud-in": "3dm-cloud-in.js",
-      "3dm-config-store": "3dm-config-store.js"
+      "3dm-config-store": "3dm-config-store.js",
+      "3dm-cloud-join": "3dm-cloud-join.js"
     }
   },
   "dependencies": {