@processlink/node-red-contrib-processlink 1.0.4 → 1.1.0

package/README.md

@@ -1,9 +1,3 @@
-<p align="center">
-  <a href="https://processlink.com.au">
-    <img src="processlink-logo.png" alt="Process Link" width="80">
-  </a>
-</p>
-
 <p align="center">
   <a href="https://processlink.com.au">
     <img src="processlink-banner.png" alt="Process Link" height="50">

package/nodes/files/processlink-files-upload.html

@@ -11,7 +11,7 @@
       apiUrl: { value: "https://files.processlink.com.au/api/upload" },
     },
     inputs: 1,
-    outputs: 1,
+    outputs: 2,
     icon: "processlink.png",
     paletteLabel: "files upload",
     label: function () {
@@ -21,7 +21,7 @@
       return this.name ? "node_label_italic" : "";
     },
     inputLabels: "file buffer",
-    outputLabels: "response",
+    outputLabels: ["success", "error"],
   });
 </script>
 
@@ -62,68 +62,60 @@
     <dt>payload <span class="property-type">buffer | string</span></dt>
     <dd>The file content to upload.</dd>
     <dt class="optional">filename <span class="property-type">string</span></dt>
-    <dd>The filename that will appear in Process Link Files. Can be set via <code>msg.filename</code> or configured in the node. Defaults to "file.bin" if not set. Any path is stripped (e.g., <code>/tmp/report.csv</code> becomes <code>report.csv</code>).</dd>
+    <dd>Filename for the upload. Can be set via <code>msg.filename</code> or in the node config. Defaults to "file.bin".</dd>
   </dl>
 
-  <h3>Configuration</h3>
+  <h3>Outputs</h3>
+  <p>This node has two outputs:</p>
+  <ol>
+    <li><strong>Success</strong> - Upload completed successfully (HTTP 201)</li>
+    <li><strong>Error</strong> - Upload failed (network error, API error, or timeout)</li>
+  </ol>
+
+  <h4>Success Output</h4>
   <dl class="message-properties">
-    <dt>Filename <span class="property-type">string</span></dt>
-    <dd>Default filename to use if <code>msg.filename</code> is not set.</dd>
-    <dt>Prefix with timestamp <span class="property-type">boolean</span></dt>
-    <dd>When enabled, automatically prefixes the filename with a timestamp in the format <code>YYYY-MM-DD_HH-MM-SS_</code>. For example, <code>report.csv</code> becomes <code>2025-02-05_14-30-45_report.csv</code>.</dd>
-    <dt>Timeout <span class="property-type">number</span></dt>
-    <dd>Request timeout in milliseconds. Default is 30000 (30 seconds).</dd>
+    <dt>payload.ok <span class="property-type">boolean</span></dt>
+    <dd><code>true</code></dd>
+    <dt>payload.file_id <span class="property-type">string</span></dt>
+    <dd>UUID of the uploaded file.</dd>
+    <dt>file_id <span class="property-type">string</span></dt>
+    <dd>Same as above (convenience property).</dd>
+    <dt>statusCode <span class="property-type">number</span></dt>
+    <dd>201</dd>
   </dl>
 
-  <h3>Outputs</h3>
+  <h4>Error Output</h4>
   <dl class="message-properties">
-    <dt>payload <span class="property-type">object</span></dt>
-    <dd>The API response containing <code>ok</code>, <code>file_id</code>, and <code>created_at</code>.</dd>
-    <dt>file_id <span class="property-type">string</span></dt>
-    <dd>The UUID of the uploaded file (convenience property).</dd>
+    <dt>payload.error <span class="property-type">string</span></dt>
+    <dd>Error message from the API or network layer.</dd>
     <dt>statusCode <span class="property-type">number</span></dt>
-    <dd>The HTTP status code (201 on success).</dd>
+    <dd>HTTP status code, or 0 for network/timeout errors.</dd>
   </dl>
 
-  <h3>Details</h3>
-  <p>
-    This node uploads files to your Process Link site. The file content should be passed in
-    <code>msg.payload</code> as a Buffer (from a file-in node) or as a string.
-  </p>
-  <p>
-    The filename can be set in <code>msg.filename</code> or configured in the node properties. If
-    the filename contains a path, only the basename will be used.
-  </p>
+  <h3>Configuration</h3>
+  <dl class="message-properties">
+    <dt>Filename <span class="property-type">string</span></dt>
+    <dd>Default filename if <code>msg.filename</code> is not set.</dd>
+    <dt>Prefix with timestamp <span class="property-type">boolean</span></dt>
+    <dd>Adds <code>YYYY-MM-DD_HH-MM-SS_</code> prefix to filename.</dd>
+    <dt>Timeout <span class="property-type">number</span></dt>
+    <dd>Request timeout in ms. Default: 30000.</dd>
+  </dl>
 
   <h3>Status Codes</h3>
   <ul>
-    <li><strong>201</strong> - Upload successful</li>
-    <li><strong>400</strong> - Bad request (missing file, invalid site ID)</li>
+    <li><strong>201</strong> - Success</li>
+    <li><strong>400</strong> - Bad request</li>
     <li><strong>401</strong> - Invalid API key</li>
-    <li><strong>403</strong> - API access not enabled for this site</li>
+    <li><strong>403</strong> - API access not enabled</li>
     <li><strong>404</strong> - Site not found</li>
-    <li><strong>429</strong> - Rate limit exceeded (max 30 uploads/minute)</li>
+    <li><strong>429</strong> - Rate limit exceeded</li>
     <li><strong>507</strong> - Storage limit exceeded</li>
   </ul>
 
-  <h3>Example Flow</h3>
-  <pre>
-[File In] → [Process Link Upload] → [Debug]
-
-The File In node reads a file and outputs msg.payload (Buffer)
-and msg.filename. Connect directly to this node to upload.</pre>
-
   <h3>References</h3>
   <ul>
-    <li>
-      <a href="https://portal.processlink.com.au" target="_blank">Process Link Portal</a> - Manage
-      your sites and API keys
-    </li>
-    <li>
-      <a href="https://github.com/process-link/node-red-contrib-processlink" target="_blank"
-        >GitHub</a
-      >
-      - Source code and issues
-    </li>
+    <li><a href="https://portal.processlink.com.au" target="_blank">Process Link Portal</a></li>
+    <li><a href="https://github.com/process-link/node-red-contrib-processlink" target="_blank">GitHub</a></li>
   </ul>
 </script>

package/nodes/files/processlink-files-upload.js

@@ -121,25 +121,24 @@ module.exports = function (RED) {
           msg.headers = res.headers;
 
           if (res.statusCode === 201 && parsedResponse.ok) {
-            // Success
+            // Success - send to output 1
             msg.file_id = parsedResponse.file_id;
             node.status({
               fill: "green",
               shape: "dot",
               text: `uploaded: ${parsedResponse.file_id?.substring(0, 8)}...`,
             });
-            send(msg);
+            send([msg, null]);
             done();
 
             // Clear status after 5 seconds
             setTimeout(() => node.status({}), 5000);
           } else {
-            // API error
+            // API error - send to output 2
             const errorMsg = parsedResponse.error || parsedResponse.message || `HTTP ${res.statusCode}`;
             node.status({ fill: "red", shape: "dot", text: errorMsg });
 
-            // Still send the message so users can handle errors in their flow
-            send(msg);
+            send([null, msg]);
             done();
 
             // Clear status after 10 seconds
@@ -152,7 +151,7 @@ module.exports = function (RED) {
         node.status({ fill: "red", shape: "ring", text: "request failed" });
         msg.payload = { error: err.message };
         msg.statusCode = 0;
-        send(msg);
+        send([null, msg]);
         done(err);
 
         setTimeout(() => node.status({}), 10000);
@@ -165,7 +164,7 @@ module.exports = function (RED) {
         node.status({ fill: "red", shape: "ring", text: "timeout" });
         msg.payload = { error: "Request timed out" };
         msg.statusCode = 0;
-        send(msg);
+        send([null, msg]);
         done(new Error("Request timed out"));
 
         setTimeout(() => node.status({}), 10000);

package/nodes/system/processlink-system-info.html

@@ -0,0 +1,101 @@
+<script type="text/javascript">
+  RED.nodes.registerType("processlink-system-info", {
+    category: "Process Link",
+    color: "#f97316",
+    defaults: {
+      name: { value: "" },
+      sendOnDeploy: { value: true },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "processlink.png",
+    paletteLabel: "system info",
+    label: function () {
+      return this.name || "system info";
+    },
+    labelStyle: function () {
+      return this.name ? "node_label_italic" : "";
+    },
+    inputLabels: "trigger",
+    outputLabels: "system info",
+  });
+</script>
+
+<script type="text/html" data-template-name="processlink-system-info">
+  <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-sendOnDeploy">&nbsp;</label>
+    <input type="checkbox" id="node-input-sendOnDeploy" style="width: auto; margin-right: 10px;" checked>
+    <span>Send system info on deploy</span>
+  </div>
+</script>
+
+<script type="text/html" data-help-name="processlink-system-info">
+  <p>Outputs system information for diagnostics and monitoring.</p>
+
+  <h3>Triggers</h3>
+  <ul>
+    <li><strong>On deploy</strong> (if enabled) - Automatically sends when flow starts</li>
+    <li><strong>On input</strong> - Any incoming message triggers a fresh reading</li>
+  </ul>
+
+  <h3>Configuration</h3>
+  <dl class="message-properties">
+    <dt>Send on deploy <span class="property-type">boolean</span></dt>
+    <dd>When checked (default), outputs system info when the flow is deployed.</dd>
+  </dl>
+
+  <h3>Output</h3>
+  <p><code>msg.payload</code> contains:</p>
+
+  <table>
+    <tr><td><strong>timestamp</strong></td><td>ISO 8601 UTC timestamp</td></tr>
+    <tr><td><strong>localTime</strong></td><td>Device local time string</td></tr>
+    <tr><td><strong>timezone</strong></td><td>Timezone name (e.g., "Australia/Sydney")</td></tr>
+    <tr><td><strong>hostname</strong></td><td>Device hostname</td></tr>
+    <tr><td><strong>platform</strong></td><td>"win32", "linux", or "darwin"</td></tr>
+    <tr><td><strong>os</strong></td><td>OS name and version</td></tr>
+    <tr><td><strong>arch</strong></td><td>CPU architecture</td></tr>
+    <tr><td><strong>user</strong></td><td>User running Node-RED</td></tr>
+    <tr><td><strong>workingDirectory</strong></td><td>Node-RED working directory</td></tr>
+    <tr><td><strong>uptime</strong></td><td>System uptime (raw seconds, breakdown, formatted)</td></tr>
+    <tr><td><strong>cpu</strong></td><td>Model, cores, architecture</td></tr>
+    <tr><td><strong>memory</strong></td><td>Total, free, used (bytes + formatted), usedPercent</td></tr>
+    <tr><td><strong>disk</strong></td><td>Total, free, used (bytes + formatted), usedPercent</td></tr>
+    <tr><td><strong>network</strong></td><td>primaryIP, mac, interfaces</td></tr>
+    <tr><td><strong>nodeRed</strong></td><td>version, uptime</td></tr>
+    <tr><td><strong>nodejs</strong></td><td>version</td></tr>
+    <tr><td><strong>processMemory</strong></td><td>rss, heapTotal, heapUsed</td></tr>
+  </table>
+
+  <h3>Uptime Structure</h3>
+  <pre>{
+  "raw": 432000,
+  "breakdown": { "days": 5, "hours": 0, "minutes": 0, "seconds": 0 },
+  "formatted": "5d 0h 0m 0s"
+}</pre>
+
+  <h3>Memory/Disk Structure</h3>
+  <pre>{
+  "total": { "bytes": 17179869184, "formatted": "16.00 GB" },
+  "free": { "bytes": 8589934592, "formatted": "8.00 GB" },
+  "used": { "bytes": 8589934592, "formatted": "8.00 GB" },
+  "usedPercent": 50
+}</pre>
+
+  <h3>Notes</h3>
+  <ul>
+    <li><strong>disk</strong> may be unavailable on some systems due to permissions.</li>
+    <li><strong>nodeRed.uptime</strong> tracks time since flow was deployed.</li>
+    <li>Use <strong>usedPercent</strong> for easy threshold checks.</li>
+  </ul>
+
+  <h3>References</h3>
+  <ul>
+    <li><a href="https://portal.processlink.com.au" target="_blank">Process Link Portal</a></li>
+    <li><a href="https://github.com/process-link/node-red-contrib-processlink" target="_blank">GitHub</a></li>
+  </ul>
+</script>

package/nodes/system/processlink-system-info.js

@@ -0,0 +1,297 @@
+/**
+ * Process Link System Info Node
+ * Outputs system information for diagnostics and monitoring
+ */
+
+module.exports = function (RED) {
+  const os = require("os");
+  const { execSync } = require("child_process");
+
+  /**
+   * Format bytes to human-readable string
+   * @param {number} bytes
+   * @returns {string}
+   */
+  function formatBytes(bytes) {
+    if (bytes === 0) return "0 B";
+    const units = ["B", "KB", "MB", "GB", "TB"];
+    const i = Math.floor(Math.log(bytes) / Math.log(1024));
+    return (bytes / Math.pow(1024, i)).toFixed(2) + " " + units[i];
+  }
+
+  /**
+   * Convert seconds to broken-down time object
+   * @param {number} totalSeconds
+   * @returns {object}
+   */
+  function formatUptime(totalSeconds) {
+    const days = Math.floor(totalSeconds / 86400);
+    const hours = Math.floor((totalSeconds % 86400) / 3600);
+    const minutes = Math.floor((totalSeconds % 3600) / 60);
+    const seconds = Math.floor(totalSeconds % 60);
+
+    return {
+      raw: Math.floor(totalSeconds),
+      breakdown: {
+        days: days,
+        hours: hours,
+        minutes: minutes,
+        seconds: seconds,
+      },
+      formatted: `${days}d ${hours}h ${minutes}m ${seconds}s`,
+    };
+  }
+
+  /**
+   * Get primary network interface info (first non-internal IPv4)
+   * @returns {object}
+   */
+  function getNetworkInfo() {
+    const interfaces = os.networkInterfaces();
+    let primaryIP = null;
+    let primaryMAC = null;
+
+    // Find first non-internal IPv4 address
+    for (const name of Object.keys(interfaces)) {
+      for (const iface of interfaces[name]) {
+        if (iface.family === "IPv4" && !iface.internal) {
+          if (!primaryIP) {
+            primaryIP = iface.address;
+            primaryMAC = iface.mac;
+          }
+        }
+      }
+    }
+
+    return {
+      interfaces: interfaces,
+      primaryIP: primaryIP || "unknown",
+      mac: primaryMAC || "unknown",
+    };
+  }
+
+  /**
+   * Get disk space information (cross-platform)
+   * @returns {object|null}
+   */
+  function getDiskInfo() {
+    try {
+      const platform = os.platform();
+      let total, free, used;
+
+      if (platform === "win32") {
+        // Windows: use wmic
+        const output = execSync("wmic logicaldisk where drivetype=3 get size,freespace", {
+          encoding: "utf8",
+          timeout: 5000,
+        });
+        const lines = output.trim().split("\n").filter((l) => l.trim());
+        if (lines.length > 1) {
+          // Sum all drives
+          total = 0;
+          free = 0;
+          for (let i = 1; i < lines.length; i++) {
+            const parts = lines[i].trim().split(/\s+/);
+            if (parts.length >= 2) {
+              free += parseInt(parts[0]) || 0;
+              total += parseInt(parts[1]) || 0;
+            }
+          }
+          used = total - free;
+        }
+      } else {
+        // Linux/Mac: use df
+        const output = execSync("df -B1 / | tail -1", {
+          encoding: "utf8",
+          timeout: 5000,
+        });
+        const parts = output.trim().split(/\s+/);
+        if (parts.length >= 4) {
+          total = parseInt(parts[1]) || 0;
+          used = parseInt(parts[2]) || 0;
+          free = parseInt(parts[3]) || 0;
+        }
+      }
+
+      if (total && total > 0) {
+        return {
+          total: {
+            bytes: total,
+            formatted: formatBytes(total),
+          },
+          free: {
+            bytes: free,
+            formatted: formatBytes(free),
+          },
+          used: {
+            bytes: used,
+            formatted: formatBytes(used),
+          },
+          usedPercent: Math.round((used / total) * 100),
+        };
+      }
+    } catch (e) {
+      // Disk info unavailable
+    }
+    return null;
+  }
+
+  /**
+   * Get Node-RED version
+   * @returns {string}
+   */
+  function getNodeRedVersion() {
+    try {
+      return RED.version();
+    } catch (e) {
+      return "unknown";
+    }
+  }
+
+  /**
+   * Collect all system information
+   * @param {number} nodeRedStartTime - timestamp when Node-RED started
+   * @returns {object}
+   */
+  function collectSystemInfo(nodeRedStartTime) {
+    const now = new Date();
+    const totalMem = os.totalmem();
+    const freeMem = os.freemem();
+    const usedMem = totalMem - freeMem;
+    const cpus = os.cpus();
+    const processMemory = process.memoryUsage();
+    const networkInfo = getNetworkInfo();
+    const diskInfo = getDiskInfo();
+
+    // Calculate Node-RED uptime
+    const nodeRedUptimeSeconds = (Date.now() - nodeRedStartTime) / 1000;
+
+    const info = {
+      timestamp: now.toISOString(),
+      localTime: now.toLocaleString(),
+      timezone: Intl.DateTimeFormat().resolvedOptions().timeZone,
+
+      hostname: os.hostname(),
+      platform: os.platform(),
+      os: `${os.type()} ${os.release()}`,
+      arch: os.arch(),
+      user: os.userInfo().username,
+      workingDirectory: process.cwd(),
+
+      uptime: formatUptime(os.uptime()),
+
+      cpu: {
+        model: cpus.length > 0 ? cpus[0].model : "unknown",
+        cores: cpus.length,
+        arch: os.arch(),
+      },
+
+      memory: {
+        total: {
+          bytes: totalMem,
+          formatted: formatBytes(totalMem),
+        },
+        free: {
+          bytes: freeMem,
+          formatted: formatBytes(freeMem),
+        },
+        used: {
+          bytes: usedMem,
+          formatted: formatBytes(usedMem),
+        },
+        usedPercent: Math.round((usedMem / totalMem) * 100),
+      },
+
+      network: networkInfo,
+
+      nodeRed: {
+        version: getNodeRedVersion(),
+        uptime: formatUptime(nodeRedUptimeSeconds),
+      },
+
+      nodejs: {
+        version: process.version,
+      },
+
+      processMemory: {
+        rss: {
+          bytes: processMemory.rss,
+          formatted: formatBytes(processMemory.rss),
+        },
+        heapTotal: {
+          bytes: processMemory.heapTotal,
+          formatted: formatBytes(processMemory.heapTotal),
+        },
+        heapUsed: {
+          bytes: processMemory.heapUsed,
+          formatted: formatBytes(processMemory.heapUsed),
+        },
+      },
+    };
+
+    // Add disk info if available
+    if (diskInfo) {
+      info.disk = diskInfo;
+    }
+
+    return info;
+  }
+
+  function ProcessLinkSystemInfoNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    // Record when this node was created (proxy for Node-RED start time)
+    const nodeRedStartTime = Date.now();
+
+    // Send on deploy if enabled
+    if (config.sendOnDeploy) {
+      // Small delay to let Node-RED fully initialize
+      setTimeout(() => {
+        const info = collectSystemInfo(nodeRedStartTime);
+        node.send({ payload: info });
+        node.status({
+          fill: "green",
+          shape: "dot",
+          text: `sent @ ${new Date().toLocaleTimeString()}`,
+        });
+        setTimeout(() => node.status({}), 5000);
+      }, 1000);
+    }
+
+    node.on("input", function (msg, send, done) {
+      // For Node-RED 0.x compatibility
+      send = send || function () { node.send.apply(node, arguments); };
+      done = done || function (err) { if (err) node.error(err, msg); };
+
+      try {
+        node.status({ fill: "yellow", shape: "dot", text: "collecting..." });
+
+        const info = collectSystemInfo(nodeRedStartTime);
+        msg.payload = info;
+
+        node.status({
+          fill: "green",
+          shape: "dot",
+          text: `sent @ ${new Date().toLocaleTimeString()}`,
+        });
+
+        send(msg);
+        done();
+
+        // Clear status after 5 seconds
+        setTimeout(() => node.status({}), 5000);
+      } catch (err) {
+        node.status({ fill: "red", shape: "ring", text: "error" });
+        done(err);
+        setTimeout(() => node.status({}), 10000);
+      }
+    });
+
+    node.on("close", function () {
+      node.status({});
+    });
+  }
+
+  RED.nodes.registerType("processlink-system-info", ProcessLinkSystemInfoNode);
+};

package/package.json

@@ -1,54 +1,58 @@
-{
-  "name": "@processlink/node-red-contrib-processlink",
-  "publishConfig": {
-    "access": "public"
-  },
-  "version": "1.0.4",
-  "description": "Node-RED nodes for Process Link platform integration - upload files, send notifications, and connect to industrial automation systems",
-  "keywords": [
-    "node-red",
-    "processlink",
-    "process-link",
-    "files",
-    "upload",
-    "api",
-    "industrial",
-    "iot",
-    "automation",
-    "manufacturing",
-    "scada",
-    "plc"
-  ],
-  "node-red": {
-    "version": ">=2.0.0",
-    "nodes": {
-      "processlink-config": "nodes/config/processlink-config.js",
-      "processlink-files-upload": "nodes/files/processlink-files-upload.js"
-    }
-  },
-  "scripts": {
-    "test": "echo \"No tests yet\" && exit 0"
-  },
-  "author": {
-    "name": "Process Link",
-    "email": "support@processlink.com.au",
-    "url": "https://processlink.com.au"
-  },
-  "contributors": [],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/process-link/node-red-contrib-processlink.git"
-  },
-  "bugs": {
-    "url": "https://github.com/process-link/node-red-contrib-processlink/issues"
-  },
-  "homepage": "https://processlink.com.au",
-  "funding": {
-    "type": "individual",
-    "url": "https://processlink.com.au"
-  },
-  "engines": {
-    "node": ">=14.0.0"
-  }
-}
+{
+  "name": "@processlink/node-red-contrib-processlink",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "1.1.0",
+  "description": "Node-RED nodes for Process Link platform integration - upload files, send notifications, and connect to industrial automation systems",
+  "keywords": [
+    "node-red",
+    "processlink",
+    "process-link",
+    "files",
+    "upload",
+    "api",
+    "industrial",
+    "iot",
+    "automation",
+    "manufacturing",
+    "scada",
+    "plc",
+    "system-info",
+    "diagnostics",
+    "monitoring"
+  ],
+  "node-red": {
+    "version": ">=2.0.0",
+    "nodes": {
+      "processlink-config": "nodes/config/processlink-config.js",
+      "processlink-files-upload": "nodes/files/processlink-files-upload.js",
+      "processlink-system-info": "nodes/system/processlink-system-info.js"
+    }
+  },
+  "scripts": {
+    "test": "echo \"No tests yet\" && exit 0"
+  },
+  "author": {
+    "name": "Process Link",
+    "email": "support@processlink.com.au",
+    "url": "https://processlink.com.au"
+  },
+  "contributors": [],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/process-link/node-red-contrib-processlink.git"
+  },
+  "bugs": {
+    "url": "https://github.com/process-link/node-red-contrib-processlink/issues"
+  },
+  "homepage": "https://processlink.com.au",
+  "funding": {
+    "type": "individual",
+    "url": "https://processlink.com.au"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}