smart-nodes 0.4.14 → 0.4.15

package/CHANGELOG.md

@@ -1,142 +1,146 @@
-# Changelog
-
-## Version 0.3.28:
-
--   Added this changlog file.
--   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
-
--   You can choose for the following nodes if they should send the result all the time or only if the result changed.
-    -   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.
-
-## Version 0.4.1:
-
--   Show only up to 2 decimal places in node status text.
--   Improved warn messages shown in console.
-
-## Version 0.4.2:
-
--   Fixed design of property page of forwarder node.
--   Corrected hysteresis to send original message.
-
-## Version 0.4.3:
-
--   Corrected hysteresis (again) to send original message.
-
-## Version 0.4.4:
-
--   Fixed the delay node to not restart the time if "only on change" option is enabled.
-
-## Version 0.4.5:
-
--   Fixed the status of hysteresis node.
-
-## Version 0.4.6:
-
--   Fixed the status of hysteresis node.
-
-## Version 0.4.7:
-
--   Added blink topic to light node.
-
-## Version 0.4.8:
-
--   Fixed reading values in heating-curve node.
-
-## Version 0.4.9:
-
--   Fixed reading config values for offset and slope in heating-curve node.
-
-## Version 0.4.10:
-
--   **breaking change** (soon): Added common and separate outputs to multi press node.
-    Please open node config and save it to make sure it will work in later versions.
--   Added common and separate outputs to long press node.
-
-## Version 0.4.11:
-
--   Fixed long press default outputs.
-
-## Version 0.4.12:
-
--   Fixed text exec node.
-
-## Version 0.4.13:
-
--   Fixed text exec node again.
-
-## Version 0.4.14:
-
--   Removed log outputs.
+# Changelog
+
+## Version 0.3.28:
+
+-   Added this changlog file.
+-   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
+
+-   You can choose for the following nodes if they should send the result all the time or only if the result changed.
+    -   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.
+
+## Version 0.4.1:
+
+-   Show only up to 2 decimal places in node status text.
+-   Improved warn messages shown in console.
+
+## Version 0.4.2:
+
+-   Fixed design of property page of forwarder node.
+-   Corrected hysteresis to send original message.
+
+## Version 0.4.3:
+
+-   Corrected hysteresis (again) to send original message.
+
+## Version 0.4.4:
+
+-   Fixed the delay node to not restart the time if "only on change" option is enabled.
+
+## Version 0.4.5:
+
+-   Fixed the status of hysteresis node.
+
+## Version 0.4.6:
+
+-   Fixed the status of hysteresis node.
+
+## Version 0.4.7:
+
+-   Added blink topic to light node.
+
+## Version 0.4.8:
+
+-   Fixed reading values in heating-curve node.
+
+## Version 0.4.9:
+
+-   Fixed reading config values for offset and slope in heating-curve node.
+
+## Version 0.4.10:
+
+-   **breaking change** (soon): Added common and separate outputs to multi press node.
+    Please open node config and save it to make sure it will work in later versions.
+-   Added common and separate outputs to long press node.
+
+## Version 0.4.11:
+
+-   Fixed long press default outputs.
+
+## Version 0.4.12:
+
+-   Fixed text exec node.
+
+## Version 0.4.13:
+
+-   Fixed text exec node again.
+
+## Version 0.4.14:
+
+-   Removed log outputs.
+
+## Version 0.4.15:
+
+-   Reverted some tests.

package/light/light.html

@@ -139,6 +139,7 @@
             defaults: {
                 name: { value: "" },
                 exec_text_names: { value: "" },
+                data_type: { value: "SIMPLE" }, // SIMPLE || HOMEASSISTANT
                 max_time_on: { value: "0" },
                 max_time_on_unit: { value: "s" },
                 alarm_action: { value: 'NOTHING' }, // NOTHING | ON | OFF
@@ -159,6 +160,19 @@
                 onEditPrepare(this, ["smart_central-control"]);
                 initTreeList(node, ["smart_central-control"]);
 
+                $("#node-input-data_type")
+                    .css("max-width", "70%")
+                    .typedInput({
+                        types: [{
+                            value: "data_type",
+                            default: "SIMPLE",
+                            options: [
+                                { value: "SIMPLE", label: node._("light.ui.simple") },
+                                { value: "HOMEASSISTANT", label: node._("light.ui.home_assistant") }
+                            ],
+                        }],
+                    });
+
                 $("#node-input-max_time_on")
                     .css("max-width", "4rem")
                     .spinner({
@@ -237,6 +251,10 @@
         <input id="node-input-exec_text_names" type="text" />
         <div style="max-width: 450px;" data-i18n="light.ui.controlled_by_words"></div>
     </div>
+    <div class="form-row">
+        <label for="node-input-data_type"><i class="fa fa-file-code-o"></i> <span data-i18n="light.ui.data_type"></span></label>
+        <input id="node-input-data_type"/>
+    </div>
     <div class="form-row">
         <label for="node-input-max_time_on"><i class="fa fa-clock-o"></i> <span data-i18n="light.ui.max_time_on"></span></label>
         <input id="node-input-max_time_on" value="0" />

package/light/light.js

@@ -45,6 +45,7 @@ module.exports = function (RED)
         let max_time_on = helper.getTimeInMs(config.max_time_on, config.max_time_on_unit);
         let alarm_action = config.alarm_action || "NOTHING";
         let alarm_off_action = config.alarm_off_action || "NOTHING";
+        let data_type = config.data_type || "SIMPLE";
 
         // ##################
         // # Runtime values #
@@ -230,7 +231,7 @@ module.exports = function (RED)
                     if (!node_settings.alarm_active)
                     {
                         isBlinking = true;
-                        node.send({ payload: !node_settings.last_value });
+                        sendState(!node_settings.last_value)
                         setStatus();
                         setTimeout(
                             () =>
@@ -238,7 +239,7 @@ module.exports = function (RED)
                                 isBlinking = false;
                                 if (!node_settings.alarm_active)
                                 {
-                                    node.send({ payload: node_settings.last_value });
+                                    sendState(node_settings.last_value)
                                     setStatus();
                                 }
                             },
@@ -283,7 +284,7 @@ module.exports = function (RED)
             }
 
             if (node_settings.alarm_active || helper.getTopicName(msg.topic) != "status")
-                node.send({ payload: node_settings.last_value });
+                sendState(node_settings.last_value)
 
             // Output is on, now
             if (node_settings.last_value && doRestartTimer)
@@ -326,7 +327,7 @@ module.exports = function (RED)
             {
                 timeout = null;
                 node_settings.last_value = false;
-                node.send({ payload: false });
+                sendTurnOff();
                 notifyCentral(false);
 
                 setStatus();
@@ -372,6 +373,67 @@ module.exports = function (RED)
             }
         }
 
+        /**
+         * Turns the output to the given state and returns the sent message
+         * @param {bool} state The new state of the output
+         * @returns The sent message
+         */
+        let sendState = state =>
+        {
+            if (state)
+                return sendTurnOn();
+
+            return sendTurnOff();
+        }
+
+        /**
+         * Turns the output on and returns the sent message
+         * @returns The sent message
+         */
+        let sendTurnOn = () =>
+        {
+            let data = null;
+            switch (data_type)
+            {
+                case "SIMPLE":
+                    data = { payload: true };
+                    break;
+
+                case "HOMEASSISTANT":
+                    data = { payload: { action: "homeassistant.turn_on" } };
+                    break;
+
+                default:
+                    return null;
+            }
+            node.send(data);
+            return data;
+        }
+
+        /**
+         * Turns the output off and returns the sent message
+         * @returns The sent message
+         */
+        let sendTurnOff = () =>
+        {
+            let data = null;
+            switch (data_type)
+            {
+                case "SIMPLE":
+                    data = { payload: false };
+                    break;
+
+                case "HOMEASSISTANT":
+                    data = { payload: { action: "homeassistant.turn_off" } };
+                    break;
+
+                default:
+                    return null;
+            }
+            node.send(data);
+            return data;
+        }
+
         /**
          * Notify all connected central nodes
          * @param {boolean} state The state if the light is on

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

@@ -1,24 +1,29 @@
-{
-    "light": {
-        "ui": {
-            "name": "Name",
-            "text": "Text",
-            "controlled_by_words": "Diese Node kann über die eingegebenen Wörter gesteuert werden. Mehrere Wörter werden durch ein Komma getrennt.",
-            "max_time_on": "Max Zeit Ein",
-            "alarm_on": "Alarm Ein",
-            "alarm_off": "Alarm Aus",
-            "controlled_by_central": "Dieser Baustein wird von folgenden Zentralbausteinen gesteuert:",
-
-            "milliseconds": "Millisekunden",
-            "seconds": "Sekunden",
-            "minutes": "Minuten",
-            "hours": "Stunden",
-
-            "no_action": "Keine Aktion",
-            "turn_on": "Einschalten",
-            "turn_off": "Ausschalten",
-            "last_state": "Letzen Zustand",
-            "last_sended_state": "Zuletzt gesendeten Zustand"
-        }
-    }
-}
+{
+    "light": {
+        "ui": {
+            "name": "Name",
+            "text": "Text",
+            "controlled_by_words": "Diese Node kann über die eingegebenen Wörter gesteuert werden. Mehrere Wörter werden durch ein Komma getrennt.",
+
+            "data_type": "Datentyp",
+            "simple": "Einfaches Format",
+            "home_assistant": "HA Action Format",
+
+            "max_time_on": "Max Zeit Ein",
+            "alarm_on": "Alarm Ein",
+            "alarm_off": "Alarm Aus",
+            "controlled_by_central": "Dieser Baustein wird von folgenden Zentralbausteinen gesteuert:",
+
+            "milliseconds": "Millisekunden",
+            "seconds": "Sekunden",
+            "minutes": "Minuten",
+            "hours": "Stunden",
+
+            "no_action": "Keine Aktion",
+            "turn_on": "Einschalten",
+            "turn_off": "Ausschalten",
+            "last_state": "Letzen Zustand",
+            "last_sended_state": "Zuletzt gesendeten Zustand"
+        }
+    }
+}

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

@@ -1,24 +1,29 @@
-{
-    "light": {
-        "ui": {
-            "name": "Name",
-            "text": "Text",
-            "controlled_by_words": "This node can be controlled using the words entered. Multiple words are separated by a comma.",
-            "max_time_on": "Max time on",
-            "alarm_on": "Alarm on",
-            "alarm_off": "Alarm off",
-            "controlled_by_central": "This block is controlled by the following central blocks:",
-
-            "milliseconds": "Milliseconds",
-            "seconds": "Seconds",
-            "minutes": "Minutes",
-            "hours": "Hours",
-
-            "no_action": "No action",
-            "turn_on": "Turn on",
-            "turn_off": "Turn off",
-            "last_state": "Last state",
-            "last_sended_state": "Last sent state"
-        }
-    }
-}
+{
+    "light": {
+        "ui": {
+            "name": "Name",
+            "text": "Text",
+            "controlled_by_words": "This node can be controlled using the words entered. Multiple words are separated by a comma.",
+
+            "data_type": "Data type",
+            "simple": "Simple format",
+            "home_assistant": "HA Action format",
+
+            "max_time_on": "Max time on",
+            "alarm_on": "Alarm on",
+            "alarm_off": "Alarm off",
+            "controlled_by_central": "This block is controlled by the following central blocks:",
+
+            "milliseconds": "Milliseconds",
+            "seconds": "Seconds",
+            "minutes": "Minutes",
+            "hours": "Hours",
+
+            "no_action": "No action",
+            "turn_on": "Turn on",
+            "turn_off": "Turn off",
+            "last_state": "Last state",
+            "last_sended_state": "Last sent state"
+        }
+    }
+}

package/logic/locales/de-DE/logic.html

@@ -1,12 +1,12 @@
-<script type="text/html" data-help-name="smart_logic">
-    <p>Dieser Knoten bietet verschiedene Logikoperationen, wie AND, OR und XOR an.</p>
-    <p>Alle Eingänge, sowie der Ausgang lassen sich gezielt invertieren, womit weitere komplexe Logiken abgebildet werden können.</p>
-    <p>Um beispielsweise eine NOT Logik zu erstellen, wird die Anzahl der Eingänge auf 1 gesetzt, die Logik auf AND oder OR und der Ausgang invertiert.</p>
-    <p>
-        <b>Hinweis:</b> Smart Nodes verwenden Topics im Format <code>name#nummer</code>, damit können verschiedene Smart Nodes mit dem gleichen Topic angesteuert werden.<br/>
-        Diese Node verwendet nur den Teil <code>nummer</code>. <code>name</code> und <code>#</code> sind dabei optional.
-    </p>
-    <p>
-        <strong>Hinweis:</strong> <code>msg.payload</code> wird automatisch auf das Logik-Ergebnis gesetzt, sofern es nicht bereits in der Konfiguration gesetzt wurde.
-    </p>
+<script type="text/html" data-help-name="smart_logic">
+    <p>Dieser Knoten bietet verschiedene Logikoperationen, wie AND, OR und XOR an.</p>
+    <p>Alle Eingänge, sowie der Ausgang lassen sich gezielt invertieren, womit weitere komplexe Logiken abgebildet werden können.</p>
+    <p>Um beispielsweise eine NOT Logik zu erstellen, wird die Anzahl der Eingänge auf 1 gesetzt, die Logik auf AND oder OR und der Ausgang invertiert.</p>
+    <p>
+        <b>Hinweis:</b> Smart Nodes verwenden Topics im Format <code>name#nummer</code>, damit können verschiedene Smart Nodes mit dem gleichen Topic angesteuert werden.<br/>
+        Diese Node verwendet nur den Teil <code>nummer</code>. <code>name</code> und <code>#</code> sind dabei optional.
+    </p>
+    <p>
+        <strong>Hinweis:</strong> <code>msg.payload</code> wird automatisch auf das Logik-Ergebnis gesetzt, sofern es nicht bereits in der Konfiguration gesetzt wurde.
+    </p>
 </script>

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

@@ -1,27 +1,27 @@
-{
-    "logic": {
-        "ui": {
-            "name": "Name",
-            "logic": "Logik",
-            "inputs": "Eingänge",
-            "invert": "Invertieren",
-            "output": "Ausgang",
-            "output_messages": "Ausgangsnachrichten",
-            "true": "Wahr",
-            "false": "Falsch",
-            "send": "Senden",
-            "outputs": "Ausgänge",
-            "note": "Hinweis:",
-            "note_text": "<code>msg.payload</code> wird automatisch auf das Logik-Ergebnis gesetzt,<br/>sofern es nicht bereits hier in der Konfiguration gesetzt wurde.",
-            "system_start": "Systemstart",
-            "save_state": "Zustand speichern",
-            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden",
-
-            "send_nothing": "Nichts senden",
-            "send_only_change": "Nur bei Änderung",
-            "always": "Immer",
-            "common_output": "Gemeinsamer Ausgang",
-            "separate_output": "Separate Ausgänge"
-        }
-    }
-}
+{
+    "logic": {
+        "ui": {
+            "name": "Name",
+            "logic": "Logik",
+            "inputs": "Eingänge",
+            "invert": "Invertieren",
+            "output": "Ausgang",
+            "output_messages": "Ausgangsnachrichten",
+            "true": "Wahr",
+            "false": "Falsch",
+            "send": "Senden",
+            "outputs": "Ausgänge",
+            "note": "Hinweis:",
+            "note_text": "<code>msg.payload</code> wird automatisch auf das Logik-Ergebnis gesetzt,<br/>sofern es nicht bereits hier in der Konfiguration gesetzt wurde.",
+            "system_start": "Systemstart",
+            "save_state": "Zustand speichern",
+            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden",
+
+            "send_nothing": "Nichts senden",
+            "send_only_change": "Nur bei Änderung",
+            "always": "Immer",
+            "common_output": "Gemeinsamer Ausgang",
+            "separate_output": "Separate Ausgänge"
+        }
+    }
+}

package/logic/locales/en-US/logic.html

@@ -1,12 +1,12 @@
-<script type="text/html" data-help-name="smart_logic">
-    <p>This node offers various logic operations, such as AND, OR and XOR.</p>
-    <p>All inputs and the output can be specifically inverted, which can be used to map further complex logic.</p>
-    <p>For example, to create a NOT logic, the number of inputs is set to 1, the logic to AND or OR and the output is inverted.</p>
-    <p>
-        <b>Note:</b> Smart Nodes use topics in the format <code>name#number</code>, so that different Smart Nodes can be controlled with the same topic.<br />
-        This node only uses the <code>number</code> part. <code>name</code> and <code>#</code> are optional.
-    </p>
-    <p>
-        <strong>Note:</strong> <code>msg.payload</code> is automatically set to the logic result if it has not already been set in the configuration.
-    </p>
+<script type="text/html" data-help-name="smart_logic">
+    <p>This node offers various logic operations, such as AND, OR and XOR.</p>
+    <p>All inputs and the output can be specifically inverted, which can be used to map further complex logic.</p>
+    <p>For example, to create a NOT logic, the number of inputs is set to 1, the logic to AND or OR and the output is inverted.</p>
+    <p>
+        <b>Note:</b> Smart Nodes use topics in the format <code>name#number</code>, so that different Smart Nodes can be controlled with the same topic.<br />
+        This node only uses the <code>number</code> part. <code>name</code> and <code>#</code> are optional.
+    </p>
+    <p>
+        <strong>Note:</strong> <code>msg.payload</code> is automatically set to the logic result if it has not already been set in the configuration.
+    </p>
 </script>