node-red-contrib-boolean-logic-ultimate 1.0.63 → 1.1.0

package/boolean-logic-ultimate/InvertUltimate.js

@@ -1,54 +1,82 @@
 module.exports = function (RED) {
-	function InvertUltimate(config) {
-		RED.nodes.createNode(this, config);
-		this.config = config;
-		var node = this;
+  function InvertUltimate(config) {
+    RED.nodes.createNode(this, config);
+    this.config = config;
+    var node = this;
 
+    function setNodeStatus({ fill, shape, text }) {
+      let dDate = new Date();
+      node.status({
+        fill: fill,
+        shape: shape,
+        text:
+          text +
+          " (" +
+          dDate.getDate() +
+          ", " +
+          dDate.toLocaleTimeString() +
+          ")",
+      });
+    }
 
-		function setNodeStatus({ fill, shape, text }) {
-			let dDate = new Date();
-			node.status({ fill: fill, shape: shape, text: text + " (" + dDate.getDate() + ", " + dDate.toLocaleTimeString() + ")" })
-		}
+    setNodeStatus({ fill: "grey", shape: "dot", text: "Waiting" });
 
-		setNodeStatus({ fill: "grey", shape: "dot", text: "Waiting" });
+    this.on("input", function (msg) {
+      // 11/11/2021 Clone input message and replace only relevant topics
+      const utils = require("./utils.js");
+      let sPayload = utils.fetchFromObject(
+        msg,
+        config.payloadPropName || "payload"
+      );
 
-		this.on('input', function (msg) {
+      // 15/11/2021 inform user about undefined topic or payload
+      if (sPayload === undefined) {
+        setNodeStatus({
+          fill: "red",
+          shape: "dot",
+          text: "Received invalid payload from " + msg.topic || "",
+        });
+        return;
+      }
 
+      var bRes = null;
+      try {
+        bRes = utils.ToBoolean(
+          sPayload,
+          RED.nodes.getNode(config.translatorConfig) // Retrieve the config node. It can be null, but it's handled in utils.js; // 15/11/2021 Convert input to boolean.);
+        ); 
+      } catch (error) {}
+      if (bRes === undefined || bRes === null) {
+        setNodeStatus({
+          fill: "red",
+          shape: "dot",
+          text:
+            "Received non convertible boolean value " +
+            sPayload +
+            " from " +
+            msg.topic,
+        });
+        return;
+      }
 
-			// 11/11/2021 Clone input message and replace only relevant topics
-			const utils = require("./utils.js");
-			let sPayload = utils.fetchFromObject(msg, config.payloadPropName || "payload");
+      var msgOUt = RED.util.cloneMessage(msg);
+      try {
+        msgOUt.payload = !bRes;
+        setNodeStatus({
+          fill: "green",
+          shape: "dot",
+          text: "(Send) " + msgOUt.payload,
+        });
+        node.send(msgOUt);
+      } catch (error) {
+        setNodeStatus({
+          fill: "red",
+          shape: "dot",
+          text: "Unable to invert the input payload " + bRes,
+        });
+      }
+    });
+  }
 
-			// 15/11/2021 inform user about undefined topic or payload
-			if (sPayload === undefined ) {
-				setNodeStatus({ fill: "red", shape: "dot", text: "Received invalid payload from " + msg.topic || "" });
-				return;
-			}
-
-			var bRes = null;
-			try {
-				bRes = utils.ToBoolean(sPayload);
-			} catch (error) {
-			}
-			if (bRes === undefined || bRes === null) {
-				setNodeStatus({ fill: "red", shape: "dot", text: "Received non convertible boolean value " + sPayload + " from " + msg.topic });
-				return;
-			}
-
-			var msgOUt = RED.util.cloneMessage(msg);
-			try {
-				msgOUt.payload = !bRes;
-				setNodeStatus({ fill: "green", shape: "dot", text: "(Send) " + msgOUt.payload });
-				node.send(msgOUt);
-			} catch (error) {
-				setNodeStatus({ fill: "red", shape: "dot", text: "Unable to invert the input payload " + bRes });
-			}
-
-		});
-
-	}
-
-
-
-	RED.nodes.registerType("InvertUltimate", InvertUltimate);
-}
+  RED.nodes.registerType("InvertUltimate", InvertUltimate);
+};

package/boolean-logic-ultimate/RailwaySwitchUltimate.html

@@ -7,7 +7,8 @@
 			triggertopic: { value: "trigger" },
 			initializewith: { value: "0" },
 			autoToggle: { value: "0" },
-			payloadPropName: { value: "payload", required: false }
+			payloadPropName: { value: "payload", required: false },
+			translatorConfig: { type: "translator-config", required: false }			
 		},
 		inputs: 1,
 		outputs: 2,
@@ -85,6 +86,15 @@
 			<option value="120">Toggle above option after 120 seconds</option>
 		</select>
 	</div>
+	<div class="form-row">
+		<br />
+		<b>Translator</b>
+		<br />
+		<label for="node-input-translatorConfig">
+			<font color="green" size="4px"><i class="fa fa-sign-in" aria-hidden="true"></i></font> Input
+		</label>
+		<input type="text" id="node-input-translatorConfig" />
+	</div>
 </script>
 
 <script type="text/markdown" data-help-name="RailwaySwitchUltimate">
@@ -95,6 +105,7 @@
 | Switcher topic | Whenever the node receives a payload from this **topic**, it switches the input messages to an output. |
 | With Input | It's the msg property to be evaluated. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
 | Then | This property, allow you to auto toggle the selected start state after some time. |
+| Translator Input | Translates the incoming <code>payload</code> value, to true/false. This allows the compatibility with, for example, **HomeAssistant** nodes. |
 
 * Input messages
 

package/boolean-logic-ultimate/RailwaySwitchUltimate.js

@@ -1,81 +1,120 @@
 module.exports = function (RED) {
-	function RailwaySwitchUltimate(config) {
-		RED.nodes.createNode(this, config);
-		this.config = config;
-		var node = this;
-		node.currentMsg = {}; // Stores current payload
-		node.sTriggerTopic = node.config.triggertopic.replace(/[`~!@#$%^&*()_|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, '') || "trigger"; // Topic controlling the iRailway
-		node.iRailway = Number(node.config.initializewith); // Railway selector
-		node.autoToggle = config.autoToggle === undefined ? 0 : parseInt(config.autoToggle); // Auto toggle the selected "initializewith" after a while (useful for homekit bridged, that sends junk after start)
-		node.timerAutoToggle = null;
+  function RailwaySwitchUltimate(config) {
+    RED.nodes.createNode(this, config);
+    this.config = config;
+    var node = this;
+    node.currentMsg = {}; // Stores current payload
+    node.sTriggerTopic =
+      node.config.triggertopic.replace(
+        /[`~!@#$%^&*()_|+\-=?;:'",.<>\{\}\[\]\\\/]/gi,
+        ""
+      ) || "trigger"; // Topic controlling the iRailway
+    node.iRailway = Number(node.config.initializewith); // Railway selector
+    node.autoToggle =
+      config.autoToggle === undefined ? 0 : parseInt(config.autoToggle); // Auto toggle the selected "initializewith" after a while (useful for homekit bridged, that sends junk after start)
+    node.timerAutoToggle = null;
 
-		function setNodeStatus({ fill, shape, text }) {
-			let dDate = new Date();
-			node.status({ fill: fill, shape: shape, text: text + " (" + dDate.getDate() + ", " + dDate.toLocaleTimeString() + ")" })
-		}
+    function setNodeStatus({ fill, shape, text }) {
+      let dDate = new Date();
+      node.status({
+        fill: fill,
+        shape: shape,
+        text:
+          text +
+          " (" +
+          dDate.getDate() +
+          ", " +
+          dDate.toLocaleTimeString() +
+          ")",
+      });
+    }
 
-		node.alignStatus = () => {
-			let sAutoToggle = node.autoToggle > 0 ? " (Autotoggle in " + node.autoToggle + "s)" : "";
-			if (node.iRailway === 0) {
-				setNodeStatus({ fill: "green", shape: "dot", text: "-> UPPER PIN" + sAutoToggle });
-			} else {
-				setNodeStatus({ fill: "blue", shape: "dot", text: "-> LOWER PIN" + sAutoToggle });
-			}
-		}
+    node.alignStatus = () => {
+      let sAutoToggle =
+        node.autoToggle > 0 ? " (Autotoggle in " + node.autoToggle + "s)" : "";
+      if (node.iRailway === 0) {
+        setNodeStatus({
+          fill: "green",
+          shape: "dot",
+          text: "-> UPPER PIN" + sAutoToggle,
+        });
+      } else {
+        setNodeStatus({
+          fill: "blue",
+          shape: "dot",
+          text: "-> LOWER PIN" + sAutoToggle,
+        });
+      }
+    };
 
-		if (node.autoToggle > 0) {
-			node.timerAutoToggle = setTimeout(() => {
-				node.autoToggle = 0;
-				node.iRailway === 0 ? node.iRailway = 1 : node.iRailway = 0;
-				node.alignStatus();
-			}, node.autoToggle * 1000);
-		}
+    if (node.autoToggle > 0) {
+      node.timerAutoToggle = setTimeout(() => {
+        node.autoToggle = 0;
+        node.iRailway === 0 ? (node.iRailway = 1) : (node.iRailway = 0);
+        node.alignStatus();
+      }, node.autoToggle * 1000);
+    }
 
-		node.alignStatus();
+    node.alignStatus();
 
-		this.on('input', function (msg) {
-			var sIncomingTopic = "";
-			if (msg.hasOwnProperty("topic")) {
-				// 06/11/2019 
-				if (!msg.hasOwnProperty("topic") || msg.topic === undefined) msg.topic = "NoTopicReceived";
-				sIncomingTopic = msg.topic.replace(/[`~!@#$%^&*()_|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, ''); // Cut unwanted Characters
-				if (sIncomingTopic === node.sTriggerTopic) {
+    this.on("input", function (msg) {
+      var sIncomingTopic = "";
+      if (msg.hasOwnProperty("topic")) {
+        // 06/11/2019
+        if (!msg.hasOwnProperty("topic") || msg.topic === undefined)
+          msg.topic = "NoTopicReceived";
+        sIncomingTopic = msg.topic.replace(
+          /[`~!@#$%^&*()_|+\-=?;:'",.<>\{\}\[\]\\\/]/gi,
+          ""
+        ); // Cut unwanted Characters
+        if (sIncomingTopic === node.sTriggerTopic) {
+          const utils = require("./utils.js");
+          let sPayload = utils.fetchFromObject(
+            msg,
+            config.payloadPropName || "payload"
+          );
 
+          // 15/11/2021 inform user about undefined topic or payload
+          if (sPayload === undefined) {
+            setNodeStatus({
+              fill: "red",
+              shape: "dot",
+              text: "Received invalid payload from " + msg.topic || "",
+            });
+            return;
+          }
 
-					const utils = require("./utils.js");
-					let sPayload = utils.fetchFromObject(msg, config.payloadPropName || "payload");
-					
-					// 15/11/2021 inform user about undefined topic or payload
-					if (sPayload === undefined ) {
-						setNodeStatus({ fill: "red", shape: "dot", text: "Received invalid payload from " + msg.topic || "" });
-						return;
-					}
-					
-					msg.payload = utils.ToBoolean(sPayload); // 15/11/2021 Convert input to boolean.
+          msg.payload = utils.ToBoolean(
+            sPayload,
+            RED.nodes.getNode(config.translatorConfig) // Retrieve the config node. It can be null, but it's handled in utils.js;
+          ); 
+          if (msg.payload === undefined) return null;
+          if (node.timerAutoToggle !== null)
+            // 28/01/2022 Stop autotoggle
+            clearInterval(node.timerAutoToggle);
 
-					// 28/01/2022 Stop autotoggle
-					if (node.timerAutoToggle !== null) clearInterval(node.timerAutoToggle);
+          if (msg.payload === false) node.iRailway = 0;
+          if (msg.payload === true) node.iRailway = 1;
+          if (node.iRailway === 0) {
+            setNodeStatus({
+              fill: "green",
+              shape: "dot",
+              text: "-> UPPER PIN",
+            });
+          } else {
+            setNodeStatus({ fill: "blue", shape: "dot", text: "-> LOWER PIN" });
+          }
+          return; // DONT'S SEND THIS MESSAGE
+        }
+      }
+      node.currentMsg = RED.util.cloneMessage(msg);
+      if (node.iRailway === 0) {
+        node.send([msg, null]);
+      } else {
+        node.send([null, msg]);
+      }
+    });
+  }
 
-					if (msg.payload === false) node.iRailway = 0;
-					if (msg.payload === true) node.iRailway = 1;
-					if (node.iRailway === 0) {
-						setNodeStatus({ fill: "green", shape: "dot", text: "-> UPPER PIN" });
-					} else {
-						setNodeStatus({ fill: "blue", shape: "dot", text: "-> LOWER PIN" });
-					}
-					return; // DONT'S SEND THIS MESSAGE
-				}
-			}
-			node.currentMsg = RED.util.cloneMessage(msg);
-			if (node.iRailway === 0) {
-				node.send([msg, null]);
-			} else {
-				node.send([null, msg]);
-			}
-		});
-
-	}
-
-
-	RED.nodes.registerType("RailwaySwitchUltimate", RailwaySwitchUltimate);
-}
+  RED.nodes.registerType("RailwaySwitchUltimate", RailwaySwitchUltimate);
+};

package/boolean-logic-ultimate/toggleUltimate.html

@@ -7,7 +7,8 @@
 				value: "Toggle"
 			},
 			valueToToggle: { value: "true" },
-			payloadPropName: { value: "payload", required: false }
+			payloadPropName: { value: "payload", required: false },
+			translatorConfig: { type: "translator-config", required: false }
 		},
 		inputs: 1,
 		outputs: 1,
@@ -55,7 +56,15 @@
 			<i class="fa fa-home"></i>&nbsp;Output Home Assistant "on"/"off" instead of true/false
 		</label>
 	</div> -->
-	
+	<div class="form-row">
+		<br />
+		<b>Translator</b>
+		<br />
+		<label for="node-input-translatorConfig">
+			<font color="green" size="4px"><i class="fa fa-sign-in" aria-hidden="true"></i></font> Input
+		</label>
+		<input type="text" id="node-input-translatorConfig" />
+	</div>
 	
 </script>
 
@@ -65,6 +74,7 @@
 |Property|Description|
 |--|--|
 | Input | It's the msg property to be evaluated. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
+| Translator Input | Translates the incoming <code>payload</code> value, to true/false. This allows the compatibility with, for example, **HomeAssistant** nodes. |
 
 * Input message
 

package/boolean-logic-ultimate/toggleUltimate.js

@@ -4,7 +4,7 @@ module.exports = function (RED) {
 		this.config = config;
 		var node = this;
 		const utils = require("./utils.js");
-		node.valueToToggle = config.valueToToggle === undefined ? true : utils.ToBoolean(config.valueToToggle);
+		node.valueToToggle = config.valueToToggle === undefined ? true : utils.ToBoolean(config.valueToToggle, RED.nodes.getNode(config.translatorConfig)) // Retrieve the config node. It can be null, but it's handled in utils.js);
 
 		function setNodeStatus({ fill, shape, text }) {
 			let dDate = new Date();

package/boolean-logic-ultimate/translator-config.html

@@ -0,0 +1,63 @@
+<script type="text/javascript">
+    RED.nodes.registerType('translator-config', {
+        category: 'config',
+        defaults: {
+            name: { value: "" },
+            commandText: { value: 'on:true\noff:false\nactive:true\ninactive:false\nopen:true\nclosed:false\nclose:false\n1:true\n0:false\ntrue:true\nfalse:false\nhome:true\nnot_home:false', required: false }
+        },
+        label: function () {
+            return this.name;
+        },
+        oneditprepare: function () {
+            var node = this;
+            node.editor = RED.editor.createEditor({
+                id: 'node-input-editorcommandText',
+                mode: 'ace/mode/text',
+                value: node.commandText
+            });
+        },
+        oneditsave: function () {
+            var node = this;
+            node.commandText = node.editor.getValue();
+            node.editor.destroy();
+            delete node.editor;
+        },
+        oneditcancel: function () {
+            var node = this;
+            node.editor.destroy();
+            delete node.editor;
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="translator-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">
+    </div>
+    <div class="form-row">
+        <label style="width:300px;" for="node-input-commandText"><i class="fa fa-tasks"></i> Translate</label>
+        <div style="height: 250px; min-height:150px;" class="node-text-editor" id="node-input-editorcommandText"></div>
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="translator-config">
+<p>This node translates the input msg to valid true/false values.<p>
+
+
+It can translate an input payload, to a true/false boolean values.<br />
+Each row in the text box, represents a translation command. <br/>
+There are some default translation's rows, to make the *boolean-logic-ultimate* nodes compatible with Homeassistant. <br/>
+You can add your own translation row.<br/>
+
+|Property|Description|
+|--|--|
+| Translate | Add, delete or edit your own translation command. The row's translation command must be **input string:true(or false)**. For example: <code>open:true</code> <code>closed:false</code> |
+
+<br/>
+
+
+[Find it useful?](https://www.paypal.me/techtoday)
+</script>

package/boolean-logic-ultimate/translator-config.js

@@ -0,0 +1,8 @@
+module.exports = function(RED) {
+    function TranslatorConfig(n) {
+        RED.nodes.createNode(this,n);
+        this.commandText = n.commandText;
+
+    }
+    RED.nodes.registerType("translator-config",TranslatorConfig);
+}

package/boolean-logic-ultimate/utils.js

@@ -1,48 +1,57 @@
-module.exports.ToBoolean = function ToBoolean(value) {
-    let res = false;
-    let decimal = /^\s*[+-]{0,1}\s*([\d]+(\.[\d]*)*)\s*$/
-
-    if (typeof value === 'boolean') {
-        return value;
-    } else if (typeof value === 'string') {
-
-        if (value.toLowerCase() === "on") return true;
-        if (value.toLowerCase() === "off") return false;
-
-        if (value.toLowerCase() === "active") return true;
-        if (value.toLowerCase() === "inactive") return false;
-
-        if (value.toLowerCase() === "open") return true;
-        if (value.toLowerCase() === "closed") return false;
-        if (value.toLowerCase() === "close") return false;
-
-        if (value.toLowerCase() === "1") return true;
-        if (value.toLowerCase() === "0") return false;
-
-        if (value.toLowerCase() === "true") return true;
-        if (value.toLowerCase() === "false") return false;
-
-        if (value.toLowerCase() === "home") return true;
-        if (value.toLowerCase() === "not_home") return false;
-
-    } else if (typeof value === 'number') {
-        // Is it formated as a decimal number?
-        if (decimal.test(value)) {
-            res = parseFloat(value) != 0;
-        }
-        else {
-            res = value.toLowerCase() === "true";
+module.exports.ToBoolean = function ToBoolean(value, _configTranslationNode) {
+  let res = false;
+  let decimal = /^\s*[+-]{0,1}\s*([\d]+(\.[\d]*)*)\s*$/;
+
+  if (typeof value === "boolean") {
+    return value;
+  } else if (typeof value === "string") {
+    try {
+      let translationTable = [];
+      if (_configTranslationNode === null) {
+        translationTable = DEFAULTTRANSLATIONINPUT.split("\n");
+      } else {
+        translationTable = _configTranslationNode.commandText.split("\n");
+      }
+      for (let index = 0; index < translationTable.length; index++) {
+        let inputPayloadToBeTranslated = translationTable[index].split(":")[0];
+        let outputBoolean = Boolean(translationTable[index].split(":")[1]);
+        if (
+          value.toLowerCase() === inputPayloadToBeTranslated.toLowerCase() &&
+          inputPayloadToBeTranslated.toLowerCase() !== ""
+        ) {
+          return translationTable[index].split(":")[1] === "true"
+            ? true
+            : false;
         }
-        return res;
+      }
+    } catch (error) {
+      console.log("Boolean-Logic-Ultimate:utils:toBoolean: " + error.message);
     }
+  } else if (typeof value === "number") {
+    // Is it formated as a decimal number?
+    if (decimal.test(value)) {
+      res = parseFloat(value) != 0;
+    } else {
+      res = value.toLowerCase() === "true";
+    }
+    return res;
+  }
 };
 
-module.exports.fetchFromObject = function fetchFromObject(_msg, _payloadPropName) {
-    // The output cannot be an oblect. In case, return undefined.
-    var _index = _payloadPropName.indexOf('.')
-    if (_index > -1) {
-        return fetchFromObject(_msg[_payloadPropName.substring(0, _index)], _payloadPropName.substr(_index + 1));
-    }
-    if (typeof _msg[_payloadPropName] === "object") return undefined;
-    return _msg[_payloadPropName];
+module.exports.fetchFromObject = function fetchFromObject(
+  _msg,
+  _payloadPropName
+) {
+  // The output cannot be an oblect. In case, return undefined.
+  var _index = _payloadPropName.indexOf(".");
+  if (_index > -1) {
+    return fetchFromObject(
+      _msg[_payloadPropName.substring(0, _index)],
+      _payloadPropName.substr(_index + 1)
+    );
+  }
+  if (typeof _msg[_payloadPropName] === "object") return undefined;
+  return _msg[_payloadPropName];
 };
+const DEFAULTTRANSLATIONINPUT =
+  "on:true\noff:false\nactive:true\ninactive:false\nopen:true\nclosed:false\nclose:false\n1:true\n0:false\ntrue:true\nfalse:false\nhome:true\nnot_home:false";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-boolean-logic-ultimate",
-    "version": "1.0.63",
+    "version": "1.1.0",
     "description": "A set of Node-RED enhanced boolean logic and utility nodes, flow interruption, blinker, invert, filter, toggle etc.., with persistent values after reboot. Compatible also with Homeassistant values.",
     "author": "Supergiovane (https://github.com/Supergiovane)",
     "dependencies": {
@@ -33,7 +33,8 @@
             "SumUltimate": "boolean-logic-ultimate/SumUltimate.js",
             "toggleUltimate": "boolean-logic-ultimate/toggleUltimate.js",
             "RailwaySwitchUltimate": "boolean-logic-ultimate/RailwaySwitchUltimate.js",
-            "Comparator": "boolean-logic-ultimate/Comparator.js"
+            "Comparator": "boolean-logic-ultimate/Comparator.js",
+            "translator-config": "boolean-logic-ultimate/translator-config.js"
         }
     }
 }