smart-nodes 0.3.37 → 0.4.0

package/CHANGELOG.md

@@ -6,10 +6,13 @@
 -   Separate values for shutter_complex node for up and down times.
     (Open each node and save it, to use the new times. This should be done before the version 0.4.0 is released.)
 -   For the following nodes you can choose to have one or two outputs (Could be a **breaking change**, please check your nodes).
+
     -   Logic
     -   Compare
     -   Hysteresis
+
 -   You can now separately declare the messages that should be sent by the following nodes (Could be a **breaking change**, please check your nodes).
+
     -   Logic
     -   Compare
     -   Hysteresis
@@ -18,3 +21,62 @@
     -   Logic
     -   Compare
     -   Hysteresis
+
+## Version 0.3.29:
+
+-   Fixed that hysteresis sends only on change, when separate outputs are enabled.
+-   Added a definable short up/down time for the shutter control.
+-   Fixed calculation of the time from string.
+
+## Version 0.3.30:
+
+-   Added counter example.
+
+## Version 0.3.31:
+
+-   Fixed logic node - invert output option.
+
+## Version 0.3.32:
+
+-   Fixed hysteresis node - always change result.
+
+## Version 0.3.33:
+
+-   Fixed hysteresis node - init send.
+
+## Version 0.3.34:
+
+-   Fixed hysteresis node - init send.
+-   Fixed light node - status.
+
+## Version 0.3.35:
+
+-   Fixed saving last message object as a clone of the original message, because it could be changed later.
+
+## Version 0.3.36:
+
+-   Fixed mixing-valve - call of toFixed function.
+
+## Version 0.3.37:
+
+-   Fixed using typedInput with node-red v4.
+-   Started to add English translations.
+
+## Version 0.4.0:
+
+-   Fully added English and German translations.
+-   Light control: Added Alarm off action
+-   Shutter complex control: Added Alarm off action
+-   Restructured the complete code
+-   Improved status texts
+-   **breaking change** (soon): Changed some node internal values. Please open and save the following node types:
+
+    -   Central node
+    -   Compare node
+    -   Counter node
+    -   Hysteresis node
+    -   Shutter complex node
+    -   Statistic node
+
+    After saving the nodes, the values are automatically converted to the new one.
+    This conversion will be removed in version 0.5.0.

package/README.md

@@ -4,17 +4,29 @@ The smart nodes was created to control smart home devices like lights, power out
 This nodes are designed to work with the [node-red-contrib-knx-ultimate](https://github.com/Supergiovane/node-red-contrib-knx-ultimate) but it could also work with other smart technologies.
 
 The knx binary input and output/switching modules should be configured very stupid. Closing a binary input should output 1 and releasing 0.
-Same for the output/switching modules, 1 should turn on and 0 turn out. That makes it easy to count the presses or check for short and long presses.
-Some node has to filter out the binary inputs if they goes to 0 or in other words, if `msg.payload == false`. Please see the internal node documentation then this signals are ignored. As an example sending a toggle topic for closing an input and also for releasing would toggle a light twice.
+Same for the output/switching modules, 1 should turn on and 0 turn off. That makes it easy to count the presses or check for short and long presses.
+Some node has to filter out the binary inputs if they goes to 0 or in other words, if `msg.payload == false`. Please see the internal node documentation then this signals are ignored. As an example sending `msg.topic = "toggle"` for pressing and releasing an button would toggle the output twice.
 
 Sometimes one source node should be connected to multiple smart nodes which requires different topics.
-To avoid requiring many change nodes, the smart node are using a special `msg.topic` notation. You can always send topics in the format `name#number`, e.g. `toggle#1`.
-Smart nodes that requires a name are using only the name part. the # and the number are optional. Smart nodes that requries a number will only use the number, the name and # is also optional.
+To avoid requiring many change nodes, the smart nodes are using a special `msg.topic` notation. You can always send topics in the format `name#number`, e.g. `toggle#1`.
+Smart nodes that requires a name are using only the name part. the # and the number are ignored and optional. Smart nodes that requries a number will only use the number, the name and # is also ignored and optional.
 
-This is usefull when one node provide information to e.g. a light control node, as well as to a logic node.
+This is usefull when one node provides information for example to a light control node and also to a logic node.
 
 This file only describes the general function of the node. See the documentation shown in NodeRed to find out how to use them, or see the included example flows.
-As I'm german, the internal documentation is only available in german. If you need another language, feel free to add localizations and adding more languages via a pull request.
+
+# Important info
+
+This smart nodes are still in development and can have breaking changes. So please always take a look in the [Changelog](CHANGELOG.md) file.
+
+# Support
+
+I spent a lots of hours in this project. If you like it, you can support my work in different ways:
+
+-   Report bugs.
+-   Create pull requests.
+-   Name tipps and tricks if you see any improvement.
+-   Donate via [Paypal](https://paypal.me/BergenSoft).
 
 # Nodes
 
@@ -27,8 +39,9 @@ This node is able to control a light or a power outlet.
 -   Auto turn off the light after a fixed time.
 -   Auto turn off the light with a custom time which is part of the message object.
 -   Toggle light between on and off.
--   Can be triggered by motion sensors.
--   Has an alarm function to go to a specific state (on or off) when the alarm is activated.
+-   Can be activated by motion sensors.
+-   Has an alarm on function to go to a specific state (on or off) when the alarm is activated.
+-   Has an alarm off function to go to a specific (on, off, the last or the last sended) when the alarm is deactivated.
 
 ## 2. Shutter control
 
@@ -38,10 +51,11 @@ There is no support for slats and it is also not planned as I don't need them, b
 ### **Features:**
 
 -   One button control which switch between `up`, `stop`, `down`, `stop`.
--   One button control for each direction `up and stop` or `down and stop`.
--   Send direct position the shutter should be.
+-   Two button control for each direction `up and stop` and `down and stop`.
+-   Send direct position the shutter should go to.
 -   Stop shutter immediately.
--   Has an alarm function to go to a specific state (Open or close) when the alarm is activated.
+-   Has an alarm on function to go to a specific state (Open or close) when the alarm is activated.
+-   Has an alarm off function to restore a specific state when the alarm gets deaktivated.
 
 ## 3. Scene control
 
@@ -165,13 +179,17 @@ This node parses a text and performs actions to the selected and matching smart
 
 ### Examples
 
-[ text ] is optional
+Text in [ Braces ] is optional<br/>
+Room names that has to be entered in the nodes are in `code` style.
+
+-   Turn on [the light in] the `living room` and the `kitchen` off.
+-   Open [the shutter in] the `kitchen` and turn `studio` off.
+-   Close [the shutter in the] `sleeping` room.
+-   `Living room` to 10 %.
+-   Turn on `living room` except the `couch` light.
+
+### **Features:**
 
--   Turn on [the light in] the living room and the kitchen off.
--   Open [the shutter in] the kitchen and turn studio off.
--   Close [the shutter in the] sleeping room.
--   Living room to 10 %.
--   Turn on living room except the couch light.
 -   Sends debug message to output.
 
 ## 15. Mixing valve

package/central/central.html

@@ -256,14 +256,14 @@
             color: "#6EE2D9",
             defaults: {
                 name: { value: "" },
-                mode: { value: "shutter" }, // shutter | light
+                mode: { value: "LIGHT" }, // LIGHT | SHUTTER
                 links: { value: [], type: "smart_shutter-complex-control[]" },
             },
             inputs: 1,
             outputs: 0,
             icon: function ()
             {
-                if (this.mode === "shutter")
+                if (this.mode === "SHUTTER")
                     return "font-awesome/fa-align-justify";
 
                 return "font-awesome/fa-lightbulb-o";
@@ -279,19 +279,36 @@
                 onEditPrepare(this, ["smart_shutter-complex-control", "smart_shutter-control"]);
                 $("#node-input-mode").on("change", function ()
                 {
-                    if (this.value == "shutter")
+                    if (this.value == "SHUTTER")
                         initTreeList(node, ["smart_shutter-complex-control", "smart_shutter-control"]);
                     else
                         initTreeList(node, ["smart_light-control", "smart_scene-control"]);
                 });
 
-                if (!this.mode)
-                {
-                    $("#node-input-mode").val("shutter").trigger("change");
-                }
+                $("#node-input-mode").typedInput({
+                    types: [{
+                        default: "LIGHT",
+                        value: "mode",
+                        options: [
+                            { value: "LIGHT", label: node._("central.ui.light_outlet") },
+                            { value: "SHUTTER", label: node._("central.ui.cover") }
+                        ],
+                    }],
+                });
+
+                // Backward compatibility
+                this.mode = this.mode?.toUpperCase();
+
+                if (this.mode)
+                    $("#node-input-mode").val(this.mode).trigger("change");
+                else
+                    $("#node-input-mode").val("SHUTTER").trigger("change");
+
             },
             oneditsave: function ()
             {
+                let node = this;
+                
                 onEditSave(this);
             },
             onadd: onAdd,
@@ -306,11 +323,8 @@
         <input type="text" id="node-input-name" />
     </div>
     <div class="form-row">
-        <label for="node-input-mode"><span data-i18n="central.ui.type"></span></label>
-        <select id="node-input-mode" style="width: 70%">
-            <option value="shutter" selected><span data-i18n="central.ui.cover"></span></option>
-            <option value="light"><span data-i18n="central.ui.light_outlet"></span></option>
-        </select>
+        <label for="node-input-mode"><i class="fa fa-arrow-right"></i> <span data-i18n="central.ui.type"></span></label>
+        <input id="node-input-mode"/>
     </div>
     <div class="node-input-link-rows" style="position:relative; height: 30px; text-align: right;"
         ><div style="display:inline-block"><input type="text" id="node-input-link-target-filter" /></div

package/central/central.js

@@ -7,48 +7,98 @@ module.exports = function (RED)
         const node = this;
         RED.nodes.createNode(node, config);
 
-        // runtime values
+        // ###################
+        // # Class constants #
+        // ###################
+        const MODE_LIGHT = "LIGHT"
+        const MODE_SHUTTER = "SHUTTER";
+
+
+        // #######################
+        // # Global help objects #
+        // #######################
+        const smart_context = require("../persistence.js")(RED);
+        const helper = require("../smart_helper.js");
+
+
+        // #####################
+        // # persistent values #
+        // #####################
+        // Not used from this node
+
+
+        // ##################
+        // # Dynamic config #
+        // ##################
+        let mode = config.mode?.toUpperCase() ?? MODE_LIGHT;
+
+
+        // ##################
+        // # Runtime values #
+        // ##################
+
+        // This map saves the state of all connected nodes.
+        // The key is the node id of the connected node.
         let states = new Map();
 
-        // listen to all events sended directly to this node
+
+        // #########################
+        // # Central node handling #
+        // #########################
         let event = "node:" + config.id;
         let handler = function (msg)
         {
             if (typeof msg.source == "undefined" || typeof msg.state == "undefined")
             {
-                console.warn(RED._("central.errors.unknown_message"), msg);
+                console.warn("Unknown message received in smart_node central.", msg);
                 return;
             }
 
             // Save feedback from linked node
             states.set(msg.source, msg.state);
-
-            if (isAllOff())
-                node.status({ fill: "red", shape: "dot", text: "central.status.all_off" });
-            else
-                node.status({ fill: "green", shape: "dot", text: "central.status.Something_is_on" });
+            setStatus();
         }
         RED.events.on(event, handler);
 
-        node.status({});
 
         node.on("input", function (msg)
+        {
+            handleTopic(msg);
+
+            setStatus();
+        });
+
+        node.on("close", function ()
+        {
+            // Cleanup event listener
+            RED.events.removeListener(event, handler);
+        });
+
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
+        let handleTopic = msg =>
         {
             // copy message, so original message stays unchanged
-            let new_msg = Object.assign({}, msg);
+            let new_msg = helper.cloneObject(msg);
+
+            let real_topic = helper.getTopicName(msg.topic);
 
             // make connected nodes behavior homogenous
-            switch (config.mode)
+            switch (mode)
             {
-                case "shutter":
-                    if (msg.topic == "up_stop")
+                case MODE_SHUTTER:
+                    if (real_topic == "up_stop")
                     {
                         if (isAllOff())
                             new_msg.topic = "up";
                         else
                             new_msg.topic = "stop";
                     }
-                    else if (msg.topic == "down_stop")
+                    else if (real_topic == "down_stop")
                     {
                         if (isAllOff())
                             new_msg.topic = "down";
@@ -57,8 +107,8 @@ module.exports = function (RED)
                     }
                     break;
 
-                case "light":
-                    if (msg.topic == "toggle")
+                case MODE_LIGHT:
+                    if (real_topic == "toggle")
                     {
                         if (isAllOff())
                             new_msg.topic = "on";
@@ -71,19 +121,16 @@ module.exports = function (RED)
             // Send cloned message to all linked nodes
             config.links.forEach(link =>
             {
-                // console.log(node.id + " -> " + link);
-                // console.log(newMsg);
+                helper.log(node.id + " -> " + link);
+                helper.log(new_msg);
                 RED.events.emit("node:" + link, new_msg);
             });
-        });
-
-        node.on("close", function ()
-        {
-            // Cleanup event listener
-            RED.events.removeListener(event, handler);
-        });
+        }
 
-        // This functions return true if all lights are off or all shutter are stopped
+        /**
+         * This functions return true if all lights are off or all shutter are stopped
+         * @returns true if all is off
+         */
         let isAllOff = () =>
         {
             for (let [key, state] of states)
@@ -94,6 +141,17 @@ module.exports = function (RED)
 
             return true;
         }
+
+        /**
+         * Set the current node status
+         */
+        let setStatus = () =>
+        {
+            if (isAllOff())
+                node.status({ fill: "red", shape: "dot", text: "central.status.all_off" });
+            else
+                node.status({ fill: "green", shape: "dot", text: "central.status.Something_is_on" });
+        }
     }
     RED.nodes.registerType("smart_central-control", CentralControlNode);
 };

package/central/locales/de-DE/central.json

@@ -1,11 +1,8 @@
 {
     "central": {
-        "errors": {
-            "unknown_message": "Unbekannte Nachricht in smart_node central empfangen."
-        },
         "status": {
             "all_off": "Alles aus",
-            "Something_is_on": "Something is on"
+            "Something_is_on": "Etwas ist an"
         },
         "ui": {
             "name": "Name",

package/central/locales/en-US/central.json

@@ -1,8 +1,5 @@
 {
     "central": {
-        "errors": {
-            "unknown_message": "Unknown message received in smart_node central."
-        },
         "status": {
             "all_off": "All off",
             "Something_is_on": "Something is on"

package/compare/compare.html

@@ -3,14 +3,13 @@
         category: "Smart Nodes",
         paletteLabel: "Compare",
         color: "#E2D96E",
-        color: "#E2D96E",
         defaults: {
             name: { value: "" },
             comparator: { value: "EQUAL" }, // EQUAL, GREATER, GREATER_EQUAL, SMALLER, SMALLER_EQUAL, UNEQUAL
             value1: { value: "" },
-            value1_type: { value: "null" },
+            value1_type: { value: "NOTHING" },
             value2: { value: "" },
-            value2_type: { value: "null" },
+            value2_type: { value: "NOTHING" },
             out_false: { value: '{"topic": ""}' },
             out_false_type: { value: 'json' },
             out_true: { value: '{"topic": ""}' },
@@ -33,17 +32,19 @@
         },
         oneditprepare: function ()
         {
+            let node = this;
+
             $("#node-input-comparator").typedInput({
                 types: [{
                     default: "EQUAL",
                     value: "comperator",
                     options: [
-                        { value: "SMALLER", label: "< Kleiner" },
-                        { value: "SMALLER_EQUAL", label: "<= Kleiner oder gleich" },
-                        { value: "EQUAL", label: "== Gleich" },
-                        { value: "UNEQUAL", label: "!= Ungleich" },
-                        { value: "GREATER_EQUAL", label: ">= Größer oder gleich" },
-                        { value: "GREATER", label: "> Größer" }
+                        { value: "SMALLER", label: node._("compare.ui.smaller") },
+                        { value: "SMALLER_EQUAL", label: node._("compare.ui.smaller_equal") },
+                        { value: "EQUAL", label: node._("compare.ui.equal") },
+                        { value: "UNEQUAL", label: node._("compare.ui.unequal") },
+                        { value: "GREATER_EQUAL", label: node._("compare.ui.greater_equal") },
+                        { value: "GREATER", label: node._("compare.ui.greater") },
                     ],
                 }],
             });
@@ -51,8 +52,8 @@
             $("#node-input-value1").typedInput({
                 type: "num",
                 types: ["str", "num", "bool", {
-                    value: "null",
-                    label: this._("compare.ui.no_value"),
+                    value: "NOTHING",
+                    label: node._("compare.ui.no_value"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -62,8 +63,8 @@
             $("#node-input-value2").typedInput({
                 type: "num",
                 types: ["str", "num", "bool", {
-                    value: "null",
-                    label: this._("compare.ui.no_value"),
+                    value: "NOTHING",
+                    label: node._("compare.ui.no_value"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -75,8 +76,8 @@
             $("#node-input-out_true").typedInput({
                 type: "json",
                 types: ["json", {
-                    value: "null",
-                    label: this._("compare.ui.send_nothing"),
+                    value: "NOTHING",
+                    label: node._("compare.ui.send_nothing"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -86,8 +87,8 @@
             $("#node-input-out_false").typedInput({
                 type: "json",
                 types: ["json", {
-                    value: "null",
-                    label: this._("compare.ui.send_nothing"),
+                    value: "NOTHING",
+                    label: node._("compare.ui.send_nothing"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -100,8 +101,8 @@
                     value: "1",
                     value: "send_only_change",
                     options: [
-                        { value: "true", label: this._("compare.ui.only_on_change") },
-                        { value: "false", label: this._("compare.ui.always") },
+                        { value: "true", label: node._("compare.ui.send_only_change") },
+                        { value: "false", label: node._("compare.ui.always") },
                     ]
                 }]
             });
@@ -112,8 +113,8 @@
                     value: "1",
                     value: "outputs",
                     options: [
-                        { value: "1", label: this._("compare.ui.common_output") },
-                        { value: "2", label: this._("compare.ui.separate_output") },
+                        { value: "1", label: node._("compare.ui.common_output") },
+                        { value: "2", label: node._("compare.ui.separate_output") },
                     ]
                 }]
             });
@@ -128,6 +129,22 @@
                     $("#resend_on_start_row").hide();
             });
             $("#node-input-save_state").trigger("change");
+
+
+
+            // Backward compatibility
+            if (this.value1_type == "null")
+            {
+                this.value1_type = "NOTHING";
+                $("#node-input-value1_type").val("NOTHING");
+            }
+
+            if (this.value2_type == "null")
+            {
+                this.value2_type = "NOTHING";
+                $("#node-input-value2_type").val("NOTHING");
+            }
+
         },
     });
 </script>
@@ -175,9 +192,8 @@
         <input id="node-input-outputs" />
     </div>
     <div class="form-row" style="max-width: 28rem">
-        <div><strong><span data-i18n="compare.ui.note"></span>:</strong></div>
-        <div><code>msg.payload</code> <span data-i18n="compare.ui.note_payload"></span></div>
-        <div><code>msg.comperator</code> <span data-i18n="compare.ui.note_comperator"></span></div>
+        <div><strong data-i18n="compare.ui.note"></strong></div>
+        <div data-i18n="[html]compare.ui.note_text"></div>
     </div>
     <hr/>
     <h4 style="margin: 0.5rem 0;"><span data-i18n="compare.ui.system_start"></span></h4>