node-red-contrib-3dm-space 0.0.7 → 1.0.0

package/3dm-cloud-config.html

@@ -10,35 +10,99 @@
             password: { type: "password" }
         },
         label: function () {
-            return this.name || "3DM Cloud Login";
+            return this.name || this.clientid || "3DM Cloud Login";
         }
     });
 </script>
 
 <script type="text/html" data-template-name="3dm-cloud-config">
-    <div class="form-row">
-        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-config-input-name" placeholder="e.g. Main PassPort">
-    </div>
+    <style>
+        .three-dm-login-panel {
+            background: #2f3544;
+            border-radius: 10px;
+            padding: 14px;
+            margin-bottom: 12px;
+        }
 
-    <div class="form-row">
-        <label for="node-config-input-username"><i class="fa fa-user"></i> Username</label>
-        <input type="text" id="node-config-input-username" placeholder="Paste device username">
-    </div>
+        .three-dm-login-row {
+            background: #3a4152;
+            border-radius: 8px;
+            padding: 10px 12px;
+            margin-bottom: 12px;
+        }
 
-    <div class="form-row">
-        <label for="node-config-input-password"><i class="fa fa-key"></i> Password</label>
-        <input type="password" id="node-config-input-password" placeholder="Paste device password">
+        .three-dm-login-row label {
+            display: block;
+            width: 100%;
+            color: #69d36f;
+            font-weight: bold;
+            margin-bottom: 6px;
+        }
+
+        .three-dm-login-row input {
+            width: 100%;
+            box-sizing: border-box;
+            background: #3a4152;
+            color: #ffffff;
+            border: none;
+            font-size: 15px;
+            padding: 4px 0;
+        }
+
+        .three-dm-login-row input::placeholder {
+            color: #b8beca;
+        }
+
+        .three-dm-login-row input:focus {
+            outline: none;
+            box-shadow: none;
+        }
+
+        .three-dm-login-note {
+            color: #c8ccd6;
+            font-size: 12px;
+            margin-top: 4px;
+        }
+    </style>
+
+    <div class="three-dm-login-panel">
+        <div class="three-dm-login-row">
+            <label for="node-config-input-clientid">Client ID</label>
+            <input type="text" id="node-config-input-clientid" placeholder="Paste Client ID from 3DM.space">
+        </div>
+
+        <div class="three-dm-login-row">
+            <label for="node-config-input-username">User Name*</label>
+            <input type="text" id="node-config-input-username" placeholder="Paste User Name from 3DM.space">
+        </div>
+
+        <div class="three-dm-login-row">
+            <label for="node-config-input-password">Password</label>
+            <input type="password" id="node-config-input-password" placeholder="Paste Password from 3DM.space">
+        </div>
     </div>
 
     <div class="form-row">
-        <label for="node-config-input-clientid"><i class="fa fa-id-card"></i> Client ID</label>
-        <input type="text" id="node-config-input-clientid" placeholder="Optional, leave blank unless supplied">
+        <label for="node-config-input-name">
+            <i class="fa fa-tag"></i> Node Name
+        </label>
+        <input type="text" id="node-config-input-name" placeholder="Optional, e.g. Main PassPort">
+        <div class="three-dm-login-note">
+            This is only the name shown inside Node-RED.
+        </div>
     </div>
 </script>
 
 <script type="text/html" data-help-name="3dm-cloud-config">
     <p>Login details for 3DM.space SCADA Cloud.</p>
-    <p>Give this login a friendly name, then paste the device username and password from 3DM.space.</p>
-    <p>Client ID is optional. Leave it blank unless supplied.</p>
+
+    <p>Copy the details from 3DM.space in this order:</p>
+
+    <ol>
+        <li>Client ID</li>
+        <li>User Name*</li>
+        <li>Password</li>
+    </ol>
+
+    <p>Node Name is optional and is only used inside Node-RED.</p>
 </script>

package/3dm-cloud-config.js

@@ -1,192 +1,197 @@
-module.exports = function (RED) {
-    "use strict";
-
-    var mqtt = require("mqtt");
-
-    /*
-     * 3DM.space Cloud connection settings
-     * Hidden from users.
-     */
-    var CLOUD_HOST = "3dm.space";
-    var CLOUD_PORT = 1883;
-    var CLOUD_URL = "mqtt://" + CLOUD_HOST + ":" + CLOUD_PORT;
-
-    var MQTT_KEEPALIVE = 60;
-    var MQTT_CLEAN_SESSION = true;
-    var MQTT_RECONNECT_MS = 5000;
-    var MQTT_CONNECT_TIMEOUT_MS = 15000;
-
-    /*
-     * Prevent the logs getting hammered with the same auth error every 5 seconds.
-     */
-    var REPEAT_ERROR_LOG_MS = 60000;
-
-    function cleanText(value) {
-        if (value === null || value === undefined) {
-            return "";
-        }
-
-        return String(value).trim();
-    }
-
-    function ThreeDMCloudConfigNode(config) {
-        RED.nodes.createNode(this, config);
-
-        var node = this;
-
-        node.name = cleanText(config.name);
-        node.clientid = cleanText(config.clientid);
-
-        node.username = node.credentials && node.credentials.username
-            ? cleanText(node.credentials.username)
-            : "";
-
-        node.password = node.credentials && node.credentials.password
-            ? cleanText(node.credentials.password)
-            : "";
-
-        node.connected = false;
-        node.client = null;
-        node.subscriptions = {};
-
-        node.lastErrorText = "";
-        node.lastErrorTime = 0;
-
-        node.setMaxListeners(0);
-
-        function warnOncePerMinute(text) {
-            var now = Date.now();
-
-            if (text !== node.lastErrorText || (now - node.lastErrorTime) > REPEAT_ERROR_LOG_MS) {
-                node.lastErrorText = text;
-                node.lastErrorTime = now;
-                node.warn(text);
-            }
-        }
-
-        node.connect = function () {
-            if (!node.username) {
-                node.connected = false;
-                node.emit("state", false);
-                warnOncePerMinute("3DM Cloud username is missing");
-                return;
-            }
-
-            var options = {
-                username: node.username,
-                password: node.password,
-                clean: MQTT_CLEAN_SESSION,
-                keepalive: MQTT_KEEPALIVE,
-                reconnectPeriod: MQTT_RECONNECT_MS,
-                connectTimeout: MQTT_CONNECT_TIMEOUT_MS
-            };
-
-            /*
-             * Only send Client ID if the user entered one.
-             */
-            if (node.clientid) {
-                options.clientId = node.clientid;
-            }
-
-            node.client = mqtt.connect(CLOUD_URL, options);
-
-            node.client.on("connect", function () {
-                node.connected = true;
-                node.lastErrorText = "";
-                node.lastErrorTime = 0;
-
-                node.emit("state", true);
-
-                Object.keys(node.subscriptions).forEach(function (topic) {
-                    node.client.subscribe(topic, node.subscriptions[topic], function (err) {
-                        if (err) {
-                            warnOncePerMinute("3DM Cloud subscribe failed: " + (err.message || err));
-                        }
-                    });
-                });
-            });
-
-            node.client.on("reconnect", function () {
-                node.emit("reconnect");
-            });
-
-            node.client.on("offline", function () {
-                node.connected = false;
-                node.emit("state", false);
-            });
-
-            node.client.on("close", function () {
-                node.connected = false;
-                node.emit("state", false);
-            });
-
-            node.client.on("error", function (err) {
-                node.connected = false;
-                node.emit("state", false);
-
-                var text = err && err.message ? err.message : String(err);
-
-                if (text.indexOf("Not authorized") !== -1 || text.indexOf("not authorized") !== -1) {
-                    warnOncePerMinute("3DM Cloud login rejected. Check username, password, and Client ID.");
-                } else {
-                    warnOncePerMinute("3DM Cloud connection error: " + text);
-                }
-            });
-
-            node.client.on("message", function (topic, payload) {
-                node.emit("cloud-message", topic, payload);
-            });
-        };
-
-        node.publish = function (topic, payload, options, callback) {
-            if (!node.client || !node.connected) {
-                var err = new Error("3DM Cloud is not connected");
-
-                if (callback) {
-                    callback(err);
-                }
-
-                return;
-            }
-
-            var data = payload;
-
-            if (typeof data !== "string" && !Buffer.isBuffer(data)) {
-                data = JSON.stringify(data);
-            }
-
-            node.client.publish(topic, data, options || {}, callback);
-        };
-
-        node.subscribe = function (topic, options, callback) {
-            node.subscriptions[topic] = options || {};
-
-            if (node.client && node.connected) {
-                node.client.subscribe(topic, options || {}, callback);
-            } else if (callback) {
-                callback();
-            }
-        };
-
-        node.on("close", function (removed, done) {
-            node.connected = false;
-
-            if (node.client) {
-                node.client.end(true, function () {
-                    done();
-                });
-            } else {
-                done();
-            }
-        });
-
-        node.connect();
-    }
-
-    RED.nodes.registerType("3dm-cloud-config", ThreeDMCloudConfigNode, {
-        credentials: {
-            username: { type: "text" },
-            password: { type: "password" }
-        }
-    });
-};
+module.exports = function (RED) {
+    "use strict";
+
+    var mqtt = require("mqtt");
+
+    /*
+     * Hidden 3DM.space Cloud connection settings.
+     */
+    var CLOUD_HOST = "3dm.space";
+    var CLOUD_PORT = 1883;
+    var CLOUD_URL = "mqtt://" + CLOUD_HOST + ":" + CLOUD_PORT;
+
+    var MQTT_KEEPALIVE = 60;
+    var MQTT_CLEAN_SESSION = true;
+    var MQTT_RECONNECT_MS = 5000;
+    var MQTT_CONNECT_TIMEOUT_MS = 15000;
+
+    /*
+     * Prevent the same connection error being logged every few seconds.
+     */
+    var REPEAT_ERROR_LOG_MS = 60000;
+
+    function cleanText(value) {
+        if (value === null || value === undefined) {
+            return "";
+        }
+
+        return String(value).trim();
+    }
+
+    function ThreeDMCloudConfigNode(config) {
+        RED.nodes.createNode(this, config);
+
+        var node = this;
+
+        node.name = cleanText(config.name);
+        node.clientid = cleanText(config.clientid);
+
+        node.username = node.credentials && node.credentials.username
+            ? cleanText(node.credentials.username)
+            : "";
+
+        node.password = node.credentials && node.credentials.password
+            ? cleanText(node.credentials.password)
+            : "";
+
+        node.connected = false;
+        node.client = null;
+        node.subscriptions = {};
+
+        node.lastErrorText = "";
+        node.lastErrorTime = 0;
+
+        node.setMaxListeners(0);
+
+        function warnOncePerMinute(text) {
+            var now = Date.now();
+
+            if (text !== node.lastErrorText || (now - node.lastErrorTime) > REPEAT_ERROR_LOG_MS) {
+                node.lastErrorText = text;
+                node.lastErrorTime = now;
+                node.warn(text);
+            }
+        }
+
+        node.connect = function () {
+            if (!node.username) {
+                node.connected = false;
+                node.emit("state", false);
+                warnOncePerMinute("3DM Cloud username is missing");
+                return;
+            }
+
+            var options = {
+                username: node.username,
+                password: node.password,
+                clean: MQTT_CLEAN_SESSION,
+                keepalive: MQTT_KEEPALIVE,
+                reconnectPeriod: MQTT_RECONNECT_MS,
+                connectTimeout: MQTT_CONNECT_TIMEOUT_MS
+            };
+
+            /*
+             * Only send Client ID if the user entered one.
+             */
+            if (node.clientid) {
+                options.clientId = node.clientid;
+            }
+
+            node.client = mqtt.connect(CLOUD_URL, options);
+
+            node.client.on("connect", function () {
+                node.connected = true;
+                node.lastErrorText = "";
+                node.lastErrorTime = 0;
+
+                node.emit("state", true);
+
+                Object.keys(node.subscriptions).forEach(function (topic) {
+                    node.client.subscribe(topic, node.subscriptions[topic], function (err) {
+                        if (err) {
+                            warnOncePerMinute("3DM Cloud subscribe failed: " + (err.message || err));
+                        }
+                    });
+                });
+            });
+
+            node.client.on("reconnect", function () {
+                node.emit("reconnect");
+            });
+
+            node.client.on("offline", function () {
+                node.connected = false;
+                node.emit("state", false);
+            });
+
+            node.client.on("close", function () {
+                node.connected = false;
+                node.emit("state", false);
+            });
+
+            node.client.on("error", function (err) {
+                node.connected = false;
+                node.emit("state", false);
+
+                var text = err && err.message ? err.message : String(err);
+
+                if (text.indexOf("Not authorized") !== -1 || text.indexOf("not authorized") !== -1) {
+                    warnOncePerMinute("3DM Cloud login rejected. Check username, password, and Client ID.");
+                } else {
+                    warnOncePerMinute("3DM Cloud connection error: " + text);
+                }
+            });
+
+            node.client.on("message", function (topic, payload) {
+                node.emit("cloud-message", topic, payload);
+            });
+        };
+
+        node.publish = function (topic, payload, options, callback) {
+            if (!node.client || !node.connected) {
+                var err = new Error("3DM Cloud is not connected");
+
+                if (callback) {
+                    callback(err);
+                }
+
+                return;
+            }
+
+            var data = payload;
+
+            if (typeof data !== "string" && !Buffer.isBuffer(data)) {
+                data = JSON.stringify(data);
+            }
+
+            node.client.publish(topic, data, options || {}, callback);
+        };
+
+        node.subscribe = function (topic, options, callback) {
+            node.subscriptions[topic] = options || {};
+
+            if (node.client && node.connected) {
+                node.client.subscribe(topic, options || {}, callback);
+            } else if (callback) {
+                callback();
+            }
+        };
+
+        node.on("close", function (removed, done) {
+            if (typeof removed === "function") {
+                done = removed;
+            }
+
+            done = done || function () {};
+
+            node.connected = false;
+
+            if (node.client) {
+                node.client.end(true, function () {
+                    done();
+                });
+            } else {
+                done();
+            }
+        });
+
+        node.connect();
+    }
+
+    RED.nodes.registerType("3dm-cloud-config", ThreeDMCloudConfigNode, {
+        credentials: {
+            username: { type: "text" },
+            password: { type: "password" }
+        }
+    });
+};

package/3dm-cloud-in.html

@@ -1,7 +1,7 @@
 <script type="text/javascript">
     RED.nodes.registerType("3dm-cloud-in", {
         category: "3DM.space",
-        color: "#656565",
+        color: "#6D6D6D",
         defaults: {
             name: { value: "" },
             server: { value: "", type: "3dm-cloud-config", required: true },
@@ -10,7 +10,7 @@
         },
         inputs: 0,
         outputs: 1,
-        icon: "icon.png",
+        icon: "font-awesome/fa-cloud-download",
         label: function () {
             return this.name || "3DM attributes in";
         },
@@ -20,22 +20,30 @@
 
 <script type="text/html" data-template-name="3dm-cloud-in">
     <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="3DM attributes in">
+        <label for="node-input-name">
+            <i class="fa fa-tag"></i> Node Name
+        </label>
+        <input type="text" id="node-input-name" placeholder="Optional, e.g. Pump Command In">
     </div>
 
     <div class="form-row">
-        <label for="node-input-server"><i class="fa fa-cloud"></i> Login</label>
+        <label for="node-input-server">
+            <i class="fa fa-cloud"></i> 3DM Cloud Login
+        </label>
         <input type="text" id="node-input-server">
     </div>
 
     <div class="form-row">
-        <label for="node-input-keyFilter"><i class="fa fa-filter"></i> Key Filter</label>
-        <input type="text" id="node-input-keyFilter" placeholder="Leave blank to allow all">
+        <label for="node-input-keyFilter">
+            <i class="fa fa-filter"></i> Attribute Key
+        </label>
+        <input type="text" id="node-input-keyFilter" placeholder="Optional, e.g. pump_cmd">
     </div>
 
     <div class="form-row">
-        <label for="node-input-outputMode"><i class="fa fa-sign-out"></i> Output</label>
+        <label for="node-input-outputMode">
+            <i class="fa fa-sign-out"></i> Output Type
+        </label>
         <select id="node-input-outputMode" style="width:70%;">
             <option value="value">Value only</option>
             <option value="object">Object with key</option>
@@ -44,15 +52,20 @@
 </script>
 
 <script type="text/html" data-help-name="3dm-cloud-in">
-    <p>Receives cloud attribute updates from 3DM.space.</p>
+    <p>Receives attribute updates from 3DM.space SCADA Cloud.</p>
 
-    <p>If Key Filter is blank, all incoming attributes pass through.</p>
+    <p>Use this node when 3DM.space needs to send a value down to Node-RED, such as a pump command, mode change, reset command, or setpoint.</p>
 
-    <p>If Key Filter is set to <code>pump_cmd</code>, only messages containing <code>pump_cmd</code> are passed through.</p>
+    <p><b>Attribute Key</b> is optional.</p>
+
+    <p>If Attribute Key is blank, all received attributes are passed through.</p>
+
+    <p>If Attribute Key is set to <code>pump_cmd</code>, only incoming messages containing <code>pump_cmd</code> are passed through.</p>
+
+    <p><b>Output Type</b> controls what the node sends:</p>
 
-    <p>Output modes:</p>
     <ul>
-        <li><b>Value only</b>: outputs just the selected value.</li>
-        <li><b>Object with key</b>: outputs a JSON object containing the selected key.</li>
+        <li><b>Value only</b>: outputs only the selected value.</li>
+        <li><b>Object with key</b>: outputs a JSON object containing the selected key and value.</li>
     </ul>
 </script>